BPMUpdateTheme command

This command generates runtime CSS for a process application or toolkit snapshot using the theme definition of a source project.

Use the BPMUpdateTheme command to make a project (process application or toolkit) to look like another project without redeploying the project. The command generates the CSS based on the theme definition of a source process application or toolkit snapshot. While the generated CSS for the two projects is different, the projects can have a similar look because the definitions used to generate the CSS are the same.

Use the command in connected mode from a Process Server.

The BPMUpdateTheme command is run using the AdminTask object of the wsadmin scripting client.

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 Process Server 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 IBM® BPM 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 Process Manager 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

BPMUpdateTheme 
-sourceContainerAcronym process_application_or_toolkit_acronym
-sourceContainerSnapshotAcronym snapshot_acronym
[-themeName theme]
-targetContainerAcronym process_application_or_toolkit_acronym
-targetContainerSnapshotAcronym snapshot_acronym

Parameters

-sourceContainerAcronym String: A required parameter that uses an acronym to identify the process application or toolkit that contains the source theme definition. For example, the BillingDispute process application might have an acronym of BILLDISP.
-sourceContainerSnapshotAcronym String: A required parameter that uses an acronym to identify the specific snapshot that contains the source theme definition.
-themeName String: An optional parameter that identifies the specific theme definition that the command will use to generate the CSS for the target process application. If the parameter is not included, the command uses the theme definition of the current source process application or toolkit.
-targetContainerAcronym String: A required parameter that uses an acronym to identify the process application or toolkit that contains the target snapshot.
-targetContainerSnapshotAcronym String: A required parameter that uses an acronym to identify the snapshot that will have the CSS generated by its current theme definition replaced by the CSS generated from the source theme definition.

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), as described in the topic BPMShowProcessApplication command.

Example

After you establish a SOAP connection to Process Server, you can use the following example to apply the BILLPAY snapshot v5.3 theme definition to the BILLDISP snapshot v2.

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Process Server 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 and find the value for SOAP_CONNECTOR_ADDRESS).

wsadmin>AdminTask.BPMUpdateTheme('[-sourceContainerAcronym BILLPAY -sourceContainerSnapshotAcronym v5.3 
-themeName billTheme -targetContainerAcronym BILLDISP -targetContainerSnapshotAcronym v2]')