Edit a custom menu that contains links that display at the top of the ProcessMaker Platform user interface.
Loading...
Loading...
Loading...
Loading...
Loading...
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.
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.
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.
See the following sections regarding how to locate a 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.
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.
Ensure that all users/group members have been shared the Saved Search. If a user cannot access a Saved Search, the following message displays instead of the Saved Search: Unauthorized error.
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
, 114
is the Saved Search ID.
The URL for the To Do Task page of that Saved Search is https://ProcessMakerPlatform-Instance-Name/tasks/saved-searches/ID
where ProcessMaker-Instance-Name
is the name of your ProcessMaker instance and ID
is the Saved Search ID.
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.
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.
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.
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.
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.
Create a hyperlink for a custom menu that displays at the top of the ProcessMaker Platform user interface.
Follow these steps to create a menu:
View all menus in your organization. The Menus tab displays:
In the Link Text setting, enter a unique name for the link. This is a required setting if an icon is not selected from the Icon setting.
From the Icon setting, select an icon to display to the left of the link text. This is a required setting if the Link Text setting does not contain a value.
From the Color Variant setting, select a color to display for the link. Both the link text and the icon display in the selected color. Select from one of the following options:
black: Black-colored. This is the default option.
danger: Red-colored
info: Teal-colored
primary: Blue-colored
secondary: Gray-colored
success: Green-colored
warning: Yellow-colored
white: White-colored
In the URL setting, enter the URL that links to the location. See the following regarding how to locate the URL for these ProcessMaker locations:
Select the Open in a new window checkbox to open the link in a new browser window.
Click Save. The link displays in the Link tab.
Edit a hyperlink for a custom menu that displays at the top of the ProcessMaker Platform user interface.
Follow these steps to edit a menu:
Edit the following settings as necessary:
In the Link Text setting, edit a unique name for the link. This is a required setting if an icon is not selected from the Icon setting.
From the Icon setting, select an icon to display to the left of the link text. This is a required setting if the Link Text setting does not contain a value.
From the Color Variant setting, select a color to display for the link. Both the link text and the icon display in the selected color. Select from one of the following options:
black: Black-colored. This is the default option.
danger: Red-colored
info: Teal-colored
primary: Blue-colored
secondary: Gray-colored
success: Green-colored
warning: Yellow-colored
white: White-colored
In the URL setting, edit the URL that links to the location. See the following regarding how to locate the URL for these ProcessMaker locations:
Select the Open in a new window checkbox to open the link in a new browser window.
Click Save.
Delete a hyperlink from a custom menu that displays at the top of the ProcessMaker Platform user interface.
Delete a previously customized link that displays commonly used tabs for users.
Follow these steps to delete a link for the menu:
Click Confirm.
Click the menu for the menu in which to create a link.
Click the Edit Menu option. The Links tab displays links for the selected menu. Links display from top to bottom in the Links tab as they display in the menu, left to right.
Click the +Link button. The Create Link screen displays.
. The Menus tab displays:
Click the menu for the menu in which to edit a link.
Click the Edit Menu option. The Links tab displays links for the selected menu. Links display from top to bottom in the Links tab as they display in the menu, left to right.
Click the Edit Link iconfor the link to edit. The Create Link screen displays with the setting values of the link.
. The Menus tab displays:
Click themenu for the menu in which to delete a link.
Click the Edit Menu option. The Links tab displays links for the selected menu. Links display from top to bottom in the Links tab as they display in the menu, left to right.
Click the Delete iconfor the link to delete. The Caution screen displays to confirm the deletion of the link.
Sort the order of links that display in a custom menu.
Follow these steps to sort the order of links in a menu:
View all menus in your organization. The Menus tab displays:
Click the menu for the menu to sort its links.
Click the Edit Menu option. The Links tab displays links for the selected menu. Links display from top to bottom in the Links tab as they display in the menu, left to right.
Select, and then drag, a sort iconcorresponding with a link to place it in a different order in the menu.