Using the ScriptPlayer

Syntax

At the command prompt, ensure you navigate to the installation location of the BmtScriptPlayer.exe.

Use the following syntax to run the Script Player:

BmtScriptPlayer [-c|-m] <projectname> [-a <actionlogname>][options]

where <projectname> is the name of the project and <actionlogname> is the name of the action log.

For example,

BmtScriptPlayer -m goSales.cpf -a import.xml

Options

You can specify how the Script Player runs using the following options.

If you are working in a UNIX environment, you may want to create a script to hide credentials that are passed on the command line.

-a FILEPATH

Apply the specified action log.

FILEPATH is the path, including the file name, to the action log file.

-b NUM

Execute transactions with sequence number equal to or higher than the number specified by NUM.

The default is the first transaction.

-c FILEPATH

Create a new project.

FILEPATH is the path, including the file name, to the models project (.cpf) file.

Using this option without specifying an action log results in the creation of an empty model.

If the model specified in the FILEPATH already exists, it is silently replaced.

-e NUM

Execute transactions with sequence number equal to or lower than the number specified by NUM.

If the option is not specified, execution ends at the transaction with the highest sequence number or transaction number 9999, whichever comes first. For action logs that contain transactions with sequence numbers 10,000 and higher, this option must be used.

-g

Upgrade the model (if required).

If this option is not specified and the model was created with a previous version, execution terminates.

If you specify this option without specifying an action log, only the model upgrade is performed.

-h

Specify the elapsed time in milliseconds. This option is not available on Unix or Linux® operating systems.

-i FILEPATH

Specify the path, including the file name, to a file that contains the authentication information.

-k DIRECTORY

Specify the install directory.

-l FILEPATH

Specify the path, including the file name, to a file that contains the options to be used when running Script Player.

-L

Specify that the object ID logs (IDLog.xml) not be created. This option is not available on Unix or Linux operating systems.

-m FILEPATH

Open an existing project.

FILEPATH is the path, including the file name, to the models project (.cpf) file.

-n

Do not save the model.

This option can be used to test action log files.

-p PASSWORD

Authenticate using the specified password (if required).

-s NAMESPACE

Authenticate using the specified namespace (if required).

-t DIRECTORY

Specify the template directory.

-T PASSWORD

Specify a security passport. A passport is an encrypted string used to allow secure conversations for the plug-ins that need it.

-u USER

Authenticate using the specified user name (if required).

-x

Terminate the test run when there is a transaction error.

By default, the script player only terminates with severe errors such as an invalid model or action log, and continues executing, even if some minor transactions fail.

-y PASSPORT

Authenticate using the specified passport (if required).

This option overrides other specified credentials (-s, -p, and -u). The Script Player skips authentication and associates the specified passport with the session.

-z

Create extended action log with action output parameters..

Examples

This table shows some examples of Script Player commands.

Table 1. Script Player commands examples
Command	Description
`BmtScriptPlayer -c <projectname>`	Create a project.
`BmtScriptPlayer -c <projectname> -a <actionlogname>`	Create a project and apply all the transactions from the action log.
`BmtScriptPlayer -c <projectname> -a <actionlogname> -b2 -e20`	Create a project and apply the transactions numbered 2-20 from the action log.
`BmtScriptPlayer -m <projectname> -a <actionlogname> -e20`	Open an existing project and apply the transactions numbered 1-20 from the action log.
`BmtScriptPlayer-m <projectname> -a <actionlogname> -n`	Open an existing project and apply all the transactions from the action log. Do not save the project.