Start a Case

To start a case, with or without associated case data, use the following command:

Syntax

START [version] [-sN] [-c] -e|-a[D]datafile] [-P priority] <node|-> procname <stepname|-> casedesc 

where:

version specifies the version of the procedure that you want to start a case of. Specify one of the following flags:

Flag

Description

-r

Start a (live) case of the Released version.

-u

Start a (test) case of the Unreleased version.

-m

Start a (test) case of the Model version.

-vX.Y

Start a case of Version X.Y, where X is the major version number and Y is the minor version number.

If version is not specified, the following default precedence order is used to select the version to use:

Released > Unreleased > Model

Using a Released version starts a live case. Using an Unreleased or Model version starts a test case.

-sN specifies the precedence order to be used to select the version of any sub-procedure started by the case. Specify one of the following values:

Value

Description

1

Released version only

2

Unreleased > Released version

3

Model > Released version

4

Unreleased > Model > Released version

5

Model > Unreleased > Released version

If the -sN flag is not specified, the following default precedence order is used to select the version to use:

Released > Unreleased > Model

Using a Released version starts a live sub-case. Using an Unreleased or Model version starts a test sub-case.

Note 

Note: For more information about procedure versions see "Using Version Control" in TIBCO iProcess Modeler Procedure Management.

-c specifies that the command returns the case number of the started case
-e indicates that case data is embedded in the command file or input stream. See Command File Format.
-a[D] datafile indicates that case data is supplied in abox format in the datafile. For more information about abox format, see "Using iProcess Abox Files" in TIBCO iProcess Modeler Integration Techniques.

If the D flag is specified, the datafile is deleted after it has been processed.

-P priority specifies the internal message queue priorities. For more information about message priorities, see "Message Prioritizing" in the appropriate TIBCO iProcess Engine (Database) Administrator’s Guide.
node is the name of the host node, if the procedure is hosted remotely. Enter a hyphen () if the procedure is hosted locally.
procname is the name of the procedure.
stepname is the step at which to start the case. Enter a hyphen () to specify the default start step.
casedesc is the case description of the case to be started.

Notes

When all the START commands succeed, the return code from SWBATCH is SW_SUCCESS. If a SWBATCH command fails, SWBATCH will continue to execute the subsequent commands, and the return code will be the same as that of the first failure command.

If you use a syntactically incorrect START command, the utility may not return an error message (in verbose mode) indicating that it could not process the command.

Examples

1. This example starts a case of procedure HIRING on the local node, with case description test1. No case data is supplied.
START - hiring - test1 
2. This example starts a case of procedure HIRING. Case data is supplied in the test1.txt file, which is deleted when the command has been processed.
START -aD test1.txt - hiring - test1
3. This example starts a case of procedure HIRING on the local node, with case description app123. Case data for the FIRST and LAST (name) fields is embedded after the command, and terminated by the use of the STOP line. See Command File Format.
START -e - hiring - app123
FIRST,George
LAST,Smith
STOP