cscpireexec (Re-executing process instances)
Format
cscpireexec [-h]
-user login-user-ID
-pass login-password
-csc HCSC-server-name
{-processname business-process-definition-name
|-processnamefile business-process-definition-file-name
|-all}
[{-processid process-instance-identifier
|-processidfile name-of- file-containing-process-instance-identifiers
|-targetcsc name-of-HCSC-server-to-be-re-executed
[-status activity-status-that-forms-re-execution-condition]}]
[-encoding encoding-name]
[-summary]
Function
Re-executes a cancelled process instance according to specified conditions.
This command can also re-execute only the process instances executed on a specified HCSC server. In such cases, the process instances to be re-executed can be specified in accordance with the activity status.
The process instances to be re-executed are as follows:
By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.
For details on how to use this command, see 6.1.5 Re-executing process instances in the Service Platform System Setup and Operation Guide.
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the user ID that is used to log in to HCSC-Manager.
-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the password that is used to log in to HCSC-Manager.
-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the name of the HCSC server to be re-executed.
-processname business-process-definition-name ~ <character string of NCName type in the XML schema> ((64 or fewer bytes in the database character encoding))
Specifies the business process definition name for the process to be re-executed.
-processnamefile business-process-definition-file-name ~ ((1 to 200 bytes))
Specifies the absolute or relative path of the business process definition file for the process to be re-executed. Specify only the business process definition names in the file. The contents of the business process definition file are read, and the leading and trailing spaces, tabs, and linefeeds are removed to obtain the identifiers of the process instances to be re-executed.
-all
Re-executes all the target process instances in a batch.
-processid process-instance-identifier ~ ((1 to 240 bytes or less))
Specifies the process instance identifier of the process to be re-executed. If the -processidfile option is not specified with this option, all the cancelled processes with the business process definition names specified in the options -processname or -processnamefile are re-executed.
A process instance identifier might be a long character string (which is a maximum of 240 characters). Note that if you set up a deep directory hierarchy for the response message output directory, the system might not be able to create a file. If a response message file is not created even after the process is re-executed, a message is displayed.
-processidfile name-of- file-containing-process-instance-identifiers ~ ((1 to 200 bytes))
Specifies the absolute or relative path of the file that contains the process instance identifier of the process to be re-executed. In the file containing process instance identifiers, specify the process instance identifiers only. During command execution, the contents of this file are read and the leading and trailing spaces, tabs, and linefeeds are removed to obtain the identifiers of the process instances you intend to re-execute. If the -processid option is not specified with this option, all the processes that have the business process definition names specified in the options -processname or -processnamefile and which were cancelled during execution are re-executed.
-targetcsc name-of-HCSC-server-to-be-re-executed ~ ((1 to 8 characters))
Specifies the name of the HCSC server to be re-executed. The process instances executed on the specified HCSC server will be re-executed. However, the process instances executed in 08-70 or earlier will not be re-executed.
If this option is omitted, the process instances executed on all HCSC servers are subject to re-execution.
-status activity-status-that-forms-re-execution-condition
Specifies the activity status that forms the condition for re-execution. You can specify the following statuses. You can also specify multiple statuses separated by commas (,).
If this option is omitted, all the above statuses are subject to re-execution, and process instances that have any of the following activities are subject to re-execution:
-encoding encoding-name ~ <<Default JavaVM encoding>> ((at least 1 character))
Specifies the name of the encoding used in the input file specified in the options processidfile or processnamefile. You can specify the following encoding names:
-summary
Specify this option to display the re-execution results for successful and failed cases.
Examples of input
cscpireexec -user admin -pass admin -processidfile process_id.txt -csc HCSC -processnamefile processname.txt
cscpireexec -user admin -pass admin -csc HCSC -processname "PC Lease"
cscpireexec -user admin -pass admin -csc HCSC -all
cscpireexec -user admin -pass admin -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing
cscpireexec -user user1 -pass password -csc CSCSrv1 -all -targetcsc CSCSrv2 -status executing,executingwait,completedwait
Display format
ProcessID,ProcessDefinitionName,Result,ErrorMessage |
Display item | Content | Description |
---|---|---|
ProcessID | PI identifier | Indicates the process instance identifier. |
ProcessDefinitionName | Business process definition name | Indicates the business process definition name. |
Result | Invocation result | Indicates the invocation result. One of the following values is displayed: Success: Invocation ended normally Failure: Invocation failed |
ErrorMessage | Error information | Indicates the error information, which is displayed as follows, depending on the contents of the Result column (invocation result): Success: "" Failure: error-information |
Return values
Return value | Meaning |
---|---|
0 | The command terminated normally. |
1 | The command terminated abnormally. |
2 | A communication timeout occurred. |
3 | An exclusion error occurred. |
9 | An error occurred when checking the execution permission. |
Notes