1. What Does This Page Cover?

3. Creating Variables

Note: It is not recommended to store sensitive data in variables as they are accessible by admins, super admins, and developers. Additionally, the values stored in variables may become accessible to live application users through script execution. Unlike the data stored in forms, user permissions cannot be configured for variables.

3.1. Variable Creation Flow

3.2. See How to Create a Variable

3.3. Steps to Create Variables

1. Go to the edit mode of your desired application to create variables and click Settings.
   
2. Click Variables listed under Developer tools.
   
   
3. Click the Add Variable button to create your first variable.
   
   A pane will open on the right, in which you need to provide the details, such as Group Name, Variable name, and Value.
   
   
4. Enter a name for your variable in the Variable field.
   

Note: 

1. You can create a maximum of 20 variables per application.
2. The Variable name can contain alphanumeric characters, and underscore, but it cannot  start with a number or underscore. Some examples of a valid variable names: interestRate, Branch24, email_id
3. The Variable name must be less than 50 characters.
5. Create a group to categorize your variables by clicking + Add Group and enter a group name. You can select a group from the dropdown if you've already created one. Alternatively, you can proceed without categorizing the variable in a group by leaving this field blank.
   

Note:
1. You cannot have two variables with the same name within the same group.
   
2. You can create a maximum of 10 groups per application, and the group names must be unique.
   
3. The Group Name must be less than 50 Characters.
4. The Group Name can contain alphanumeric characters, and underscore, but it cannot start with a number or underscore. Some examples of a valid group names: interestRate, ZykerBranch, organization_info  
6. Enter the value for your variable in the Defined Value field. The datatype of the variable will be auto-assigned based on the format of input value.
   

Note: 

1. The size of collection must be less than 2kB.                     
2. You can only create up to four collections per application.
1. 
   
2. Refer to the table below for sample values categorized by data type:
   

3. Data Type	Sample Values
   Number	1 Note: Only number values within the range of -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807 are supported.
   Decimal	1.0 Note: The integral part of the decimal data type must not exceed 19 digits, and the fractional part cannot exceed 6 digits.
   Boolean	true
   Text	Hello World Note: The maximum limit for TEXT type variable is 255 characters.
   Collection (List)	["Creator",6] Note: - DATE or DATE-TIME data type values are not supported inside a collection. - Collection size cannot be more than 2 KB
   Collection (Key-Value)	{"Product" : "Creator", "Version" : 6} Note: - The key specified in the collection must be only TEXT. - DATE or DATE-TIME data type values are not supported inside a collection. - Collection size cannot be more than 2 KB
   Date	'15-Aug-1947' Refer this help document to learn about other supported date formats. Note: Input date values can be in any supported date format. However, the format of the returned date value will be based on the application's date format settings.

   
   
4. 

   Note: If the value assigned to a variable does not match any of the specified data type formats, it will be considered as a TEXT data type.
7. Click Create.
   
1. Once added, you can view its defined value and current value as shown. You can use the search tab to search a variable with its name and filter tab to find the desired variable group.
   
   

Note: The defined value refers to the value assigned to the variable when it was created. On the other hand, the current value represents the real-time, last updated value of the variable after script executions within the application.

4. Create and Update Variables in Code View

Note: You cannot rename or delete a variable or variable group in the code view

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
   
2. Click Code View in the top-right corner, as shown.
   
1. You will be shown the created variable in the code format. If you haven't created any variables previously, you will be presented with an empty Deluge editor.
   
2. You can edit the values in the code directly or create a new variable by following the syntax given below.
   
   Creating a variable with group:
   
3. thisapp.variables.<group_name>.<variable_name> = <value>;


Creating a variable without group:

4. thisapp.variables.<variable_name> = <value>;
   
3. Click Save. A pop-up will be shown with the change summary to confirm the changes to be made. 
   
4. Click Proceed in the pop up to save the changes made in the Code View.
   
   

5. Access and Modify Variables Using Deluge

Note: 

1. Simultaneous modifications and access to a variable may not give expected results.
   
2. The value of a variable updated through a Deluge script will be reflected in the current value only at the end of the script execution, even though the script executes using the modified value.
   

1. <group_name> is the TEXT that represents the name of the group to which the variable belongs.
   
2. <variable_name> is the TEXT that represents the name of the variable in the specified group to access its value.
   

6. Variables in Different Environments

Note: In the environment settings, you can only view the defined value and current value of variables specific to that environment. To create or manage variables, you must access the application settings in the development environment.

7. Manage Variables

1. View variable reference
2. Edit variable
3. Delete variable 
4. Rename group
5. Delete group
   

7.1. View Variable References

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
2. Click on the desired variable name you'd like to see references for.
   
   
3. Click on the View Variable Reference hyperlink below the Variable field.
   
   

7.2. Edit Variable

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
2. Click on the variable name that you want to edit.
   
   
3. On the next page, you will be shown the details of the variable. Click on the Variable field to modify the variable name and the Value field to update the variable's value.
   

Note: 
1. A variable cannot be moved from one group to another.
2. You cannot assign a value with a different data type to the variable. In other words, the data type of the variable cannot be modified.
1. 
   
4. Click Update.
   
1. The changes will be saved immediately once you click Change in the confirmation popup that appears.
2. For collection variable type modifications, such as changing from a list to a key-value structure or vice versa, a pop-up window will appear, displaying references to all the locations where the collection variable is used. You can review these references and click Change to save the changes.

Note: When removing a key from a key-value collection, replace the references with appropriate values. Similarly, when adding a key to a list-type collection, make sure to replace the references with key-value pairs. This precautionary step is essential to prevent potential errors in your application and maintain its functionality.

7.3. Delete Variable

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
2. Hover over the variable that you want to delete and click the delete icon () that appears.
   
1. If the variable is not used in your application, it will be deleted immediately once you click Delete in the confirmation popup that appears.
   
2. Otherwise, a popup with references of all the places where you have used the variable will be displayed.
   
3. You need to delete all the mentioned references in order to Proceed to Delete the variable.
   

7.4. Rename Group

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
2. Hover over the desired group name that you want to change and click the edit icon ().
   
   
3. Enter the new group name in the pop-up and click Rename.
   
   

7.5. Delete Group

1. Navigate to Variables under Developer Tools in your application settings. All variables that you have created will be listed here.
   
2. Hover over the desired group name that you want to delete and click the delete icon ().
   
   
   
1. If the variables in that group is not used in your application, it will be deleted immediately once you click Delete in the confirmation popup that appears. 
   
2. Otherwise, a popup with the list of all variables with references will be displayed.
   
3. You need to delete all the mentioned variables and its references individually in order to Proceed to Delete the variable group.
   

8. Points to Note

1. Variable names within a group must be unique.
2. The data type of the variable remains constant once it is created and it cannot be changed. For the collection data type, the value can be changed from list to key-value format and vice versa.
3. When changing the key-value type collection into a list-type collection, replace the references with appropriate values. Similarly, when changing a list-type collection to key-value type collection, make sure to replace the references with key-value pairs. This precautionary step is essential to prevent potential errors in your application and maintain its functionality.

9. Limitations

1. It is not possible to create a sandbox with C5 application, if it contains variables.
2. Variables are not available for applications within the C5 sandbox and developer zone.
3. A maximum of 10 groups can be created per application.
4. A maximum of 20 variables can be created per application, irrespective of the number of groups. Among the 20 variables, only a maximum of four variables can be of the collection data type.
5. The size of each collection variable must not exceed 2 KB.
6. A variable cannot be moved from one group to another.
7. System variables can be only assigned to a variable through a Deluge script.
8. Renaming or deleting a variable or variable group is currently not supported in code view.
9. A maximum of 500 variable assignments can be performed via a Deluge script per day.
10. Simultaneous modifications and access to a variable through scripts may not give expected results.
11. Value of variables cannot be modified through scripts in the following workflow actions:
    
1. Form on load
2. Form on validate
3. User input of a field
4. Subform - Addition of row
5. Subform - Deletion of row
6. Subform - User input of a field
7. Stateless form - button actions
8. Page script
   
12. 
    Note: If a function involving variable modification is invoked within these actions, it will not be executed.

10. Related Links

1. Understand Variables