Configure Smart Connectors

Owned by Oksana Vishchuk
Last updated: Apr 18, 2024 by Damian Rozmiarkowski
4 min read

Overview

Smart Connectors are powerful tools that allow the creation of predefined projects as soon as a file is uploaded to the folder or sent in a message to the e-mail address specified in the Smart Connector configuration. They work similarly to periodic jobs and are designed to save the project manager's time when a client orders multiple translation projects of the same type. 

This guide shows you how to create and configure a Smart Connector. Depending on your knowledge of JavaScript, you can either configure the basic Smart Connector, which does not require any knowledge of JavaScript, or you can prepare an advanced Smart Connector, which requires at least basic knowledge of JavaScript but offers a lot more options.

Prepare Folders for Smart Connectors

Before following this guide, make sure that a special folder in a file-sharing service or in your e-mail service is already prepared and can be mapped for the Smart Connector to scan.

Create a Smart Connector

  1. Go to the Configuration menu → Integrations → Smart Connectors.

  2. Click the Add Smart Connector button in the top right-hand corner. You will be directed to the Add Smart Connector page.

  3. Select the Project or Quote radio button according to your needs.

  4. Provide a Name for the new Smart Connector.

The Smart Connector’s name is not related to the name of the project or quote created using this Smart Connector. The project or quote name can be specified in the Robot Code field.

  1. Check the Active box to enable this Smart Connector.

  2. Select a Client for whom the quotes or projects will be created in the search-as-you-type field.

The Smart Connector selects the default contact person specified in the client's price list. If there is no default contact person, the first contact person from the client's price list is selected.

  1. (Optional) Select a Budget Code for this client.

  2. Select the Client's Price Profile. If the client has only one price profile, it will be selected automatically.

  3. In the Files Aggregation section, select how to process files from the mapped folder: 

    1. Process every top level file separately option creates separate projects or quotes for each file from the mapped folder.

    2. Process files in batches option creates one project or quote for all files from the mapped folder.

  4. In the Scan for Input Files section, select the Files location and provide the path to a folder that will be mapped and scanned for files. The folder can be either located on your local machine, on the FTP or SFTP server, or on an e-mail server. Provide the necessary information in the fields that appears after you specify the file location.

  5.  In the After Successfully Processing, Store Files in and In Case of Errors, Store Files in sections, decide whether you want to store the files from the mapped folder in an XTRF directory or on FTP or SFTP servers. Provide the necessary path or server details according to your selection.

  6. In the Person Responsible section, select the Home Portal user that will receive notifications or this Smart Connector.

  7. In the Connector Definition section, decide whether you want to configure a basic Smart Connector or an advanced one.

    • For a basic Smart Connector: select the source and target languages, service, and specialization that will be applied to all projects or quotes created by this Smart Connector.

    • For an advanced Smart Connector:

      • Select the Robot Code radio button.

      • Change the settings according to your needs. You can find the list of available parameters by clicking the Available Parameters link on the left or in the Smart Connectors - Technical Guide.

        The advanced parameters added to the robot code in this example are:

        • name: specifies the name of the project,

        • sourceLanguage: specifies the source language

        • targetLanguages: specifies the target language

        • service: specifies the type of workflow in the project

        • specialization: specifies the specialization of the project

        • categories: specifies the category of the project

        • notes: adds the message "Important notes" to the Notes section in the project’s Instructions tab

        • startDate: specifies the start date of the project

        • deadline: specifies the deadline of the project

  8. Click the Save button.

  9. Go to the Schedule tab. Here you can configure how often the Smart Connector should check for new files in the e-mail folder.

  10. Click the Save button.

  11. Go to the E-mail Notifications tab. Here you can select when the person responsible for the Smart Connector (see step 12 above) and the client should receive notifications concerning the projects and quotes created by this Smart Connector.

  12. Click the Save button.