Creating a Custom Event

Creating a Custom Event

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 Event to add a folder.

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

4. Click of an event. The page for adding an event is displayed.

   If no event category is created, click next to Event. The page for adding an event is displayed.

5. Select Create new event, set basic information, and click Add.
   Figure 1 Adding an event
   

   Table 1 Parameters for adding an event

   Parameter	Description
   Label	Label of the new event, which is displayed on the page. Value: 1–64 characters.
   Name	Name of the event. The name is the unique identifier of the event in the system and cannot be changed after being 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 event. Value: 1–255 characters.

   If an event exists in the system, you can select Import existing event and add an event based on the selected event.

   Figure 2 Importing an existing event to create an event
   

6. On the event details page, click the Custom Parameters tab to add custom parameters.

   Custom parameters are used to record meaningful event state changes. You can create custom parameters as required. For example, in this section, an event that records hiring status changes is created. You need to add two parameters: EmployName (candidate's name) and Result (hiring result).

   1. In the Custom Parameters area, click New.
   2. Set Label and Name to EmployName, set Data Type to String, and click Save.
      Figure 3 Setting parameters
      

      Table 2 Parameter description

      Parameter	Description
      Label	Label of the new parameter, which is displayed on the page. Value: 1–80 characters.
      Name	Unique ID of the new parameter in the system, which cannot be changed after being created. The following requirements must be met: The name contains 1 to 64 characters. Start with a letter and can contain only letters, digits, and underscores (_). It cannot end with an underscore (_).
      Data Type	Select a type from the drop-down list. Options: Number, Date, Date Time, Boolean, and String.
      Description	Enter the description of the parameter. Value: 1–255 characters.
      Is Required	Indicates whether the parameter is mandatory. If this parameter is selected, the parameter is mandatory. By default, this parameter is not selected. That is, this parameter is optional.

   3. Repeat the preceding operations to create a parameter whose Name and Label are Result and Data Type is Boolean.
      Figure 4 Creating a Result parameter
      
      Figure 5 Custom parameter table
      

7. On the Basic Information tab page, click Enable to enable this event.

   An event can be used in flows and business processes only after it is enabled. Otherwise, the event cannot be selected.