Understanding how to create the review template

To define review template properties, you configure elements in the XML file that is based on the schema defined in the ReviewContext-schema.xsd file. The ReviewContext-schema.xsd file is located in ReviewCommentingAndApproval application. (See Schema files under ReviewCommentingAndApproval/resources/schemas .).

It is recommended that you create a review template with all the required XML elements specified in the review template schema. A sample review template is available for you to use as a starting point. (See Sample review template .)

After you complete the creation of your review template, save it by invoking building block services. For example, you can create a custom process in Workbench that invokes the Store Review Template operation to save the review template. Alternatively, you can build applications that use Java APIs or Flex APIs to save the review template.

The following is a summary of the steps to create a review template:

1. Using a text editor, XML editor or tool, author the review template using the ReviewContext-schema.xsd.

2. Define the name and description of the review stages. (See Defining properties to identify a review template .)

3. Define whether stages execute after another stage completes and whether participants see comments from other stages. (See Configuring straight-through processing for stages and Setting comment visibility .)

4. Define the stages for the review and for each stage define the following characteristics of the stage:

   • Configure how each stage executes and whether the stage is a review or approval stage. (See Adding review and approval stages .)

   • Define length of time to complete the stage, such as five days. (See Setting schedules for stages .)

   • (Optional) Add reminders for the stage. (See Adding reminders to stages .)

   • (Optional) Add default participants, such as reviewers that are always part of a review stage. (See Adding default participants .)

5. (Optional) Add supporting documents to the review template. (See Configuring audits .)

6. (Optional) Add auditing to the review template. (See Configuring audits .)

7. Save the XML file and store the template to the Content Services using one of the following mechanisms:

   • Invoke a service created as a process in Workbench that has the Store Review Template operation (Review Commenting & Approval Core service).

   • Use the ReviewCommentingAndApprovalService.storeReviewTemplate method from the building block Flex API.

   • Use the ReviewCommentingAndApprovalServiceClient.storeReviewTemplate method from the building block Java API.