Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
These are the basics you already know how to do, but need to be documented nonetheless.
Ensure that the device from which you are using ProcessMaker Platform meets the minimum Web browser requirements.
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.
Log on to ProcessMaker Platform using your credentials.
Please contact your Administrator if you do not know either of the following:
the web address to access the log in page
your log in credentials
Are you changing or forgetting your password?
If SSO Settings 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.
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.
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 SSO Settings. 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 My Requests page 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 ProcessMaker Support.
Follow these steps to reset your password:
Access the log in page as described in Log On. If you do not know the web address to access the log on page, ask your Administrator for assistance.
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-coloured 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.
Log on as described in Log On.
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 password:
If your organization requires a password change, the Change Password screen displays after Log On:
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. Password special characters are recommended. Password validation indicates how strong your password is and, at a minimum, it should meet the medium strength requirements described above.
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.
Use natural language in the chatbot to search documentation. Furthermore, receive platform-specific notices from ProcessMaker regarding new versions and upgrades.
Use ProcessMaker Platform to more easily do the following:
Follow these steps to search documentation using the chatbot:
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:
Click your user avatar. Your user name displays in the Edit Profile option.
Select Edit Profile.
Follow these steps to change your profile information:
Change the following General Information settings as necessary:
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.
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:
Follow these steps to change your user avatar:
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.
Remove the current avatar: Click the Clear button. The initials for that person's full name display. Continue to step 7.
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 (_
)
Follow these steps to change your log on information:
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 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.
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:
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.
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.
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.
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 for ProcessMaker Platform.
to ProcessMaker Platform.
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: .
to ProcessMaker Platform.
The Profile page displays. See .
Your user profile contains the following sections that determine how your is represented:
The Profile page displays.
Locate the Profile section.
In the First Name setting, enter your first name. Your first name displays to other users who . This is a required setting.
Change your , , and/or if necessary.
in which you are a participant
assigned to you and which you have completed
you have designed
you have developed
If your user profile does not have an avatar, such as when a , the initials of your full name display.
The Profile page displays.
Change an avatar: Select the Change button to upload a new avatar image. Continue to step 4.
From the Upload Avatar screen, click the Browse button to locate the image to be your avatar.
Locate and then select the image to be your avatar. The image fits into the Upload Avatar screen.
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.
Passwords must be at least eight (8) characters long, must contain at least one uppercase letter and a number or symbol. are recommended.
The Profile page displays.
Locate the Login Information section.
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. are recommended. If you enter a new password, password validation indicates how strong your password is if you enter a new password.
Change your , , and/or if necessary.
The Profile page displays.
Locate the Settings section.
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 for the open-source edition. However, if the is installed, you may display the user interface labels and messages to German-, Spanish-, or French-language. Changing this setting only affects your user account. Optionally, select one of the following non-English languages if the Translations package is installed:
Change your , , and/or if necessary.
See the permissions or ask your Administrator for assistance.
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.
Select Documentation.
View information about the ProcessMaker Platform version and installed packages.
Follow these steps to view ProcessMaker Platform and package version information:
Log on to ProcessMaker Platform.
Click your user avatar and then select About.
The About ProcessMaker page displays.
The About ProcessMaker page displays the following information:
ProcessMaker Platform current version
A link to report an issue and view the processmaker GitHub repository
A link to the Documentation
A list of packages installed including Name, description, and version for each package
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.
Log out of ProcessMaker Platform.
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.
Select Log Out from the list.
Set how you want tabular information to display.
Use these tips to control how tabular information displays in all your lists such as Project Categories except Task lists, Request lists, and Save searches. Control information as follows:
Click the drop-down to the right of the pagination buttons to adjust how many records display on each page. Select to display 10, 25 or 50 rows per page. Ten records per page displays by default.
If there are fewer than 10 records to display in the table, pagination functions do not display.
Filter your information with different criteria in Task lists, Request lists, and Save searches. Filter information as follows:
Follow the next steps to filter information:
View one of the following:
In a list column header, click the three dots. A window displays filter criteria.
Apply one or more filter criteria as follows:
Click sort ascending to sort data in alphanumeric order or sort in chronological order if the data is dates/times.
Click sort descending to sort data in alphanumeric descending order or sort in inverse chronological order if the data is dates/times.
The Filter the column section displays by default. Click + to add a filter column. Configure the column filter as follows:
From the Operator setting, select one of the following according to the data type:
If the column data type is a number or a date, it displays the following operators: =, <, <=, >, >=, between, in, contains, regex.
If the column data type is a string, it displays the following operators: =, in, contains, regex.
If the column is a task status, it displays the following operators: =, in.
In the Type value setting, enter the information accordingly.
If there is more than one filter row, from the Select an operator setting, select And or Or to filter a subsequent filter.
Click Apply to apply filter criteria. The list filters data as configured.
Otherwise, click Cancel to cancel the filter criteria and close the window.
If want to clean previous filters, click Clear to remove all previous filters.
Filter information does not support the Task columns.
Regular expressions, or regex, are patterns composed of characters and symbols used to find specific sequences in text. For an introduction to regex syntax, check out this primer. To practice and refine your regex skills, RegExr is an excellent tool, offering interactive examples and a platform for testing your patterns.
Click the sort arrowsin a column header to sort the records in that page by that sort preference. Columns that display alphanumeric data sort in alphanumeric orderor inversely. Columns that display dates/times sort in chronological orderor inversely. When the sort arrow points down, sort order is in descending order. When the sort arrow points up, sort order is in ascending order.
Click the Nextor Previouspagination buttons to view the next or previous page of records, respectively. If the first page is displayed, the Previouspagination button is disabled. If the last page is displayed, the Nextpagination button is disabled.
Click the Firstor Lastpagination buttons to view the first or last page of all records, respectively. If the first page is displayed, the Firstpagination button is disabled. If the last page is displayed, the Lastpagination button is disabled.