BPMUpdateFile command

Edit online
Use the BPMUpdateFile command to update the contents of an existing file in your process application or toolkit. When the command runs, it creates a new version of the file at the tip of the branch.

You use the AdminTask object of the wsadmin scripting client to run the BPMUpdateFile command.

Prerequisites

Note: 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:
  • Run the command in the connected mode; that is, do not use the wsadmin -conntype none option.

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

  • Note: If you use a SOAP connection, the command can take longer to complete than the specified SOAP timeout value. Although the command runs 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. The BPMUpdateFile command does not write to a log file, but the wsadmin scripting client always writes a profile_root/logs/wsadmin.traceout log file where you will find exception stack traces and other information.

Syntax

BPMUpdateFile
-containerAcronym process_application_acronym
[-containerTrackAcronym track_acronym]
-fileType file_type
-fileName file_name
-inputFile input_file_path
[-fileDescription file_description]

Parameters

-containerAcronym project_acronym
A required parameter that identifies the target project. The wildcard character (*) is supported and the theme is regenerated for all named snapshots in the server.
-containerTrackAcronym track_acronym
On a Workflow Center server, an optional parameter that identifies the acronym of the track associated with the process application. If not specified, the default track is used. Projects can have a non-default track if track development is enabled in Workflow Center. Snapshots installed on a Workflow Server do not have tracks.
-fileType file_type
A required parameter that identifies the type of file to be updated. The possible values are Web, Server, or Design. A web file can contain images, .css files, or other assets that are used in your IBM Process Designer coaches. A server file can contain JAR or JavaScript files or some other type of asset that are used in an IBM Business Automation Workflow implementation. A design file can contain .xsl files (content type text/xml or application/xslt+xml) to override the transform XSL for one or more heritage coaches.
-fileName file_name
A required parameter that specifies the name of the file to be updated.
-inputFile input_file_path
A required parameter that identifies the absolute path of the input file used to override the current file.
-fileDescription file_description
An optional parameter that is used to provide a description of the file to be updated. If the descriptive text contains spaces, it must be enclosed in single quotation marks (').

Example

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.
The following Jython example uses the BPMUpdateFile command to update an existing file or create a new file:
wsadmin -conntype SOAP -port 8880 -host ProcessServer.mycompany.com -user admin -password admin
AdminTask.BPMUpdateFile( [ '-containerAcronym', 'HSB', '-containerTrackAcronym', 'Main',
'-fileType', 'Server', '-fileName', 'monitor.jar', '-inputFile', 'C:\misc\monitor_v3.jar',
'-fileDescription', 'External implementation of the Monitor component' ] )