Skip to content

Creating a "Data Definition"

To create a Data Definition in Worksoft SaaS in the context of your Project, just go the “More” menu in the top navigation and click “Data Definitions”, and when on the home screen of the “Data Definitions” module, click “Create” button.

To create a Data Definition, you just need to give your definition:
  • A “Name” that is easy to remember the name (something that serves as a short mnemonic to not only you but to other colleagues of yours) 
  • A “Description” that will help you (and colleagues of yours) remember its purpose over time (When you go back to view/edit it a year from the time you created it, we don’t want you to think ‘What is this data definition for?’ OR ‘Why did I define it this way?’) 
  • All the column headers for your definition. We call them “Attributes” in Worksoft SaaS.

Going back to the example AUT (the health insurance premium and penalty calculator), you can create your data definition in Worksoft SaaS using the following values:


Once you define your Data Definition in Worksoft SaaS, your definition would like shown below:

You may be thinking “Do I have to be this specific or detailed in defining my Data Definition for me to use the Data-Driven testing feature in Worksoft SaaS?” Don’t worry. The short answer is “No, you don’t have to”. The best practice, however, which we strongly encourage you to follow, is taking the time to properly naming and commenting on the data definition (including the attributes). This will go a long way in helping you (and your colleagues) maintain your automation assets efficiently in Worksoft SaaS.

Having said that if you want to create a data definition with lot simpler names and descriptions (because you are either in a rush to test drive the data-driven feature of Worksoft SaaS or because you like “quick-and-dirty-first-and-clean-up-later-when-it-works” approach), feel free to create your definition with short/cryptic names like shown below:


The only thing we want you to note is that you (currently) will not be allowed to edit/change the “Name” of the data definition over time but will be allowed to edit/change the “Description” and/or the “Attribute” names.

Therefore think through an appropriate name for your definition. We (currently) don’t let you change the data definition name over time (in edit mode) because that is how we allow to you maintain versions of your data definitions as your AUT evolves (maybe more inputs are added to the calculator or more outputs get spit out of it as the health care law evolves).

Add Description for Attributes:

Though having a provision to add the description at the Data Definition level, you are now given the provision to add the description at the attribute level as well. It means you may now go ahead and add a description for each and every attribute of the Data Definition.

When you click on the pencil icon which is present beside the attribute name, you are given a text area to enter the text/description. This is auto-saved for each attribute and to reflect these changes, you may need to click on the Save button after the modifications are done.

Also, when you hover on the pencil icon, you will be seeing the description added to that attribute. If no description is added, it gives you "No 'description' is provided for this Attribute. To enter a description, click on this icon" message.


Note: When you try to create a Data Definition manually, you are given a provision to add the description at the same time. But, if you are creating the Data Definition by importing the file, then you may need to first save the file and then edit the Data Definition in order to add the description.

Save the Data Definition:

Once you have manually created or imported Data Definition(s) from a CSV file, you will have to decide if you want to save your Data Definition(s) with a "WIP" (stands for "Work In Progress") or with an "Active" status. 

Status of the Data Definition:

Worksoft SaaS does not allow you to make edits to an "Active" version. When you attempt to edit an "Active" version, Worksoft SaaS will create a "WIP" version for you to edit while your "Active" version remains as is. Once you make the necessary edits to the "WIP" version, you can "Activate" it. Until you "activate" the "WIP" version, you will see two versions of the same Data Definition (one that is in “Active” status and another in “WIP” status).

You can edit a "WIP" version multiple times until you are happy with it. It will make sense to save a Data Definition in "WIP" status if you are not sure that the definition you just created is final OR know that you may need additional changes to it.  

To save as "Active", please click on the "Save as Active" button. To save as "WIP', please click on the "Save as WIP" button.


Feedback and Knowledge Base