ProcessMaker Documentation
ProcessMaker HomeGive Us FeedbackRelease NotesDownload Open-Source Edition
Search…
ProcessMaker 4.2
ProcessMaker Documentation
Quick Links
ProcessMaker Home
Give Us Feedback
Contact Sales
Start Here
How to Use This Document
Get Started with ProcessMaker
Use ProcessMaker
Web Browser Requirements
Log On to ProcessMaker
Profile Settings
View File Manager
View ProcessMaker Product Documentation
View ProcessMaker Version Information
Session Timeout Warning
Log Out of ProcessMaker
Requests
Task Management
File Management
Search ProcessMaker Data Using ProcessMaker Query Language (PMQL)
Saved Searches
Notifications
Control How Tabular Information Displays
JSON: The Foundation of Request Data
What is Request Data?
What is a Request Variable?
What is JSON?
Manage and Model Processes
Process Management
Script Management
Screen Management
Reference Magic Variables in ProcessMaker Assets
Environment Variable Management
Signal Management
Data Connector Management
Vocabularies Management
What is a Vocabulary?
Manage Your Vocabularies
View Vocabularies
Create a New Vocabulary
Search for a Vocabulary
Edit a Vocabulary
Delete a Vocabulary
Vocabular Design Best Practices
Process Modeling
ProcessMaker Administration
User Management
Group Management
Permission Descriptions for Users and Groups
Manage Saved Searches
Settings
Client Authentication Management
Customize the User Interface
Queue Management
Script Executor Management
ProcessMaker Collections
User Interface Language Management
Download for On-Premises Installation
On-Premises Server Requirements
Download the Open-Source Edition for On-Premises Installation
Open-Source Edition Installation Instructions
Packages
What is a Package?
ProcessMaker Packages
ProcessMaker API Documentation
Access ProcessMaker RESTful API Documentation
ProcessMaker Examples
Collections Examples
Data Connector Examples
Screen Design Examples
Script Executor Examples
Deprecation Notices
Advanced Screens Package
Other Links
Download ProcessMaker Open-Source Edition
ProcessMaker Open-Source Edition Installation Instructions
Privacy Statement
Powered By GitBook
Create a New Vocabulary
Create a new Vocabulary that enforces JSON schema compliance in your ProcessMaker assets.

Create a New ProcessMaker Vocabulary

ProcessMaker Package Required

The Vocabularies package must be installed.

Permissions Required

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 assets to which that Vocabulary is applied. Any ProcessMaker 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 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:
  1. 1.
    ​View your Vocabularies. The Vocabularies page displays.
  2. 2.
    Click the +Vocabulary button. The Create Vocabulary screen displays.
  3. 3.
    In the Title field, enter the name of the Vocabulary. This name must be unique from all other Vocabularies. This is a required field.
  4. 4.
    In the Description field, enter the description of the Vocabulary. This is a required field.
  5. 5.
    Optionally, click the Browse button beside the JSON Schema field to locate the JSON schema from which ProcessMaker 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.
  6. 6.
    Click Save. The Edit page displays the Vocabulary. See Edit a Vocabulary.

Related Topics

Previous
View Vocabularies
Next
Search for a Vocabulary
Last modified 1yr ago
Export as PDF
Copy link
Edit on GitHub
Contents
Create a New ProcessMaker Vocabulary
Related Topics