Skip to main content

Eneumeration

Introduction​

This document provides a detailed overview of the "Enumeration" feature in the data menu of a Digisquares application. Enumerations are essential for defining a set of named values that a variable can take, enhancing data consistency and integrity within the application.

Definition​

Enumerations are a set of predefined, named values that a variable can take. They are used to restrict the possible values a variable can hold, ensuring that the data remains consistent and within expected parameters.

Usage​

  • State Representation: Define possible states for an entity (e.g., order status, user roles).
  • Category Management: Use enumerations to categorize data consistently.
  • Data Validation: Ensure that variables only take on valid, predefined values.
  • Improved Readability: Enhance code readability and maintainability by using descriptive enumeration values.

Creating and Managing Enumerations​

To create and manage enumerations in a Digisquares application, follow these steps:

Step-by-Step Guide​

1. Accessing the Enumeration Menu​

  1. Navigate to the data menu in your Digisquares application.
  2. Select the "Enumeration" option from the list. This will open the enumeration configuration interface.

2. Defining a New Enumeration​

  1. Group: Enter the group name to which the enumeration belongs (optional).
  2. Name: Enter a unique name for the enumeration.
  3. Type: Select the data type for the enumeration values (e.g., string, number).
  4. Value: Enter each value that the enumeration will include. Click the "+" button to add each value to the list.

New Enumeration

Example:

{
  "group": "UserManagement",
  "name": "UserRoles",
  "type": "string",
  "values": ["Admin", "Editor", "Viewer"]
}

3. Saving the Enumeration​

After defining the group, name, type, and values, click the "Save" button to save the enumeration configuration. The new enumeration is now available for use throughout the application.

Example Usage​

State Representation​

To use an enumeration for state representation:

  • Bind a variable to the enumeration.
  • The variable will only accept values defined in the enumeration.
{
  "fieldName": "userRole",
  "type": "UserRoles",
  "value": "Admin"
}

Form Dropdown​

To use an enumeration in a form dropdown:

  • Bind the dropdown menu options to the enumeration.
  • The dropdown will display the values defined in the enumeration.
<select name="userRole">
 <option value="Admin">Admin</option>
 <option value="Editor">Editor</option>
 <option value="Viewer">Viewer</option>
</select>

Managing Existing Enumerations​

To edit or delete an existing enumeration:

  • Navigate to the enumeration menu.
  • Select the enumeration you wish to manage.
  • Update the values, type, or name as needed, or delete the enumeration if it is no longer required.

Best Practices for Using Enumerations​

  • Consistency: Use enumerations to ensure data consistency across your application.
  • Validation: Leverage enumerations for validating user inputs and other variable values.
  • Descriptive Names: Use clear and descriptive names for enumerations and their values to improve readability and maintainability.
  • Centralized Management: Manage enumerations centrally to easily update and maintain valid value sets across the application.

Conclusion​

Enumerations are a powerful feature in a Digisquares application, providing a way to define and enforce valid value sets for variables. By understanding how to define, use, and manage enumerations, you can ensure data consistency, improve validation, and enhance the overall readability and maintainability of your application.