Confluence has been updated to version 6.15.9

Introduction

You can synchronize Zendesk tickets with any of the supported issue tracking platforms.

Exalate has a distributed architecture. The Exalate app for Zendesk is responsible for translating issue tracker-based information to a common issue format (and the other way around).


You can exchange the following data between a Zendesk ticket and a Jira issue:

  • ticket id ↔ issue key
  • subject ↔ summary
  • description ↔ description
  • ticket type ↔ issue type
  • submitter ↔ creator
  • assignee ↔ assignee
  • requester ↔ reporter
  • comments ↔ comments
  • priority ↔ priority
  • status ↔ status
  • tags ↔ labels
  • attachments ↔ attachments
  • custom fields ↔ custom fields

Check out Zendesk fields and entities available for synchronization for more details.

Install the Exalate app

Exalate architecture requires installing one Exalate application on each instance.

You can install Exalate for the Zendesk app directly from your Zendesk account. The app is hosted on our server.

Install the Exalate app and configure the proxy user. The proxy user must be a dedicated Zendesk agent. 

The proxy user must generate the Access Token in the Zendesk Admin under Channels API tab. It will be used during the installation process. 

 How to install Exalate app

In this article, we describe how to install Exalate for Zendesk from the marketplace.

Before you Begin

To be able to install Exalate, you need to have:

How to Install Exalate

1. Log in to your Zendesk account.

2. Navigate to Marketplace in the APPS section.

3. Find Exalate in the Marketplace.



4. Click Install to begin the installation.

5. Select an account you want to install the app with (applicable only if you have multiple Zendesk accounts) and click Install.

6. Configure the app before installation.

Before installing the app, you will be able to update the name of the app and set which roles and groups will be able to access it.

 Field descriptions
Title
Your custom name of the app. Required field. The default value for the field is Exalate
Enable role restrictions?
If checked, you can set which roles can access the app.
Enable group restrictions?
If checked, you can choose which user groups can access the app.

7. Click Install.

8. Select Exalate in the side panel.

9. Click Allow to confirm that Exalate can have access to read and write your data.

10. Accept the license agreement by pressing Accept.

Congratulations! The app is installed, now you have a new icon on the left sidebar. Click the icon to open Exalate.

Next step

Configure the license

Set up a Connection

 Exalate proxy user


A proxy user is a user, that will be used to carry out any changes such as creating issues, updating data, adding comments and attachments, etc.

It's the user who impersonates external instances. All changes on local issues are performed on behalf of this user. You can use an existing user account or create a new one, specifically dedicated to the Exalate app. 

Attention

Changes made by the proxy user will not be synchronized.

If you set the administrator as a proxy user and create issues with the help of the 'create on behalf of ' Service Desk functionality, issues will not be synchronized.

Configuration

The proxy user configuration depends on the issue tracking platform. 

How to set a proxy user on Jira Cloud

Atlassian creates the app user for Jira Cloud apps automatically. This user cannot be modified. The app user is a proxy user for Exalate.

The username is Exalate and email address is com.exalate.jiranode@connect.atlassian.com

The proxy user on Jira Cloud is a member of the following user-groups: 

  • atlassian-addons
  • atlassian-addons-admin
  • jira-core-users
  • jira-servicedesk-users
  • jira-software-users 


How to set a proxy user on Jira Server

Navigate to General settings in the Exalate admin menu to set the proxy user.

How to set up a proxy user on Zendesk

Navigate to Admin → Apps → Manage → Exalate app settings → App configuration

Exalate requires a dedicated Zendesk admin as a proxy user. 

Input the proxy user email address and the token generated by that user. Check how to generate access token for more details.

How to set a proxy user on Exalate for Servicenow

  1. Log in to the Exalted admin console
  2. Navigate to General Settings
  3. Input details:
    • Servicenow instance URL
    • Proxy user name
    • Proxy user password

The proxy user must have permissions to Create/Read/Update entities on ServiceNow instance. Check ServiceNow - Permissions for more details.




Required permissions

The proxy user needs permissions to create and change issue information.


In ServiceNow, proxy users can sync tables or attributes based on the access from their user role. Check ServiceNow - Permissions for more information.

The following permissions are required:

  • Browse Project
  • Create issue
  • Edit issue
  • Link issue
  • Transition issue: change statuses (on issue transition)
  • If comments are synchronized, the proxy user will need to add, edit, and delete a comment
  • If attachments are synchronized, the proxy user needs to add, and delete attachments
  • If work logs are synchronized, the proxy user needs to add, edit, and delete work log 
  • If security levels are synchronized, the proxy user needs to access the security levels
  • If you're using trigger the proxy user must be able to search issues. 


Jira Service Desk permissions

The proxy user needs to be a service desk agent.

 



Configure the License 

Once the installation is finished, you need to get the evaluation license.

Set up a Connection

Synchronization between two instances requires a configured Connection. One side needs to initiate the connection and send an invitation to the partner (the Destination instance). 

The other side needs to finish the configuration from their side. 

You can synchronize with any of the supported issue tracking platforms. For more details check out the typical use cases. 

You can set up the synchronization between your Zendesk and Jira Cloud using our new interface. It helps to configure the connection and map fields in-between from one single place. Make sure that you have admin access to both Zendesk and Jira Cloud to try this out.

To start synchronization with your partner - Initiate Connection

If you have an Invitation code - Accept an Invitation.


Synchronize tickets

You can start the synchronization of tickets on Zendesk in different ways: 

  • Configure a trigger to synchronize tickets automatically according to the specified search query.
  • If you have admin access to both instances, you can define the sync scope in the visual mode for both sync sides.
  • Synchronize tickets manually using Entity Sync Status panel in the Exalate admin console.


Configure the synchronization behavior of your use case with the help of the Zendesk configuration guides.