Review, Commenting, and Approval building block assets

The Review, Commenting, and Approval building block provides services that use various assets. Understanding the assets helps you to better understand how to work with the building block. (See Managed Review & Approval Solution Accelerator Concepts and Technologies in Managed Review & Approval Solution Accelerator 9.5 Solution Guide .)

You can use the assets for tasks such as review initiation, review template creation, and review management. Use the services in processes you create in Workbench or in applications that you create using available Java and Flex APIs.

  • Review templates: XML files that specify the details for review. Each review template defines the characteristics of a review, such as the number of review stages, and other attributes such as the name, and supporting documents. You can add additional attributes that include:
    • The users in each stage

    • Whether users are mandatory or optional

    • The duration of a stage

    • Audit levels to use

    • Whether approval routing slips and review tracking sheets are required for the review.

    You define new review templates for each type of review and approval workflow you want to automate and manage. Each review template defines the attributes for a specific review type. The review template schema can be used as a basis for producing and editing review templates. (See Implementing User Stories .)

  • Search Filters: An object that contains the search filtering attributes. The object is used to search for reviews.

  • Documents for review: A file is passed to the API s using a com.idp.Document object. Review documents are uploaded to a location that supports WebDAV. The files that you can provide are dependent on the configuration of the LiveCycle server. For instance, if you have the PDF Generator service available, you can submit files formats, such as Microsoft Word or images.

  • Supporting documents: Supporting documents are not part of the content to be reviewed. These documents are attachments to a task assigned in Adobe® LiveCycle® Workspace 9. Supporting documents can include documents and URLs that provide supplemental information.

When you use the building block, the following assets are created in subsequent API calls or processes in Workbench.

  • Review Identifier (ID): A unique identifier, (also known as a review context identifier or review instance) that identifies a review.

  • Review document: A PDF document that users review or approve. For a given review, a review document contains all the documents that a review initiator specified. All review documents are converted to PDF files and merged into a single PDF document.

  • Supporting documents: Supporting documents are not part of the content to be reviewed. These documents are attachments to a task assigned in Workspace. Supporting documents can include documents and URLs that provide supplemental information.

  • Review tracking sheet: A PDF document that tracks the users and decisions of users involved in the review stage.

  • Approval routing slip: A PDF document that tracks the approvals or digital signatures of users that approved the review.

  • Search results: An XML document that specifies the results of a search for review templates or reviews. (See Search result schema .)

  • Audit logs: Database entries that can be queried to determine the events that occurred during a review. (See Review, Commenting, and Approval database .)

// Ethnio survey code removed