Examples Form Portal

Usage

Log into your processmaker.io account and navigate to “Your instances” tab.

Choose the instance you’d like to run a sample process on.

You will see a label called "Form Examples" and a link: https://examples.api.processmaker.io; click on it and a page with sample forms will open in a new tab.

Your API URL and Access Token for the selected Instance will be passed to the forms automatically. You may see these at the bottom. Site with sample forms will keep these values in a browser’s cookies.

There are three Process samples provided on the site: Onboarding, NDA signing  and a Time Off request. To read more about the sample processes please refer to Readme section.

Generic pages

These pages are similar in function for each sample, the details of each sample process will be described under their own specific Process paragraphs. Please note all the API requests will be issued from the selected user (you may select a user on the top right). E.g. a process imported under the user “Test” will be visible and manageable only from the user “Test”. Some forms will be delegated to a specific user, please ensure you have selected the correct user to work with these forms (refer to specific Process details).

Readme

This page contains links to documentation for the selected process and to download the appropriate BPMN file. The file contains BPMN 2.0 XML scheme and can be opened it any BPMN 2.0 complaint editor. To import BPMN files, they should be downloaded to your computer, please click on corresponding links to download.

Import

This page allows the user to import a BPMN file into your instance. To do so, please click on “Choose File” button and select the previously downloaded BPMN file on your device. Refer to the Readme section on how to download the BPMN file. After selecting the appropriate file, click on “Start Import” button to initiate the process.

When the file is successfully imported you will get a positive confirmation message.

During the import, the web form initiated a request to the API and got a response. To see the details of request/response - you may use the “Show Request” and “Show Response” buttons in the Logging section. This will reveal full details about communication with the API endpoint.

To read more about API endpoints and the JSON API communication format, please refer to the “Documentation” section on the PM.IO website.

Process List

This page will initiate API requests to your PM.IO Instance to get the list of Processes, and its instances, if any.

Processes will be represented as buttons stating process name and its UUID. If a Process has any instances they will be listed under process and will contain the status of the instance(s).

To delete a Process, click on a button with Process name, which will send a request to the API for Process deletion. There will be no additional confirmation message, so use this with care. If you accidentally deleted a Process, you will need to delete all the Processes and start over again with the BPMN Import.