Batch Script Automation in Tabx

Contents

• Running a Batch Script
• Script Rules
• Script Processing Behaviour
• An Example Script

Tabx offers a way to script the management of Single Categorical Variables, Multi Categorical variables and Groups within a Project. The Batch Script tool can be found in the Edit Project page > Script Tab. A Batch script is simply a spreadsheet with two columns inside: "Instruction" and "Value".

When parsed and executed, Tabx walks through the instructions row by row and uses any value it needs to in the "Value" column.

Running a Batch Script

To run a Batch Script, simply upload the excel file and press Run. Tabx will display an output of all actions taken, as well as any errors within the script, after the script executes. To get a preview of what Tabx will do without making any additions or edits to the current Project, press Preview instead of Run. If the script output is correct, reupload the batch script to execute.

The available instructions are:

* Required as part of a Single type variable Definition
** Required as part of a Multi Definition

Script Rules

Your batch script must adhere to the following rules to execute correctly:

• Only entries in cell columns A and B will be parsed. Any values in cell columns C further will be ignored - notes can be kept in these columns.
• A "Definition" means all instructions between instructions START_NEW_MULTI and END_NEW_MULTI,  EDIT_MULTI and END_EDIT_MULTI, EDIT_SINGLE and END_EDIT_SINGLE, EDIT_GROUP and END_EDIT_GROUP. 
  • A Multi Definition must include:
    • 1 of START_NEW_MULTI or 1 of EDIT_MULTI
    • 1 of MULTI_LABEL
    • 1 or more of MULTI_CATEGORY
    • 1 of END_NEW_MULTI or END_EDIT_MULTI
    • MULTI_GROUP and MULTI_FILTER instructions are always optional, and will use default values if not set (see table above).
• Rows can be blank between instruction rows. See example below.
• A header row of "Instruction" and "Value" is not required.
• The final instruction in the batch script must be either END_EDIT_SINGLE, END_NEW_MULTI, END_EDIT_MULTI or END_EDIT_GROUP.

Script Processing Behaviour

When executing your batch script, Tabx does the following:

• All new Multi Definitions are collected and added to the Project after the Batch Script has completed.
• When editing Multi’s, all existing answer categories are REMOVED before re-adding the newly defined answer categories within the Edit Multi Definition.

Example Script

Below is an example script that adds two new multi’s to the Project and edits the categories for existing Tabx Multi "M1". It will only execute for the project named "Demo Project".