Automation
    1. Phrase
    2. Phrase TMS
    3. Automation

    Automated Project Creation - APC (TMS)

    Available for

    • Project Managers

    • Team, Ultimate and Enterprise plans

    Get in touch with Sales for licensing questions.

    Note

    APC is built on top of new architecture with better performance and reliability, as well as a simpler setup than the legacy version.

    APC is close to a full feature parity with the legacy version. Most recently it was updated to support most legacy features including the ability to generate analyses and quotes, and send notifications. It will be extended to support additional use cases in the latter part of 2022.

    The legacy version is recommended for use cases that require the service functionality.

    Video Disclaimer

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

    Set Up Automated Project Creation

    Automated project creation rules allow the configuration of how Phrase monitors specific folders and creates new projects if new or updated content is detected in them.

    Exporting translations back to the repository:

    • Jobs are exported when the project status is set to Completed.

    • Jobs can be manually exported by choosing Download > Export to online repository. Even unchanged files will be exported.

    • Each target file is stored in a target path specified in APC settings.

    Re-importing:

    • Jobs can be re-imported from the Download menu on the jobs table.

    Set up Automation Rules

    Prerequisites:

    Follow these steps:

    1. Set monitoring:

      1. From the Settings Setup_gear.png page, click Automated project creation.

        The Automated project creation page opens.

      2. Click New.

        The Monitoring page opens.

      3. Provide a name for the APC.

      4. Set active/inactive status.

      5. Click Select Folder to choose a folder to monitor for new or updated content.

        The contents of the folder are listed.

      6. Select specific files to be monitored.

        Not all options are available on all connectors.

        • If none selected, the entire folder is monitored for a change or for new files.

        • Include subfolders to enable the monitoring of the selected folder and its subfolders.

        Filename Pattern (regex) lets customers define a regular expression to filter out files to be monitored within the folder.

      7. Click Add monitor to select either a Schedule-based or Webhook-based trigger.

      8. Click Next.

        The Creation & Export page opens.

    2. Set creation & export:

      1. Choose how project is to be created.

      2. Select a project template from the dropdown list.

        • Source language is defined in the project template and either all or a subset of target languages can be selected.

      3. Select criteria for exporting translations.

      4. Click Next.

        The Automations page opens.

    3. Set optional automations:

      1. Select required automations.

      2. Select source update options.

      3. Click Save.

        The APC is added to the list on the Automated project creation page.

    With the automation rules set, content can now be created in the designated folders. Based on frequency checks, Phrase looks into the specified folder and identifies new or updated content (based on file names, metadata, size, etc.).

    The status of a monitored repository can be updated immediately by selecting an automation rule and clicking Check now. To force APC to import all monitored files, click Force import.

    Automatic Creation of New Projects from Online Repositories

    On the Automated Project Creation page, Phrase displays currently available rules, connection status and the last checked and next check dates and times.

    If new content is identified, new projects are created with either default settings or settings taken from the selected project template.

    Set Target File Pathnames

    Each target file is exported to a folder specified in project settings.

    Disable Automated Project Creation

    There are three ways to disable APC:

    • Manually disabled in settings.

    • Automatically disables after 90 days of inactivity.

    • Automatically after the organization profile has been deactivated (at the end of the subscription).

    When a connector used as part of the Automated Project Creation rules detects three or more consecutive instances of a project not being created when it should be, notification is sent to affected users.

    Zip File Support

    • Multiple ZIP files can be imported to one project.

    • Translated files are exported back to ZIP files.

    • If one ZIP file is imported to multiple targets, the translated files will be exported to multiple ZIP files—one ZIP for each target language—using the target locale code in the ZIP name (for example Pack18.en_us.ZIP).

    Translation with Pivot Languages through APC

    In multilingual localization, a pivot language can be used as bridge language to enable translation from the source language to any required number of target languages. The pivot language approach is especially valid when there are limited translation resources available in the source language for any reason.

    Translation with pivot languages is one of the possible APC use cases to automate the translation process. The example below summarizes required steps to follow:

    1. Create a folder in the desired online repository to store the source language content.

      In this example, source files in French language are added to a Google Drive folder.

    2. Set up APC monitoring options to monitor content updates in the desired online repository.

    3. Set up APC to create a project with the required source language and the chosen pivot language to use as target language.

      In this example, the APC is set up to create a project with French as source language and English as pivot target language.

    4. Configure the APC export settings to export translated content into the corresponding target language folder on the same online repository.

      In this example, the APC is set up to export the English translations into a target folder on the same Google Drive.

    5. Once the project is completed, the export triggers APC to create another project for translating content from the pivot language into the desired target language.

      In this example, the export triggers APC to create another project for translating content from English into German.

    Note

    Required connectors and project templates must be set up to apply the use case.

    For large scale projects, translation with pivot languages can also be achieved by custom scripting via APIs.

    Automated Project Creation (Legacy)

    Automated Project Creation rules allow the configuration of how Phrase monitors specific folders and creates new projects if new or updated content is detected in them. This provides full process automation; analysis, pre-translation, assignment to Linguists/Vendors, and the e-mailing of notifications.

    As soon as a project status changes to Completed by Project Status Automation rules, the translated files are sent back to the Online Repository into newly created subfolders identified by language codes (en, es, ja, etc.). If a user triggers the export manually, the completed file is exported to the standard {targetLang} folder.

    Exporting Translations Back to the Repository

    • Jobs are exported when the project status is set to Completed.

    • Jobs can be manually exported by choosing Download > Export to Online Repository. Even unchanged files will be exported.

    • Each target file is stored in a target path specified in APC settings.

    Re-importing

    • Jobs can be re-imported from the Download menu on the jobs table.

    Set up Automation Rules

    Prerequisites:

    Note

    When the service is created, ensure either Analyses only or Analyses and quotes is selected and the Use naming defined in the project template's settings option is deselected in the Financials section. If None is selected, Automated Project Creation will not create a new project for new or updated content in the monitored folder.

    Follow these steps:

    1. From the Settings Setup_gear.png page, click Automated Project Creation.

      The Automated Project Creation page opens.

    2. Click New.

      The Create automated project settings page opens.

    3. Provide a name for the APC.

    4. Set active/inactive status.

    5. Select Version 2 (BETA) if required (the following options will change if selected).

    6. Select Run as Continuous Project if required.

    7. Choose the Remote Folder to monitor for new or updated content.

      The contents of the folder are listed

    8. Select specific files to be monitored.

      Not all options are available on all connectors.

      • If none selected, the entire folder is monitored for a change or for new files.

      • Include subfolders to enable the monitoring of the selected folder and its subfolders.

    9. Select where to Export completed file to.

    10. Depending on the pathname of the required target files, set Export completed files to and Target Subfolder Path fields.

    11. Designate a Processed subfolder.

      Imported files are moved to this folder providing visibility on which files are being processed. If disabled, source files stay in their original folder.

      If this option is disabled and File Renaming is not used, original documents can be overwritten by their translations (depending on repository).

      Filename Pattern (regex) lets customers define a regular expression to filter out files to be monitored within the folder.

    12. Set a frequency for how often Phrase should check for new content in the designated folder.

    13. Choose required Service.

    14. Select the source and target languages that automatically created projects will be associated with.

    15. To differentiate between projects coming from different automation rules, use a Project name to define the automatically generated names of projects.

      The macro {filename} can be used in the Project's title. If multiple filenames are used in the project's name, only the first filename will be used.

    16. Set Project owner.

      Project owner will always be notified when a new project is created using automation rules.

    17. Customize Email Templates used for notifications if required.

    Automatic Creation of New Projects from Online Repositories

    On the Automated Project Creation page, Phrase displays currently available rules, connection status and the last checked and next check dates and times.

    If new content is identified, new projects are created with either default settings or settings taken from the selected project template.

    Set Target File Pathnames

    Relative to the source file the target files can be exported to:

    • Same folder

      If specific files are selected, then select Source file folder for Export completed files to and keep the Target Subfolder Path empty. Not supported if the entire folder is monitored.

    • Language subfolder

      Always keep the Target Subfolder Path empty.

      If specific files are monitored, then select Target language subfolder for Export completed files to.

    • Any folder

      If specific files are monitored, then select Target language subfolder for Export completed files to.

      Specify the folder name in the Target Subfolder Path:

      • Use these macros to represent target language.

        • {targetLang} Based on language codes.

        • {targetLangName} Based on language names.

        • {targetLangRFC}

          • Examples: es, en-US, az-Latn-AZ

          • Based on RFC 5646

        • {targetLangAndroid}

          • Examples: es, en-rUS

        • {targetLangAndroidBCP}

          • Examples: b+es, b+en+US

      • Subfolders can be created within the source folder.

        Available for Amazon S3, Azure, FTP, SFTP, Dropbox, Google Drive, Box, OneDrive, Git, GitHub, GitLab, and Bitbucket Cloud.

      • For some repositories, an absolute path is available. Begin your path with / to indicate the absolute path.

        Available for Amazon S3, Azure, FTP, SFTP, Dropbox, Google Drive, Box, OneDrive, Git, GitHub, GitLab, and SharePoint. When using Git connector, the leading / is followed by the branch name, and then by the root of the repository where .git folder is located. If the branch doesn’t exist, it will be created. When using other Git-based connectors (e.g. GitLab), the leading slash is followed by the root of the repository where .git folder is located.

      • Use .. to refer to the parent folder.

      Tip

      Examples

      If the source file is /files/loc/ui.properties and the target language is German (Germany):

      • translations/{targetLang} will create /files/loc/translations/de_de

      • /files-{targetLang}/loc will create /files-de_de/loc/<filename>

      • ../{targetLang} will create /files/de_de/<filename>

    Zip File Support

    • Multiple ZIP files can be imported to one project.

    • Translated files are exported back to ZIP files.

    • If one ZIP file is imported to multiple targets, the translated files will be exported to multiple ZIP files—one ZIP for each target language—using the target locale code in the ZIP name (for example Pack18.en_us.ZIP).

    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.

    Articles related to Automation