Setting up a Connection

    Set Up a Connection in Basic Mode

    Refer to our step-by-step Getting Started guide to begin your synchronization journey.

    • Before you set up a Connection in Basic mode ensure that you don't use an older version of Exalate.
    • The Basic mode is available under Exalate's Free Plan.

    To initiate a connection in Basic mode:

    1. Navigate to the Connections tab in Exalate.

    2. Click Initiate connection.


    Attention: 

    It doesn't matter which side you start initiating the Connection from. The Exalate UI will remain the same.

    3. Enter the Destination Instance URL.

    The Destination Instance URL is the link to the instance you want to set up a connection with. You can directly enter the link of that instance or the Exalate URL from the General Settings tab in the Exalate admin panel.

     If you enter a link to your instance—Exalate will determine it's a local connection between 2 projects within your instance.

    Exalate will suggest available Configuration Modes based on the destination instance.

    4. Select Basic.

    5. Click Next.

    6. Select a project or repository where you would like to sync entities received from the destination side.

    In case there isn't a concept of a project or repository in the platform you use, this option will not be displayed. 

    7. Click Initiate.

    8. Confirm if you have admin access to the destination instance.

    Further steps will be different if you have or don't have admin access to the destination instance.

    • Select Yes, I have admin access if you have admin access to the destination instance. You will be redirected to the destination instance to establish a connection.
    • Select No, I don't have admin access if you don't have admin access to the destination instance. You will generate an invitation for the destination instance admin so they could establish a connection on their end.
      Click Yes, I have admin access

    If you don't have admin access:

    Copy the invitation code that is generated. 

    You can send this code to the destination instance admin. On the destination side, the admin needs to accept the connection invitation and paste the code. After that, the connection is established. 

    9. Click Initiate.

    You will be required to verify access on the destination instance. After which complete the following steps on the destination instance.

    10. If applicable, select the project or repository where you want to sync entities. 

    11. Click Confirm.

    The Connection has been set up. 

    You can sync your first entity in Exalate to see how it works: enter the entity URN and click Exalate


    When syncing your first entity, you will see the status of your sync. The links to both entities are displayed at the bottom as shown below. You can open them up to see more details.

    Set Up a Connection in Visual Mode

    Before you initiate a connection in visual mode, please make sure that:

    • your connection is public. 
    • you have admin access to the remote instance. 
    • you are either in the Evaluation (trial) period or have a Paid license.

    At the moment, Visual mode is only available in Exalate for Jira Cloud, Jira On-premise, Zendesk, Jira Server, and Azure DevOps. More nodes will be added in the future, so stay tuned for future updates!

    To initiate a connection in Visual mode:

    1. Navigate to the Connections tab in Exalate.

    2. Click Initiate connection.


    Attention: 

    It doesn't matter which side you start initiating the Connection from. The Exalate UI will remain the same.

    3. Enter the Destination instance URL

    The destination instance URL is a link to the instance you want to set up a connection with. You can enter the link to the instance you are trying to connect, or the Exalate URL from General Settings.

    If you enter a link to your instance — you will establish a Local Connection.

    Exalate will suggest available Configuration Modes based on the destination instance's version of Exalate.

    4. Choose Visual

    5. Click Next

    Further steps will be different depending on if your connection is public or local. 

    6. Enter Connection information.

    Field

    Description

    Connection nameName of the connection
    DescriptionDescription of the connection
    Destination instance URLLink to the other instance you want to set up a connection with. You can enter the link to the instance you are trying to connect, or the Exalate URL from General Settings.
    Local instance short nameShort name of your instance
    Remote instance short nameName of the destination instance

    In the case of Local connections, after entering the connection description the connection will be established. Click the Initiate button for that. 

    7. Click Next

    8. Click Verify admin access to confirm that you have admin rights.

    9. Click Accept to finish the verification process.

    You will be redirected to the remote instance to finish the verification process. You will be notified about the permissions, the destination instance user will have.

    The destination instance user will have different permissions based on the task management system you are using.

    10. Click Initiate

    Congratulations! The connection is set up. Now you can proceed to the configuration.

    Set Up a Connection in Script Mode

    Attention: 

    It doesn't matter which side you start initiating the Connection from. The Exalate UI will remain the same. 

    If you are initiating the connection you become the source and the other side becomes the destination.

    Initiate a Connection

    To initiate a connection in Script mode:

    1. Navigate to the Connections tab in Exalate.

    2. Click Initiate connection.


    3. Enter the Destination instance URL

    The destination instance URL is a link to the instance you want to set up a connection with. You can enter the link to the instance you are trying to connect, or the Exalate URL from General Settings.

    If you enter a link to your instance — you will establish a local connection.

    If the destination instance is in a private network, or you don't have the link, click I don't have a URL.

    Exalate will suggest available configuration modes based on the destination instance's version of Exalate.

    4. Choose Script.

    5. Click Next

    6. Enter Connection information.

    Field

    Description

    Connection nameName of the connection
    DescriptionDescription of the connection
    Destination instance URLLink to the other instance you want to set up a connection with. You can enter the link to the instance you are trying to connect, or the Exalate URL from General Settings.
    Local instance short nameShort name of your instance
    Remote instance short nameName of the destination instance


    In the case of Local connections, after entering the connection details the connection will be established. Click the Initiate button for that. 

    7. Click Initiate.

    8. Click Copy invitation code.

    To establish a Connection in Script mode between two instances, you need to generate an Invitation Code on one instance and accept it on the other instance.

    The Invitation Code includes pre-populated Connection details such as Connection name, instance short names, and Destination instance URL. 

    You are only required to finish the configuration by accepting the invitation.

    You can send the Invitation Code to the destination instance admin.

    11. Click Go to remote to access the destination instance.

    When the other side accepts your invitation your connection will be activated. Refresh the Connections page to see the Connection status change.

    Accept the Connection Invitation

    1. Navigate to the Connections tab in the Exalate console.

    2. Click Accept invitation.

    3. Paste the invitation code.

    Paste the invitation code that you received from the other side.

    4. Click Next.

    5. Select a project where you would like to sync issues received from the other side. 

    In case there isn't a concept of a project or repository in the platform you use, this option will not be displayed. 

    6. Click Confirm.

    Congratulations! The connection is set up.