Orchestrator
    1. Phrase
    2. Phrase Orchestrator
    3. Orchestrator

    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:

    1. Click Preview for the selected template.

      The preview opens with the template displayed as a workflow.

    2. 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, it is recommended to 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

    1. 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.

    2. 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.

    3. 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.

    4. 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.

    5. 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.

      network_tab.jpg

    6. 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.

    7. 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

    1. 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.

    2. Publish the workflow.

    3. 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

    1. 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.

    2. 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

    3. 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.

        tm1_primary.jpg

      • 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.

        tm2_penalty.jpg

      TM configuration is displayed in the Translation memories table:

      tm_configuration.jpg
    Using the Template

    1. 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.

    2. Publish the workflow.

    3. Go back to the TMS project, and import a new job for all target languages.

    4. 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

    1. 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.

    2. 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.

    3. 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.

    4. 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.

    5. 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.

      network_tab.jpg

    6. 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.

    7. 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

    1. 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.

    2. Publish the workflow.

    3. 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

    1. When a new translation project is created in Phrase, automatically create a task in Asana with the Phrase TMS project details.

    2. 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

    1. 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.

    2. 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.

    3. 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.

    4. In Phrase TMS, configure a custom field to store an Asana Task ID.

    5. In Settings/Project Metadata/Custom Fields, select the row that contains the Asana Task ID custom field.

    6. Right-click on the row and select Inspect.

      This will open the browser's developer console.

    7. 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.

    8. 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.

    1. 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> }}.

    2. In the Data parameter, replace the placeholder values with the Asana project ID and workspace ID identified in the preliminary steps.

    3. 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.

    4. Publish the workflow.

    5. 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

    1. 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> }}.

    2. Publish the workflow.

    Strings Template: Populate project with jobs

    Preliminary Steps

    1. Create a project in Strings with English as source language and add other languages that will serve as target locales. Make a note of the ProjectUID.

    2. Configure the GitHub sync for this project.

    3. Manually test content import and export from GitHub within the UI.

    Using the Template

    1. Edit the template in the Orchestrator workflow editor to include the ProjectUID from the newly created Strings project.

    2. Upload a new file into the project and set the language locale of the file to English.

      The Orchestrator workflow is triggered:

      • A new job is created in the monitored project.

      • Non-English language locales are added to the job.

      • The job starts.

    Strings Template: Send content to GitHub

    Preliminary Steps

    1. Create a project in Strings. Make a note of the ProjectUID.

    2. Configure a GitHub sync for this project as well as in GitHub (i.e. create and test the configuration YAML file).

    3. Manually test content import and export from GitHub within the UI.

    Using the Template

    1. Open the template trigger in the Orchestrator workflow editor, and replace the projectID placeholder in the filter with the ProjectUID from preliminary step 1.

    2. Create a job in the Strings project and start it.

    3. Perform translations in the job and complete it.

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

    Was this article helpful?

    Sorry about that! In what way was it not helpful?

    The article didn’t address my problem.
    I couldn’t understand the article.
    The feature doesn’t do what I need.
    Other reason.

    Note that feedback is provided anonymously so we aren't able to reply to questions.
    If you'd like to ask a question, submit a request to our Support team.
    Thank you for your feedback.