Versions Compared

Old Version 2

changes.mady.by.user Oksana Vishchuk

Saved on

compared with

New Version 3

changes.mady.by.user Damian Rozmiarkowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Overview

The OAuth 2.0 is a new authorization protocol that offers a secure way to share resources between two different sites using only the username and password tokens (no credentials are exposed). Several services have already switched from basic authorization to OAuth 2.0, and XTRF is keeping pace with those changes.

How to get access to the OAuth 2.0

Info

As for now, OAuth 2.0 is only available for Google Cloud Platform (Gmail) and Microsoft Azure (Outlook/Office 365) accounts.

To start using the OAuth 2.0 authorization protocol, please contact our Help Desk. After you get a confirmation from our team that the service is enabled, you’ll need to make some configurations both in your e-mail service settings and the XTRF Configuration menu.

Configure e-mail services

Configure Google Cloud account

  1. Login to your Google Cloud Platform account.

  2. Create a new project or open an existing one.

  3. Go to APIs & Services in the Navigation menu or Quick Access menu.

  4. Click the +Enable API and Services button at the top of the page. You will be directed to the API Library.

  5. In the Google Workspace section, click the Gmail API card.

  6. Go to the Credentials tab, click the +Create Credentials button, and select the OAuth client ID option.

  7. From the Application type drop-down list, select Web application.

  8. In the Name field, provide a name for the new OAuth client.

  9. In the Authorized redirect URIs section, add a new URI like: {your-host}/home-api/authentication/mail/oauth2/code, where {your-host} is your DNS, e.g., https://xtrf-app/home-api/authentication/mail/oauth2/code.

  10. Click the Create button.

  11. Copy the ClientID and the ClientSecret that will appear in the OAuth client created pop-up. You can also find them later in the newly created OAuth client profile.

Configure Microsoft Azure account

  1. Login to your Microsoft Azure account.

  2. Go to Manage Azure Active Directory > View.

  3. From the +Add drop-down list at the top of the page, select App registration. You will be directed to the Register an application page.

  4. Provide a Name for the new app.

  5. In the Supported account types section, select the Accounts in any organizational directory (Any Azure AD directory - Multitenant) option.

  6. In the Redirect URI (optional) section:

    1. From the Select a platform drop-down list, select Web.

    2. Provide a new URI like: {your-host}/home-api/authentication/mail/oauth2/code, where {your-host} is your DNS, e.g., https://xtrf-app/home-api/authentication/mail/oauth2/code.

  7. Click the Register button.

  8. In the left-hand navigation menu, select API permissions.

  9. Click the + Add a permission button.

  10. In the Request API permissions right-hand side panel, go to the Microsoft APIs tab and select Microsoft Graph.

  11. Select the Delegate permission card.

  12. Locate and select the SMTP and IMAP permissions.

  13. Click the Add permissions button.

  14. In the left-hand navigation menu, select Certificates & secrets.

  15. Click the +New client secret button.

  16. In the Add a client secret right-hand side panel, provide a description and select the expiry time.

  17. Click the Add button. The new client secret will appear on the Client secrets list.

  18. Copy the content of the Value field (this will be the Client Secret in XTRF).

  19. In the left-hand navigation menu, select Overview.

  20. In the Essentials section, copy the Application (Client) ID field (this will be the Client Id in XTRF).

Configure XTRF

Configure SMTP settings

Info

Once you configure the OAuth 2.0 in one area, the token will be active in other parts of the system as well. After you provide the same SMTP server and e-mail address and click the Save button, a ‘Your access token is active’ message will appear. In that case, there is no need to provide the ClientID and ClientSecret again.

  1. Go to the (blue star) Configuration menu > General Configuration > Settings > E-mail tab.

  2. In the Authorization method section, select OAuth2.

  3. In the SMTP Server field, enter:

    • smtp.gmail.com:587 for Gmail

    • smtp-mail.outlook.com:587 for Outlook.

  4. In the E-mail Address field, provide your company e-mail address.

  5. From the Connection Type drop-down list, select TLS.

  6. Click the Save button.

  7. In the OAuth2 Configuration section, provide the Client Id and the Client Secret you have copied from Google Cloud or Microsoft Azure accounts (see the instructions above).

  8. Click the Save button.

  9. Click the Generate new token button and give the necessary permission to the app. You will receive an ‘OAuth2 Token was generated' message.

  10. (Optional) Test the connection by entering your company e-mail address in the Send Test E-mail to field and clicking the Test button.

You can also configure the OAuth 2.0 authorization for your company branches:

  1. Go to the (blue star) Configuration menu > General Configuration > Branches and open the desired branch in edit mode.

  2. Go to the E-mail tab.

  3. Check the Use Own SMTP Server box.

  4. Select the OAuth2 radio button.

  5. In the SMTP Server field, enter:

    • smtp.gmail.com:587 for Gmail

    • smtp-mail.outlook.com:587for Outlook.

  6. In the E-mail Address field, provide the branch’s e-mail address.

  7. From the Connection Type drop-down list, select TLS.

  8. Provide the Client Id and the Client Secret you have copied from Google Cloud or Microsoft Azure accounts (see the instructions above).

  9. Click the Save button.

  10. Click the Generate new token button.

  11. (Optional) Test the connection by entering your company e-mail address in the Send Test E-mail to field and clicking the Test button.

Configure Smart Connectors

A Smart Connector can be used to automatically create projects and quotes for the selected client based on files from the dedicated e-mail folder. To create a Smart Connector for this purpose, perform the following steps:

  1. Go to the (blue star) Configuration menu > Integration > Smart Connectors tab.

  2. Click the Add Smart Connector button in the top right-hand corner. You will be directed to the Add Smart Connector page.
    Note: You can also configure an existing Smart Connector.

  3. Select theProject or Quote radio button according to your needs.

  4. Provide a Name for the new Smart Connector.

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

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

  7. In the Files Aggregation section, select how to process files from the e-mail folder:

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

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

  8. In the Scan for Input Files section:

    1. In the Files location row, select theE-mail radio button.

    2. In the Authorisation method row, select the OAuth2 radio button.

    3. Provide the Host Name. Use imap.gmail.com for Gmail or outlook.office365.com for Outlook.

    4. Provide the port number 993 in the separate field.

    5. Check the Use SSL box.

    6. In the Username field, enter your company e-mail address.

    7. In the Folder field, provide the e-mail folder name from which the project files are to be uploaded.

    8. Provide the Client ID and Client Secret you have copied from Google Cloud or Microsoft Azure accounts (see the instructions above)
      Note: If you see the ‘Token is active’ message, you may skip this step.

  9. (Optional) 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 an e-mail folder in an XTRF directory or on FTP or SFTP servers. Provide the necessary path or server details according to your selection.

  10. In the Person Responsible section, select the Home Portal user that will receive notifications about this Smart Connector work (see step 15 below).

  11. In the Connector Definition section, select the source and target languages, service, and specialization that will be applied to all projects or quotes created by this Smart Connector.
    Note: If you are not creating the Smart Connector from scratch but are editing an existing one, you can provide the necessary changes in the Robot Code field.

  12. Click the Save button.

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

  14. Click the Save button.

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

  16. Click the Save button.

  17. (Optional) Check the Smart Connector:

    1. Go to your e-mail service and add an e-mail with attachments to the e-mail folder you provided in step 8.

    2. On the Smart Connector page, click the Test Connector button. The Smart Connector Test pop-up window will appear.

    3. Click the Finish Test button. If all the settings are correct, a new project or quote will appear on your Home Portal.

Note

After creating a project or quote, the Smart Connector will delete files from your e-mail folder to avoid creating another project or quote with the same files.