User story for managing reviews using a custom implementation

Narrative

When the functionality provided in the solution template does not satisfy your requirements, you can create a custom implementation. The following are common reasons for you to create a custom implementation to manage reviews:

  • You have backend processes that simplify the user experience to manage reviews for users.

  • You have requirements to create your own user interface to manage reviews.

  • You want to use an existing application or portal to manage reviews.

Estimated time to implement

To implement this story, expect to spend 3-5 days. The time depends on the management tasks that you allow users to and the user interface you provide. For example, if you do not permit users to end or extend stage duration, there is no requirement to spend time implementing the functionality. The time estimates include:

  • Developing processes in Workbench or writing code to provide the review management tasks.

Additional time to create a user interface is not part of the estimate. Consider reusing portions of the GlobalCorp solution template where applicable.

Note: The time to implement the story depends on the skill sets of your staff and how well you know your requirements. The estimates are broad guidelines and differ for each organization.

Implementation overview

You can create a custom implementation to manage a review by completing the following tasks:

  1. Manage the review time schedule

    In Workbench, use the review context ID and invoke operations from the Review Commenting & Approval Core service to manage the review time. The following tasks are permitted:

    • Extend or shorten the time frame before a stage expires using Update Stage Duration operation.

    • You can end a stage to force the next stage in the review to start.

    • Revoke or end the entire review.

    Alternatively, you can use methods from the Review, Commenting, and Approval building block Java API or Flex API to provide the same functions. (See Extending the stage duration and Revoking a review in Review, Commenting, and Approval Building Block 9.5 Technical Guide .)

  2. Add review participants.

    You can add additional reviewers and approvers to the review. In some limited instances, you can remove reviewers from the review. The limitation is a recommendation but is not enforced from a technical perspective. (See Adding and removing participants from the review in Review, Commenting, and Approval Building Block 9.5 Technical Guide .)

  3. Handling comments and revising the review.

    During the review, review initiators and moderators can see comments applied to the review document. To revise a review, you require the review context ID and an updated revision of the review document. (See Viewing reviewed documents and supporting documents and Creating a new revision of the review and updating content in Review, Commenting, and Approval Building Block 9.5 Technical Guide .)

  4. Searching for reviews.

    To search for reviews, you provide search criteria using a search template. You can pass the search criteria in a process in Workbench or programmatically use the building block Java API or Flex API calls to implement the functionality. (See Searching for reviews in Review, Commenting, and Approval Building Block 9.5 Technical Guide .)

Tools used

  • Workbench to build processes to provide functions to manage reviews.

  • Integrated development tools, such as Adobe Flash Builder to write user interfaces using Flex. You can also use other development environment, such as Eclipse to create your applications in Java or Microsoft Visual Studio to implement .NET applications.

Team members and skill sets

  • Building processes using Workbench and Designer. (LiveCycle Developer)

  • Flex, Java, web services to build user applications to initiate reviews. (LiveCycle Developer, LiveCycle Programmer)

// Ethnio survey code removed