BPMRegenTheme command

Edit online

 Traditional: 
 Running the BPMRegenTheme command updates the snapshots to use the updated CSS without requiring you to redeploy the snapshots.

Some interim fixes or cumulative fixes (fix packs), contain changes in the CSS theme. To apply these changes to the snapshots that were created based on the older version of the CSS theme, use BPMRegenTheme command. The BPMRegenTheme command regenerates the runtime CSS for a process application or toolkit snapshots.

To determine whether to run the command, check the readme file of the interim fix and the post-upgrade documentation for the fix pack. You must run the BPMRegenTheme command if either of these scenarios apply:
  • The interim fix or fix pack contain any changes in the CSS theme.
  • Your process application uses the UI toolkit.
Important:
  • To update a process application or toolkit tip, you can remove and then add one of your process application or toolkit dependent toolkits. Removing and adding a dependent toolkit regenerates the theme. This procedure must be performed in IBM® Process Designer after you upgrade or install an interim fix that contains CSS-related changes.
  • If you are performing a rolling upgrade, as long as your IBM Workflow Center is on an earlier version than your workflow servers, after deploying any snapshots to the workflow servers run the BPMRegenTheme command to update the CSS theme of the snapshot.

Prerequisites

Important: In an environment with multiple security domains configured, use the PALService MBean instead of this wsadmin command. See The Process Application LifeCycle (PAL) MBean.
The following conditions must be met:

  • In a network deployment environment, you must run this command on the node containing the application cluster member that handles Workflow Center applications. Do not run this command from the deployment manager profile.

  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.
  • To access the wsadmin command, the ID being used must have a WebSphere® Application Server role with more privileges than the monitor role. See Administrative roles for information about roles.
  • To access the Business Automation Workflow API used by this command, the ID being used must belong to the bpmAdminGroup. The default name for the bpmAdminGroup is tw_admins. See IBM Business Automation Workflow default group types for information about groups.
    Tip: By default, only the DeAdmin user has both the WebSphere Application Server administrator role and membership in the bpmAdminGroup.
Attention: If you are using a SOAP connection, the command can take longer to complete than the specified SOAP timeout value. Although the command continues to run until it is finished, you might see the exception java.net.SocketTimeoutException: Read timed out. To prevent this exception, set a higher value for the com.ibm.SOAP.requestTimeout property in the profile_root/properties/soap.client.props file.

Location

Start the wsadmin scripting client from the profile_root/bin directory.

You can check the status of the command in the server SystemOut.log file.

Syntax

BPMRegenTheme 
-targetContainerAcronym process_application_or_toolkit_acronym
[-targetContainerSnapshotAcronym snapshot_acronym]
[-outputFile absolute_path_to_log_file]

Parameters

--targetContainerAcronym String
A required parameter that uses an acronym to identify the acronym of the process application or toolkit that will have its CSS regenerated. The * wildcard is supported. The theme is regenerated for the specified snapshot in the server using the currently applied theme.
--targetContainerSnapshotAcronym String

An optional parameter that uses an acronym to identify the snapshot that will have its CSS regenerated based on the currently applied theme definition. If not provided, the theme is regenerated for all of the named snapshots in the target process application or toolkit, which includes the tip if you run the command in Process Center.

-outputFile String

An optional parameter that contains the absolute path to the log file for logging the results of the theme regeneration.

Tip: If you do not know the acronym for a required parameter, use the BPMShowProcessApplication command to list the details of a process application, including acronyms.

Some interim fixes or cumulative fixes (fix packs), contain changes in the CSS theme. To apply these changes to the snapshots that were created based on the older version of the CSS theme, use BPMRegenTheme command.

BPMRegenTheme command regenerates the runtime CSS for a process application or toolkit snapshots.

To determine whether to run the command , check the readme of the ifix and the post installation documentation for the fixpack. If the iFix or fixpack contain any changes in the CSS theme and your process application uses UI toolkit , then running BPMRegenTheme command is required.

Example

The following example illustrates how to establish a SOAP connection to the Workflow Center server and regenerate the CSS for the BILLDISP v2 snapshot.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Workflow Center applications. To determine the correct port number, see the WebSphere administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports or check \AppServer\profiles\<PS_Profile>\logs\AboutThisProfile.txt and find the value for SOAP_CONNECTOR_ADDRESS).
wsadmin -conntype SOAP -port 8880 -host ProcessServer01.mycompany.com -user admin -password admin -lang jython

AdminTask.BPMRegenTheme(['-targetContainerAcronym', 'BILLDISP', 
     '-targetContainerSnapshotAcronym', 'v2', '-outputFile', 'c:/regenThemeLog.txt'])

You will likely need to run the command on all your applications. If so, you can use a wildcard, for exampleAdminTask.BPMRegenTheme(['-targetContainerAcronym', '*']).