Skip to content

User-Defined Variables

In Worksoft SaaS, User-Defined Variables are the variables that can be created and included in the Test Scripts or Data Files to have a specific value to be bound based on the environment which will be picked up during the runtime of the tests.

User-Defined Variables are very easy to create and use them during the executions of the Test Runs. In the User-Defined Variables module, you can see two tabs available as "Environments" and "My Work Space".


In both the tabs, you can create the variables for the different environments. The main purpose of having the "My Workspace" tab will allow you to drive the values of your choice in both the local & cloud executions using the variables specified for the respective environment under this tab. The User-Defined Variables are user-specific alone. You can also view the values of the User-Defined Variables of a single environment or all the environments by selecting the radio button from the dropdown. You can also set the default setting driven from the "My Project Settings".


Also, please note that the first two columns are frozen (Actions & Name) and the different environment columns can be viewed by using a scroll bar if there are more environments in the viewport area.

For each User-Defined Variable, you can see two sections shown on clicking the three-dotted menu. Below are the options available under the two sections:

  • Definition of UDV: Under this section, you can Create/Delete/Edit a User-Defined Variable
  • Value by Environment by UDV: Under this section, you can copy the value of the UDV from one environment to another.

  • Definition of UDV

    When you click on the “Create New User-Defined Variable” option or the plus icon in the menu, you can see a popup displayed where you can select the type of UDV(Manual/Dynamic), add the name & description of the User-Defined Variable along with encryption type.


    You can delete the User-Defined Variable by selecting the "Delete this User-Defined Variable" from the menu. A confirmation popup will be displayed.


    When you select the “Enter/Edit Values for User-Defined Variable”, you can see all the value fields for the different environments in the edit mode. You can enter the value in the desired field and save the changes by clicking on the “Save” button as shown below.


    Values by Environment for UDV

    Enter/Edit Values for User-Defined Variable: When you select this option from the menu, the values available under each environment changes from view mode to edit mode and you can modify the values or add the values to the empty cells and save the changes by clicking on the save button shown in the actions column. If you wish to cancel the changes, you can simply click on the cancel button.


    Please note that this option is available only for the manual User-Defined Variables and this option is not shown for the dynamic User-Defined Variables as shown below.


    Copy Values from one Environment to another Environment/My Workspace: When you select this option from the menu, you can see a popup displaying the options which allow you to copy the values of the UDV from one Environment to another by selecting the values from the three dropdowns are shown in this popup.


    • Select User-Defined Variables: From this dropdown, you can select the multiple User-Defined Variables from the different products or from the Project.
    • Target Product Environment(s): The environments to which the value has to be copied are to be selected from this dropdown.

    Activity History: When you select the "Activity History" option from the menu, you can see the information related to the changes made by you or your team members for the User-Defined Variables (like UDV creation, updation of the name or values of the variables, bulk copying of variables within the environments).


    For the existing User-Defined Variables within your domain, you can see a popup with a message saying no activities are performed yet and for any of the activities performed liked creating a UDV, you can see the informed seen in the popup.



    You can also copy the values from one environment to another environment or "My Workspace" by clicking on the icon which is available on the top-right side in the User-Defined Variable Home screen.


    You can also perform "Select All" to select all the variables from al the available projects within your domain as shown below.

    You can view the "Description", "Created/Last Updated" information by clicking on the "Blue ribbon" which is shown on the top right side of the name of the User-Defined Variable as shown below.


    You can view the value of the UDV which has been recently used details like "Last Updated Date, Run id and Last Updated By" by clicking on the "Blue ribbon" shown in the "Value" field of each environment as shown below.


    You can have the default setting for which tab(Environment/My Workspace) you wish to view upon navigating to the User-Defined Variables module by specifying this option in the "My Project Settings" module.

    To know more about how to configure the default settings for the User-Defined Variables module, click here.

    Feedback and Knowledge Base