cscpiselect (Finding process instances)

Organization of this page

Format
Function
Arguments
Examples of input
Display format
Return values
Notes

Format

cscpiselect [-h]
 -user login-user-ID
 -pass login-password
 -csc HCSC-server-name
 -table 
 {process|activity|link|set|string|numeric|boolean
 |message|relation|process_set}
 [-detail]
 [-separator {comma|tab}]
 [{-count|-orderby sort-condition}]
 [{-where where-clause
 |-wherefile name-of-file-containing-where-clause
 |[-processname business-process-definition-name]
 [-date [inquiry-start-date-and-time],inquiry-end-date-and-time]
 [-status {executing|completed|faulted|error
 |executingwait|completedwait|all}]
 [-targetcsc HCSC-server-name-to-be-searched]}]
 [-encoding encoding-name]
 [-canceltimer cancellation-time]

To Page Top

Function

Searches the business process information for the set up HCSC server according to specified conditions, and outputs the information in the CSV or TSV format.

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 the following locations in the uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:

6.1.2 Searching the execution log of a process instance
6.1.3 Acquiring detailed information from the process instance execution logs

To Page Top

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 executing SQL statements.

`-table {process|activity|link|set|string|numeric|boolean|message|relation|process_set}`

Specifies the table to be searched.

When process_set is specified in this option, the process summary information and correlation set information are linked internally to perform the search. Therefore, to specify a process information column or a correlation set information column in the search condition, add P or C in the where clause respectively.

If a value other than process_set is specified in this option, the table name need not be specified in the where clause. For the information that can be specified in the where clause, see the SQL reference documentation for the database in use.

process

Displays the process summary information corresponding to the specified search condition.

Note that you cannot specify a table name and add a comment line in the where clause. The following are examples of correct and incorrect settings for the where clause:

Examples of settings 1

 Example of incorrect settings: Table name is specified
 P.Status='Completed'
 Example of correct settings: Table name is not specified
 Status='Completed'

Examples of settings 2

 Example of incorrect settings: Comment line is added
 Status='Completed' AND
 # ProcessDefinitionName like 'BP%'
 Example of correct settings: Comment line is not added
 Status='Completed' AND
 ProcessDefinitionName like 'BP%'

activity

Displays the activity information corresponding to search conditions.
link

Displays the link information corresponding to search conditions.
set

Displays the correlation set information corresponding to search conditions.
string

Displays the string variable information corresponding to search conditions.
numeric

Displays the numeric variable information corresponding to search conditions.
boolean

Displays the boolean variable information corresponding to search conditions.
message

Displays the message variable information corresponding to search conditions.
relation

Displays the message-related information corresponding to search conditions.
process_set

Searches the correlation set information for the process summary information corresponding to search conditions and then displays the information. Specify the table name in the where clause. The following are examples of correct and incorrect settings for the where clause:

Examples of settings
```
 Example of incorrect settings: Table name is not specified
 State='Completed'
 Example of correct settings1: Table name is specified
 P.State='Completed'
 Example of correct settings2: Table name is specified
 P.State='Completed' AND
 C.ProcessDefinitionName like 'BP%'
```

`-detail`

Specify this option to output all the table information.

`-separator {comma|tab}` ~<<comma>>

Specifies the separator for demarcating the information.

`-count`

Specifies that only the number of search result rows is output. Use this option to obtain only the number of searched items when the search result contains large amount of data (this corresponds to count(*) in SQL statements).

`-orderby` `sort-condition` ~ ((at least 1 character))

Specifies the data sorting condition. This corresponds to the order by clause in SQL statements. The options -orderby and -count cannot be simultaneously specified. For the information that can be specified in the order by clause, see the SQL reference documentation for the database in use. If the -orderby option is not specified, the command assumes that the order by clause is not specified.

`-where` `where-clause` ~ ((at least 1 character))

Specifies the where clause. For the information that can be specified in the where clause, see the SQL reference documentation for the database in use.

If the SplitKey string is used for search, the information about the SplitKey string is not output. Also, depending on the value specified in the -table option, you must add the SplitKey string in the view table described in the following table. For details about the view table configuration, see the explanation of the view table information in C.1 Table information about process instance execution log managemen in the uCosminexus Service Platform Setup and Operation Guide.

Table 5‒5: View table that requires the addition of the `SplitKey` string
Value set in the `-table` option	View table that requires the addition of the `SplitKey` string in advance
`process`	None
`activity`	`CSCBP_cluster-name_V_ACTIVITY`
`link`	`CSCBP_cluster-name_V_LINK`
`set`	None
`string`	`CSCBP_cluster-name_V_STR_VARIABLE`
`numeric`	`CSCBP_cluster-name_V_NUM_VARIABLE`
`boolean`	`CSCBP_cluster-name_V_BOOL_VARIABLE`
`message`	`CSCBP_cluster-name_V_MSG_VARIABLE`
`relation`	None
`process_set`	None

`-wherefile` `name-of-file-containing-where-clause` ~ ((1 to 200 bytes))

Specifies the name of the file containing the where clause using an absolute or relative path. The linefeed code in the specified file is replaced with spaces, and then the SQL statement is executed. For the information that can be specified, see the SQL reference documentation for the database in use.

Note that the precautions for using the SplitKey string for a search are the same as those for the -where option.

`-processname` `business-process-definition-name` ~ ((at least 1 character))

Specify this option to perform a search using the business process definition name. You can specify this option only when a value other than relation or process_set is specified in the -table option.

`-date` `[inquiry-start-date-and-time],inquiry-end-date-and-time` ~ <one-byte numeric characters>

Specify this option to search by the start date and time of a process instance. This option searches the process instances that started from the specified inquiry start date and time to the inquiry end date and time. You can specify this option only when process or activity is specified in the -table option. If the inquiry start date and time is omitted, the search is performed from the process instances that started before the inquiry end date and time. Do not place a space before or after the comma (,) separating the inquiry start date and time from the inquiry end date and time. Specify the inquiry start date and time and the inquiry end date and time in the format shown below. Make sure that you use the default time zone to specify the dates and times.

Inquiry start date and time: Specify the date and time in the YYYYMMDDhhmmss format.
Inquiry end date and time: Specify the date and time in the YYYYMMDDhhmmss format.

YYYY: Year (1970 YYYY)

MM: Month (01 MM 12)

DD: Date (01 DD 31)

hh: Hours (00 hh 23)

mm: Minutes (00 mm 59)

ss: Seconds (00 ss 59)

`-status {executing|completed|faulted|error|executingwait|completedwait|all}` ~ <<all>>

Specify this option to perform a search using the status of the process instance and activity instance.

You can only specify the arguments executing, completed, faulted, and error when process or activity is specified in the -table option. Also, you can only specify the arguments executingwait and completedwait when activity is specified in the -table option.

executing

The process summary information or activity information of process instances with the Executing status will be searched.
completed

The process summary information or activity information of process instances with the completed status will be searched.
faulted

The process summary information or activity information of process instances with the faulted status will be searched.
error

The process summary information or activity information of process instances with the error status will be searched.
executingwait

The activity information with the executingwait status will be searched.
completedwait

The activity information with the completedwait status will be searched.
all

The process summary information or activity information with all the above statuses will be searched.

The following are examples of incorrect and correct settings for the -table option with an example of specifying the executingwait argument in the -status option:

Examples of settings

Example of incorrect settings: activity is not specified in the -table option
 -table process -status executingwait
Example of correct settings: activity is specified in the -table option
 -table activity -status executingwait

`-targetcsc` `HCSC-server-name-to-be-searched` ~ ((1 to 8 characters))

Specifies the name of the HCSC server to be searched. The process instances executed on the specified HCSC server will be searched. Note that the process instances executed in 08-70 or earlier will not be searched.

If this option is omitted, the process instances executed on all the HCSC servers will be searched.

`-encoding` `encoding-name` ~ <<Default Java VM encoding>> ((at least 1 character))

Specifies the name of the encoding used in the input file specified in the -wherefile option. You can specify the following encoding names:

UTF-8
US-ASCII
ISO-8859-1
Encoding supported by Java VM

`-canceltimer` `cancellation-time` ~ ((0 to 86400)) <<0>>

This option enables you to cancel the processing if the processing does not end even after the specified time has lapsed. Specify the time until the cancellation of processing in seconds. If the -count option is specified, this option is ignored even if specified.

If a value other than 0 is specified

After the lapse of the specified time, the processing will be cancelled and the resources will be released even if records matching the conditions are left behind. The command ends normally with the return value 10. In this case, a warning message is output to the message log and the console.
If 0 is specified

The processing is not cancelled until all the records matching the conditions are processed.

To Page Top

Examples of input

(1) To display the entire process summary information

cscpiselect -user admin -pass admin -csc HCSC -table process

(2) To display the entire summary information for the process whose correlation set definition name is rentalNumber and whose correlation set value is 100

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table process_set
 
Contents of sql_where.txt
 
C.CorrelationSetName = 'rentalNumber' AND C.CorrelationSetValue = '100'

(3) To display the number of rows of character strings whose business process definition name begins with BP, from the activity information

cscpiselect -user admin -pass admin -count -wherefile sql_where.txt -csc HCSC -table activity
 
Contents of sql_where.txt
 
ProcessDefinitionName like 'BP%'

(4) To search all the link information items

cscpiselect -user admin -pass admin -csc HCSC -table link

(5) To search all the correlation set information items

cscpiselect -user admin -pass admin -csc HCSC -table set

(6) To search the string variable information with the condition ProcessID = '11111'

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table string
 
Contents of sql_where.txt
 
ProcessID = '11111'

(7) To search the numeric variable information with the conditions ProcessID = '11111', and a business process definition name beginning with BP

cscpiselect -user admin -pass admin -wherefile sql_where.txt -csc HCSC -table numeric
 
Contents of sql_where.txt
 
ProcessID = '11111' AND ProcessDefinitionName like 'BP%'

(8) To search the boolean variable information with the conditions ProcessID = '11111', and a definition value of 0

cscpiselect -user admin -pass admin -where "ProcessID = '11111' AND VariableValue = 0" -csc HCSC -table boolean

(9) To search the message variable information with the conditions ProcessID = '11111' and the variable definition name containing ABC, and sorting the search results in the descending order of ProcessID

cscpiselect -user admin -pass admin -wherefile sql_where.txt -orderby "ProcessID DESC"-csc HCSC -table message
 
Contents of sql_where.txt
 
ProcessID = '11111' AND VariableName like '%ABC%'

(10) To search the process summary information by specifying the last executed HCSC server , and then displaying the information

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -targetcsc CSCsrv2

(11) To search the execution log generated until March 31, 2012 (however, the processing stops and the resources are released if the search takes 300 seconds or more)

cscpiselect -user admin -pass admin -csc CSCSrv1 -table process -date ,20120331235959 -canceltimer 300

To Page Top

Display format

(1) Process summary information (when process or process_set is specified)

If -detail is omitted

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,CSCServerName
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,HCSC-server-name
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,HCSC-server-name
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to EndTime (PI-end-time).

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,State,StartTime,EndTime,ChangeCount,CSCServerName
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,update-count,HCSC-server-name
PI-identifier,business-process-definition-name,business-process-definition-version,PI-status,PI-start-time,PI-end-time,update-count,HCSC-server-name
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to ChangeCount (update-count).

Description

The following table describes the information for one record in the CSCBP_cluster-name_PROCESS table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`State`	PI status	Indicates the status of the process instance.
`StartTime`	PI start time	Indicates the process instance start time (GMT). The start time is output in the format `YYYY/MM/DD hh:mm:ss` that is defined as `java.text.SimpleDateFormat`: `YYYY`: Year `MM`: Month `DD`: Date `hh`: Hour `mm`: Minutes `ss`: Seconds
`EndTime`	PI end time	Indicates the process instance end time (GMT). The end time is output in the format `YYYY/MM/DD hh:mm:ss` that is defined as `java.text.SimpleDateFormat`: `YYYY`: Year `MM`: Month `DD`: Date `hh`: Hour `mm`: Minutes `ss`: Seconds
`ChangeCount`	Update count	Indicates the data update count.
`CSCServerName`^#	HCSC server name	Indicates the name of the last executed HCSC server.

#: If no values exist in the process instance log, nothing is displayed.

(2) Activity information (when activity is specified)

If -detail is omitted

ProcessID,ActivityNumber,ActivityDefinitionName,ActivityKind,State,StartTime,EndTime,WaitTime
PI-identifier,ACI-identifier,AC-definition-name,AC-type,ACI-status,AC-start-time,AC-end-time,AC-wait-time
PI-identifier,ACI-identifier,AC-definition-name,AC-type,ACI-status,AC-start-time,AC-end-time,AC-wait-time
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to WaitTime (AC-wait-time).

If -detail is specified

ProcessID,ActivityNumber,ProcessDefinitionName,
ProcessDefinitionVersion,ActivityDefinitionName,ActivityKind,
ParentNumber,ScopeNumber,RepeatNumber,State,
FirstChildNumber,LastChildNumber,StartTime,EndTime,WaitTime,CSCServerName
PI-identifier,ACI-identifier,business-process-definition-name,
business-process-definition-version,AC-definition-name,AC-type
Parent-ACI-identification-number,Subordinate-SCI-identification-number,Subordinate-RP-identification-number,ACI-status,
First-child-ACI-identification-number,Last-child-ACI-identification-number,AC-start-time,AC-end-time,AC-wait-time,HCSC-server-name
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to CSCServerName (HCSC-server-name).

Description

The following table describes the information for one record in the CSCBP_cluster-name_ACTIVITY table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ActivityNumber`	ACI identifier	Indicates the activity instance identification number. This is a unique value in process instances.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`ActivityDefinitionName`	AC definition name	Indicates the activity definition name.
`ActivityKind`	AC type	Indicates the activity type.
`ParentNumber`	Parent ACI identification number	Indicates the identification number of the parent activity instance.
`ScopeNumber`	Subordinate SCI identification number	Indicates the identification number of the subordinate scope instance.
`RepeatNumber`	Subordinate RP identification number	Indicates the identification number of the subordinate iteration processing.
`State`	ACI status	Indicates the status of the activity instance.
`FirstChildNumber`	First child ACI identification number	Indicates the identification number of the first child activity instance.
`LastChildNumber`	Last child ACI identification number	Indicates the identification number of the last child activity instance.
`StartTime`^#	AC start time	Indicates the activity start time (GMT). The start time is output in the format `YYYY/MM/DD hh:mm:ss` that is defined as `java.text.SimpleDateFormat`: `YYYY`: Year `MM`: Month `DD`: Date `hh`: Hour `mm`: Minutes `ss`: Seconds
`EndTime`^#	AC end time	Indicates the activity end time (GMT). The end time is output in the format `YYYY/MM/DD hh:mm:ss` that is defined as `java.text.SimpleDateFormat`: `YYYY`: Year `MM`: Month `DD`: Date `hh`: Hour `mm`: Minutes `ss`: Seconds
`WaitTime`^#	AC wait time	Indicates the activity wait time (GMT). The wait time is output in the format `YYYY/MM/DD hh:mm:ss` that is defined as `java.text.SimpleDateFormat`: `YYYY`: Year `MM`: Month `DD`: Date `hh`: Hour `mm`: Minutes `ss`: Seconds
`CSCServerName`^#	HCSC server name	Indicates the name of the last executed HCSC server.

#: If no values exist in the process instance log, nothing is displayed.

(3) Link information (when link is specified)

If -detail is omitted

ProcessID,LinkDefinitionName,State
PI-identifier,link-definition-name,link-status
PI-identifier,link-definition-name,link-status
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
LinkDefinitionName,RepeatNumber,State
PI-identifier,business-process-definition-name,business-process-definition-version,
link-definition-name,Subordinate-RP-identification-number,link-status
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to State (link-status).

Description

The following table describes the information for one record in the CSCBP_cluster-name_LINK table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`LinkDefinitionName`	Link definition name	Indicates the link definition name.
`RepeatNumber`	Subordinate RP identification number	Indicates the identification number of a subordinate iteration processing.
`State`	Link status	Indicates the status of the link (true value).

(4) Correlation set information (when set is specified)

If -detail is omitted

ProcessID,CorrelationSetName,CorrelationSetValue
PI-identifier,correlation-set-definition-name,correlation-set-value
PI-identifier,correlation-set-definition-name,correlation-set-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,ScopeDefinitionName,
ScopeNumber,CorrelationSetName,CorrelationSetValue,State
PI-identifier,business-process-definition-name,business-process-definition-version,SC-definition-name,
SCI-identification-number,correlation-set-definition-name,correlation-set-value,validity-of-correlation-set
PI-identifier,business-process-definition-name,business-process-definition-version, SC-definition-name,
SCI-identification-number,correlation-set-definition-name,correlation-set-value, validity-of-correlation-set
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to State (validity-of-correlation-set).

Description

The following table describes the information for one record in the CSCBP_cluster-name_CORRELATIONSET table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`ScopeDefinitionName`	SC definition name	Indicates the scope definition name.
`ScopeNumber`	SCI identification number	Indicates the identification number of the scope instance.
`CorrelationSetName`	Correlation set definition name	Indicates the correlation set definition name.
`CorrelationSetValue`	Correlation set value	Indicates the correlation set value. This value is converted to a character string, linked, and then stored.
`State`	Validity of correlation set	Indicates the validity of a correlation set (true value).

(5) String variable information (when string is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name, SCI-identification-number,variable-definition-name,variable-value
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_STR_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`ScopeDefinitionName`	SC definition name	Indicates the scope definition name.
`ScopeNumber`	SCI identification number	Indicates the identification number of the scope instance.
`VariableName`	Variable definition name	Indicates the variable definition name.
`VariableValue`	Variable value	Indicates the variable value.

(6) Numeric variable information (when numeric is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name, SCI-identification-number,variable-definition-name,variable-value
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_NUM_VARIABLE table. For details, see Appendix C. Database Table Information in the uCosminexus Service Platform Setup and Operation Guide.

Display item	Content	Description
ProcessID	PI identifier	Indicates the process instance identifier.
ProcessDefinitionName	Business process definition name	Indicates the business process definition name.
ProcessDefinitionVersion	Business process definition version	Indicates the business process definition version.
ScopeDefinitionName	SC definition name	Indicates the scope definition name.
ScopeNumber	SCI identification number	Indicates the identification number of the scope instance.
VariableName	Variable definition name	Indicates the variable definition name.
VariableValue	Variable value	Indicates the variable value.

(7) Boolean variable information (when boolean is specified)

If -detail is omitted

ProcessID,VariableName,VariableValue
PI-identifier,variable-definition-name,variable-value
PI-identifier,variable-definition-name,variable-value
 ...

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,variable-value
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to VariableValue (variable-value).

Description

The following table describes the information for one record in the CSCBP_cluster-name_BOOL_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`ScopeDefinitionName`	SC definition name	Indicates the scope definition name.
`ScopeNumber`	SCI identification number	Indicates the identification number of the scope instance.
`VariableName`	Variable definition name	Indicates the variable definition name.
`VariableValue`	Variable value	Indicates the variable value.

(8) Message variable information (when message is specified)

If -detail is omitted

ProcessID,VariableName,
VariableValue
PI-identifier,variable-definition-name,
variable-value
PI-identifier,variable-definition-name,
variable-value
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to VariableName (variable-definition-name), and VariableValue (variable-value) is displayed on the next line.

If -detail is specified

ProcessID,ProcessDefinitionName,ProcessDefinitionVersion,
ScopeDefinitionName,ScopeNumber,VariableName,
VariableValue
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,
variable-value
PI-identifier,business-process-definition-name,business-process-definition-version,
SC-definition-name,SCI-identification-number,variable-definition-name,
variable-value
 ...

Note: There is no linefeed from ProcessID (PI-identifier) to VariableName (variable-definition-name), and VariableValue (variable-value) is displayed on the next line.

Description

The following table describes the information for one record in the CSCBP_cluster-name_MSG_VARIABLE table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item	Content	Description
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ProcessDefinitionName`	Business process definition name	Indicates the business process definition name.
`ProcessDefinitionVersion`	Business process definition version	Indicates the business process definition version.
`ScopeDefinitionName`	SC definition name	Indicates the scope definition name.
`ScopeNumber`	SCI identification number	Indicates the identification number of the scope instance.
`VariableName`	Variable definition name	Indicates the variable definition name.
`VariableValue`	Variable value	Indicates the variable value.

(9) Message-related information (when relation is specified)

If -detail is omitted

MessageID,ProcessID,ActivityNumber,SendOrReceive
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag
 ...

If -detail is specified

MessageID,ProcessID,ActivityNumber,SendOrReceive,AsynchronousMessagingID
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag,ID
MSG-identifier,PI-identifier,ACI-identification-number,send-and-receive-flag,ID
 ...

Note: There is no linefeed from MessageID (MSG-identifier) to AsynchronousMessagingID (ID).

Description

The following table describes the information for one record in the CSCBP_cluster-name_MSG_RELATION table. For details, see Appendix C. Database Table Information in the Service Platform Setup and Operation Guide.

Display item	Content	Description
`MessageID`	MSG identifier	Indicates the message identifier.
`ProcessID`	PI identifier	Indicates the process instance identifier.
`ActivityNumber`	ACI identification number	Indicates the identification number of the activity instance.
`SendOrReceive`	Send and receive flag	Indicates the send and receive flag for the message.
`AsynchronousMessagingID`	ID	Indicates the ID of an asynchronous message that uses Reliable Messaging.

(10) Count display

KEOS52029-I: row count is number-of-rows

To Page Top

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.
`10`	Processing will be cancelled because the specified cancellation time elapsed.

To Page Top

Notes

Do not specify any comment line.
The where clause of an SQL statement is specified in the option for this command. Therefore, change the user ID and the password periodically to avoid unauthorized use of the command by a third party.
You can use this command only when you use a database.
If all the following options are not specified, the command assumes that the where clause is not specified:
- -where option
- -wherefile option
- -processname option
- -date option
- -status option

To Page Top

cscpiselect (Finding process instances)

Format

Function

Arguments

-h

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

-table {process|activity|link|set|string|numeric|boolean|message|relation|process_set}

-detail

-separator {comma|tab} ~<<comma>>

-count

-orderby sort-condition ~ ((at least 1 character))

-where where-clause ~ ((at least 1 character))

-wherefile name-of-file-containing-where-clause ~ ((1 to 200 bytes))

-processname business-process-definition-name ~ ((at least 1 character))

-date [inquiry-start-date-and-time],inquiry-end-date-and-time ~ <one-byte numeric characters>

-status {executing|completed|faulted|error|executingwait|completedwait|all} ~ <<all>>

-targetcsc HCSC-server-name-to-be-searched ~ ((1 to 8 characters))

-encoding encoding-name ~ <<Default Java VM encoding>> ((at least 1 character))

-canceltimer cancellation-time ~ ((0 to 86400)) <<0>>

Examples of input

Display format

Return values

Notes

`-h`

`-user` `login-user-ID` ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

`-pass` `login-password` ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

`-csc` `HCSC-server-name` ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

`-table {process|activity|link|set|string|numeric|boolean|message|relation|process_set}`

`-detail`

`-separator {comma|tab}` ~<<comma>>

`-count`

`-orderby` `sort-condition` ~ ((at least 1 character))

`-where` `where-clause` ~ ((at least 1 character))

`-wherefile` `name-of-file-containing-where-clause` ~ ((1 to 200 bytes))

`-processname` `business-process-definition-name` ~ ((at least 1 character))

`-date` `[inquiry-start-date-and-time],inquiry-end-date-and-time` ~ <one-byte numeric characters>

`-status {executing|completed|faulted|error|executingwait|completedwait|all}` ~ <<all>>

`-targetcsc` `HCSC-server-name-to-be-searched` ~ ((1 to 8 characters))

`-encoding` `encoding-name` ~ <<Default Java VM encoding>> ((at least 1 character))

`-canceltimer` `cancellation-time` ~ ((0 to 86400)) <<0>>