ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
Locate the URL for ProcessMaker Locations
Locate the URL for ProcessMaker 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 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 user interface:
Generally, ensure that all users/group members have access to the ProcessMaker destination. The following message displays to users that do not have access to a ProcessMaker location or asset: Unauthorized.

Locate the URL to Start a Request Via Web Entry

Ensure that the Process for which to start a Request from a custom menu link allows authenticated user and/or group Web Entry, and all users that have access to the menu also may start Requests via Web Entry.
If a user cannot access the Web Entry because that authenticated user has not been granted access, the following message displays instead of the Request: Unauthorized.
Your user account or group membership must have the following permissions to access the Process model so as to locate the Web Entry's URL unless your user account has the Make this user a Super Admin setting selected:
    Processes: Edit Processes
    Processes: View Processes
See the Process permissions or ask your Administrator for assistance.
Follow these steps to locate the URL that starts a Request via Web Entry:
    1.
    View your active Processes. The Processes tab of the Processes page displays.
    2.
    Click the Open Modeler icon
    for the Process that contains the Web Entry.
    3.
    Select the Start Event element that allows Web Entry, expand the Web Entry panel, and then locate the Web Entry URL setting.
    4.
    Click the Copy to Clipboard option. This is the Web Entry URL for the link.

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 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:
    1.
    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 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.
    2.
    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.
    3.
    View the data details of the Request, Task, or Collection Saved Search from to determine its ID.
    4.
    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://ProcessMaker-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://ProcessMaker-Instance-Name/tasks/saved-searches/ID where ProcessMaker-Instance-Name is the name of your ProcessMaker instance and ID is 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:
If a user cannot access a Collection, the following message displays instead of the Collection: Unauthorized.

ProcessMaker 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:
    1.
    View your Collections. The Collections page displays.
    2.
    View the records for the Collection from which to get its URL. The list of records display for the selected Collection.
    3.
    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.

ProcessMaker 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:
    1.
    View the data details of the Request, Task, or Collection Saved Search from to locate its URL.
    2.
    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:
    1.
    View your dashboards. The Dashboards tab displays of the Dashboards page.
    2.
    Copy the URL from the Web browser address bar. This is the dashboard's URL.

Related Topics

Last modified 3mo ago