Automate completeness reporting in a workflow template
In an Inspire workflow template, you can design the process you use to develop content and provide deliverables to your customers. This process can include running a completeness report before you publish a component or send it for translation, so that you can see if there are any errors or problems. In a workflow template, you can include an action that tells Inspire to open the Check component completeness screen. This allows a Workgroup user to quickly generate a report and advance the workflow.
Required permissions
You must have permission to the Projects Module to work with projects and workflows.
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
- Learn more about Inspire's topic workflow template in: Understand the topic workflow.
- 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.
- An Action is unique to the template it's included in. If you want to use the new or updated Action in a different template, you have to re-create it in that specific template.
- In an active workflow, the InspireCompletenessReport action tells Inspire to check how many components are included in the previous Activity (such as Approve components) and take one of the following actions:
- If there is one XML component, Inspire opens the Check component completeness screen so that you can select the items you want to see in the report.
- If there is more than one XML component, you can choose which components to run the report on first, and then select the items you want to see in the report.
- If there are no XML components, Inspire gives you an error message. The report is not created, and the workflow does not advance to the next step.
- If you don't want to use this automated action, you can manually run the report to Check component completeness.
- After you add this new Inspire Completeness Report (InspireCompletenessReport) to a template, you can use it in a workflow transition.
Before you begin
This automated Action is only available in a Topic workflow template (not a sequential reviewer template), or a completely new workflow template component.
- At least one component must be included in the active workflow for this automated action to complete successfully.
To add an InspireCompletenessReport action to a topic workflow template:
- Create a new Action for InspireCompletenessReport.
- Add an Activity to review the report.
- Create a Transition that connects the running of the report to the activity of reviewing the report.
