Summary

View a Request's summary.

Overview

Each Request displays a summary of that Request to that time.

Follow these steps to view a Request summary:

1. Ensure that you are logged on to ProcessMaker Platform.

2. View one of the following Requests pages:

   • My Requests, In Progress, or All Requests page if the request status is In Progress.

   • My Requests, Completed, or All Requests page if the request status is Completed.

   • My Requests, or All Requests page if the request status is Canceled.

   • My Requests, In Progress, Completed, or All Requests page if the request status is Error.

3. 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.

   • Click the Open Request iconfor a Request. That Request's summary displays.
4. On the right side, locate a box block titled with the Request status.

Summary

The summary displays according to the Request status type.

• Canceled request summary

• Completed request summary

• In-Progress request summary

• Request summary with errors

Canceled Request Summary

The following summary displays about a canceled Request:

Request participant summary for 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.

• 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.
• 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.

Completed Request Summary

The following summary displays about a completed Request:

Request participant summary for 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.

• 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.
• 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.

In-Progress Request Summary

The following summary displays about an in-progress Request:

Request participant summary for 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.

• 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.
• 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.

Request Summary With Errors

The following summary displays about a Request in which an error occurred:

Request participant summary for a Request with errors

• 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. 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.
• 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.

A Request summary with errors has the following actions:

• Manually complete a Request with an error

• Rollback a Request that has an error

• Retry a Request that has a Script or Data Connector error

Manually Complete a Request with an Error

Follow these steps to manually complete a Request with an error:

1. Locate the Complete field.
2. Click Complete. A message displays to confirm you want to complete the Request.
3. Click Confirm. The status for the selected Request changes from Error to Complete.

Rollback a Request that Has an Error

A user may rollback to return to a previously completed Task when an error has occurred in that Request. The Process Manager receives both an in-application and email notification that the Request is in-error. Rolling the Request back places its status as in-progress instead of in error so that the Process Manager may properly route that Request.

A Request may be rolled back in the following circumstances:

• That user attempting to rollback that Request is a Process Manager.

• The Script Task or Data Connector object that has an error is preceded by a Form Task element during that Request's workflow routing.

• The Script Task or Data Connector object that has an error has a subsequent Form Task element.

• That Request is in an ERROR state.

If a Request with an error does not meet these conditions, the button to rollback that Request is not available.

Follow these steps to rollback a Request that has an error:

1. Locate the Rollback Request field.
2. Click Rollback. The Caution screen displays to confirm rollbacking the Request that is in an ERROR state.
3. Click Confirm. ProcessMaker Platform rolls back to the previously completed Task.

4. Fix the error in the affecting Script Task or Data Connector object.

5. Continue that Request's workflow as normal.

Retry a Request That Has an Error

A user may attempt to resume a Request that has a Script Task failed in the following circumstances:

• That user attempting to retry that Request must have the Make this user a Super Admin option enabled on that user account.

• 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:

1. Locate the Retry Request field.
2. Click Retry. The Caution screen displays to confirm retrying the Request that is in an ERROR state.
3. Click Confirm. ProcessMaker Platform tries to resume that Request.