Managing Entities & Variables

Entity and Variable:

To maintain a structured and efficient system, entities such as funds, users, patients and applications are identified and represented using variables in camelCase format. A variable is a named storage space designed to hold specific information, called a value. For example, variables such as fundName, userEmail, patientId or applicationStatus can be used to store corresponding details about each entity. This approach ensures clarity, consistency and ease of data management throughout the system. Descriptive variable names improve readability and help streamline processes by clearly defining their purpose and content.

Take the entity 'Application' for example. This entity can have attributes such as 'applicationName', 'applicationID' and 'applicationType'. Each attribute provides specific details about the application, including its unique identifier, name and category. 

To add a new entity, follow these instructions:

1. First, go to the home screen and choose "Manage Data Variables" from the main menu on the left. 

 

2. Then, in the top-right corner of the screen, click on the "Add Entity" button. 

3. This action will bring up a small window where you can input the name of the new entity. Enter the name and click "Save." 

4. The entity will then be successfully added to the system. 

To add a variable to an existing entity, follow the revised steps:

1. On the home screen, select “Manage Data Variables” in the left sidebar. 

2. This action displays a list of all entities available in the system.

3. Select the entity you want to modify, which will display the variables it currently contains.

4. Select the "Add Variable" button.

5. The required details for adding a variable include the following:

• Name: The name of the variable.

• Data Type: Specifies the type of data, such as String or Date.

• Validations: Includes options like Required and Validate Max Characters.

  • Required: Ensures the document generates only when a value is provided. If left blank, the document will not generate.

  • Validate Max Characters: Defines the maximum number of characters allowed for a variable. For example, if a Name variable is limited to 20 characters, the document will not generate if the input exceeds this limit.

• Sample Value: A sample or dummy value for reference, such as entering “Name” for a Customer.Name variable.

• Maximum Values: Applicable when the variable type is a List. Learn more about it [HERE].

6. The new variable is then successfully included in the selected entity.

• Related Articles

• Intro to Data Variables & How to use them?

  In Perfect Doc Studio, variables are managed at a global level, as demonstrated in the accompanying video. The system features entities that house variables, defining all relevant data variables for your business. This ensures the consistency of ...

• View list of all Variables in a Document Template

  If you want to see a list of all the variables included in the document template, go to the left panel and click on "Preview & Download". This will display a list of all the variables that have been added to the document. Here you can see the list of ...

• What are List Variables and How to use them?

  In Perfect Doc Studio, a list variable refers to a variable that holds multiple values. They are used to store multiple related values under a single variable name, ensuring consistency and simplifying data integration across documents. For example, ...

• What are Link Variables and How to use them?

  Perfect Doc Studio allows you to dynamically insert hyperlinks into your documents using Link Variables. This feature is especially useful when you want to personalize or conditionally include links without hardcoding URLs. Assign Links to Variables: ...

• Managing Teams in Perfect Doc Studio

  In Perfect Doc Studio, organizations have the flexibility to create multiple teams as needed. This functionality enables better organization and streamlined management of templates. Each template can be assigned to a specific team, ensuring that ...