Creating a Structure

Creating a Structure

1. Log in to the application designer by referring to Logging In to the Application Designer.
2. In the navigation pane, choose Data.
3. (Optional) Click next to Structure to add a folder.

   By default, structures are stored in the root folder. Before creating a structure, you can create a folder for storing the structure. You can drag the structure to a specified folder.

4. Move the cursor to the created structure folder and click . The page for creating a structure is displayed.

   If no structure folder is created, click next to the structure to go to the page for creating a structure.

5. Configure basic information, and click Save.

   Table 1 Parameters for creating a structure

   Parameter	Description
   Name	Name of the new structure, which is displayed on the page. Value: 1–64 characters.
   Unique ID	ID of the new structure, which is the unique identifier of the structure in the system and cannot be changed after the structure is created. The naming requirements are as follows: The value cannot exceed 64 characters, including the prefix namespace and the suffix. To prevent duplicate data names among different tenants, each tenant must define a unique namespace when first creating an application. A tenant can create only one namespace. After being created, the namespace cannot be modified. Start with a letter and can contain only letters, digits, and underscores (_). It cannot end with an underscore (_).
   Description	Enter the description of the structure. Value: 1–255 characters.

6. Add fields to the structure and click the save button.
   Figure 1 Adding a fields to a structure
   
   • Manually adding fields
     1. On the structure tab page of the created structure, click next to the structure.
     2. Click Add to add a field.

        Table 2 Field parameters

        Parameter	Description
        Label	Name of the new structure field.
        Identifier	ID of the new structure field in the system.
        Type	Type of a new field in a structure. Text Number Currency Date Date/Time Checkbox Single-choice list: You can enter an option value or use a global option list. Multi-choice list: You can enter an option value or use a global option list. Any Object Struct: Global structures and internal structures are supported. Node: Click to define a field as an internal structure. The internal structure can be referenced by other fields in the current structure.
        Collection	Whether the variable is an array variable, that is, a collection variable.
        Required	Whether it is mandatory.
        Description	Description of the new structure. Configure the description as the structure's function.

   • JSON Import: To create structure fields easily, click JSON Import to convert sample JSON into structure metadata.
     Incremental import and overwriting import are supported. Incremental import means retaining existing content and adding new content to it. Overwriting import means replacing existing content with new content.

     Figure 2 JSON Import
     

     Figure 3 JSON Import
     

7. Use the structure.

   After a structure is created, it can be used in external inputs, output parameters, and variable structures of flows, connectors, and BPMs. The following describes how to use a structure in a flow.

   1. Create a blank flow by referring to Creating a Blank Flow.
   2. On the flow design page, click and then click + next to the object variable.
   3. Select Global and select the created struct from the global struct drop-down list.
      Figure 4 Adding an object variable
      
   4. Click Save and view the created object variable of the structure type.
      Figure 5 Object variable of the structure type