View the product documentation.
Follow these steps to view product documentation:
Log on to ProcessMaker Platform.
Click your user avatar.
The Documentation page displays in a new window.
The Documentation page displays the following information:
General information about the ProcessMaker Platform edition
Current product version
Information about the Release Notes
Links to documentation for previous versions
Privacy Statement
See our Application Program Interface (API) documentation if you are a developer or coding engineer who wants to learn how each function in the interface has a corresponding API endpoint.
Use the in-platform chatbot to ask questions regarding ProcessMaker Platform functionality from any location in the platform. The chatbot displays in the same language as that user's profile setting for ProcessMaker Platform.
Follow these steps to search documentation using the chatbot:
Log on to ProcessMaker Platform.
Click the chatbot from any location in ProcessMaker Platform.
Enter your question using English or a non-English natural language. Right-to-left languages like Arabic have limited support on mobile devices.
Press Enter. The chatbot searches against documentation to provide a response.
Explore new ProcessMaker Platform features in the following ways:
Look for the following green-colored badges that indicate a new platform feature:
These badges display only until you initially click on that feature.
Look for walk-throughs to updates of existing features to see call-outs for what's new in them.
ProcessMaker may send notices to your user account, or to all members in your organization, to inform you of platform-specific information. This may include, but not limited to, new ProcessMaker releases and dates in which those releases are scheduled to be generally available and/or deployed.
Platform-specific notices display as a banner at the bottom of every ProcessMaker Platform page until you close it by clicking the Close icon.
Platform-specific notices display in English language.
Personalize your user profile, user avatar, and application settings.
Follow these steps to access your profile settings:
Log on to ProcessMaker Platform.
Click your user avatar. Your user name displays in the Edit Profile option.
Your user profile contains the following sections that determine how your user is represented:
Follow these steps to change your profile information:
Access your profile. The Profile page displays.
Change the following General Information settings as necessary:
In the First Name setting, enter your first name. Your first name displays to other users who view your profile information. This is a required setting.
In the Last Name setting, enter your last name. Your last name displays to other users who view your profile information. This is a required setting.
In the Job Title setting, enter the job title or description you have in your organization.
Change the Contact Information settings as necessary:
In the Email setting, enter your business email address. Your email address displays to other users who view your profile information. This is a required field.
In the Phone setting, enter your business telephone number.
In the Fax setting, enter your fax number.
In the Cell setting, enter your cell number.
Change the Address settings as necessary:
From the Country drop-down menu, select the country for your business address.
In the Address setting, enter your business address.
In the City setting, enter the city for your business address.
In the State or Region setting, enter the state, region, or province for your business address.
In the Postal Code setting, enter your business postal code.
Change your user avatar, log on information, and/or settings if necessary.
Click Save. The following message displays: Your profile was saved.
Your avatar represents you throughout ProcessMaker Platform. Below are a few ways your avatar represents you:
Requests in which you are a participant
Tasks assigned to you and which you have completed
Screens you have designed
Scripts you have developed
If your user profile does not have an avatar, such as when a user account is created, the initials of your full name display.
Follow these steps to change your user avatar:
Access your profile. The Profile page displays.
Locate the Avatar section.
Do one of the following:
Upload an avatar: If there is no avatar image, the initials for that person's full name display. Click the Upload Avatar button. The Browse button displays. Continue to step 4.
Change an avatar: Select the Change button to upload a new avatar image. Continue to step 4.
Remove the current avatar: Click the Clear button. The initials for that person's full name display. Continue to step 7.
Locate and then select the image to be your avatar. The image fits into the Upload Avatar screen.
Change any of the following settings if necessary:
Click Save to save the profile. The following message displays: Your profile was saved.
Usernames and passwords must adhere to the following protocol:
Aside from alphanumeric characters, ProcessMaker Platform allows only the following characters in usernames:
commercial at (@
)
hyphen (-
)
period (.
)
plus (+
)
underscore (_
)
Passwords must be at least eight (8) characters long, must contain at least one uppercase letter and a number or symbol. Password special characters are recommended.
Follow these steps to change your log on information:
Access your profile. The Profile page displays.
In the Username setting, change your username if necessary. Aside from alphanumeric characters, ProcessMaker Platform allows only the following characters in usernames:
commercial at (@
)
hyphen (-
)
period (.
)
plus (+
)
underscore (_
)
This is a required setting.
In the New Password setting, enter your new password. Leave the New Password setting blank to keep the current password. Passwords must be at least eight (8) characters long, must contain at least one uppercase letter and a number or symbol. Password special characters are recommended. If you enter a new password, password validation indicates how strong your password is if you enter a new password.
In the Confirm Password setting, confirm that your new password matches that entered into the New Password field if you enter a new password. If you entered a new password, password validation indicates if the New Password and Confirm Password values do not match.
Change your profile information, user avatar, and/or settings if necessary.
Click Save. The following message displays: Your profile was saved.
Use the Settings section of the profile settings to specify how ProcessMaker Platform displays date and time information to you, which natural language to display settings, and the status of your user account.
ProcessMaker Platform supports the following natural languages:
English
French
German
Spanish
Follow these steps to change your settings:
Access your profile. The Profile page displays.
In the Date Format drop-down menu, select the format how dates are displayed from the following options:
m/d/Y (12/31/2017)
m/d/Y h:i A (12/31/2017 11:30 pm)
m/d/Y H:i (12/31/2017 23:30)
d/m/Y (31/12/2017)
d/m/Y h:i A (31/12/2017 11:30 pm)
d/m/Y H:i (31/12/2017 23:30)
Y/m/d (2017/12/31)
Y/m/d H:i (2017/12/31 23:30)
d.m.Y H:i (31.12.2017 23:30)
Y-m-d H:i (2017-12-31 23:30)
From the Time Zone drop-down menu, select the time zone in which to display times.
From the Language drop-down menu, select in which language to display user interface labels and messages. Note that English-language is the default language and the only natural language provided. However, you may display the user interface labels and messages in German-, Spanish-, or French-language. Changing this setting only affects your user account. Optionally, select one of the following non-English languages:
German: Select the de option.
Spanish: Select the es option.
French: Select the fr option.
From the Status drop-down menu, select the status of your user account. Below is a description of each status:
Active: An Active user account is one in which a person can use his or her user account to log on to ProcessMaker Platform.
Inactive: An Inactive user account is one in which a person cannot use his or her user account to log on to ProcessMaker Platform.
Change your profile information, user avatar, and/or log on information if necessary.
Click Save. The following message displays: Your profile was saved.
To view another user's profile information, click that person's avatar.
After clicking the avatar, that person's profile information displays. Each user is responsible for profile content.
Hover your cursor over a user's avatar to view that person's full name.
Ensure that the device from which you are logging on meets the following requirements:
Your web browser application on your device is the latest version of one of the following browsers:
Apple Safari
Google Chrome
Microsoft Edge
Mozilla Firefox
Your display is at least 1200 by 720 pixel resolution.
Follow these steps to log on:
Enter the fully qualified domain name for the server or instance hosting ProcessMaker Platform followed by/login
in a supported web browser. For example: https://myServer.myDomain.net/login
If the web address is correct, the log in page displays.
Do one of the following:
Enter your user account credentials:
In the Username field, enter your username.
In the Password field, enter your password.
Optionally, select the Remember me check box to not enter your log in credentials in the future.
Click the Log In button.
If ProcessMaker Platform is configured to only allow one device per user account to be logged on, ProcessMaker Platform immediately logs you off if your user account logs on with a second device. When this occurs, the following message displays above the log on settings: Your account has been timed out for security.
To enable this security feature, ask for more information from ProcessMaker Support.
Follow these steps to reset your password:
Click the Forgot Password? link as highlighted below.
The Forgot Your Password? page displays.
In the Email Address field, enter the email address to which to send a reset link.
If you enter an email address which is not recognized, the following message displays in red-colored text below the Email Address field: We can't find a user with that e-mail address.
Click Request Reset Link.
Check your email for the instructions to reset your password.
After you select the link in that email to reset your password, click the Back to Login link to return to the log in page.
Follow these steps to change your password:
In the Confirm Password setting, re-enter your password to confirm it. Password validation indicates if the New Password and Confirm Password values do not match.
If password validation is successful, click Change Password. The web browser page is redirected to the login page.
Follow these steps to log out of ProcessMaker Platform:
Click your user avatar.
You are logged out and the log on screen displays.
If ProcessMaker Platform is configured to only allow one device per user account to be logged on, ProcessMaker Platform immediately logs you off if your user account logs on with a second device. When this occurs, the following message displays above the log on settings: Your account has been timed out for security.
To enable this security feature, ask for more information from Support.
View information about the ProcessMaker Platform version and installed packages.
Select Documentation.
Features with text labels: New features with text labels display the following badge:
Features with icons: New features accessible from an icon display the following badge:
Locate the Profile section.
From the Upload Avatar screen, click the Browse button to locate the image to be your avatar.
Adjust the size of the image using the image size indicatorto fit well inside the circle where your avatar displays, and then click Save. Your avatar displays in the Avatar section.
Locate the Login Information section.
Locate the Settings section.
Log on using Single Sign-On (SSO) or a third-party authentication service: Click the button for a third-party service in which you subscribe to use that service's credentials to log on. For details on setting up SSO or third-party authentication, see . If there is configured a default SSO provider, users are automatically redirected to the IDP Single Sign On log on page instead of displaying the normal Login page.
If the log on is successful, the page displays.
Are you or your password?
.
If is configured with a default SSO provider and there is a problem when logging through SSO, please ask your Administrator to contact the ProcessMaker Customer Success Manager and request to disable the default SSO login.
Access the log in page as described in . If you do not know the web address to access the log on page, ask your Administrator for assistance.
Log on as described in .
Passwords must be at least eight (8) characters long, must contain at least one uppercase letter and a number or symbol. are recommended.
If your organization requires a password change, the Change Password screen displays after :
In the New Password setting, enter a new password. Passwords must be at least eight (8) characters long, must contain at least one uppercase letter and a number or symbol. are recommended. Password validation indicates how strong your password is and, at a minimum, it should meet the medium strength requirements described above.
Select Log Out from the list.
to ProcessMaker Platform.
A link to and
A link to the
Receive a warning that your log on session is almost expired.
If you have not interacted with the application in 120 minutes (two hours), ProcessMaker Platform warns you that your log on session is almost expired. If your log on session expires, you will lose any unsaved work that may include any of the following:
Information that you started entering into a Task but did not submit (thereby completing the Task) is lost.
Any Process model changes that you made since the last time you saved the model are lost.
Any Script changes that you made since the last time you saved the Script are lost.
Any Screen changes that you made since the last time you saved the Screen are lost.
Any user account or group changes you made but have not yet saved are lost.
As long as you are saving changes in the application, the session time out period does not begin to expire.
When 10% of the session timeout remains, a session timeout notice displays.
Click the Stay Connected button to renew your session before the timer indicator displays 00:00. Otherwise, ProcessMaker logs you off automatically and any unsaved work is lost.
If your session times out, you will need to log on again to continue using ProcessMaker Platform.
If ProcessMaker Platform is configured to only allow one device per user account to be logged on, ProcessMaker Platform immediately logs you off if your user account logs on with a second device. When this occurs, the following message displays above the log on settings: Your account has been timed out for security.
To enable this security feature, ask for more information from Support.
Receive updates about Requests and your assigned Tasks.
Participants and Designers can access notifications easily to ensure communication and easy access to relevant comments.
Request participants may receive notifications when the following events occur:
The Inbox tab displays participant event notifications as follows:
A Request has started. The notification specifies for which Process.
A Request participant is assigned a Task. Selecting a notification for an assigned Task opens that Task's summary.
Task assignees and/or Request participants may be notified when a Task is due.
The Request starter's Request is canceled. Selecting a notification for a canceled Request opens that Request's summary.
The Request starter's Request is completed. Selecting a notification for a completed Request opens that Request's details.
A Process is imported.
The Notifications tab also displays when each of these types of events occur.
The Comments tab displays comment notifications when a user tags you in a Request comment, a Task comment, or as a collaborator designing a Process model. Selecting a notification for a tagged comment opens that Request summary, Task summary, or Process that contains the tagged comment. If you are not a Request participant prior to being tagged in a Request or Task comment, you become a Request participant.
Process Designers may receive notifications when the following events occur:
The Inbox tab displays the following Designer event notifications:
A Request has started for a specific Process. The Notifications tab also displays each of these events.
A Request participant is assigned a Task. Selecting a notification for an assigned Task opens that Task's summary.
Task assignees and/or Request participants may be notified when a Task is due.
The Request starter's Request is canceled. Selecting a notification for a canceled Request opens that Request's summary.
The Request starter's Request is completed. Selecting a notification for a completed Request opens that Request's summary.
A Process is imported.
The Notifications tab also displays when each of these types of events occur.
The Comments tab displays comment notifications when a user tags you from Process Modeler. This may occur while collaborating in real-time on a Process. If commenting in the Process is enabled, a comment posted in Process Modeler also sends a notification to the Process Manager and to any user tagged.
You may configure your Saved Search to notify you each time search results change based on your Saved Search parameters. For example, suppose that you have a Saved Search for all in-progress Requests for a particular Process, such as for a Purchase Request Process. Each time a Request starts for that Process, your Saved Search results change. If your Saved Search is configured to send notifications each time your Saved Search results change, you receive a notification.
There are three types of notifications:
Inbox
Notifications
Comments
When reviewing new notifications you can do the following:
Select the notification represented by the hyperlinked text.
A notification may contain the following information:
Task name: The name of the assigned Task displays as a hyperlink to that Task.
Task assignment date: To the right of the Task name displays the date and time in which the notification was sent to you. 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.
Request name: Below the assigned Task displays the name of the Request associated with that Task.
Request starter: Below the Request name is the full name of the person who started the Request.
Request completed: If you are a Request participant when a Request completes, a notification displays Request completed: followed by the name of the completed Request.
Request canceled: If you are a Request participant when a Request is canceled, a notification displays Request canceled: followed by the name of the canceled Request.
The Unread Notifications page displays all your unread notifications. To view the Unread Notifications page, follow the next steps:
Select a tab Inbox or Comments.
The Unread Notifications page displays the following information in tabular format about your unread notifications:
User: The User column displays to whom the notification applies. This user is often you, but it might also include others such as a person who canceled a Request.
Subject: The Subject column displays the subject of the notification. If the subject pertains to an assigned Task, the subject may include the following:
Task name: The name of the Task displays in blue-colored text. Select the Task name to open the Task.
Request name: The name of the Request associated with the Task displays in parentheses.
Tagged comment: If tagged in a comment, the Request comment or Task comment in which you were tagged.
Created: The Created column displays when the notification was sent to you. 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.
Need to search for a notification? See Search for a Notification.
Follow these steps to view all your notifications:
Select the Inbox or Comments tab.
The All Notifications page displays the following information in tabular format about all your notifications:
Status: The Status column displays the status of the notification using one of the following icons:
User: The User column displays to whom the notification applies. This user is often you, but it might also include others such as a person who canceled a Request.
Subject: The Subject column displays the subject of the notification. If the subject pertains to an assigned Task, the subject may include the following:
Action icon: An icon displays what action is associated with the notification so you can prioritize which notification to read first. These are the action icon indicators:
Task name: The name of the Task displays in blue-colored text. Select the Task name to open the Task.
Request name: The name of the Request associated with the Task displays in parentheses.
Tagged comment: If tagged in a comment, the Request comment or Task comment in which you were tagged.
Created: The Created column displays when the notification was sent to you. 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.
Need to search for a notification? See Search for a Notification.
Search for any notification displaying in the Unread Notifications or All Notifications pages.
To search for a notification, select the Search setting and then enter text to filter notifications using any of the following criteria:
User: Search for the user associated with the notification.
Subject: Search by the subject of the notification.
The notifications screen displays your notifications. To view new notifications, click the Notifications iconwhen it indicates you have one or more notifications.
Notifications remain visible until you click the Notifications icon and scroll down all notifications.
Click the View All button to view all notifications.
If you have no notifications when you select the Notifications icon, the following message displays: All Cleared! No new notifications at the moment.
Click the Notifications icon. Inbox notifications display.
Click the View All button. All notifications display.
Click the Unread Notifications iconin the left sidebar when you are viewing the All Notifications page.
Status: The Status column displays the unread status iconto indicate the notification is unread. Click the icon to indicate that the notification is read. Doing so makes the notification display in the All Notifications page.
Click the Notifications icon. Inbox notifications display.
Click the View All button.
Click the All Notifications iconin the left sidebar. The All Notifications page displays.
Unread status: The notification is unread. Click the icon to indicate its status as read.
Read status: The notification is either read or dismissed when the notification was viewed. Click the icon to indicate its status as unread.
Assigned Task: The Assigned Task iconindicates that the notification is associated with an assigned task.
Completed Request: The Completed Request iconindicates that the notification is associated with a completed Request.
Canceled Request: The Canceled Request iconindicates that the notification is associated with a canceled Request.