EditVariables

The EditVariables flag allows you to manually change the properties of variables’ value generators. Its syntax contains 4 elements.

Variable Name

The scenario suite variable’s full name.

Variable Index

Optional. If the variable’s value generator has multiple sub-variables, you can specify the index of the sub-variable you want to edit. By default, the index is 0.

Property name

The property of the variable’s value generator that you want to edit.

Value

The value you want to assign to the modified property.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}[2].IncrementSequenceValue=0.6"

 

Generator Types

The following value generator types are available in Test:

 

Boolean

The Boolean variable generator contains the following properties.

AllowNull: bool

Whether or not the generator can include random blanks. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyBoolean}.AllowNull=true"

IsSequence: bool

Whether the generated values alternate between true and false (true) or are randomly generated (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyBoolean}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyBoolean}.IsSequenceRecycling=true"

 

Date Time

The Date Time variable generator contains the following properties.

AllowNull: bool

Whether or not the generator can include random blanks. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.AllowNull=true"

IsSequence: bool

Whether the generated values are generated from first to last in a sequence (true) or randomly (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.IsSequenceRecycling=true"

LimitationMin: int

The earliest date that can be generated relative to the reference date. Default is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.LimitationMin=-5"

LimitationMax: int

The latest date that can be generated relative to the reference date. Default is 10.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.LimitationMax=7"

DateModifier: int

The unit of time for LimitationMin and LimitationMax. Accepted values are Millisecond, Second, Minute, Hour, Day, Month and Year. Default value is Year.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.DateModifier=Day"

IncrementSequenceValue: int

The amount by which to increment for every new value, provided that IsSequence is true. If positive, the sequence will start at LimitationMin. If negative, the sequence will start at LimitationMax. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.IncrementSequenceValue=5"

IncrementSequenceDateModifier: int

The unit of time for IncrementSequenceValue. Accepted values are Millisecond, Second, Minute, Hour, Day, Month and Year. Default value is Year.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.IncrementSequenceDateModifier=Day"

DateReferenceBase: string

The method of defining the reference date. Accepted values are Now and SpecificDate. If Now is used, the reference date is the time at which the variable is instantiated. If SpecificDate is used, the reference date is defined by the Reference property. Default value is Now.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.DateReferenceBase=SpecificDate"

Reference: string

The reference date, provided that DateReferenceBase has the value SpecificDate. The format for this property is yyyyMMddhhmmss.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.Reference=19700101000000"

DateOutputFormat: string

The format of the output date. Default value is YYYYMMddhhmmss.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDate}.Reference=yyyy-MM-dd HH:mm:ss"

 

Directory Listing

The Directory Listing variable generator contains the following properties.

IsSequence: bool

Whether the generated values follow the source in order (true) or are in random order (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.IsSequenceRecycling=true"

Directory: string

The directory for which the contents are to be listed. Can be a path in the library or a full file path.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.Directory=LocalLibrary/Profiles"
$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.Directory=C:\ProgramData\Caristix\Common\Library\HL7Reference"

Recursive: bool

Whether or not to recursively list the files in the directory’s subdirectories. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.Recursive=true"

FilenamePattern: bool

The pattern to be used to match files. If empty, all files are listed. See the UseRegex below property for more information. Default value is empty.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.FilenamePattern=.cxp"

UseRegex: bool

Whether or not to use a regex for pattern matching. If UseRegex is true, the FilenamePattern property is considered a regex. If UseRegex is false, any file that contains the value of the FilenamePattern is considered matching. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyDirectory}.UseRegex=true"

 

Excel File

The Excel File variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.AllowNull=true"

IsSequence: bool

Whether the generated values follow the source in order (true) or are in random order (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.IsSequenceRecycling=true"

LimitationMin: int

The minimum length of the source values to consider. Any values with a length less than LimitationMin are ignored. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.LimitationMin=5"

LimitationMax: int

The maximum length of the source values to consider. Any values with a length greater than LimitationMax are ignored. If LimitationMax is 0, there is no maximum length. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.LimitationMax=10"

FilePath: string

The full path to the source Excel file. Cannot be used with LibraryFilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.FilePath=C:\ProgramData\Caristix\Common\Samples\Excel\PatientProfile.xlsx"

LibraryFilePath: string

The path to the source Excel file from within your Caristix Library. Cannot be used with FilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.LibraryFilePath=Tutorial Scenarios/Tutorial Mapping Table.xlsx"

WorksheetName: string

The name of the source worksheet.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.WorksheetName=Worksheet1"

ColumnId: int

The column used for the generated value, provided that the generated variable is a primitive, e.g. a String variable. The value is mapped to the alphabetical value of the column: 1 = A, 2 = B, etc. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.ColumnId=2"

ColumnIdKey: int

The column used for the the Key property of the generated values, provided that the generated variable is a key-value pair, e.g. Mapping Table. The value is mapped to the alphabetical value of the column: 1 = A, 2 = B, etc. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.ColumnKeyId=2"

ColumnIdValue: int

The column used for the the Value property of the generated values, provided that the generated variable is a key-value pair, e.g. Mapping Table. The value is mapped to the alphabetical value of the column: 1 = A, 2 = B, etc. Default value is 2.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.ColumnValueId=1"

MinRow: int

The first row that is used for generating the values. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.MinRow=2"

MaxRow: int

The last row that is used for generating the values. If MaxRow is 0, all non-empty rows are used. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyExcelFile}.MaxRow=7"

 

Lorem Ipsum

The Lorem Ipsum variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyLoremIpsum}.AllowNull=true"

LimitationMin: int

The minimum length of the generated values. Default value is 12.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyLoremIpsum}.LimitationMin=5"

LimitationMax: int

The maximum length of the generated values. Default value is 27.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyLoremIpsum}.LimitationMax=10"

 

Numeric

The Numeric variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.AllowNull=true"

IsSequence: bool

Whether the generated values are generated from first to last in a sequence (true) or randomly (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.IsSequenceRecycling=true"

LimitationMin: int

The smallest number that can be generated. Default is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.LimitationMin=5"

LimitationMax: int

The largest number that can be generated. Default is 10.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.LimitationMax=15"

IncrementSequenceValue: double

The amount by which to increment for every new value, provided that IsSequence is true. If positive, the sequence will start at LimitationMin. If negative, the sequence will start at LimitationMax. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.IncrementSequenceValue=0.05"

DecimalScale: string

The decimal scale of the generated numbers, i.e. the amount of digits after the decimal point. Default is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyNumeric}.DecimalScale=2"

 

SQL Query

The SQL Query variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.AllowNull=true"

IsSequence: bool

Whether the generated values follow the source in order (true) or are in random order (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.IsSequenceRecycling=true"

LimitationMin: int

The minimum length of the source values to consider. Any values with a length less than LimitationMin are ignored. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.LimitationMin=5"

LimitationMax: int

The maximum length of the source values to consider. Any values with a length greater than LimitationMax are ignored. If LimitationMax is 0, there is no maximum length. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.LimitationMax=10"

DatabaseConnectionName: string

The name of the Database Connection used for the SQL Query.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.DatabaseConnectionName=My Local Connection"

SQLQuery: string

The SQL Query that is used to generate the values.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySQLQuery}.SQLQuery=SELECT * FROM [DE_ID_DATABASE].[Request]"

 

Static

The Static variable generator contains the following properties.

ValueContent: string

The value of the static variable.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyStatic}.ValueContent=Some static value"

 

String

The String variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.AllowNull=true"

LimitationMin: int

The minimum length of the generated values. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.LimitationMin=5"

LimitationMax: int

The maximum length of the generated values. Default value is 10.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.LimitationMax=8"

IncludeLowercaseLetter: bool

Whether or not to include lowercase letters in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.IncludeLowercaseLetter=true"

IncludeUppercaseLetter: bool

Whether or not to include uppercase letters in the generated values. Default value is true.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.IncludeUppercaseLetter=false"

IncludeSpecialCharacter: bool

Whether or not to include special characters in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.IncludeSpecialCharacter=true"

IncludeSpecialCharacterList: string

The list of special characters to include, provided that IncludeSpecialCharacter is true. Default value is #!@$%?&*+=.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyString}.IncludeSpecialCharacter=:#@$?&*()[]_"

 

Substring

The Substring variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySubstring}.AllowNull=true"

LimitationMin: int

The starting character of the generated values relative to the reference variable. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySubstring}.LimitationMin=5"

LimitationMax: int

The maximum ending character of the generated values relative to the reference variable. Default is the maximum value of an integer.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySubstring}.LimitationMax=10"

ReferenceVariable: string

The reference variable from which values will be sourced to build the substring. The syntax of this property is ${VariableName}.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MySubstring}.ReferenceVariable=${MyString}"

 

Table

The Table variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.AllowNull=true"

IsSequence: bool

Whether the generated values follow the source in order (true) or are in random order (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.IsSequenceRecycling=true"

LimitationMin: int

The minimum length of the source values to consider. Any values with a length less than LimitationMin are ignored. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.LimitationMin=5"

LimitationMax: int

The maximum length of the source values to consider. Any values with a length greater than LimitationMax are ignored. If LimitationMax is 0, there is no maximum length. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.LimitationMax=10"

FilePath: string

The path to the profile containing the source table. Cannot be used with LibraryFilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.FilePath=C:\ProgramData\Caristix\Common\Library\HL7Reference\HL7 v2.6.cxp"

LibraryFilePath: string

The path to the profile containing the source table from within your Caristix Library. Cannot be used with FilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.LibraryFilePath=HL7Reference/HL7 v2.6.cxp"

TableId: string

The ID of the source table.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTable}.TableId=0007"

 

Text File

The Text File variable generator contains the following properties.

AllowNull: bool

Whether or not to randomly include blank values in the generated values. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.AllowNull=true"

IsSequence: bool

Whether the generated values follow the source in order (true) or are in random order (false). Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.IsSequence=true"

IsSequenceRecycling: bool

If IsSequence is true, whether or not to continue where the sequence left off (true) or to restart from the beginning (false) every time the variable is instantiated. Default value is false.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.IsSequenceRecycling=true"

LimitationMin: int

The minimum length of the source values to consider. Any values with a length less than LimitationMin are ignored. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.LimitationMin=5"

LimitationMax: int

The maximum length of the source values to consider. Any values with a length greater than LimitationMax are ignored. If LimitationMax is 0, there is no maximum length. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.LimitationMax=10"

FilePath: string

The path to the source Text file. Cannot be used with LibraryFilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.FilePath=C:\ProgramData\Caristix\Common\Samples\TextFile\PatientProfile.csv"

LibraryFilePath: string

The path to the source Text file from within your Caristix Library. Cannot be used with FilePath.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.LibraryFilePath=Tutorial Scenarios/Tutorial Mapping Table.csv"

ColumnId: int

The column used for the generated values. Default value is 1.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.ColumnId=2"

ColumnDelimiter: string

The delimiter for separating columns. Default value is a comma (“,”).

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.ColumnDelimiter=:"

MinRow: int

The first row that is used for generating the values. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.MinRow=2"

MaxRow: int

The last row that is used for generating the values. If MaxRow is 0, all available rows are used. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.MaxRow=7"

MinPosition: int

The position of the first character in a line that is used for generating the values. Characters before MinPosition are ignored. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.MinPosition=4"

MaxPosition: int

The position of the last character in a line that is used for generating the values. Characters after MaxPosition are ignored. If MaxPosition is 0, the rest of the line after the first used character is considered. Default value is 0.

$ Execute-Test C:\myScenarioSuite.cxs -var "${MyTextFile}.MaxPosition=10"