Excel Add-In for Jira Service Desk

Build 21.0.7930

Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From Jira Service Desk to launch the CData Query window. To setup your connection, you will have to click the Select button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting to Jira Service Desk

You can establish a connection to any Jira Service Desk Cloud account or Jira Service Desk Server instance. To connect set the following property:

  • URL (for example: https://yoursitename.atlassian.net).

Authenticating to Jira Service Desk

Basic Authentication

Authenticating with a Cloud Account

To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Supply the following to connect to data:

  • AuthScheme: Set this Basic.
  • User: Set this to the username of the authenticating user.
  • APIToken: Set this to the API token found previously.
Authenticating with a local Server Account

To authenticate with a local server account, you will need to supply the following connection properties:

  • AuthScheme: Set this Basic.
  • User: Set this to the username of the authenticating user.
  • Password: Set this to the password of the authenticating user.
  • URL: Set this to the URL associated with your Jira Service Desk endpoint. For example, https://yoursitename.atlassian.net.

Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

Authenticate with a Custom OAuth App (3LO)

You can leverage Jira Service Desk's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials. See Using OAuth Authentication for an authentication guide.

Authenticate Using OAuth1.0

To connect to Jira Service Desk you will need to follow the steps below:

  • Firstly, generate an RSA public/private key pair. In your terminal, run the following commands:
    -openssl genrsa -out jira_privatekey.pem 1024
    -openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
    -openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
    -openssl x509 -pubkey -noout -in jira_publickey.cer -out jira_publickey.pem
  • Create application links in your account. Go to Settings -> Applications -> Application links.
  • Enter a test URL for the url field, click 'Create new link'.
  • Ignore the error and click continue. We only want to configure incoming calls (from app to Jira Service Desk).
  • In the 'Link applications' window, fill in the fields as you like as they are not relevant. But make sure to check 'Create incoming link'. Click Continue to go to the next page.
  • Fill in the required fields:
    -Consumer Key: Fill this as you like. You will use this as OAuthClientId later on.
    -Consumer Name: Fill this as you like.
    -Public key: Enter the key in the 'jira_publickey.pem' file you generated earlier. And click continue.
To connect set the following properties:

  • URL (for example: https://yoursitename.atlassian.net).
  • OAuthClientId to the Consumer Key of your application.
  • OAuthClientSecret to any value (such as 'testClientSecret').
  • OAuthJWTCert to the location of your private key file.
  • OAuthJWTCertType to the appropriate option based on the private key file being used. If using the generated PEM key file, set OAuthJWTCertType to PEMKEY_FILE.
  • InitiateOAuth to GETANDREFRESH.

Authenticating with Crowd

Set the AuthScheme to Crowd. The following connection properties are used to connect to Crowd:

  • User: The CROWD user account.
  • Password: The password associated with the Crowd account.
  • SSOLoginUrl: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application -> SSO -> SSO information -> Identity provider single sign-on URL.
  • SSOExchangeUrl: The URL used used to exchange the SAML token for JiraServiceDesk cookies. This URL may have the following formats:
    • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer
    • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlsso
The following SSOProperties are needed to authenticate to Crowd:
  • AppName: The name of the application in which SSO is enabled.
  • AppPassword: The password of the application in which SSO is enabled.

The following is an example connection string:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginUrl='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;SSO Properties='AppName=CrowdApp;AppPassword=CrowdAppPassword;';

Authenticating with Okta

Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:

  • User: Set this to the Okta user.
  • Password: Set this to Okta password for the user.
  • SSOLoginUrl: Set this to the login url used by the SSO provider.
  • SSOExchangeUrl: The URL used used to exchange the SAML token for JiraServiceDesk cookies. This URL may have the following formats:
    • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer
    • https://<authority of JiraServiceDesk instance>/plugins/servlet/samlsso
The following SSOProperties are needed to authenticate to Okta:
  • APIToken (optional): Set this to the API Token that the customer created from the Okta org. It should be used when authenticating a user via a trusted application or proxy that overrides OKTA client request context.

The following is an example connection string:

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginUrl='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;

Accessing Custom Fields

By default, the add-in surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to Jira Service Desk you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

See Also

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930