Setup

Attestation requires a request Flow, a work order, and an attestation Flow where approvers can accept or reject the request.

Prerequisites

Before configuring attestation, make sure that:

• the WorkOrders functionality is deployed
• the request Flow can collect the data that approvers need to review
• an attestation Flow exists with an Attestor control
• accept and reject Pipes are available for the decision outcome
• a PDF can be generated or provided for the work order

Request Flow

The request Flow collects the data for the operation. Instead of applying the final change directly, the final Step Pipe should create a work order that can be reviewed by one or more attestors.

The work order should contain enough information for the approver to understand what will happen if the request is accepted.

Typical data includes:

• who created the request
• what object or user the request concerns
• what change is being requested
• which approvers should review the request
• which accept Pipe should run if the request is approved
• which reject Pipe should run if the request is rejected

PDF content

The work order should include a PDF that describes the requested change. The PDF can be generated dynamically, for example with an HTML-to-PDF step in the request process, or provided as a static PDF when the content does not need to change.

Use the PDF to make the approval decision clear and traceable. It should contain the information the approver needs without requiring them to inspect backend data or logs.

Attestation Flow

The attestation Flow is used by the approver. It normally contains an Attestor control, which shows work orders assigned to the logged-in user and lets the user accept or reject pending requests.

{
  "id": "attestor",
  "type": "Attestor"
}

See Attestor for more information about the control.

Accepting a work order

When all required attestors have accepted the work order, the accept Pipe is executed. Data from the original request is available to the Pipe through the request object, for example request.<property>.

The accept Pipe runs in system context. Do not assume that a user session is available when it executes.

Use the accept Pipe for the action that should happen only after approval, such as creating an account, updating membership, extending validity, or sending a final notification.

Rejecting a work order

If an attestor rejects the work order, the reject Pipe is executed. Use the reject Pipe for notification, cleanup, or any follow-up that should happen when the request is not approved.

Only one rejection is enough for the work order to be rejected.

Archiving

After attestation is completed, the PDF can be sent to an external archive. This makes it possible to keep a long-term record of the request, decision, and supporting information.