Skip to content

Create or Edit Action Type Form

Krish Majumdar edited this page Jan 10, 2023 · 4 revisions

A new action type form can be created by pressing the yellow [Create New Action Type Form] button at the top of the List All Action Types interface page. Doing this will prompt the user for an ID string to assign to the new type form, and once this is confirmed, the user will be automatically redirected to the page for creating it.

An existing action type form may be edited at any time, and as many times as desired, by pressing the yellow [Edit Action Type Form] corresponding to that component type on the List All Action Types interface page. The user will then be automatically redirected to the page for editing it. Please note that editing an action type form may cause errors with existing actions of that type, so extreme care must be taken when making such changes.

The same interface page is used to both create new type forms and edit existing ones, and it looks similar to the following:

Create-Edit-Action-Type-Form

The top section of the page shows general information about the action type - its name, ID, when it was last edited and by who, recommended component type(s), and any user-specified tags. Some of these fields may be edited directly - these are denoted by a white background. Fields with a grey background cannot be changed by the user - they are either fixed (in the case of the type form ID) or will be automatically changed by the database upon successful submission of the type form.

The red-outlined box making up the second section of the page indicates where the type form should be constructed. A number of pre-built form components are available for the user to make use of, such as single- and multi-line text fields, number fields, checkboxes, etc. These can all be found in the dropdown menus in the left-side panel of the box, and the desired form components can be dragged out to the main area of the box and arranged as desired. Please contact the admin team at [email protected] if you would like more information about creating and editing action type forms - there are a lot of details and subtle intricacies behind this process that cannot easily be explained in this Wiki article.

Once the user is satisfied with the construction and layout of the type form, they must press the green [Submit Changes] button below the red-outlined box to save the type form into the database. Upon a successful submission, the user will then be automatically returned to the List All Action Types page.

The last section of the page, below the submission button, allows the user to view and/or edit the raw JSON schema of the type form in an expandable box (collapsed by default). This is the format in which the type form is actually stored in the database, and users familiar with JSON may find it easier to make changes to the type form in this manner. Any changes made in the JSON box are reflected in the graphical version within the red-outlined box (after making changes, the user must click anywhere on the page outside the JSON box for the changes to take effect), and vice versa. The user also has the options of downloading the JSON schema to their device as a text file, or copying the contents of the JSON box to their device's clipboard.

Clone this wiki locally