Add the Inspire translation completeness report action

You can include an action to run a translation completeness report before you publish workflow components or send them for translation. The translation completeness report tells you which languages the component has been translated into, whether the translated components in the language subfolders are locked, and whether it has branches. This lets you identify any errors or issues before advancing the workflow.

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.
  • In an active workflow, the InspireTranslationCompletenessReport 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 component, Inspire opens the Translation Completeness Report screen so that you can select the languages and items you want to see in the report.
    • If there is more than one 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 components, Inspire gives you an error message. The report is not created, and the workflow does not advance to the next step.
  • The report tells you which languages the component has been translated into, whether the translated components in the language subfolders are locked, and whether it has branches.
  • If you don't want to use this automated action, you can manually run the report. Follow the steps in: Create a translation completeness report for one component or Create a translation completeness report for multiple components.
  • After you add this new Inspire Translation Completeness Report (InspireTranslationCompletenessReport) to a template, you can use it in a workflow transition.

To add the Inspire translation completeness report 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 InspireTranslationCompletenessReport 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: InspireTranslationCompletenessReport.

    Important notes:

    • Do not use any spaces
    • Make sure to use capital letters for Inspire, Translation, Completeness, and Report
    • If the string is not entered exactly as shown, Inspire will not be called to send notifications or open the Translation completeness report screen
  7. In Description, do one of the following: you can leave it empty or enter the following text:
    • Leave it empty.
    • Enter the following text: System action to create a translation completeness report for workflow components.
    • 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.
    Results:
    • Your list of Actions is saved.
    • The InspireTranslationCompletenessReport action is added to the template Actions options but is not in use until you add it to a Transition.
    • When you create or update a Transition, you can select the InspireTranslationCompletenessReport action.