Manage uniform JSON schemas for all ProcessMaker Platform assets in your organization.
Loading...
Loading...
Loading...
Loading...
Loading...
Create a new Vocabulary that enforces JSON schema compliance in your ProcessMaker Platform assets.
The Vocabularies package must be installed.
Your user account or group membership must have the following permissions to create a Vocabulary unless your user account has the Make this user a Super Admin setting selected:
Vocabularies: Create Vocabularies
Vocabularies: View Vocabularies
See the Vocabularies permissions or ask your Administrator for assistance.
A Vocabulary is a JSON schema designed to validate ProcessMaker Platform assets to which that Vocabulary is applied. Any ProcessMaker Platform asset to which that Vocabulary is applied must conform to that JSON schema. Vocabularies are granular, in that one or more Vocabularies can be assigned to specific BPMN 2.0 element types within a Process or the Process model itself to validate the ProcessMaker Platform asset that is referenced from that element.
See Vocabulary Design Best Practices before you start designing a Vocabulary.
Follow these steps to create a new Vocabulary:
View your Vocabularies. The Vocabularies page displays.
In the Title field, enter the name of the Vocabulary. This name must be unique from all other Vocabularies. This is a required field.
In the Description field, enter the description of the Vocabulary. This is a required field.
Optionally, click the Browse button beside the JSON Schema field to locate the JSON schema from which ProcessMaker Platform assets are to conform. This file must use the .json
file extension. This setting is not required because you can design the Vocabulary after is it is created.
Click Save. The Edit page displays the Vocabulary. See Edit a Vocabulary.
Filter all Vocabularies in your organization to find that one you need.
Use the Search function to filter all Vocabularies from the Vocabularies page based on your entered text.
The Vocabularies package must be installed.
Your user account or group membership must have the "Vocabularies: View Vocabularies" permission to search for Vocabularies unless your user account has the Make this user a Super Admin setting selected.
See the Vocabularies permissions or ask your Administrator for assistance.
Follow these steps to search for a Vocabulary:
View your Vocabularies. The Vocabularies page displays.
Enter in the Search field the text to filter Vocabularies using any of the following criteria:
Name: Filter by the Vocabulary name that displays in the Title column.
Description: Filter by the Vocabulary description that displays in the Description column.
As you enter text into the Search field, Vocabularies display that match your entered text.
If there are no search results, the following message displays: No Data Available.
View the Vocabularies used to maintain uniform JSON schemas in your organization.
ProcessMaker Platform displays all Vocabularies in one table. This makes it easy to manage Vocabularies.
The Vocabularies package must be installed.
Your user account or group membership must have the "Vocabularies: View Vocabularies" permission to view the list of Vocabularies unless your user account has the Make this user a Super Admin setting selected.
See the Vocabularies permissions or ask your Administrator for assistance.
Follow these steps to view all Vocabularies in your organization:
Log on to ProcessMaker Platform.
Click the Designer option from the top menu. The Designer Welcome Screen displays.
The Vocabularies page displays the following information in tabular format about Vocabularies:
ID: The ID column displays the Vocabulary's ID. ProcessMaker Platform Platform automatically generates the ID value when the Vocabulary is created and represents a sequential number of how many total Vocabularies have been created to that time.
Title: The Title column displays the Vocabulary's name.
Description: The Description column displays the Vocabulary's description.
Modified: The Modified column displays the date and time the Vocabulary was last modified. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Vocabulary was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search field to filter Vocabularies that display.
Click the +Vocabulary button. See Create a New Vocabulary.
If no Vocabularies exist, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Delete a Vocabulary from being used in all ProcessMaker Platform assets in your organization.
When a Vocabulary is deleted, ProcessMaker Platform assets that use that Vocabulary are not affected. However, that Vocabulary can no longer be used in other ProcessMaker Platform assets to maintain a uniform JSON schema.
Deleting a Vocabulary from the Vocabularies page cannot be undone.
Click Confirm.
Click the +Vocabulary button. The Create Vocabulary screen displays.
Click the Vocabularies icon from the left sidebar. The Vocabularies page displays all Vocabularies.
Click the Edit icon. See Edit a Vocabulary.
The must be installed.
See the permissions or ask your Administrator for assistance.
Follow these steps to delete a :
. The Vocabularies page displays.
Click the Delete iconfor your Vocabulary. The Caution screen displays to confirm the deletion of the Vocabulary.
Edit the JSON data schema that a Vocabulary represents.
The Vocabularies package must be installed.
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.
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:
View your Vocabularies. The Vocabularies page displays.
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.
In the Content section, edit the JSON schema following one or both of these methods:
Visually edit a Vocabulary using a graphical interface that non-developers may find easier to design a Vocabulary.
Changes made to the visual editor reflect in the coded JSON schema and vice versa.
Click Save.
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:
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.
Follow these guidelines to add a property to this Vocabulary regardless of whether this Vocabulary inherits the properties from another Vocabulary:
Click the + icon. A new property embeds to the JSON schema root and below any existing schema properties.
Rename this property by clicking inside the property name below the Property column.
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.
Indicate if this property requires a value by selecting the checkbox below the Required column for that property.
Do any of the following as necessary:
Select the Code tab to view your entire JSON schema.
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:
Edit your JSON schema. Optionally, select the Visual tab to view your entire JSON schema in the graphical interface.
Click the Edit iconfor your Vocabulary.
The Edit page displays.
Locate the Content section of the Vocabulary below the Description setting. The Visual tab displays by default.
Click the View Property as Schema iconto view the JSON schema property as code.
Click the Delete Property iconto delete a property.
Locate the Content section of the Vocabulary below the Description setting, and then select the Code tab.