| Status | ||||||
|---|---|---|---|---|---|---|
|
| Table of Contents |
|---|
General Description
This example shows the user how to use the ProcessMaker I/O API for the most a common organization business process present in most organizations.
Onboarding Process Example
This diagram describe the onboarding process for a new customer.
The process diagram defined below will conduct a tracking of all onboarding requests for the integration project.
...
Activity name | Activity type | Activity description | Forms |
|---|---|---|---|
| Manual request | Empty start event | Requester asks about new access and fills out the manual request form. | Manual Request |
| API request | Message start event | Onboarding process can be started from 3rd part API. | |
| Record customer | User task | In this form the user needs to define the workflow requirement. | Record Form (Google Form) |
Validate Workspace | User task | This task is for the validators, they need to define 2 main aspects:
| Validate Workspace form |
Create Production Workspace Create Sandbox Workspace Create Development Workspace | Service task | These tasks can be performed, depending on the initial request, to create the workspace with requested information. | |
| Generate Summary | Script task | This activity is executed by ProcessMaker I/O engine, and is a script to generate a PDF with the information about the workspaces and credentials. | |
| Verify Onboarding Data | User task | This activity is created to validate that the same user has approved all information generated by the other activities. | Verify Onboarding Data |
Messages
Message Title | Item | Type | Content |
|---|---|---|---|
Notification to requester | "Verify Onboarding Data" User Task /Notify Requester Message event | email message | Hello {{ You request was approved and implemented. A workspaces for {{ Please find the summary document with Credential report in the attachment Best regards! |
Notification to supervisors | "Validate workspace" User task /Notify Supervisor Message event | email message | Hello {{ We just wanted to inform you, that {{ Best regards! |
...
Document name | Item | Type | Template |
|---|---|---|---|
Credential report | Generate Summary | Credential report |
Getting Started with
...
To work with the MVP example, click on the top navigation tab labeled “Onboarding Example” on the Examples portal.
It will be selected by default when you open up the page for the first time. Top navigation will present the steps available for the selected example.
...
Use Case
How to Launch an Instance* of ProcessMaker I/O
*ProcessMaker I/O is designed to be installed in the cloud, so in this document an instance refers to an installation of ProcessMaker in a virtual machine or a container.
If you don't have a ProcessMaker I/O instance yet, please:
- Go to the Instance page.
- Click Create an Instance and follow the instructions provided.
If you already have a ProcessMaker I/O instance, please:
- Launch an instance of ProcessMaker I/O on the Instance page.
- Copy/remember the instance URL link, these will be required later
- Click on Form examples link
- Switch to Onboarding on the top
- Download Onboarding BPMN file on your computer
- Click on Import tab on the top left and upload BPMN file from your PC.
Users
For this specific example you will need three users:
...