Locate the URL for ProcessMaker Platform Locations
Locate the URL for ProcessMaker Platform locations so as to link to them from a custom menu or to redirect users to that location when they next log on.
Overview
Create a customized hyperlink within a menu to either a ProcessMaker Platform location or an external site.
Consider the following destinations for a hyperlink so that users/group members that have access to the destination may view them without navigating the ProcessMaker Platform user interface:
Link to the URL that starts a specific Request of a Process. See how to locate the URL to start a Request.
Link to Tasks to do. See how to locate the To Do Task list URL.
Link to a Collection. See how to locate a Collection's URL.
Link to a Saved Search. See how to locate a Saved Search's URL.
Link to a dashboard. See how to locate a dashboard's URL.
Generally, ensure that all users/group members have access to the ProcessMaker Platform destination. The following message displays to users that do not have access to a ProcessMaker Platform location or asset: Unauthorized.
Locate the URL to Start a Request
A custom menu link can be configured such that when clicked, a Request starts. The URL for a Process's Request is available from its Start button in the New Request screen.
If a user is not configured from a Start Event element in the Process from which to start a Request, the following message displays when that user attempts to start that Request: Unauthorized.
Follow these steps to locate the URL to start a Request:
Click the +Request button from which all Requests start. The New Request screen displays.
Locate the Start button for the Process from which to start a Request, right-click that Start button, and then copy the link address/URL from that button. This is the URL from which to start that Request.
Locate a Task Page URL
See the following sections regarding how to locate a Task page URL:
Locate the Default Task Page URL
The default To Do Task page is located at https://ProcessMaker-Instance-Name/tasks where ProcessMaker-Instance-Name is the name of your ProcessMaker Platform instance. This is the URL to enter when configuring the hyperlink for a menu or to redirect to the default Task page.
Locate a Task Page from a Saved Search
Follow these guidelines to determine a Saved Search's ID, which is required for the hyperlink to that Saved Search's Task page for a menu's hyperlink or to redirect to its Task page:
Ensure that the Saved Search is shared with you or you are its owner; otherwise you cannot determine the Saved Search ID, which is the numerical representation your ProcessMaker Platform instance uses for that Saved Search. The Saved Search determines which Task-related results it displays, such as whether it displays tasks to be done, that are completed, and/or are self-serviced.
View the data details of the Request, Task, or Collection Saved Search to determine its ID.
From the Web browser address bar, note the number that ends the URL. This number is the Saved Search ID. For example, in the Saved Search URL
https://ProcessMakerPlatform-Instance-Name/requests/saved-searches/114,114is the Saved Search ID.The URL for the To Do Task page of that Saved Search is
https://ProcessMakerPlatform-Instance-Name/tasks/saved-searches/IDwhereProcessMaker-Instance-Nameis the name of your ProcessMaker instance andIDis the Saved Search ID.
Locate a Collection's URL
Ensure that all users/group members that use the menu or redirect to a Collection have the following:
Collection permissions, as configured from a user's account or a group
Access to at least view the records in that Collection, either as individual users or as group members
If a user cannot access a Collection, the following message displays instead of the Collection: Unauthorized.
Package Required
The Collections package must be installed to locate the URL for a Collection.
Permissions Required
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the Collections permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View record permission from a Collection's configuration to view that Collection's records. See Configure a Collection or ask the manager of that Collection for assistance.
Follow these steps to locate a Collection's URL:
View your Collections. The Collections page displays.
View the records for the Collection from which to get its URL. The list of records displays for the selected Collection.
Copy the URL from the Web browser address bar. This is the Collection's URL.
Locate a Saved Search's URL
Ensure that all users/group members that use the menu or redirect to a Saved Search have been shared the Saved Search.
Ensure that the Saved Search in which to get its URL has been shared with you or you are its owner; otherwise, you will not be able to access the Saved Search to locate its URL.
If a user cannot access a Saved Search, the following message displays instead of the Saved Search: Unauthorized.
Package Required
The Saved Searches package must be installed to locate the URL for a Saved Search.
Follow these steps to locate a Saved Search's URL:
View the data details of the Request, Task, or Collection Saved Search to locate its URL.
Copy the URL from the Web browser address bar. This is the Saved Search's URL.
Locate a Dashboard's URL
Follow these steps to locate a dashboard's URL:
View your dashboards. The Dashboards tab displays the Dashboards page.
Copy the URL from the Web browser address bar. This is the dashboard's URL.
Related Topics
pageWhat is a Menu?pageWhat is a Dashboard?pageView MenuspageCreate a MenupageCreate a Link for a MenupageEdit a Link for a MenupageDelete a Link from a MenupageSort the Order of Links in a MenupageDelete a MenupageMenu Design Best PracticespageConfigure a Custom Home Page and/or a MenupageWhat is a Screen?pageWhat is a Saved Search?pageWhat is a Collection?pageDynamic UI PackagepageWhat is a Package?Last updated