Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Learn what information displays in a Request summary based on its status type.
Loading...
Loading...
Loading...
Loading...
Understand what Requests are in ProcessMaker Platform.
In ProcessMaker Platform, a "Request" is a single occurrence of a Process. A Request is more than just starting a Process. A Request is the workflow routing of one incident of a Process.
This is called a “Request” because many Processes begin with a request for an approval or a decision. Below are a few examples:
Request approval for a budget.
Request a leave of absence for next week.
Request to purchase office supplies.
You may start a Request for Processes that you have permission to do so. Likewise, you can participate in others' Requests. This occurs when someone else in your organization starts a Request that involves you. You would be notified of the Request and that you have a Task to do. You might be the only person deciding on a Request, or you might be among other users involved in the workflow routing of a Request for a Process.
Learn what information displays in summaries for in-progress Requests.
Follow these steps to view a summary for an in-progress Request:
Ensure that you are logged on to ProcessMaker Platform.
View one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
In Progress page. See View Requests That Are In Progress.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column in the Request page, click the Request number associated with the Process that you want to view. That Request's summary displays.
The Tasks tab displays the summary for all assigned Tasks to the Request participants to that time.
The Tasks tab displays the following summary in tabular format about assigned Tasks to Request participants to that time:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each Task to be completed for the selected Request for all Request participants. If a Task is assigned to you, a hyperlink displays in the Task name.
Assigned: The Assigned column displays the username's avatar to whom the Task is assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task is due. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
If there are no assigned Tasks for the selected Request, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
The Summary tab displays the summary of information entered and accumulated into the Request when a Request completes. However, because the Request is in progress, there are no Request values to display. Instead, the Summary tab displays the following message: This Request is currently in progress. This screen will be populated once the Request is completed.
Below this message, the history of the Request displays all Request actions. See Request History.
The Completed tab displays the summary of all Tasks Request participants completed to that time.
The Completed tab displays the following summary in tabular format about completed Tasks participants completed to that time in the Request:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each completed Task in the selected Request.
Assigned: The Assigned column displays the username's avatar to whom the Task was assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task was due. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
If the selected Request has no completed Tasks, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Requests store files associated differently depending if the File Manager package is installed. See the following sections regarding how Requests store files:
File Manager package is not installed: The Files tab displays Request files.
File Manager package is installed: The File Manager tab displays Request files.
When the File Manager package is not installed, the Files tab displays all files associated with the Request to that time. The Files tab only displays in that Request summary if one of the following occurs:
At least one file has been uploaded to that Request.
A PDF Generator connector in that Request has automatically generated a PDF of a Display-type Screen. Note that to use the PDF Generator connector, the PDF Generator package must be installed.
The Files tab displays the following summary in tabular format about the files associated with the Request:
File Name: The File Name column displays the name of each file associated with the selected Request. Click the file name to download it to your local computer or network location.
MIME Type: The MIME Type column displays the MIME type for the associated file.
Created At: The Created At column displays the date the file became associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
When the File Manager package is installed, the File Manager tab displays all files associated with the Request to that time.
The File Manager tab displays the following summary in tabular format about the files associated with the Request:
Name: The Name column displays the name of each file associated with the selected Request. Beside each file's name is its MIME type.
Users: The Users column displays the avatar for the Request participant that uploaded each file associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. Hover your cursor over a user's avatar to view that person's full name.
Size: The Size column displays the size of each file associated with the selected Request.
Modified: The Modified column displays the date that was modified. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Follow these steps to share a file with one or more users:
In the Share screen, enter with which user(s) to share this file.
Click Save. The following message displays: Shared users successfully updated.. The user(s) with which the file is shared receives a notification of the shared file.
Files that have been shared with you are in File Manager's Shared With Me folder.
Below the table, the history of the Request displays all Request actions. See Request History.
The Forms tab displays the Screen associated with each Task that each Request participant submitted in the Request to that time. For example, if a Request participant entered information into a Screen, all Request participants can view the Request data that the Task assignee entered.
The Forms tab displays the following summary in tabular format about submitted Screens by Request participants to that time in the Request:
Screen: The Screen column displays the name of each submitted Screen in the selected Request.
Description: The Description column displays the description of each Screen.
Below the table, the history of the Request displays all Request actions. See Request History.
Each in-progress Request displays a summary of the Request to that time.
The following summary displays about an in-progress Request:
Requested By: The Requested By field displays the avatar and full name of the person who started the selected Request. Hover your cursor over a user's avatar to view that person's full name.
Cancel Request: The Cancel Request field allows a Request participant or ProcessMaker Platform Administrator to cancel the Request if that Request participant's user account has the appropriate permission to cancel Requests for that Process. If your user account does not have the permission(s) to cancel Requests for that Process, the Cancel Request field does not display. See Cancel a Request.
Child Requests: The Child Requests field displays any child Requests associated with this Request, referred to as the parent Request when a child Request exists. A child Request is one from which this Request automatically started as designed in its associated Process. All child Requests have their own statuses since each routes independently of their parent Request. Click the link for any child Request to view the Request summary for that child Request. For example, a child Request represents a Sub Process. If there are no child Requests associated with this Request, the Child Requests field does not display. The status icon displays beside each child Request. See View Your Requests for descriptions of each status icon.
Participants: The Participants field displays each Request participant's avatar in the selected Request to that time. Hover your cursor over a user's avatar to view that person's full name.
Request creation date: The date and time the Request was created displays below the Participants field. 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.
Below the tabular information summarizing the Request displays that Request's history: all Request actions to that time in chronological order. The oldest Request actions display at the top of the Request history.
The following information displays about each action in the Request history:
Request participant: The Request participant who performed the action is represented by his or her avatar. Hover your cursor over a user's avatar to view that person's full name. If the system performed an action by running a Script or other automated function, that action is represented by "S" avatar.
Date and time the action occurred: To the right of the Request participant displays the date and time the Request action occurred. 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.
Description of the action: To the right of when the Request action occurred displays a description of that action. The system generates this action description.
Click the Open Request iconfor a Request. That Request's summary displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Click the View iconfor the Request associated with the file to view its summary.
Click the Download iconfor the file to download to your local computer.
Click the Share iconfor the file to share. The Share screen displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
To view a Screen and the Request data submitted by a Request participant, click the Details icon. The submitted Screen displays.
Click the Details iconagain to hide the displayed Screen and its Request data.
To print a Screen and its Request data, click the Print icon. A print preview displays in a new browser window from which you can select an accessible printer.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Parent Request: The Parent Request field displays the parent Request associated with this Request, referred to as the child Request when a parent Request exists. The parent Request is one that automatically started this Request as designed in its associated Process. The parent Request has its own status since it routes independently of its child Request(s). Click the link for the parent Request to view the Request summary for that Request. For example, a parent Request represents the main Process that started a Sub Process Request. If there is no parent Request associated with this Request, the Parent Request field does not display. The status icon displays beside the parent Request. See View Your Requests for descriptions of each status icon. Below is an example of a parent Request in a Request summary.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history. See Request Comments.
Learn what information displays in summaries for completed Requests.
Follow these steps to view a summary for a completed Request:
Ensure that you are logged on to ProcessMaker Platform.
View one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
Completed page. See View Completed Requests.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column in the Request page, click the Request number associated with the Process that you want to view. That Request's summary displays.
The Summary tab displays the summary of information entered into Screens and accumulated into the completed Request. The Summary tab may display values in the Request in the following ways:
By default, completed Request data displays in JSON format key-value pairs in tabular format that represent Screen control data.
Configure a Display-type Screen that summarizes specific information from the completed Request. See Configure a Process.
When the Summary tab displays the JSON-formatted key-value pairs from the completed Request data, the following information displays:
Key: The Key column displays the JSON key name that represents the Screen control name the Request participant entered data. For example, use a Rich Text control to enter your company's name that has a Variable Name setting value of companyName
which would display in the Key column here.
Value: The Value column displays that key's value as entered by a person manually interacting with a form. For example, use a Rich Text control to enter your name could have the value John Doe
which would display in the Value column here.
Below the table, the history of the Request displays all Request actions. See Request History.
Your user account or group membership must have the "Requests: Edit Request Data" permission to edit Request data unless your user account has the Make this user a Super Admin setting selected.
See the Request permissions or ask your Administrator for assistance.
The Data tab displays the data from a completed Request in JSON format. The Data column only displays when that Request is completed.
Follow these steps to edit and save the completed Request data from those values that were submitted in the Request:
View the Data tab. Note that the Data tab does not display until the Request is completed.
From the editable JSON setting, change the values that were submitted during the Request to those that you want.
Click Save. The following message displays when the Request values are changed: Request data successfully updated.
Below the editable JSON setting, the history of the Request displays all Request actions. See Request History.
The Completed tab displays the summary of all assigned Tasks to Request participants for the selected completed Request.
The Completed tab displays the following summary in tabular format about assigned Tasks to Request participants for the completed Requests:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each completed Task in the selected Request.
Assigned: The Assigned column displays the username's avatar to whom the Task was assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task was due. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
If the selected Request is not completed, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Requests store files associated differently depending if the File Manager package is installed. See the following sections regarding how Requests store files:
File Manager package is not installed: The Files tab displays Request files.
File Manager package is installed: The File Manager tab displays Request files.
When the File Manage package is not installed, the Files tab displays the summary of all files associated with the Request to that time. The Files tab only displays in that Request summary if one of the following occurs:
At least one file has been uploaded to that Request.
A PDF Generator connector in that Request has automatically generated a PDF of a Display-type Screen. Note that to use the PDF Generator connector, the PDF Generator package must be installed.
The Files tab displays the following summary in tabular format about the files associated with the Request:
File Name: The File Name column displays the name of each file associated with the selected Request. Click the file name to download it to your local computer or network location.
MIME Type: The MIME Type column displays the MIME type for the associated file.
Created At: The Created At column displays the date the file became associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
When the File Manager package is installed, the File Manager tab displays all files associated with the Request to that time.
The File Manager tab displays the following summary in tabular format about the files associated with the Request:
Name: The Name column displays the name of each file associated with the selected Request. Beside each file's name is its MIME type.
Users: The Users column displays the avatar for the Request participant that uploaded each file associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. Hover your cursor over a user's avatar to view that person's full name.
Size: The Size column displays the size of each file associated with the selected Request.
Modified: The Modified column displays the date that was modified. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Follow these steps to share a file with one or more users:
In the Share screen, enter with which user(s) to share this file.
Click Save. The following message displays: Shared users successfully updated.. The user(s) with which the file is shared receives a notification of the shared file.
Files that have been shared with you are in File Manager's Shared With Me folder.
Below the table, the history of the Request displays all Request actions. See Request History.
The Forms tab displays the Screen associated with each Task that each Request participant submitted in the Request to that time. For example, if a Request participant entered information into a Screen, all Request participants can view the Request data that the Task assignee entered.
The Forms tab displays the following summary in tabular format about submitted Screens by Request participants to that time in the Request:
Screen: The Screen column displays the name of each submitted Screen in the selected Request.
Description: The Description column displays the description of each Screen.
Below the table, the history of the Request displays all Request actions. See Request History.
Each completed Request displays a summary of the Request.
The following summary displays about a completed Request:
Requested By: The Requested By field displays the avatar and full name of the person who started the selected Request. Hover your cursor over a user's avatar to view that person's full name.
Child Requests: The Child Requests field displays any child Requests associated with this Request, referred to as the parent Request when a child Request exists. A child Request is one from which this Request automatically started as designed in its associated Process. All child Requests have their own statuses since each routes independently of their parent Request. Click the link for any child Request to view the Request summary for that child Request. For example, a child Request represents a Sub Process. If there are no child Requests associated with this Request, the Child Requests field does not display. The status icon displays beside each child Request. See View Your Requests for descriptions of each status icon.
Participants: The Participants field displays each Request participant's avatar in the selected Request. Hover your cursor over a user's avatar to view that person's full name.
Request completion date: The date and time the Request was completed displays below the Participants field. 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.
Below the tabular information summarizing the Request displays that Request's history: all Request actions to that time in chronological order. The oldest Request actions display at the top of the Request history.
The following information displays about each event in the Request history:
Request participant: The Request participant who performed the action is represented by his or her avatar. Hover your cursor over a user's avatar to view that person's full name. If the system performed an action by running a Script or other automated function, that action is represented by "S" avatar.
Date and time the action occurred: To the right of the Request participant displays the date and time the Request action occurred. 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.
Description of the action: To the right of when the Request action occurred displays a description of that action. The system generates this action description.
View and send comments to Requests.
Comments allow Request participants to solicit and provide feedback on business decisions throughout a Request:
Post Request comments: Post comments to the currently displayed Request summary. All Request participants that view that Request's summary see that comment. Write and preview comments using rich text features including but not limited to text styles, images, hyperlinks, and lists. The commenting editor uses Markdown syntax. Request participants may edit and/or delete their posted comments if allowed in a Process's Requests.
Tag users in a Request comment: Precede a user's username with the @
symbol to invite that user into the comment thread so that user can participate in the discussion. Upon using the @
symbol and then typing the initial letters of the user to tag, those users that match those initial letters display for selection. After sending the comment with tagged users, those users receive a notification of the comment they were tagged within, and then may select that notification to view that Request comment. Selecting a notification for a tagged comment opens that Request summary that contains the tagged comment. If the tagged user is not a Request participant prior to being tagged in a Request comment, that user becomes a Request participant only for that Request.
Add emoticon reactions to sent Request comments: Add emoticon reactions to posted Request comments if allowed in a Process's Requests.
Add votes to sent Request comments: Add votes to posted Request comments if configured for use in a Process's Requests.
Use a Markdown syntax quick guide for the most commonly used Markdown syntax.
The Comments package must be installed to use Request commenting functions.
For Requests to provide commenting functions, the Process associated with your Requests must be configured to allow the following commenting functions:
Allow comments: The Process must be configured to allow comments.
Add reactions to comments: Add emoticon reactions to posted comments in a Request summary if its associated Process is configured to allow it.
Allow comment voting: Vote on posted comments in a Request summary if its associated Process is configured to allow it. Voting allows Request participants to vote on the merits of a posted comment and provide feedback to the Request participant that posted that comment.
Allow comment editing: Request participants may edit their posted comments in a Request summary if its associated Process is configured to allow it.
Allow comment deletion: Request participants may delete their posted comments from a Request summary if its associated Process is configured to allow it.
See Configure Commenting Functions in Configure a Process or ask your Process designer to configure the Process to use comments in its associated Requests.
Ensure the following to view comments for a Request:
The Comments package is installed.
Follow these steps to view posted comments to a Request summary:
Ensure that you are logged on to ProcessMaker Platform.
Do one of the following:
Click the Requests option from the top menu if it is not currently displayed. The My Requests page displays.
View one of the following Requests pages:
All Requests page. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Each posted comment contains the following information:
Avatar: The user's avatar identifies the sender of each comment. Hover your cursor over a user's avatar to view that person's full name.
Datetime: The datetime displays when the comment was posted to the Request summary. 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 number: The Request number displays to the right of the datetime when the comment was posted.
Comment: The posted comment displays below the preceding information. The comment may contain tagged users, emoticon reactions, and/or votes. If a comment contains replies, click the Load Replies button to display that comment's replies.
Reply: Click the Reply button to reply to a selected comment. See Send or Reply to a Comment in a Request.
Each posted comment may contain the following ways to provide reaction or feedback to a selected comment depending how the Process associated with that Request is configured to use commenting functions:
Ensure the following to add reactions to a posted Request comment:
The Comments package is installed.
Follow these steps to add a reaction to a posted Request comment:
Browse for and then select the emoticon reaction to add to the posted comment. The emoticon reaction displays as a new reply to the posted comment.
Ensure the following to add votes to a posted Request comment:
The Comments package is installed.
Follow these steps to add a vote to a posted Request comment:
View the posted comments for a Request. The voting indicators display below each posted comment.
Do one of the following:
The selected vote indicator displays as a reply to the selected comment and one vote adds to the voting icons below that comment.
Ensure the following to post a comment to a Request:
The Comments package is installed.
Follow these steps to post or reply to a Request comment:
Do one of the following:
Post a new Request comment: View the end of that Request's history to locate the Write tab to write and post a new comment to that Request.
From the Write tab, write your Request comment. Optionally use rich text features such as text styles, images, hyperlinks, lists, code-, and/or quote-styles. The commenting editor uses Markdown syntax. Use a Markdown syntax quick guide for the most commonly used Markdown syntax. Follow these guidelines:
Text styles, including bold, italics, strikethrough, and code styles: Click a text style button from the commenting editor toolbar. The commenting editor displays both the preceding and following Markdown syntax in the commenting editor. Place your cursor between the Markdown syntax, and then write your text to display in that text style. For example, click the Bold text style button from the commenting editor toolbar. Four asterisks display in the commenting editor: two asterisks to precede your text and two to follow your text since bold-style text in Markdown syntax requires two asterisks both preceding and following text for that style. Alternatively, write your text in plain text, highlight the text to display in a particular text style, and then click that text style's button.
Tag users in a Request comment: Precede a user's username with the @
symbol to invite that user into the comment thread so that user can participate in the discussion. Upon using the @
symbol and then typing the initial letters of the user to tag, those users that match those initial letters display for selection. After sending the comment with tagged users, those users receive a notification of the comment they were tagged within, and then may select that notification to view that Request comment. Selecting a notification for a tagged comment opens that Request summary that contains the tagged comment. If the tagged user is not a Request participant prior to being tagged in a Request comment, that user becomes a Request participant only for that Request.
Optionally, click the Preview tab to preview your currently written comment as it would display after it is posted.
Click the Send button. The comment posts.
Ensure the following to post a comment to a Request:
The Comments package is installed.
Request participants may edit their own comments, but not those posted by others.
Follow these steps to edit one of your Request comments:
Locate your posted Request comment to edit.
Edit your comment using the commenting editor as you did when you posted or replied to a comment.
Click the Update Comment button. The edited comment posts.
Ensure the following to post a comment to a Request:
The Comments package is installed.
Request participants may delete their own comments, but not those posted by others. If the comment being deleted has replies, then its replies are also deleted.
Follow these steps to delete one of your Request comments:
Locate your posted Request comment to delete.
Click Confirm and the comment is deleted from the list of posted comments.
Learn what information displays in summaries for canceled Requests.
Follow these steps to view a summary for a canceled Request:
Ensure that you are logged on to ProcessMaker Platform.
View one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column in the Request page, click the Request number associated with the Process that you want to view. That Request's summary displays.
The Summary tab displays the summary of information entered into Screens and accumulated into the Request to the time of its cancellation.
The Summary tab displays the JSON-formatted key/value pairs in tabular format that represent Screen control data. Information is displayed:
Key: The Key column displays the JSON key name that represents the Screen control name the Request participant entered data. For example, a Rich Text control to enter your company's name could have a Variable Name setting value of companyName
which would display in the Key column here.
Value: The Value column displays that key's value as entered by a person manually interacting with a form. For example, a Text control to enter your name could have the value John Doe
which would display in the Value column here.
Below the Summary tab, the history of the Request displays all Request actions. See Request History.
The Completed tab displays the summary of all Tasks Request participants completed to the time the selected Request was canceled.
The Completed tab displays the following summary in tabular format about completed Tasks Request participants completed to the time the Request was canceled:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each completed Task in the selected Request.
Assigned: The Assigned column displays the username's avatar to whom the Task was assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task was due. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.
Below the table, the history of the Request displays all Request actions to the time the selected Request was canceled. See Request History.
If the selected Request has no completed Tasks, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Requests store files associated differently depending if the File Manager package is installed. See the following sections regarding how Requests store files:
File Manager package is not installed: The Files tab displays Request files.
File Manager package is installed: The File Manager tab displays Request files.
When the File Manager package is not installed, the Files tab displays the summary of all files associated with the Request to that time. The Files tab only displays in that Request summary if one of the following occurs:
At least one file has been uploaded to that Request.
A PDF Generator connector in that Request has automatically generated a PDF of a Display-type Screen. Note that to use the PDF Generator connector, the PDF Generator package must be installed.
The Files tab displays the following summary in tabular format about the files associated with the Request:
File Name: The File Name column displays the name of each file associated with the selected Request. Click the file name to download it to your local computer or network location.
MIME Type: The MIME Type column displays the MIME type for the associated file.
Created At: The Created At column displays the date the file became associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Below the table, the history of the Request displays all Request actions to the time the selected Request was canceled. See Request History.
When the File Manager package is installed, Request summaries the File Manager tab displays all files associated with the Request to that time.
The File Manager tab displays the following summary in tabular format about the files associated with the Request:
Name: The Name column displays the name of each file associated with the selected Request. Beside each file's name is its MIME type.
Users: The Users column displays the avatar for the Request participant that uploaded each file associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. Hover your cursor over a user's avatar to view that person's full name.
Size: The Size column displays the size of each file associated with the selected Request.
Modified: The Modified column displays the date that was modified. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Follow these steps to share a file with one or more users:
In the Share screen, enter with which user(s) to share this file.
Click Save. The following message displays: Shared users successfully updated.. The user(s) with which the file is shared receives a notification of the shared file.
Files that have been shared with you are in File Manager's Shared With Me folder.
Below the table, the history of the Request displays all Request actions. See Request History.
The Forms tab displays the Screen associated with each Task that each Request participant submitted in the Request to that time. For example, if a Request participant entered information into a Screen, all Request participants can view the Request data that the Task assignee entered.
The Forms tab displays the following summary in tabular format about submitted Screens by Request participants to that time in the Request:
Screen: The Screen column displays the name of each submitted Screen in the selected Request.
Description: The Description column displays the description of each Screen.
Below the table, the history of the Request displays all Request actions. See Request History.
Each canceled Request displays a summary of the Request to the time the Request was canceled.
The following summary displays about a canceled Request:
Requested By: The Requested By field displays the avatar and full name of the person who started the selected Request. Hover your cursor over a user's avatar to view that person's full name.
Child Requests: The Child Requests field displays any child Requests associated with this Request, referred to as the parent Request when a child Request exists. A child Request is one from which this Request automatically started as designed in its associated Process. All child Requests have their own statuses since each routes independently of their parent Request. Click the link for any child Request to view the Request summary for that child Request. For example, a child Request represents a Sub Process. If there are no child Requests associated with this Request, the Child Requests field does not display. The status icon displays beside each child Request. See View Your Requests for descriptions of each status icon.
Participants: The Participants field displays each Request participant's avatar in the selected Request to the time the Request was canceled. Hover your cursor over a user's avatar to view that person's full name.
Request cancellation date: The date and time the Request was canceled displays below the Participants field. 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.
Below the tabular information summarizing the Request displays that Request's history: all Request actions to that time in chronological order. The oldest Request actions display at the top of the Request history.
The following information displays about each event in the Request history:
Request participant: The Request participant who performed the action is represented by his or her avatar. Hover your cursor over a user's avatar to view that person's full name. If the system performed an action by running a Script or other automated function, that action is represented by "S" avatar.
Date and time the action occurred: To the right of the Request participant displays the date and time the Request action occurred. 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.
Description of the action: To the right of when the Request action occurred displays a description of that action. The system generates this action description.
Learn what information displays in summaries for Requests with errors.
Follow these steps to view a summary for a Request that has an error:
Ensure that you are logged on to ProcessMaker Platform.
View one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
In Progress page. See View Requests That Are In Progress.
Completed page. See View Completed Requests.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column in the Request page, click the Request number associated with the Process that you want to view. That Request's summary displays.
The Errors tab displays the description of the error for a selected Request if an error occurred. The Errors tab only displays if an error has occurred.
The Errors tab displays the following summary in tabular format about Request errors:
Error: The Error column displays the error description.
Time: The Time column displays how long ago the error occurred.
Element: The Element column displays to which element the error occurred within the Process associated with the Request.
Below the table, the history of the Request displays all Request actions to the time the error occurred. See Request History.
The Tasks tab displays the summary for all assigned Tasks to Request participants to the time the error occurred.
The Tasks tab displays the following summary in tabular format about assigned Tasks to Request participants to the time the error occurred:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each Task to be completed for the selected Request for all Request participants. If a Task is assigned to you, a hyperlink displays in the Task name.
Assigned: The Assigned column displays the username's avatar to whom the Task is assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task is due. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
If there are no assigned Tasks for the selected Request, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
The Summary tab displays the summary of information entered into the Request when a Request completes. However, because the Request is in progress, there are no Request values to display. The Summary tab displays the following message: This Request is currently in progress. This screen will be populated once the Request is completed.
Below this message, the history of the Request displays all Request actions. See Request History.
The Completed tab displays the summary of all Tasks Request participants completed to the time the Request error occurred.
The Completed tab displays the following summary in tabular format about completed Tasks Request participants completed to the time the Request error occurred:
#: The # column displays the Task ID associated with its Process. Each time that Task is assigned to a Request participant, the ID for that Task increments by one.
Task: The Task column displays the name of each completed Task in the selected Request.
Assigned: The Assigned column displays the username's avatar to whom the Task was assigned. Hover your cursor over a user's avatar to view that person's full name.
Due: The Due column displays the date the Task was due. 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.
Below the table, the history of the Request displays all Request actions. See Request History.
If the selected Request has no completed Tasks, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Requests store files associated differently depending if the File Manager package is installed. See the following sections regarding how Requests store files:
File Manager package is not installed: The Files tab displays Request files.
File Manager package is installed: The File Manager tab displays Request files.
When the File Manager package is not installed, the Files tab displays the summary of all files associated with the Request to that time. The Files tab only displays in that Request summary if one of the following occurs:
At least one file has been uploaded to that Request.
A PDF Generator connector in that Request has automatically generated a PDF of a Display-type Screen. Note that to use the PDF Generator connector, the PDF Generator package must be installed.
The Files tab displays the following summary in tabular format about the files associated with the Request:
File Name: The File Name column displays the name of each file associated with the selected Request. Click the file name to download it to your local computer or network location.
MIME Type: The MIME Type column displays the MIME type for the associated file.
Created At: The Created At column displays the date the file became associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Below the table, the history of the Request displays all Request actions to the time the Request error occurred. See Request History.
When the File Manager package is installed, the File Manager tab displays all files associated with the Request to that time.
The File Manager tab displays the following summary in tabular format about the files associated with the Request:
Name: The Name column displays the name of each file associated with the selected Request. Beside each file's name is its MIME type.
Users: The Users column displays the avatar for the Request participant that uploaded each file associated with the selected Request. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. Hover your cursor over a user's avatar to view that person's full name.
Size: The Size column displays the size of each file associated with the selected Request.
Modified: The Modified column displays the date that was modified. The file became associated with the Request when the person who attached it submitted the Screen to which the file was uploaded. 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.
Follow these steps to share a file with one or more users:
In the Share screen, enter with which user(s) to share this file.
Click Save. The following message displays: Shared users successfully updated.. The user(s) with which the file is shared receives a notification of the shared file.
Files that have been shared with you are in File Manager's Shared With Me folder.
Below the table, the history of the Request displays all Request actions. See Request History.
The Forms tab displays the Screen associated with each Task that each Request participant submitted in the time the Request error occurred. For example, if a Request participant entered information into a Screen, all Request participants can view the Request data that the Task assignee entered.
The Forms tab displays the following summary in tabular format about submitted Screens by Request participants to that time in the Request:
Screen: The Screen column displays the name of each submitted Screen in the selected Request.
Description: The Description column displays the description of each Screen.
Below the table, the history of the Request displays all Request actions. See Request History.
Each Request that has an error displays a summary of the Request to the time of the error.
The following summary displays about a Request in which an error occurred:
Requested By: The Requested By field displays the avatar and full name of the person who started the selected Request. Hover your cursor over a user's avatar to view that person's full name.
Participants: The Participants displays each Request participant's avatar in the selected Request to the time of the error. Hover your cursor over a user's avatar to view that person's full name.
Request error date: The date and time in which the Request error occurred displays below the Participants field. 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.
Follow these steps to manually complete a Request with an error:
Click Confirm. The status for the selected Request changes from Error to Complete.
A user may attempt to resume a Request that has an error in the following circumstances:
The Request that has an error is not a child Request to a parent Request.
That Request is in an ERROR state.
The error in the Request is caused by one or more Script Tasks which is in an ACTIVE, ERROR, or FAILING state.
The Request does not have any other Tasks that are in ACTIVE, ERROR, or FAILING states.
If a Request with an error does not meet these conditions, the button to retry that Request is not available.
Retrying the Request only attempts to retry the affected Script Task(s) which are in an ACTIVE, ERROR, or FAILING state. If the error for a Request under these circumstances is resolved when retrying that Request, the Request resumes. Its status becomes in-progress. Workflow routes that were in progress prior to the error resume.
If the error for that Request is not resolved, the Request immediately errors again.
Follow these steps to retry a Request that has an error:
Click Confirm. ProcessMaker Platform tries to resume that Request.
Below the tabular information summarizing the Request displays that Request's history: all Request actions to that time in chronological order. The oldest Request actions display at the top of the Request history.
The following information displays about each event in the Request history:
Request participant: The Request participant who performed the action is represented by his or her avatar. Hover your cursor over a user's avatar to view that person's full name. If the system performed an action by running a Script or other automated function, that action is represented by "S" avatar.
Date and time the action occurred: To the right of the Request participant displays the date and time the Request action occurred. 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.
Description of the action: To the right of when the Request action occurred displays a description of that action. The system generates this action description.
Begin an instance of a Process by starting a Request of that Process.
Click +Request from the top options bar. This button is always available.
Do one of the following:
Click the Start button to start a Request for the selected Process. A Request is one occurrence of a Process.
From the Search field, enter text to filter the list of Processes, and then click the Start button to start a Request for the selected Process.
A Request starts for the Process you selected.
The New Request screen displays active Processes only. Processes that are of either disabled or archived status do not display in the New Request screen because Requests cannot start for these statuses. If a Process is not visible in this screen, ensure the following:
You may copy the hyperlink that starts a Request from its Start button. To copy a Request's hyperlink, right-click on that Request's Start button, and then use your Web browser's function to copy a hyperlink.
If there are no active Processes or you are not authorized to start a Request for a Process, the following message displays: Please visit the Processes page and click on +Process to get started.
View in-progress Requests in which you are participating.
The In Progress page displays in-progress Requests in which you are participating. You are a Request participant because you started that Request or have been assigned a Task in that Request. Request information displays in tabular format.
Follow these steps to view in-progress Requests in which you are participating:
Do one of the following:
Click the Requests option from the top menu if the Requests page is not currently displayed. The My Requests page displays.
The In Progress page displays the following information in tabular format about in-progress Requests:
#: The # column displays the Request number associated with the Process. This number represents the sequential occurrence of that Process.
Status: The Status column displays the In Progress status for all Requests in this view.
Participants: The Participants column displays each Request participant's avatar. Avatars in this column do not indicate the chronological order in which those users participated in that Request. Hover your cursor over a user's avatar to view that person's full name.
Completed: The Completed column displays the date and time the Request was completed. Since Requests in this tab are in-progress, this column is empty.
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Use Request data to search for Requests on this page based on the following criteria:
Process: Search using one or more Process names associated with a Request.
Status: Search using one or more of the following Request statuses:
In progress: Include Requests that are in progress as part of your search criteria. Requests that are in progress are included by default when searching for Requests on this page.
Completed: Include Requests that are completed as part of your search criteria.
Error: Include Requests that are in error as part of your search criteria.
Canceled: Include Requests that have been canceled as part of your search criteria.
Requester: Search using one or more users who started a Request.
Participants: Search using one or more users participating in a Request.
If the Saved Searches package is not installed, the Save Search button is not available.
If there are no Requests in this tab, the following message displays: No Results.
View the status of Requests you've started.
The My Requests page displays all Requests you started. Request information displays in tabular format.
Follow these steps to view the Requests that you started:
Do one of the following:
Click the Requests option from the top menu if the Requests page is not currently displayed. The My Requests page displays.
The My Requests page displays the following information in tabular format about Requests you started:
#: The # column displays the Request number associated with the Process. This number represents the sequential occurrence of that Process.
Status: The Status column displays the status of the Request. The following are possible statuses:
Participants: The Participants column displays each Request participant's avatar. Avatars in this column do not indicate the chronological order in which those users participated in that Request. Hover your cursor over a user's avatar to view that person's full name.
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Use Request data to search for Requests on this page based on the following criteria:
Process: Search using one or more Process names associated with a Request.
Status: Search using one or more of the following Request statuses:
In progress: Include Requests that are in progress as part of your search criteria.
Completed: Include Requests that are completed as part of your search criteria.
Error: Include Requests that are in error as part of your search criteria.
Canceled: Include Requests that have been canceled as part of your search criteria.
Requester: Search using one or more users who started a Request. The currently logged on user is included by default when searching for Requests on this page.
Participants: Search using one or more users participating in a Request.
If the Saved Searches package is not installed, the Save Search button is not available.
If there are no Requests in this tab, the following message displays: No Results.
Click the Open Request iconfor a Request. That Request's summary displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Click the View iconfor the Request associated with the file to view its summary.
Click the Download iconfor the file to download to your local computer.
Click the Share iconfor the file to share. The Share screen displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
To view a Screen and the Request data submitted by a Request participant, click the Details icon. The submitted Screen displays.
Click the Details iconagain to hide the displayed Screen and its Request data.
To print a Screen and its Request data, click the Print icon. A print preview displays in a new browser window from which you can select an accessible printer.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Parent Request: The Parent Request field displays the parent Request associated with this Request, referred to as the child Request when a parent Request exists. The parent Request is one that automatically started this Request as designed in its associated Process. The parent Request has its own status since it routes independently of its child Request(s). Click the link for the parent Request to view the Request summary for that Request. For example, a parent Request represents the main Process that started a Sub Process Request. If there is no parent Request associated with this Request, the Parent Request field does not display. The status icon displays beside the parent Request. See View Your Requests for descriptions of each status icon. Below is an example of a parent Request in a Request summary.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history. See Request Comments.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Click the Open Request iconfor the Request you want to view its comments.
Browse the Request history. Request comments display in the Request history in chronological order. The comment icondistinguishes comments from actions in the Request history. The comment icon displays for each posted comment except those posted as replies to a comment. If the Process associated with this Request provides additional commenting functionality, you may do the following while viewing a Request comment:
Add a reaction to a Request comment: Click theicon to add an emoticon reaction to a selected comment or reply. See Add a Reaction to a Request Comment.
Add a vote to a Request comment: Click either theandicon below a selected comment to vote favorably or unfavorably to that comment, respectively. See Add a Vote to a Request Comment.
Click the reaction iconbelow the posted comment to add an emoticon reaction. Available emoticon icons display.
Click theicon below the comment to vote favorably for it.
Click theicon below the comment to vote unfavorably for it.
Reply to an existing Request comment: Browse through that Request's history to locate the existing comment to which to reply, and then click the Reply button at the bottom of that Request comment. The Write tab displays below that Request comment.
Add an image: Click the Image button from the commenting editor toolbar. A screen displays to enter the absolute URL to the image to display in the comment. In the Please enter image url setting, enter the image's absolute URL, and then click OK.
Add a hyperlink: Select the text in the commenting editor to display as a hyperlink, and then click the Link button from the commenting editor toolbar. A screen displays to enter the hyperlink available from the selected text. In the Please enter link setting, enter the hyperlink available from the selected text, and then click OK.
Click the Edit Comment iconon the top right of the posted comment. The commenting editor displays with the posted comment contents.
Click the Remove Comment iconon the top right of the posted comment. The Caution screen displays to confirm the deletion of the Request comment.
Click the Open Request iconfor a Request. That Request's summary displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Click the View iconfor the Request associated with the file to view its summary.
Click the Download iconfor the file to download to your local computer.
Click the Share iconfor the file to share. The Share screen displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
To view a Screen and the Request data submitted by a Request participant, click the Details icon. The submitted Screen displays.
Click the Details iconagain to hide the displayed Screen and its Request data.
To print a Screen and its Request data, click the Print icon. A print preview displays in a new browser window from which you can select an accessible printer.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Parent Request: The Parent Request field displays the parent Request associated with this Request, referred to as the child Request when a parent Request exists. The parent Request is one that automatically started this Request as designed in its associated Process. The parent Request has its own status since it routes independently of its child Request(s). Click the link for the parent Request to view the Request summary for that Request. For example, a parent Request represents the main Process that started a Sub Process request. If there is no parent Request associated with this Request, the Parent Request field does not display. The status icon displays beside the parent Request. See View Your Requests for descriptions of each status icon. Below is an example of a parent Request in a Request summary.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history. See Request Comments.
Click the Open Request iconfor a Request. That Request's summary displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Click the View iconfor the Request associated with the file to view its summary.
Click the Download iconfor the file to download to your local computer.
Click the Share iconfor the file to share. The Share screen displays.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
To view a Screen and the Request data submitted by a Request participant, click the Details icon. The submitted Screen displays.
Click the Details iconagain to hide the displayed Screen and its Request data.
To print a Screen and its Request data, click the Print icon. A print preview displays in a new browser window from which you can select an accessible printer.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history.
Child Requests: The Child Requests field displays any child Requests associated with this Request, referred to as the parent Request when a child Request exists. A child Request is one from which this Request automatically started as designed in its associated Process. All child Requests have their own statuses since each routes independently of their parent Request. Click the link for any child Request to view the Request summary for that child Request. For example, a child Request represents a Sub Process. If there are no child Requests associated with this Request, the Child Requests field does not display. The status icon displays beside each child Request. See View Your Requests for descriptions of each status icon. Below is an example of a Child Request in a Request summary.
Parent Request: The Parent Request field displays the parent Request associated with this Request, referred to as the child Request when a parent Request exists. The parent Request is one that automatically started this Request as designed in its associated Process. The parent Request has its own status since it routes independently of its child Request(s). Click the link for the parent Request to view the Request summary for that Request. For example, a parent Request represents the main Process that started a Sub Process request. If there is no parent Request associated with this Request, the Parent Request field does not display. The status icon displays beside the parent Request. See View Your Requests for descriptions of each status icon. Below is an example of a parent Request in a Request summary.
Click Complete. A message displays to confirm you want to cancel the Request.
Locate the Retry Request field.
Click Retry. The Caution screen displays to confirm retrying the Request that is in an ERROR state.
Depending on if the Comments package is installed and commenting functions are allowed in that Process's Requests, comments that Request participants posted to that Request display in chronological order within that Request's history. The comment icondistinguishes comments from actions in the Request history. See Request Comments.
Follow these steps to start a :
Ensure that you are to ProcessMaker Platform.
The New Request screen displays. This screen displays for which you are authorized to start new . Below is the New Request screen with Processes from which a Request can be started. Processes can be organized into within your organization to make it easier for people in your organization to locate from which Process to start a Request. For example, Processes for Finance, Human Resources, and Purchasing departments can be organized into their own Categories.
The logged on user attempting to start a Request for this Process is configured to do so from a element in that Process. are required in a user account to edit a Process.
Ensure that the Status setting in the is set to Active.
After the Request starts, that Request displays in the .
The following video demonstrates how to start a Request using the.
Ensure that you are to ProcessMaker Platform.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Click the In Progress tab or click the In Progress iconfrom the left sidebar. The In Progress page displays.
Below is an example of the In Progress page that displays in-progress Requests. The is not installed in this example.
Name: The Name column displays the Process name associated with the Request. Click the Process name to .
Started: The Started column displays the date and time you made the Request. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
To , do one of the following:
Click the Open Request iconfor the Request to view its summary.
You can do and searches for Requests.
If the is installed, you may save search parameters and share them with other and by clicking the Save Search button. See .
, including how to sort columns or how many items display per page.
Ensure that you are to ProcessMaker Platform.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Below is an example of the My Requests page that displays Requests the logged on user has started. The is not installed in this example.
Name: The Name column displays the Process name associated with the Request. Click the Process name to .
In Progress: The Request is in-progress and is represented by theicon.
Completed: The Request is completed and is represented by theicon.
Canceled: The Request has been canceled and is represented by theicon. See .
Error: An error occurred with the Request and is represented by theicon. to see the error.
Started: The Started column displays the date and time you started the Request. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
Completed: The Completed column displays the date and time the Request was completed. If the Request is not completed, this field displays no value for that Request. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your Time zone setting is specified.
To , do one of the following:
Click the Open Request iconfor the Request to view its summary.
You can do and searches for Requests.
If the is installed, you may save search parameters and share them with other and by clicking the Save Search button. See .
, including how to sort columns or how many items display per page.
View completed Requests in which you participated.
The Completed page displays completed Requests in which you participated. You were a Request participant because you started that Request or were assigned a Task in that Request. Request information displays in tabular format.
Follow these steps to view completed Requests in which you participated:
Ensure that you are logged on to ProcessMaker Platform.
Do one of the following:
Click the Requests option from the top menu if it is not currently displayed. The My Requests page displays.
Below is an example of the Completed page that displays completed Requests. The Saved Search package is not installed in this example.
The Completed page displays the following information in tabular format about completed Requests:
#: The # column displays the Request number associated with the Process. This number represents the sequential occurrence of that Process.
Name: The Name column displays the Process name associated with the Request. Click the Process name to view the Request summary.
Status: The Status column displays the Completed status for all Requests in this view.
Participants: The Participants column displays each Request participant's avatar. Avatars in this column do not indicate the chronological order in which those users participated in that Request. Hover your cursor over a user's avatar to view that person's full name.
Started: The Started column displays the date and time you made the Request. 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.
Completed: The Completed column displays the date and time the Request was completed. 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.
To view a Request summary, do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Use Request data to search for Requests on this page based on the following criteria:
Process: Search using one or more Process names associated with a Request.
Status: Search using one or more of the following Request statuses:
In progress: Include Requests that are in progress as part of your search criteria.
Completed: Include Requests that are completed as part of your search criteria. Requests that are completed are included by default when searching for Requests on this page.
Error: Include Requests that are in error as part of your search criteria.
Canceled: Include Requests that have been canceled as part of your search criteria.
Requester: Search using one or more users who started a Request.
Participants: Search using one or more users participating in a Request.
You can do basic and advanced searches for Requests.
If the Saved Searches package is not installed, the Save Search button is not available.
If there are no Requests in this tab, the following message displays: No Results.
Control how tabular information displays, including how to sort columns or how many items display per page.
Cancel a Request if you are granted to do so.
You can cancel a Request in the following circumstances:
The Process associated with a Request is configured to allow you or the group of which you are a member to cancel Requests for that Process.
Any Administrator can cancel a Request associated with any active Process.
If a Process is not configured to allow you to cancel Requests, then the Cancel button to cancel Requests does not display in Request summaries associated with that Process.
Follow these steps to cancel a Request:
Ensure that you are logged on to ProcessMaker Platform.
Do one of the following:
Click the Requests option from the top menu if it is not currently displayed. The My Requests page displays.
View one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
In Progress page. See View Requests That Are In Progress.
Completed page. See View Completed Requests.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Information about the Request displays that includes the Cancel button. Note that if the Request associated with the Process is not configured to allow your user account or group to cancel Requests, then the Cancel Request section and Cancel button does not display.
Click Cancel. A message displays to confirm you want to cancel the Request.
Click Confirm. The Request is canceled.
Canceled Requests display in the All Requests page. Note that your user account must have the Requests: View All Requests permission to view the All Requests tab.
Search for any Request in which you started or have been a participant.
Do basic or advanced searches for Requests. To do basic or advanced searches for Requests, view one of the following Requests pages:
My Requests page. See View Your Requests That You Started.
In Progress page. See View Requests That Are In Progress.
Completed page. See View Completed Requests.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
Use ProcessMaker Query Language (PMQL) for the most accurate means by which to locate specific Requests.
Use ProcessMaker Query Language (PMQL) for the most accurate means by which to locate specific Requests.
Follow these steps to do a basic search for a Request:
View one of the Requests pages described in the Overview of this topic.
Ensure that the basic search settings are displaying on the Requests page you are viewing.
Use Request data to search for Requests based on the following criteria:
Search using one or more of the following Request statuses:
In progress: Include Requests that are in progress as part of your search criteria. Requests that are in progress are included by default when searching for Requests on the In Progress page.
Completed: Include Requests that are completed as part of your search criteria. Requests that are completed are included by default when searching for Requests on the Completed page.
Error: Include Requests that are in error as part of your search criteria.
Canceled: Include Requests that have been canceled as part of your search criteria.
To view a Request summary, do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
See Saved Searches.
If there are no search results, the following message displays: No Data Available.
Use ProcessMaker Query Language (PMQL) to compose an advanced search for Requests.
Follow these guidelines to do an advanced search for a Request using PMQL:
View one of the Requests pages described in the Overview of this topic.
Ensure that the advanced search setting is displaying on the Requests page you are viewing.
In the PMQL setting, enter your PMQL parameters that compose your advanced search. See Request
Data Type PMQL Properties.
To view a Request summary, do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
See Save and Share Request- and Task-Related Searches.
If there are no search results, the following message displays: No Data Available.
View all Requests in your organization.
The All Requests page displays all Requests in your organization regardless of whether you participated in them. Request information displays in tabular format.
Your user account or group membership must have the "Requests: View All Requests" permission to view the list of all Requests unless your user account has the Make this user a Super Admin setting selected.
See the Request permissions or ask your Administrator for assistance.
Follow these steps to view all Requests in your organization:
Ensure that you are logged on to ProcessMaker Platform.
Do one of the following:
Click the Requests option from the top menu if it is not currently displayed. The My Requests page displays.
Below is an example of the All Requests page that displays all Requests. The Saved Search package is not installed in this example.
The All Requests page displays the following information in tabular format about all Requests:
#: The # column displays the Request number associated with the Process. This number represents the sequential occurrence of that Process.
Name: The Name column displays the Process name associated with the Request. Click the Process name to view the Request summary.
Status: The Status column displays the status of the Request. The following are possible statuses:
Participants: The Participants column displays each Request participant's avatar. Avatars in this column do not indicate the chronological order in which those users participated in that Request. Hover your cursor over a user's avatar to view that person's full name.
Started: The Started column displays the date and time you made the Request. 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.
Completed: The Completed column displays the date and time the Request was completed. If the Request is not completed, this field displays no value for that Request. 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.
To view a Request summary, do one of the following:
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
Use Request data to search for Requests on this page based on the following criteria:
Process: Search using one or more Process names associated with a Request.
Status: Search using one or more of the following Request statuses:
In progress: Include Requests that are in progress as part of your search criteria.
Completed: Include Requests that are completed as part of your search criteria.
Error: Include Requests that are in error as part of your search criteria.
Canceled: Include Requests that have been canceled as part of your search criteria.
Requester: Search using one or more users who started a Request.
Participants: Search using one or more users participating in a Request.
You can do basic and advanced searches for Requests.
If the Saved Searches package is not installed, the Save Search button is not available.
If there are no Requests in this tab, the following message displays: No Results.
Control how tabular information displays, including how to sort columns or how many items display per page.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Click the Completed tab or click the Completed iconfrom the left sidebar. The Completed page displays.
Click the Open Request iconfor the Request to view its summary.
If the Saved Searches package is installed, you may save search parameters and share them with other users and groups by clicking the Save Search button. See Create and Share a Saved Search.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Click the Open Request iconfor the Request you want to cancel.
If not, then click the Basic Search button.
Process: From the Process field, select one or more Process names associated with a Request as part of the search criteria. Type into the Process setting to filter Processes that display in that setting's drop-down menu. To remove a Process that is currently selected, click theicon for that selection or click Enter
when the drop-down is visible.
Status: From the Status setting, select one or more Request statuses as part of the search criteria. Type into the Status setting to filter statuses that display in that setting's drop-down menu. To remove a status that is currently selected, click theicon for that selection or click Enter
when the drop-down is visible.
Requester: From the Requester setting, select one or more Request starters as part of your search criteria. A Request starter is a user who starts a Request. The currently logged on user is included by default when searching for Requests on the My Requests page. Type into the Requester setting to filter Request starters that display in that setting's drop-down menu. To remove a Request starter that is currently selected, click theicon for that selection or click Enter
when the drop-down is visible.
Participants: From the Participants setting, select one or more Request participants as part of your search criteria. Type into the Participants setting to filter Request participants that display in that setting's drop-down menu. To remove a Request participant that is currently selected, click theicon for that selection or click Enter
when the drop-down is visible.
Click the Search buttonto search for Requests based on your entered criteria.
Optionally, if the Save Searches package is installed, save and share the Request search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.
Click the Open Request iconfor the Request that you want to view its summary.
Basic Request searches also use PMQL, but basic searches provide a user interface. Configure a basic search, and then click the Advanced Search buttonto see the PMQL. This may help you learn how to use PMQL.
If not, then click the Advanced Search button.
Click the Search buttonto search for Requests based on your entered criteria. If there is no search criteria in the PMQL setting when the Search button is clicked, the following message displays: Search query is empty. Please add search attributes or PMQL before saving.
Optionally, if the Save Searches package is installed, save and share the Request search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.
Click the Open Request iconfor the Request that you want to view its summary.
Click the Home breadcrumb iconif the Requests page is not currently displayed. The My Requests page displays.
Click the All Requests tab or click the All iconfrom the left sidebar. The All Requests page displays.
In Progress: The Request is in-progress and is represented by theicon.
Completed: The Request is completed and is represented by theicon.
Canceled: The Request has been canceled and is represented by theicon. See Cancel a Request.
Error: An error occurred with the Request and is represented by theicon. View the Request summary to see the error.
Click the Open Request iconfor the Request to view its summary.
If the Saved Searches package is installed, you may save search parameters and share them with other users and groups by clicking the Save Search button. See Create and Share a Saved Search.