Product-Documentation

Functionality

Workflow

Document Creation

A document is created based on a Ziflow-configured product in Storefront.

User Checkout

When the user proceeds to checkout, the system verifies their “UserProfileEmailAddress” field. If empty, the workflow is aborted, and an error message is displayed.

Basket Review

• Before completing the checkout process, all items in the basket are reviewed to identify any Ziflow-configured products. If a Ziflow item is present with other items or there are multiple Ziflow items in the basket, the checkout process is aborted, and an error message is shown.
• The checkout is processed using following logic:
  • If there are mixed Ziflow and non-Ziflow items, all Ziflow items are set to on hold and user is navigated to the basket. The user then can continue with the ordering process.
  • If there are multiple Ziflow items in the basket, only the latest one is kept in basket, while other items are set to on hold and user is navigated to the basket. The user then can continue with the ordering process.
• The error message text is retrieved from a strings file and inherits existing error styles.

Single Ziflow Item Checkout

If there is only one Ziflow item in the basket, and the user’s email address is set, the checkout process proceeds.

Order Placement

When an order is placed in Storefront, the integration checks for the existence of any approval workflows for a specific reviewer (a dedicated Storefront user account used solely for the Ziflow integration).

Proof Preparation

If an approval workflow is found, the integration prepares the rendered proof for submission to Ziflow by generating the proof for the document and copying the proof to the output folder. If the Storefront proof is not found, the Ziflow workflow is aborted.

Ziflow Workflow Creation

A product metadata field specifies the Ziflow workflow template to use. The integration creates a Ziflow workflow for the selected template using the Ziflow API. The Storefront document’s rendered proof and internal document ID are sent to Ziflow.

Document Approval Process

The Storefront document remains in the approvals queue until the Ziflow approval process is completed.

Ziflow Approval Result

When the Ziflow approval is processed, the integration receives the approval result through the Ziflow API callback. It searches for the corresponding Storefront document based on the returned pass-through value and evaluates the document’s approval status in Ziflow.

Pending Approval Status

The Storefront document stays pending approval until all decision maker approvers respond in Ziflow. This ensures that comments from all approvers can be returned to the user.

Document Status Update

Once all decision maker approvers finish reviewing the document in Ziflow, the integration updates the document status in Storefront based on the approval result.

Approval and Rejection Actions

• If the item in Ziflow is approved, the user can approve or decline the document on the Orders page, allowing Storefront to proceed with the standard ordering workflow.
• If the item in Ziflow requires changes, the Storefront document is rejected. The user can then reorder the document from the Orders page, and the re-ordered document will be associated with the existing Ziflow workflow to maintain continuity in the Ziflow ordering process. Subsequent versions of the proof will be available in Ziflow, while the reorder button will be hidden for the order/item.
• Ziflow comments are retrieved once the workflow is complete and saved with the Storefront document for review on the Orders page and in email notifications.

User Site

The overall progress of Ziflow items can be reviewed on the Orders page.

When debug logging is enabled, additional columns are rendered on the Orders page with Storefront and Ziflow statuses for each document.

The Storefront/Ziflow actions are accessed using the “Review” link to the Order Details page.

Depending on the Storefront and Ziflow statuses, there are up to three actions availabe on top of the page:

• Decline in Storefront for items “Pending” or “Approved” in Ziflow.
• Approve in Storefront for items “Approved” in Ziflow.
• Reorder for items with “Changes Required” in Ziflow.