Add the Inspire Create Review action

To automate the process of creating a review in a Topic workflow, you can add an Action that tells Inspire to open a new Create Review screen automatically and populate any known details so that the workflow user can quickly create the review and advance the workflow to the next stage (such as Reviewing). After you add this Action, you must select it in a Transition so that the functionality is triggered in a workflow that uses this template.

Required permissions

You must have permission to the Projects Module to work with projects and workflows. Other than that, you do not need special permissions to create, edit, or delete workflow templates.

However, keep in mind that administrators and other users can set permissions on components and folders.

  • You must have permission to edit the workflow template component.
  • You must have folder permissions where the template is stored.
  • For details on how to check and set permissions, refer to: Set permissions

For a complete list of permissions, including starting a workflow from a template, read: Workflow permissions.

Tips and tricks

  • This automated Action is only available in a topic workflow template (not a sequential reviewer template), or a completely new workflow template component.
  • You can create an entirely new workflow template component that has no default Activities and Transitions.
    • Use the Topic workflow template explained in this topic as an example of what you can create.
    • To create a new template, follow the steps in: Create a workflow template component.
  • This automated Action is helpful because the writer who is developing content can easily create the review without having to leave the Project's Workflow panel (or the Dashboard).
    • When a user advances a project workflow task and the Transition has an Action of InspireCreateReview, Inspire opens the Create Review screen for the current user.
    • Inspire uses the Activity workflow details to populate the following information: Title, Coordinator, Approver, Due Date, Components, and Reviewers.
    • The user can add, edit, or simply verify these details and click Create.
    • Inspire then creates a review and advances the workflow to the next task (usually this is called Reviewing).
    • When creating a review assignment for a project workflow, Inspire automatically includes the component attachments in the review.
    • When the user marks the review as Completed, Inspire changes the project assignment to Completed.

      Currently, completing or cancelling a review does not automatically advance workflow.

  • After you add this new Action to the provided template or a custom template you've created, you can use it in a workflow transition.

  • If you don't want to use this automated Action then the user must manually open the Reviews module, click Create, and add all review details.

For more details on the complete automation process shown in this diagram, read: Automate Reviews in a template.

To add the InspireCreateReview Action:

  1. Click Components.
  2. In the Folders pane, select Workflows.

    You can save a workflow template to another folder. If you did this, open that folder instead of the Workflows folder.

  3. In the Components pane, select a workflow.

    The InspireCreateReview action is only available in Topic workflows or a completely new workflow template component.

  4. In the workflow editor toolbar, click Actions.
  5. On the Action Management screen, click Create.

  6. On the Create Action screen, in Name, enter the following string of characters exactly: InspireCreateReview.

    Important notes:

    • Do not use any spaces
    • Make sure to use capital letters for Inspire, Create, and Review
    • If the string is not entered exactly as shown, Inspire will not be called to open the Create Review screen
  7. In Description, do one of the following:
    • Leave it empty
    • Enter the following text: System action that will open the review UI so a user can create a review.
    • Enter your own text
  8. To save your changes on the Create Action screen, click Create.
    Results:
    • You can see your new action on the Action Management screen.
  9. To save the list of actions, on the Action Management screen, click Save.

    To automate the creation of a review, your next step is to Add a Create Review Activity.