ProcessMaker Platform Documentation
Spring 2023, ProcessMaker Platform
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search
⌃K
Links

Edit a Vocabulary

Edit the JSON data schema that a Vocabulary represents.

Edit a Vocabulary

Package Required

The Vocabularies package must be installed.

Permissions Required

Your user account or group membership must have the following permissions to edit a Vocabulary unless your user account has the Make this user a Super Admin setting selected:
  • Vocabularies: Edit Vocabularies
  • Vocabularies: View Vocabularies
See the Vocabularies permissions or ask your Administrator for assistance.

Learn How to Design JSON Schemas

Need to learn how to design JSON schemas? Start with JSON Schema. Need to learn how to convert valid JSON to a JSON schema? Use the JSON Schema Tool, though do not use JSON intended for production on this free GitHub application.
Follow these steps to edit a Vocabulary:
  1. 1.
    ​View your Vocabularies. The Vocabularies page displays.
  2. 2.
    Do one of the following:
    The Edit page displays.
  3. 3.
    Edit the following information about the Vocabulary as necessary:
    • In the Title field, edit the Vocabulary name. This is a required field.
    • In the Description field, edit the description of the Vocabulary. This is a required field.
  4. 4.
    In the Content section, edit the JSON schema following one or both of these methods:
    Changes made to the visual editor reflect in the coded JSON schema and vice versa.
  5. 5.
    Click Save.

Visually Design a Vocabulary

Design a Vocabulary from the Visual tab in the Content section of a Vocabulary if you are not familiar with coding a JSON schema but understand the design compliance your ProcessMaker Platform assets must meet.
Changes to the Vocabulary in the Visual tab reflect in the Code tab, and vice versa.
Prior to editing the content of a Vocabulary, review the guidelines and best practices in Vocabulary design.
Follow these steps to visually edit a Vocabulary:
  1. 1.
    ​Edit a Vocabulary.
  2. 2.
    Locate the Content section of the Vocabulary below the Description setting. The Visual tab displays by default.
  3. 3.
    Select from the Length or Inherit column whether this Vocabulary inherits its properties, at least in part, from another Vocabulary. A property is a key-value pair to define an object in the JSON schema. If no other Vocabularies exist, only the No inheritance option is available. Note that unless a JSON schema was uploaded when this Vocabulary was created, its root name is mainSchema. The JSON schema root contains the JSON schema properties as noted in the Property column. The default setting for the Length or Inherit column is No inheritance, meaning this Vocabulary does not reference properties from another Vocabulary.
  4. 4.
    Follow these guidelines to add a property to this Vocabulary regardless of whether this Vocabulary inherits the properties from another Vocabulary:
    1. 1.
      Click the + icon. A new property embeds to the JSON schema root and below any existing schema properties.
    2. 2.
      Rename this property by clicking inside the property name below the Property column.
    3. 3.
      Select which data type this property requires by selecting it below the Type column for this property. Specifying a data type for this property is not required; however, if a data type is not selected, then validation for that property's value does not occur. A JSON schema property may use one of the following data types:
      • Text (String data type)
      • Integer
      • Decimal (Request data stores as a Floating Point data type)
      • Boolean
      • Date (Request data stores a validated date as a String data type if that date is acquired from a Date Picker control)
      • Datetime (Request data stores a validated datetime as a String data type if that datetime is acquired from a Date Picker control)
      • Array
      • Object
      See JSON Data Types for examples of each data type.
    4. 4.
      Indicate if this property requires a value by selecting the checkbox below the Required column for that property.
  5. 5.
    Do any of the following as necessary:
    • Click the View Property as Schema icon
      to view the JSON schema property as code.
    • Click the Delete Property icon
      to delete a property.
    • Select the Code tab to view your entire JSON schema.

Code a Vocabulary

Code a Vocabulary from the Code tab in the Content section of a Vocabulary.
Changes to the Vocabulary in the Code tab reflect in the Visual tab, and vice versa.
Prior to editing the content of a Vocabulary, review the guidelines and best practices in Vocabulary design.
Follow these steps to code a Vocabulary:
  1. 1.
    ​Edit a Vocabulary.
  2. 2.
    Locate the Content section of the Vocabulary below the Description setting, and then select the Code tab.
  3. 3.
    Edit your JSON schema. Optionally, select the Visual tab to view your entire JSON schema in the graphical interface.
Last modified 1mo ago