Skip to content

Data Definition: Application Test Driver Inputs

← Test Cycle Scheduler

This data definition specifies the structure for the data file(s) that will contain the inputs to the "Worksoft SaaS Test Cycle Runner" component that is responsible to create test cycle(s) and schedule one or more "Application Test Drivers", which in turn will schedule the application tests that will get run within the newly created test cycle(s).

Attribute Purpose / Description Example Input
execution_indicator Mandatory

This attribute controls whether or not a particular row gets picked up from a data file for scheduling by the Test Cycle Runner.

The options for this parameter are "Yes" and "No". Rows that have a value of "No" will not get picked by the Test Cycle Runner. This is mandatory parameter that requires you to populate a value ("Yes" or "No") for every row in the data file.
detail_of_runs_to_
be_scheduled		 Mandatory This attribute can be used the specify the information that will be used by the Application Test Driver to schedule the application test runs.

This is mandatory parameter that requires you to populate a JSON value for every row in the data file.

Use the following JSON format when you populate data into the column of values for this attribute within the data files: 
{
  "testingContextKey": "<yourRunDefinitionTestingContextKey>",
  "runDefinitionStatus": ["WIP" | "Active"],
  "runDefinitionNameMnemonicForDeveloper": "<yourNameMnemonicForYourRunDefinition>",
  "testingPlatformMnemonicForDeveloper": "<yourNameMnemonicForYourTestingPlatform>",
  "userNotesForUIDisplay": "<yourUserNotesForTheTestRun>",
  "batchLabel": "",
  "userAliasToScheduleThisRun": "<userAlias>"
}

Please note:
  • The parameter "testingContectKey' will be the unique Alphanumeric Key is generated when a Testing Context is created for a platform combination for a specific Run Definition. This key helps in identifying the Run Definition and execute the Test Runs remotely. You find the Key for a Run Definition in the Testing Context Screen. Example: 4BNX3HR
  • If the specific Run Definition is in Active status, the parameter "runDefinitionStatus" can be ignored. But if the Run Definition is in WIP state, it is mandatory to specify the value if not Worksoft SaaS would consider Active version of the Run Definition
  • The parameters "runDefinitionNameMnemonicForDeveloper" and "testingPlatformMnemonicForDeveloper" are both optional and the values of these parameters are NOT used by Worksoft SaaS. However, populating them in the data file will help you (like any valuable mnemonics do) to easily remember imortant information that pertains to each testing context ke like the Run Definition Name and the Testing Platform.
  • The paramater "userNotesForUIDisplay" is an optional field that lets you to pass the text which later can be used to identify a specific run especially when the same run definition is executed many times each time with different data inputs.
  • The parameter "batchLabel" uniquely groups different run definition testing context keys under a specific batch. If you pass a value for the "batchLabel" in this data file, then a corresponding row must be included in the data file that follows the data definition "Application Test Batch Dependency Configuration".
  • The parameter "userAliasToScheduleThisRun" is used to override the user account using which the executions of the application test runs will happen. If you pass value for this parameter, the test run will run using the User Alias of the Person or Machine User it belongs to. Since User Aliases have their own allocations of capacity and concurrency, the test run's execution will be picked up and executed based on the capacity and concurrency allocated to that user alias.

user_defined_
variable_overrides		 Optional

This attribute can be used the specify the values that must be used as override values for the "User-Defined Variables" used within the application test runs scheduled. Use the following JSON format when you populate data into the column of values for this attribute within the data files: 
[
  {
    "name": "<nameOfAUserDefinedVariable>",
    "value": "<valueForTheUserDefinedVariable>"
  }
]
label_overrides Optional

This attribute allows you to OPTIONALLY pass 'override' values for Labels for all the Application Test Runs that get executed by the Test Cycle Runner.

Use the following JSON format when you populate data into the column of values for this attribute within the data files:

{
  "<parentLabelName>": [
    "<labelNameThatWillBeUsedForOverridingAnyPreviousLabelsCurrentlyAssigned>"
  ]
}

An example value if you want to override the currently assigned label (value) within the parent label "Test Case" with a new value of label "User Places an order greater than $1000" is as follows:

{
  "Test Case": [
    "User places an order greater than $1000"
  ]
}

More than one label can be passed as the value for the override within each parent label. In other words, you can override with labels A, B within a parent label "x" and with labels C, D, E within another parent label "y".
data_file_overrides Optional This attribute can be used the specify the override values for the "Data Files" used within the application test runs scheduled. Use the following JSON format when you populate data into the column of values for this attribute within the data files: 
[
  {
    "currentDataFileName": "YOUR_CURRENT_DATA_FILE_NAME",
    "currentDataFileStatus": "YOUR_CURRENT_DATA_FILE_STATUS",
    "replacementDataFileName": "YOUR_REPLACEMENT_DATA_FILE_NAME",
    "replacementDataFileStatus": "YOUR_REPLACEMENT_DATA_FILE_STATUS",
    "currentDataFilterName": "YOUR_CURRENT_DATA_FILTER_NAME",
    "replacementDataFilterName": "YOUR_REPLACEMENT_DATA_FILTER_NAME"
  }
]
file_overrides Optional

This attribute can be used the specify the override values for the "Files" used within the application test runs scheduled. Use the following JSON format when you populate data into the column of values for this attribute within the data files: 
[
  {
    "currentFileName": "YOUR_CURRENT_FILE_NAME",
    "replacementFileName": "YOUR_REPLACEMENT_FILE_NAME"
  }
]
batching_and_
sequencing_inputs		 Optional

Mostly applicable for Performance tests

This attribute can be used the specify the Time Slices option which allows you to trigger the execution of a run at different times and also allows you to specify the number of batches. You can also specify the number of runs required in a Batch and also specify the TimeLag between batches. You can specify number of time slices to trigger runs at different time and batches. Use the following JSON format when you populate data into the column of values for this attribute within the data files: 
{
  "offsetFromTestCycleExecutionStartTime": "00:00:00",
  "batchCount": "1",
  "batchSize": "1",
  "timeLagBetweenBatches": "00:00:00"
}
Please note:
  • The parameter "offsetFromTestCycleExecutionStartTime" allows you to optionally specify when a batch has to start relative to the "execution_schedule_params > startTimeForScheduleExecution" if provided OR the "test_cycle_info > plannedWindowStartTime".
  • The parameter "batchSize" allows you to optionally specify the number of runs which are to be triggered at the specified Execution Start Time. The value must numeric and should be greater than 0.
  • The parameter "batchCount" allows you to optionally specify the number of batches required. The value must numeric and should be greater than 0.
  • The parameter "timeLagBetweenBatches" allows you to optionally specify the wait time between the batches. 'Time Lag' must be in HH:MM:SS format. The value specified in this parameter is considered only when the "batchCount" value is greater than 0.
developer_notes Optional This attribute can be optionally used by you to add a mnemonic kind of free form text that will help you easily remember the purpose behind each row in the data file that feeds into the Test Cycle Runner.

Feedback and Knowledge Base

(thinking…)