Workflow Templates

Content is machine translated from English by Phrase Language AI.

Note

Due to continuous improvements, the user interface may not be exactly the same as presented in the video.

A library of common templates is available for building workflows. Click Template Library in the left-hand menu to open the library.

Templates are presented in the library with short description and can be both searched and sorted by provider.

To use a template for a workflow, follow these steps:

Click Preview for the selected template.

The preview opens with the template displayed as a workflow.
Click Import template.

The template is opened in a new workflow with pre-populated values. Values and parameters can be modified as required.

Configure Workflow Templates

To ensure optimal workflow performance, there are a series of preliminary steps to complete before configuring a workflow template. If prompted to retrieve a value during these steps, save it in a temporary notepad file for future reference when configuring the workflow.

The following examples of configuration assume the relevant template has been imported and is ready to publish.

TMS Template: Review QA flagged content

Preliminary Steps

Create a new project in TMS with the following conditions:
- The name of the project contains ORCH-TEST.
- Pre-translation uses MT.
- Pre-translation happens automatically or is manually triggered after a job is created.
Ensure there is a project template that can assign users to jobs in the created project. If not, save the newly created project as a template, and set up assignment rules in the Providers section of the template.
Open the project template by selecting it from the project template list, then copy its UID from the URL and save it in a notepad.
Open TMS in a Chrome browser and navigate to the Email templates page by selecting Settings/Administration/Email templates. Select the desired email template and press F12 to enable Chrome's Inspect mode.
Select Network from Chrome's Inspect panel and click Save in the TMS email template.

Two headers are displayed on the Inspect panel. Click the top one, copy the UID at the end of the Request URL field and save this value in a notepad.
Go to https://cloud.memsource.com/web/docs/api#operation/runQaForJobPartsV3 and expand settings in the REQUEST BODY SCHEMA.

All possible values for QA checks are displayed under warningTypes. Make note of the desired QA checks.
Create a JSON based on this example:
```
{"templateUid":"1xIwBX5Zj2TGnWpbxKCnB2", 
"emailUid":"CKJtAh2ihgW7dVqCi4B1G7", 
"QAchecks": ["NonConformingTerm","ForbiddenTerm"]}
```
- templateUID is the UID identified in step 3.
- emailUID is the UID identified in step 5.
- QAchecks uses the QA checks identified in step 6.

Using the Template

In the Orchestrator workflow editor, open the parameters of the Configuration values action. Replace the template's JSON with the JSON from preliminary step 7.
Publish the workflow.
Go back to the TMS project and import a new job.

Note

If the job is not pre-translated automatically, pre-translate it manually.

The Orchestrator workflow is triggered. After execution, the job in the first workflow step is either completed or assigned according to the project template settings.

TMS Template: Adapt for locale variants

Preliminary Steps

Create a new project in TMS with the following conditions:
- The name of the project contains ORCH-TEST.
- Target language is set to these locales: deAT, deDE, esAR, esES, esMX.
- Pre-translation does not happen automatically.
Create two translation memories (TM):
- TM1 with all the language locales: deAT, deDE, esAR, esES, esMX
- TM2 with only the main locales: DE and ES
From the Translation memories table of the project, click Select to configure both TMs as follows:
- Main locales (DE and ES)
  
  Select both TMs with WRITE mode enabled. Define priority order by setting TM1 as primary.
- Other language locales
  
  Select both TMs and enable the WRITE mode only for TM1. Define priority order by setting TM1 as primary and adding a 2% penalty to TM2.
TM configuration is displayed in the Translation memories table:

Using the Template

Open the template in the Orchestrator workflow editor and note these settings:
- The trigger is filtered for the target language code. To further customize the workflow, change the target language filters on the trigger.
- The Language inheritance action has a hard-coded JSON that defines language behavior. For customization, edit this JSON as required.
```
[
    {
        "source": "de_de",
        "target": [
            "de_at"
        ]
    },
    {
        "source": "es_es",
        "target": [
            "es_mx",
            "es_ar"
        ]
    }
]
```
- The workflow filters jobs in the different language locales based on the file name of the completed job. Therefore, this workflow is reliable only if file names are unique. For non-unique file names, a more complex workflow may be needed.
Publish the workflow.
Go back to the TMS project, and import a new job for all target languages.
Translate DE-DE or ES-ES jobs and complete them.

The Orchestrator workflow is triggered. After execution:
- Jobs in the corresponding language locales are pre-translated.
- Any segments already stored in TM1 will be 101 or 100% matches.
- Any segments with new or modified content will be 99% matches inserted from TM2.

TMS Template: QPS based segment routing

Preliminary Steps

Create a new project in TMS with the following conditions:
- The name of the project contains ORCH-TEST-QPS.
- The project has a minimum of 2 workflow steps.
- Pre-translation uses MT.
- Pre-translation happens automatically or is manually triggered after a job is created.
- Pre-translation is set to complete the job, so that the Orchestrator workflow is triggered automatically after the import.
Ensure there is a project template that can assign users to jobs in the created project. If not, save the newly created project as a template, and set up assignment rules in the Providers section of the template.
Open the project template by selecting it from the project template list, then copy its UID from the URL and save it in a notepad.
Open TMS in a Chrome browser and navigate to the Email templates page by selecting Settings/Administration/Email templates. Select the desired email template and press F12 to enable Chrome's Inspect mode.
Select Network from Chrome's Inspect panel and click Save in the TMS email template.

Two headers are displayed on the Inspect panel. Click the top one, copy the UID at the end of the Request URL field and save this value in a notepad.
Go to https://cloud.memsource.com/web/docs/api#operation/runQaForJobPartsV3 and expand settings in the REQUEST BODY SCHEMA.

All possible values for QA checks are displayed under warningTypes. Make note of the desired QA checks.
Create a JSON based on this example:
```
{"templateUid":"1xIwBX5Zj2TGnWpbxKCnB2", 
"emailUid":"CKJtAh2ihgW7dVqCi4B1G7", 
"QAchecks": ["NonConformingTerm","ForbiddenTerm"]}
```
- templateUID is the UID identified in step 3.
- emailUID is the UID identified in step 5.
- QAchecks uses the QA checks identified in step 6.

Using the Template

In the Orchestrator workflow editor, open the parameters of the Configuration values action. Replace the template's JSON with the JSON from preliminary step 7.
Publish the workflow.
Go back to the TMS project and import a new job.

Note

If the job is not pre-translated and completed automatically, pre-translate and complete it manually.

The Orchestrator workflow is triggered. After execution:
- Eligible segments are locked and confirmed.
- The job in the second workflow step has EMAILED status and is assigned according to the project template settings.

TMS Template: Asana Auto-create / Auto-complete

Use case

When a new translation project is created in Phrase, automatically create a task in Asana with the Phrase TMS project details.
Send a notification or update the task in Asana to notify the project manager when a translation project is marked as complete in Phrase TMS.

Auto-create a task

Preliminary Steps

Generate a token in Asana then securely store it as a variable in Orchestrator.

An authentication token in order to exchange data between Orchestrator and an Asana account is required.
Find the workspace UID in Asana:
1. Select the the profile icon to display the organization details in a new tab of the browser.
  
  The URL shows something like https://app.asana.com/admin/111111111111111/overview.
2. Copy the UID (111111111111111) from the URL and save it in a notepad.
Find the project UID in Asana:
1. Navigate to the desired project where tasks will be automatically created.
  
  The URL shows something like https://app.asana.com/0/2222222222222222/3333333333333333.
2. From the project URL, copy the UID (2222222222222222) , then save it in a notepad.
In Phrase TMS, configure a custom field to store an Asana Task ID.
In Settings/Project Metadata/Custom Fields, select the row that contains the Asana Task ID custom field.
Right-click on the row and select Inspect.

This will open the browser's developer console.
In the console, find the value that starts with td data-testing. Look above it for the first tr class value that looks like row-icyz98tQWPbp3ZRd3q9mg3.
Copy only the ID (e.g., icyz98tQWPbp3ZRd3q9mg3) and save it a notepad.

Using the Template

A populated custom field for asana_id is required for this workflow to execute.

In the Orchestrator workflow editor, open the parameters of the Send HTTP Request action.
1. Under the headers parameter, there is a name/value pair for Authorization. Use the Field Picker to replace the content in value with the Asana variable as defined in preliminary steps.
  
  The output format should be Bearer {{ @<variable name> }}.
In the Data parameter, replace the placeholder values with the Asana project ID and workspace ID identified in the preliminary steps.
Open the parameters for the Update TMS project with Asana details action.
- Under customFields, replace the uid with the custom field ID placeholder identified in the preliminary steps.
Publish the workflow.
In TMS, complete the project.

The Orchestrator workflow is triggered to automatically create a task in Asana.

Auto-complete a TMS project

Preliminary Steps

This template works in conjunction with the Auto-create template.

Using the Template

In the Orchestrator workflow editor, open the parameters of the Send HTTP Request action.
1. Under the headers parameter, there is a name/value pair for Authorization. Use the Field Picker to replace the content in value with the Asana variable as defined in preliminary steps.
  
  The output format should be Bearer {{ @<variable name> }}.
Publish the workflow.

Strings Template: Key level language adaptation

Description

This workflow monitors for a translation being saved and set to Reviewed state within the editor. Once a translation is set to Reviewed, the workflow automatically checks if the translation needs to be copied to any of the other locales. E.g. when the translation for French is completed and set to Reviewed, the same translation is copied into the Canadian French locale. The copied translation is set to the Unverified state. If there is a translation for the adapted locale, it is overwritten.

This workflow allows the configuration of language inheritance rules using a JSON object similar to this example:

[
    {
        "source": "de",
        "target": [
            "de-at",
            "de-ch"
        ]
    },
    {
        "source": "fr",
        "target": [
            "fr-ca",
            "fr-ch"
        ]
    }
]

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Project ID> with the project ID of the workflow.
  - The project ID can be copied from Strings by looking up the project in the project list and clicking the ID button.
4. Optionally click the + Item button and add another project ID to apply the template to more than one project. To run the workflow with all projects, remove the filter.
5. Click Save filters.
Create a .JSON file in a text editor based on the example.
- Ensure the language names are exactly the same as in the project. To check language names, view them in the the Languages tab.
Edit the parameters of the Configuration values action.
1. Open the Configuration values action.
2. From the Parameters tab, click Edit parameters.
3. Use the .JSON from step 3 for the input field.
4. Click Save parameters.
From the project, edit a translation and save it as Reviewed.

The workflow is triggered and the copied, unreviewed translations for the locales adapted from the completed language are displayed.

Strings Template: Automatic job completion

Description

This workflow monitors for a job target locale being completed. Once a job target locale is completed, the workflow automatically checks if all job target locales are completed, and if so, the whole job is completed. If some of the locales are not completed yet, the action of completing the job is skipped.

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Project ID> with the project ID of the workflow.
  - The project ID can be copied from Strings by looking up the project in the project list and clicking the ID button.
4. Optionally click the + Item button and add another project ID to apply the template to more than one project. To run the workflow with all projects, remove the filter.
5. Click Save filters.
Publish the workflow.
In the project, open and existing job or start a new one.
Mark on the job target locales as Completed.

Within a couple minutes, the execution starts.

Strings Template: Send content to GitHub

Preliminary Steps

Create a project in Strings. Make a note of the ProjectUID.
Configure a GitHub sync for this project as well as in GitHub (i.e. create and test the configuration YAML file).
Manually test content import and export from GitHub within the UI.

Using the Template

Open the template trigger in the Orchestrator workflow editor, and replace the projectID placeholder in the filter with the ProjectUID from preliminary step 1.
Create a job in the Strings project and start it.
Perform translations in the job and complete it.

The Orchestrator workflow is triggered to export the content into the GitHub repository.

Strings Template: Export to online repository upon job completion

Description

This workflow monitors for Strings job completion within Strings projects. When a job is completed, the workflow automatically looks up the repository sync ID for the project and triggers the export according to the configuration file located in the root of the repository.

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Project ID> with the project ID of the workflow.
  - The project ID can be copied from Strings by looking up the project in the project list and clicking the ID button.
4. Optionally click the + Item button and add another project ID to apply the template to more than one project. To run the workflow with all projects, remove the filter.
5. Click Save filters.
Provide the account ID.
1. Select the action bundle.
2. From the Parameters tab, click Edit parameters.
3. Replace <accountID> with the Strings organization account ID.
  - The account ID can be copied from the Account & billing tab by navigating to the clicking user settings in the top-right corner and selecting Organization from the Settings menu.
4. Click Save parameters.
Publish the workflow.

The workflow will be triggered with the next job completion.

Strings Template: Job creation after file upload

Description

After a new upload, the workflow creates a new job with target languages defined either via the use of a Job template, or by identifying the source language of the project (the default locale) and using the remainder of project languages as the job’s target locales.

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Project ID> with the project ID of the workflow.
4. Click Save filters.
Replace or remove the <Job template ID> placeholder in the Create job from list of keys or tags field.
Publish the workflow.
In the corresponding Strings project, make a new upload and ensure the Skip upload tags option is not selected.

The action will be executed within a few minutes.

Strings Template: Job level language pivoting workflow

Description

Monitors job completion for a predefined locale in a project. Once the locale is completed, the workflow checks all remaining locales in the project and creates a job with the pivot language as a source and remaining locales as the target.

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Locale name> with the name of the locale to execute the workflow for.
4. Replace <Project ID> with the project ID of the workflow.
  - The project ID can be copied from Strings by looking up the project in the project list and clicking the ID button.
5. Click Save filters.
Publish the workflow.

In the corresponding Strings project, open an existing job or start a new one. Mark one of the jobs whose locale matches the <Locale name> as Completed to trigger the workflow.

Strings Template: Populate project with jobs

Preliminary Steps

Create a project in Strings with English as source language and add other languages that will serve as target locales. Replace en in the jq field of the Filter non-EN locales action with the language code of the Strings job source locale in case a different language than en is used as the job source language

Using the Template

Create a new workflow based on the template.
Edit the workflow trigger filter.
1. Select the trigger.
2. From the Filters tab, click Edit filter.
3. Replace <Project ID> with the project ID of the workflow.
4. Click Save filters.
Publish the workflow.
In the corresponding Strings project, make a new upload and ensure the Skip upload tags option is not selected.

Strings Template: Scheduled export to online repository

Description

This workflow is triggered based on a pre-defined time schedule. When the workflow runs, it automatically looks up the repository sync IDs for the listed projects and triggers exports according to the configuration file located in the root of the repository.

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger schedule.
1. Select the trigger.
2. From the Schedule tab, click Edit schedule.
3. Select the required cadence.
4. Click Save schedule.
Provide the account ID.
1. Select the action bundle.
2. From the Parameters tab, click Edit parameters.
3. Replace <accountID> with the Strings organization account ID.
  - The account ID can be copied from the Account & billing tab by navigating to the clicking user settings in the top-right corner and selecting Organization from the Settings menu.
4. Click Save parameters.
Publish the workflow.
In the Strings project, open an existing job or start a new one and mark the job as Completed to trigger the workflow

Strings Template: Scheduled job creation

Description

This workflow runs on a schedule. The workflow automatically identifies the keys that have an unverified translation in any of the locales, creates a job from those keys and starts it. This workflow configures the project ID to monitor for new keys and the job template ID to use for job creation.

The JSON to add to this action needs to follow this syntax example:

{
"projectId":"f6dfee6466384379606b6158a410cd46", "jobTemplateId":"ea47c725dfdb894df2dea5902b1f0894"
}

Usage

To use the template, follow these steps:

Create a new workflow based on the template.
Edit the workflow trigger schedule.
1. Select the trigger.
2. From the Schedule tab, click Edit schedule.
3. Select the required cadence.
4. Click Save schedule.
Create a .JSON file in a text editor based on the example.
- The project ID can be copied from Strings by looking up the project in the project list and clicking the ID button.
- The job template ID can be copied from the URL when the job template is opened.
Edit the parameters of the Configuration values action.
1. Open the Configuration values action.
2. From the Parameters tab, click Edit parameters.
3. Use the .JSON from step 3 for the input field.
4. Click Save parameters.
Publish the workflow.

When the schedule triggers the workflow, a new job is created and started in the jobs list. If there are no unverified keys in the project, the workflow stops and a new job is not added.