Script
Parameters

Subsystem
List

Top
level

Standard Script Parameters

This page describes the standard script parameters. All scripts should use all applicable standard parameters when it makes sense to do so. However, not all scripts will use all the standard parameters.

Restrictions

Each of the standard script parameters has a set of restrictions on its values. These restrictions are specified below in the descriptions for the individual parameters.

If you are running a script, you are responsible for observing these restrictions. If you provide a parameter value that violates a restriction, then the behaviour of the script is undefined, and the results are invalid. Note that each individual script may impose additional restrictions on each parameter. Refer to the script's documentation for details.

If you are writing a script, you should check each parameter (that your script uses) against these restrictions using RequireSetup.

Safe Specs

In order to permit the use of one set of standard script parameters for all scripts, each parameter defines a set of "safe" specifications. These are specified below in the descriptions for the individual parameters.

If you are running a script, you may assume that any script will work with parameters that fall within the safe specs.

If you are writing a script, you must ensure that your script will accept parameters that fall within the safe specs (if your script uses the parameter at all). You are encouraged, but not required, to make your script accept parameters outside of the safe spec (but within the Restrictions).

Summary of Parameters

Parameter Name	Data Type	Handled By	Comments
Source Clip Parameters
`SourceClipBin`	`string`	Script
`SourceClip1`	`MONclipParam`	Script	{ ClipName, MarkIn, MarkOut , PosType }
`SourceClip2`	`MONclipParam`	Script	{ ClipName, MarkIn, MarkOut , PosType }
`SourceClip3`	`MONclipParam`	Script	{ ClipName, MarkIn, MarkOut , PosType }
Sequence Parameters
`SequenceBin`	`string`	Script
`SequenceName`	`string`	Script
`SequencePositionType`	`MONposTypeParam`	Script	values: `MONposSelection`
PRODUCT Parameters
`lsMCapplicationDir`	`list of string`	MC Rec.
`sMCapplicationFile`	`string`	MC Rec.
`sMCapplicationName`	`string`	MC Rec.
`sMCvideoMediaDrive`	`string`	Script
`sMCaudioMediaDrive`	`string`	Script
`lsMCstartupOptions`	`list of string`	MC Rec.	values: `MCstartupOption`.
`sMCmodel`	`string`	MC Rec.	values: `MCmodel`.
`sMCinternalReleaseName`	`string`	MC Rec.
`bMCquitOnScriptExit`	`boolean`	MC Rec.	(NEW)
Other Parameters
`ProjectName`	`string`	MC Rec.	Default = `gsMC_DEFAULT_PROJECT`
`UserName`	`string`	MC Rec.	Default = `gsMC_DEFAULT_USER`
`iRECrandomSeed`	`integer`	Recovery	Default = time of day
`lsCUloggingOptions`	`list of string`	Recovery	values: `CUloggingOption`
`bREClogSysInfo`	`boolean`	Recovery
`bRECquitOnFatalError`	`boolean`	Recovery
`sRECdontRunScript`	`string`	Recovery
`lsCUdebugPrint`	`list of string`	Recovery

lsMCapplicationDir

Type: list of string
Defaults: glsMC_APPL_DIR

Specifies the directory (folder) in which the PRODUCT application resides. Each string in the list must be a directory in the path; the entire list must specify a complete path to the PRODUCT folder.

Safe Specs

(not applicable>

lsMCapplicationDir

Type: string
Defaults: glsMC_APPL_FILE

Specifies the name of the PRODUCT application (executable) file.

Safe Specs

(not applicable>

sMCapplicationName

Type: string
Defaults: glsMC_APPL_NAME

Specifies the name of the PRODUCT application (main window).

Safe Specs

(not applicable>

sMCaudioMediaDrive

Type: string
Defaults: gsMC_AUDIO_MEDIA_DRIVE

This parameter specifies the drive for audio media.

Restrictions

The string must contain the name of a drive (volume) on the test system which is suitable for storing media.

Safe Specs

(not applicable>

sMCvideoMediaDrive

Type: string
Defaults: gsMC_VIDEO_MEDIA_DRIVE

This parameter specifies the drive for video media.

Restrictions

The string must contain the name of a drive (volume) on the test system which is suitable for storing media.

Safe Specs

(not applicable>

sMCmodel

Type: string
Default: none

This is the name of the PRODUCT model under test. If the product, when launched, is not this model, the test will be terminated with a setup error. You should never need to refer to this parameter in your script.

Restrictions

The string must be one of the values of the enum MCmodel.

Safe Specs

(not applicable>

sMCinternalReleaseName

Type: string
Default: none

This is the internal release name of the PRODUCT product under test. Examples are "Twister", "Jaguar" and "Whirlpool". You should never need to refer to this parameter in your script. Its only purpose is to be placed in the results file.

Restrictions

(none)

Safe Specs

(not applicable>

bMCquitOnScriptExit

Type: boolean
Default: FALSE

If set to TRUE, this parameter causes the PRODUCT to quit at the end of every script, regardless of whether the script was successful.

Restrictions

(none)

Safe Specs

(not applicable>

lsCUloggingOptions

Type: list of string
Default: { "eCU_LOG_GUI_ACTIONS" }

This is the set of options that control the format and content of the results file. It is handled automatically by the Recovery System; you do not have to explicitly examine it in your script.

This parameter is only used during ScriptEnter (i.e. at script start-up time), not during TestCaseEnter (i.e. not for each separate testcase).

Restrictions

Each string in the list must be one of the values of the enum CUloggingOption.

Safe Specs

(not applicable>

bREClogSysInfo

Type: boolean
Default: FALSE

If this parameter is set to TRUE, the recovery system will log system information to the results file. This amount of information is large, as is the amount of time it takes to generate it. This parameter is handled automatically by the Recovery System; you do not have to explicitly examine it in your script.

It is only used during ScriptEnter (i.e. at script start-up time), not during TestCaseEnter (i.e. not for each separate testcase).

Restrictions

(none)

Safe Specs

(not applicable>

lsMCstartupOptions

Type: list of string
Default: (none)

This is the default set of options that control how the PRODUCT's startup dialogs are handled when the PRODUCT is launched. For more information, see MCrecLaunch.

Restrictions

Each string in the list must be one of the values of the enum MCstartupOption.

Safe Specs

(not applicable>

ProjectName

Type: string
Default: gsMC_DEFAULT_PROJECT

This is the name of the project that will be open when your script starts up. It is handled automatically by the Recovery System; you do not have to explicitly examine it in your script.

This parameter is only used during ScriptEnter (i.e. at script start-up time), not during TestCaseEnter (i.e. not for each separate testcase).
Note that the project could be NTSC, PAL or Film. In most cases, your script should run in any type of project. You can check for this by calling gwPRJwindow.GetFormat.

Restrictions

The project must contains the bin(s) specified by the SourceClipBin and SequenceBin parameters. (It may contain other bins as well.)

Safe Specs

Note that some scripts require their own special projects and bins. Refer to the script documentation for details.

sRECdontRunScript

Type: string

If this parameter is defined, the script will be terminated during ScriptEnter. An error will be logged in the result file that includes the string value of this parameter.

Use this parameter to temporarily prevent script execution, while maintaining a record that the script was intentionally not run.

Restrictions

(none)

Safe Specs

not applicable

bRECquitOnFatalError

Type: boolean
Default: FALSE

This specifies whether the application will be shut down and restarted when the recovery system encounters a fatal error dialog. It is handled automatically by the Recovery System; you do not have to explicitly examine it in your script.

Restrictions

(none)

Safe Specs

Note that some scripts require their own special projects and bins. Refer to the script documentation for details.

iRECrandomSeed

Type: integer
Default: time of day

Scripts should normally not need to examine this parameter directly. The recovery system automatically sets the seed for QA Partner's random number generator by calling RandSeed, and displays the value of the seed in the results file. If the RandomSeed script parameter is specified, its value is used as the seed. If this parameter is not specified, the recovery system sets the seed to a value calculated from the time of day.

Normally, a script should be run without an explicit random number seed. This allows the script to use different sets of random numbers each time it runs. However, if you need to exactly reproduce what a script did, you can obtain the seed from the previous run by looking in the results file, and use the value to set the seed so that the next run will produce exactly the same set of random numbers.

SequenceBin

Type: string

This parameter specifies the name of a bin containing sequences.

Restrictions

This bin must exist in the project specified by the ProjectName parameter.
This bin contains at least one sequence which conforms to the restrictions specified for the SequenceName parameter. (It may also contain any number of other media objects of any type.)
A script may not modify the media objects in this bin, except to mark in and out points.
A script may not add or delete media objects in this bin.

Safe Specs

Note that some scripts require their own special projects and bins. Refer to the script documentation for details.

SequenceName

Type: string

This parameter specifies the name of a sequence.

Restrictions

This sequence must exist in the bin specified by the SequenceBin parameter.
The length of the sequence is at least one video frame; there is no upper limit.
The sequence has at least one video or audio track, and possibly both.
The sequence may or may not contain anything that a sequence can legally contain, including filler and effects.
A script may not modify this sequence, except to mark in and out points. (It may make a copy and modify the copy.)

Safe Specs

Tracks: the sequence contains V1, A1, and A2.
Duration: the length of the sequence is between 10 seconds and 5 minutes.
Content: at least 2 clips, straight edits (no split edits), no effects, no filler.
Source Clips: each clip conforms to the Safe Specs for the Source Clips; each clip is at least 5 seconds long, with at least 1 second of head and tail available (to permit the creation of transition effects).

SequencePositionType

Type: MONposTypeParam

This parameter specifies the timecode or edgecode type that will be used for specifying locations in a sequence. For a description of the syntax of this string parameter, see MONposTypeParam. Scripts should retrieve this parameter by calling MONgetPosTypeParam.

Restrictions

(none)

Safe Specs

Value: "eMON_POS_MASTER_TC"

SourceClip1, SourceClip2, SourceClip3

Type: MONclipParam

Each of these parameters specifies a source clip that can be used for editing.

The value of each of these parameters is a list of 4 strings. The first string in the list is the name of the source clip; the second string is the mark in point; the third string is the mark out point. Andthe fourth string specifies the position type (timecode or edgecode). For more information, see MONclipParam.

Scripts should retrieve these parameters by calling MONgetClipParam.

Restrictions

Location: the source clip must exist, with a unique name, in the bin specified by the SourceClipBin parameter.
Duration: the length of the source clip is at least one video frame; there is no upper limit.
Type: the source clip may be anything that can be used as source material, including a master clip, subclip, sequence, imported graphic, motion effect, etc.
Tracks: the source clip has at least one video or audio track, and possibly both.
Mark In / Mark Out: the mark in and mark out points must be within the bounds of the source clip. The mark out point must not be less than the mark in point.
PosType:None
Modifications: a script may not modify the source clip, except to mark in and out points. (It may make a copy and modify the copy.)

Safe Specs

Tracks: the source clip contains V1, A1, and A2.
Duration: the length of the source clip is between 10 seconds and 3 minutes.
Type: the source clip is a digitized (not imported) master clip.
Mark In: at least one second away from the beginning of the source clip; at least 5 seconds away from Mark Out.
Mark Out: at least one second away from the end of the source clip; at least 5 seconds away from Mark In.
Resolution: all source clips have resolutions that are compatible with each other.
PosType: "eMON_POS_SOURCE_TC V1"

SourceClipBin

Type: string

This parameter specifies the name of a bin containing source clips.

Restrictions

This bin must exist in the project specified by the ProjectName parameter.
This bin contains at least one source clip which conforms to the restrictions specified for the SourceClip parameters. (It may also contain any number of other media objects of any type.)
A script may not modify the media objects in this bin, except to mark in and out points.
A script may not add or delete media objects in this bin.

Safe Specs

Note that some scripts require their own special projects and bins. Refer to the script documentation for details.

SourcePositionType
Type: MONposTypeParam
This parameter specifies the timecode or edgecode type that will be used for specifying locations in source clips. For a description of the syntax of this string parameter, see MONposTypeParam. Scripts should retrieve this parameter by calling MONgetPosTypeParam.

Restrictions

Safe Specs

Value: "eMON_POS_SOURCE_TC V1"

UserName

Type: string
Default: gsMC_DEFAULT_USER

This is the name of the user that will be used to open a project. It is handled automatically by the Recovery System; you do not have to explicitly examine it in your script.

This parameter is only used during ScriptEnter (i.e. at script start-up time), not during TestCaseEnter0 (i.e. not for each separate testcase). Most scripts shouldn't care about this parameter.

This page is maintained by (REMOVED).
It was last updated on 4 May 1999.