Jira Service Management v2 Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8858 of the connector.
Get Started¶
Establish a Connection¶
Connect to Jira Service Management¶
You can establish a connection to any Jira Service Management Cloud account or Jira Service Management Server instance. To connect set the following property:
URL
(for example: https://yoursitename.atlassian.net).
Access Custom Fields¶
By default, the connector surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields
.
Authenticate to Jira Service Management¶
Basic¶
To authenticate with a local server account, specify the following connection properties:
AuthScheme
: Set this toBasic
.User
: Set this to the username of the authenticating user.Password
: Set this to the password of the authenticating user.
API Token¶
To connect to a Cloud account, you 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 is displayed.
Supply the following to connect to data:
AuthScheme
: Set this toAPIToken
.User
: Set this to the username of the authenticating user.APIToken
: Set this to your previously noted API token.
Note
Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.
OAuth 2.0¶
You can leverage Jira Service Management's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials.
AuthScheme
must be set to OAuth
in all OAuth flows. Also, in all scenarios, you must create and configure a custom OAuth application. See Creating a Custom OAuth App for more information.
Desktop Applications¶
Follow the steps below to authenticate with the credentials for a custom OAuth application.
InitiateOAuth
: Set this toGETANDREFRESH
. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
.OAuthClientId
: Set this to the client ID assigned when you registered your application.OAuthClientSecret
: Set this to the client secret assigned when you registered your application.CallbackURL
: Set this to the redirect URI defined when you registered your application.URL
: Set this to the URL to your Jira Service Management endpoint, for example,https://yoursitename.atlassian.net
.OAuthVersion
: Set this to2.0
.
When you connect, the connector opens Jira Service Management's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- The connector obtains an access token from Jira Service Management and uses it to request data.
- Extracts the access token from the callback URL and authenticates requests.
- Saves OAuth values in the location specified in
OAuthSettingsLocation
. These values persist across connections.
The connector refreshes the access token automatically when it expires.
OAuth1.0¶
To connect to Jira Service Management you will need to follow the steps below:
-
First, 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 and click
Create new link
. -
Ignore the error and click continue. We only want to configure incoming calls from the application to Jira Service Management.
-
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: Set to any string. You need this as the OAuthClientId later.
- Consumer Name: Set to any string.
- Public key: Enter the key from the jira_publickey.pem file you generated earlier.
- Consumer Key: Set to any string. You need this as the OAuthClientId later.
-
Click
continue
.
To connect set the following properties:
URL
: Set to your Jira Service Management endpoint. For example,https://yoursitename.atlassian.net
.OAuthClientId
: Set to the Consumer Key of your application.OAuthClientSecret
: Set to any value (such as "testClientSecret").OAuthJWTCert
: Set to the location of your private key file.OAuthJWTCertType
: Set to the appropriate option based on the private key file you are using. If using the generated PEM key file, setOAuthJWTCertType
toPEMKEY_FILE
.InitiateOAuth
: Set toGETANDREFRESH
.
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 toyour application -> SSO -> SSO information -> Identity provider single sign-on URL
.SSOAppName
: The name of the application in which SSO is enabled.SSOAppPassword
: The password of the application in which SSO is enabled.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/samlconsumerhttps://<authority
of JiraServiceDesk instance>/plugins/servlet/samlsso
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;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;
Okta¶
To connect to Okta, set the AuthScheme
to Okta
, and set these properties:
User
: The Okta user.Password
: The Okta user's password.SSOLoginURL
: The SSO provider's login 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/samlconsumerhttps://<authority
of JiraServiceDesk instance>/plugins/servlet/samlsso
If you are using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties
to authenticate using Okta. Set any of the following, as applicable:
-
APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
-
MFAType: If you have configured the MFA flow, set this to one of the following supported types:
OktaVerify
,Email
, orSMS
. -
MFAPassCode: If you have configured the MFA flow, set this to a valid passcode.
If you set this to empty or an invalid value, the connector issues a one-time password challenge to your device or email. After the passcode is received, reopen the connection where the retrieved one-time password value is set to the MFAPassCode connection property.
-
MFARememberDevice:
True
by default. Okta supports remembering devices when MFA is required. If remembering devices is allowed according to the configured authentication policies, the connector sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable toFalse
.
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;
Create a Custom OAuth App¶
Jira Service Management uses the OAuth authentication standard, which requires the authenticating user to interact with Jira Service Management via the browser.
Note
Jira Service Management supports OAuth 2.0 only.
Create an OAuth App¶
To obtain the OAuth client credentials, consumer key, and consumer secret:
- Log in to your Jira Service Management site.
- Navigate to your application management:
https://developer.atlassian.com/apps/
. - Select
Create new app
, then name the app. - If missing, add OAuth 2.0 functionality to your application by navigating to APIS AND FEATURES > + Add > Add OAuth 2.0 (3LO).
- From
APIS AND FEATURES > + Add
, add theJIRA Service Desk platform REST API
to your app. You also need to add the JIRA application to get all the functionalities of the driver. - From
APIS AND FEATURES > + JIRA Service Desk platform REST API
, add the desired scopes to your app. - Set up your Callback URL. Navigate to
APIS AND FEATURES > OAuth 2.0 (3LO)
. Enter a URL that is accessible to your application and save the changes.
Fine-Tuning Data Access¶
Fine Tuning Data Access¶
You can use the following properties to gain more control over the data returned from Jira Service Management:
ServiceDeskID
: The ID of the specific service desk you would like to connect to.
By default we get the first ID returned from an extra call to get all service desks. You can get the ServiceDeskId by executing a Select query to the ServiceDesks view.IncludeCustomFields
: Whether or not to include custom fields in queries to the Requests table.RequestLanguage
: Set this to any language installed in Jira to translate display column names in the specified language.
Specify an IETF BCP 47 language tag as described here:https://tools.ietf.org/html/bcp47
.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Jira Service Management connector.
User Defined Views
The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Jira Service Management and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
User Defined Views¶
The Jitterbit Connector for Jira Service Management allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Requests WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert
property for the available formats to do so.
Client SSL Certificates¶
The Jira Service Management connector also supports setting client certificates. Set the following to connect using a client certificate.
SSLClientCert
: The name of the certificate store for the client certificate.SSLClientCertType
: The type of key store containing the TLS/SSL client certificate.SSLClientCertPassword
: The password for the TLS/SSL client certificate.SSLClientCertSubject
: The subject of the TLS/SSL client certificate.
Data Model¶
Overview
This section shows the available API objects and provides more information on executing SQL to Jira Service Management APIs.
Key Features
- The connector models Jira Service Management entities like documents, folders, and groups as relational views, allowing you to write SQL to query Jira Service Management data.
- Stored procedures allow you to execute operations to Jira Service Management
- Live connectivity to these objects means any changes to your Jira Service Management account are immediately reflected when using the connector.
Tables
Tables describes the available tables. Tables are statically defined to model Jira Service Management entities such as RequestApprovals, RequestComments, and RequestParticipants.
Views
Views describes the available views. Views are statically defined to model Jira Service Management entities such as Users, Organizations, and ServiceDesks.
Stored Procedures
Stored Procedures are function-like interfaces to Jira Service Management. Stored procedures allow you to execute operations to Jira Service Management, including downloading documents and moving envelopes.
Tables¶
The connector models the data in Jira Service Management as a list of tables in a relational database that can be queried using standard SQL statements.
Jitterbit Connector for Jira Service Management Tables¶
Name | Description |
---|---|
CustomerTransitions | Returns a list of transitions that customers can perform on the request. |
RequestApprovals | This resource represents a request approval. |
RequestComments | This resource represents request comments. |
RequestParticipants | This resource represents request participants. |
CustomerTransitions¶
Returns a list of transitions that customers can perform on the request.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
RequestID
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM CustomerTransitions WHERE RequestID = '10001'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
RequestId [KEY] | String | True | The ID of the request. |
RequestKey | String | True | The Key of the request. |
Id [KEY] | String | False | The ID of the transition. |
Name | String | True | The Name of the customer transition. |
Comment | String | False | The body of the comment for the transition. |
RequestApprovals¶
This resource represents a request approval.
Select¶
Note
This resource is marked as EXPERIMENTAL and may change without notice.
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
Id
supports the following operator: =.
For example, the following query is processed server side:
SELECT * FROM RequestApprovals WHERE RequestID = '10001' AND ID = '10002'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Id [KEY] | String | True | The ID of the approval. |
RequestKey | String | True | The ID of the request. |
RequestId [KEY] | String | True | The Key of the request. |
Name [KEY] | String | True | The Name of the approval. |
FinalDecision | String | False | The final decision. The allowed values are approve, decline. |
CanAnswerApproval | String | True | Shows if this approval can be answered. |
Approvers | String | True | The approvers of this request. |
CreatedDate | String | True | The datetime this request was approved. |
CompletedDate | String | True | The datetime this request approval was created. |
RequestComments¶
This resource represents request comments.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
Id
andPublic
support the following operator: =.
For example, the following query is processed server side:
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002'
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Id [KEY] | String | True | The ID of the comment. |
RequestId [KEY] | String | True | The ID of the request. |
RequestKey | String | True | The Key of the request. |
Body | String | False | The Body of the comment. |
Public | Boolean | True | Shows if the comment is public or internal |
AuthorKey | String | True | The key of the comment author. |
CreatedAt | String | True | The datetime the comment was created. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Internal | Boolean | Specifies whether to return internal comments or not. Default: true. |
RequestParticipants¶
This resource represents request participants.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
RequestID
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM RequestParticipants WHERE RequestID = '10001'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
AccountId [KEY] | String | True | The Account ID of the participant. |
RequestId [KEY] | String | True | The ID of the Request. |
RequestKey | String | True | The Key of the request. |
EmailAddress | String | True | The Email address of the participant. |
DisplayName | String | True | The display name of the participant. |
Active | Boolean | True | Shows if a participant is active. |
TimeZone | String | True | The time zone of the participant. |
Views¶
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Jitterbit Connector for Jira Service Management Views¶
Name | Description |
---|---|
Customers | This resource represents a customer. |
KnowledgeBaseArticles | The articles which match the given query string across all service desks. |
Organizations | This resource represents an organization. |
QueueRequests | This resource returns the customer requests in a queue. |
Requests | This resource represents a request. |
RequestSLACycles | This resource represents the SLAs (service level agreements) on a customer request. |
RequestStatusChangelog | This resource represents the status transitions for a customer request. |
RequestTypeFields | The fields for a service desk's customer request type. |
RequestTypeGroups | This resource represents a request type group. |
RequestTypes | This resource represents a request type. |
ServiceDesks | This resource represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests. |
Users | This resource represents a user. |
Customers¶
This resource represents a customer.
Note
This resource is available only for Cloud instances.
Columns¶
Name | Type | Description |
---|---|---|
AccountId [KEY] | String | The ID of the account. |
Active | Boolean | Shows if the customer is active. |
DisplayName | String | The Display Name of the customer. |
EmailAddress | String | The email address of the customer. |
TimeZone | String | The time zone of the customer. |
ServiceDeskId | String | The ID of the service desk. |
KnowledgeBaseArticles¶
The articles which match the given query string across all service desks.
Columns¶
Name | Type | Description |
---|---|---|
ServiceDeskId | String | The ID of the service desk. |
Title | String | The title of the article. |
Excerpt | String | The excerpt of the article. |
SourceType | String | The article's source type |
SourcePageId | String | The article's source page id |
SourceSpaceKey | String | The article's source space key |
ContentiFramesource | String | The link to the article. |
Query | String | The string used to filter the articles (required). |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Highlight | Boolean | If set to true matching query term in the title and excerpt will be highlighted using the {@code @@@hl@@@term@@@endhl@@@} syntax. Default: false. |
Organizations¶
This resource represents an organization.
Select¶
Note
This resource is marked as EXPERIMENTAL and may change without notice.
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | String | The ID of the organization. |
Name | String | The Name of the organization. |
ServiceDeskId | String | The ID of the service desk. |
QueueRequests¶
This resource returns the customer requests in a queue.
The connector exposes each queue in your service desk as a view. The static columns below are exposed for all of these views. Set IncludeCustomFields
to true in order to retrieve fields that may be specific to a queue.
Columns¶
Name | Type | Description |
---|---|---|
RequestId [KEY] | String | The ID of the request. |
RequestKey [KEY] | String | The Key of the request. |
Summary | String | The summary of the request. |
Status | String | The status of the request. |
Created | Datetime | The date the request was created. |
Requests¶
This resource represents a request.
Select¶
Set IncludeCustomFields
to true in order to retrieve fields and custom fields that are specific to a request type. By default, only the columns mentioned below will be pushed. Note that setting IncludeCustomFields
to true will decrease performance.
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
RequestID
supports the=
operator.RequestTypeID
supports the=
operator.ServiceDeskID
supports the=
operator.RequestOwnership
supports the=
operator.RequestStatus
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM Requests WHERE RequestID = '10001'
SELECT * FROM Requests WHERE RequestTypeID = '12'
SELECT * FROM Requests WHERE ServiceDeskID = '2'
SELECT * FROM Requests WHERE RequestOwnership = 'admin'
SELECT * FROM Requests WHERE RequestStatus = 'OPEN_REQUESTS'
Columns¶
Name | Type | Description |
---|---|---|
RequestId [KEY] | String | The ID of the request. |
RequestKey [KEY] | String | The Key of the request. |
RequestTypeId | String | The ID of the request type. |
ServiceDeskId | String | The ID of the service desk. |
CreatedDate | String | The date when the request is created. |
ReporterKey | String | The key of the reporter. |
ReporterDisplayName | String | The display name of the reporter. |
ReporterEmail | String | The email of the reporter. |
ReporterName | String | The name of the reporter. |
ReporterTimeZone | String | The time zone of the reporter. |
CurrentStatus | String | The current status of the request. |
RequestParticipants | String | The participants of the request. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
RequestOwnership | String | The owner of the request. The allowed values are OWNED_REQUESTS, PARTICIPATED_REQUESTS, ALL_REQUESTS. |
RequestStatus | String | The status of the request. The allowed values are CLOSED_REQUESTS, OPEN_REQUESTS, ALL_REQUESTS. |
RequestSLACycles¶
This resource represents the SLAs (service level agreements) on a customer request.
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | String | The ID of the SLA. |
RequestId [KEY] | String | The ID of the request. |
RequestKey [KEY] | String | The Key of the request. |
Name | String | The Name of the cycle. |
OngoingCycleStartTime | Datetime | Time and date at which the SLA cycle started. |
OngoingCycleBreached | Boolean | Indicates whether the SLA has been breached or not. |
OngoingCycleBreachTime | Datetime | Time and date at which the SLA cycle would have breached its limit. |
OngoingCyclePaused | Boolean | Indicates whether the SLA is paused or not. |
OngoingCycleWithinCalendarHours | Boolean | Indicates whether the SLA it timed during calendared working hours only or not |
OngoingCycleGoalDuration | String | Duration within which the service should be completed. |
OngoingCycleElapsedTime | String | Duration of the service. |
OngoingCycleRemainingTime | String | Duration remaining for the service to be completed. |
CompletedCycleStartTime | Datetime | Time and date at which the SLA cycle started. |
CompletedCycleStopTime | Datetime | Time and date at which the SLA cycle completed. |
CompletedCycleBreached | Boolean | Indicates whether the SLA has been breached or not. |
CompletedCycleBreachTime | Datetime | Time and date at which the SLA cycle breached in case of completed breached cycle or would have breached in case of non-breached completed cycle. |
CompletedCycleGoalDuration | String | Duration within which the service should have been completed. |
CompletedCycleElapsedTime | String | Duration in which the service was completed. |
CompletedCycleRemainingTime | String | Duration remaining after the service was completed. |
RequestStatusChangelog¶
This resource represents the status transitions for a customer request.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
RequestID
supports the=
operator.RequestKey
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM RequestStatusChangelog WHERE RequestID = '10001'
SELECT * FROM RequestStatusChangelog WHERE RequestKey = 'TEST-1'
Columns¶
Name | Type | Description |
---|---|---|
RequestId [KEY] | String | The ID of the request. |
RequestKey [KEY] | String | The Key of the request. |
Status | String | The status of the request. |
StatusDate | Datetime | The date of the request status. |
RequestTypeFields¶
The fields for a service desk's customer request type.
Columns¶
Name | Type | Description |
---|---|---|
ServiceDeskId | String | The ID of the service desk containing the request types whose fields are to be returned. |
RequestTypeId | String | The ID of the request types whose fields are to be returned. |
FieldId | String | ID of the field. |
Name | String | Name of the field. |
Description | String | Description of the field. |
Required | Boolean | Indicates if the field is required (true) or not (false). |
JiraSchema | String | Jira specific implementation details for the field in the UI. |
ValidValues | String | List of valid values for the field. |
DefaultValues | String | List of default values for the field. |
Visible | Boolean | Boolean incidating if the field is visible. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
Expand | String | Use expand to include additional information in the response. This parameter accepts hiddenFields that returns hidden fields associated with the request type. |
RequestTypeGroups¶
This resource represents a request type group.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
ServiceDeskId
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM RequestTypeGroups WHERE ServiceDeskId = '1'
Note
This resource is marked as EXPERIMENTAL and may change without notice.
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | String | The ID of the request type group. |
ServiceDeskId [KEY] | String | The ID of the service desk. |
Name | String | The Name of the request type group. |
RequestTypes¶
This resource represents a request type.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
ServiceDeskId
supports the=
operator.ID
supports the=
operator.GroupIds
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM RequestTypes WHERE ServiceDeskId = '1'
SELECT * FROM RequestTypes WHERE Id = '10012'
SELECT * FROM RequestTypes WHERE GroupIds = '12'
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | String | The ID of the request type. |
ServiceDeskId [KEY] | String | The ID of the service desk. |
GroupIds | String | The IDs of the groups that this request type is part of. |
Name | String | The Name of the request type. |
Description | String | The description of the request type. |
PortalId | String | The ID of the customer portal associated with the service desk project. |
IssueTypeId | String | The ID of the issue type the request type is based upon. |
Pseudo-Columns¶
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
---|---|---|
SearchQuery | String | String to be used to filter the results. |
ServiceDesks¶
This resource represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests.
Select¶
The connector will use the Jira Service Management API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.
Id
supports the=
operator.
For example, the following query is processed server side:
SELECT * FROM ServiceDesks WHERE ID = '1'
Columns¶
Name | Type | Description |
---|---|---|
Id [KEY] | String | The ID of the service desk. |
ProjectId | String | The ID of the project. |
ProjectName | String | The name of the project. |
ProjectKey | String | The key of the project. |
Users¶
This resource represents a user.
Select¶
Note
This resource is marked as EXPERIMENTAL and may change without notice.
Columns¶
Name | Type | Description |
---|---|---|
AccountId [KEY] | String | The Account ID of the user. |
OrganizationId [KEY] | String | The ID of the organization. |
EmailAddress | String | The Email address of the user. |
DisplayName | String | The display name of the user. |
Active | Boolean | Shows if a user is active. |
TimeZone | String | The time zone of the user. |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Jira Service Management.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Jira Service Management, along with an indication of whether the procedure succeeded or failed.
Jitterbit Connector for Jira Service Management Stored Procedures¶
Name | Description |
---|---|
AddAttachment | Creates a temporary attachment or assigns a temporary one to a request. |
AttachTemporaryFile | This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using AddAttachment stored procedure. |
CreateCustomer | Creates a new customer. |
CreateSchema | Creates a schema file for the specified table or view. |
GetOAuthAccessToken | Gets an authentication token from JIRA. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with JiraServiceDesk. |
AddAttachment¶
Creates a temporary attachment or assigns a temporary one to a request.
Input¶
Name | Type | Required | Description |
---|---|---|---|
RequestId | String | False | Set this to the request Id. |
RequestKey | String | False | Set this to the request Key. |
AttachmentId | String | True | Set this to the temporary attachment Id. |
Public | String | False | Set this to specify if the attachment will be public or internal. |
AdditionalComment | String | False | Set this to the body of the comment. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | String | The result of the procedure. |
AttachTemporaryFile¶
This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using AddAttachment stored procedure.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Source | String | False | The path of the file. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TemporaryAttachmentId | String | The ID of the temporary attachment. |
FileName | String | The file name. |
CreateCustomer¶
Creates a new customer.
Input¶
Name | Type | Required | Description |
---|---|---|---|
Email | String | False | The Email of the new customer. |
FullName | String | False | The full name of the new customer. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Key | String | The Key of the customer. |
AccountId | String | The ID of the account. |
Name | String | Name of the customer. |
EmailAddress | String | Email address of the customer. |
DisplayName | String | Display name of the customer. |
Active | String | Status of the customer. |
Timezone | String | Timezone of the customer. |
CreateSchema¶
Creates a schema file for the specified table or view.
CreateSchema¶
Creates a local schema file (.rsd) from an existing table or view in the data model.
The schema file is created in the directory set in the Location
connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.
The connector checks the Location
to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location
that does not match an existing table or view, a new table or view entry is added to the data model of the connector.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TableName | String | True | The name of the table or view. |
FileName | String | True | The full file path and name of the schema to generate. Ex : 'C:\Users\User\Desktop\JiraSD\DataSetTest.rsd' |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Returns Success or Failure. |
GetOAuthAccessToken¶
Gets an authentication token from JIRA.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | Enter either APP or WEB. The type of authentication mode to use. Set to APP to get authentication tokens via a desktop app. Set to WEB to get authentication tokens via a Web app. The default value is APP. |
Verifier | String | False | The verifier token returned by JIRA after using the URL obtained with GetOAuthAuthorizationURL. Required for only the Web AuthMode. |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Square API for a list of available permissions. The default value is read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access. |
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the JIRA app settings. |
AuthToken | String | False | The request token returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0. |
AuthKey | String | False | The request token secret returned by GetOAuthAuthorizationURL. Required for only the Web AuthMode. Used for OAuth 1.0. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The access token used for communication with JIRA. |
OAuthAccessTokenSecret | String | The access token secret used for communication with JIRA. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
CloudId | String | The Cloud ID for the Atlassian site that was authorized. |
ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the auth token from this URL.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. |
Scope | String | False | A comma-separated list of permissions to request from the user. Please check the JIRA API for a list of available permissions. The default value is read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access. |
State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the QuickBooksOnline authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
AuthToken | String | A token used as input for the GetOAuthAccessToken stored procedure to verify the request and get the access token. |
AuthKey | String | A key used as input for the GetOAuthAccessToken stored procedure to verify the request and get the secret key. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with JiraServiceDesk.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from JiraServiceDesk. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Jira Service Management:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Requests table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Requests'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
sys_procedureparameters¶
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SampleProcedure stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Requests table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Requests'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:jiraservicedesk:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Jira Service Management. |
URL | The URL to your JIRA Service Desk endpoint. |
User | The Jira Service Management user account used to authenticate. |
Password | The password used to authenticate the user. |
APIToken | APIToken of the currently authenticated user. |
Property | Description |
---|---|
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
SSOExchangeUrl | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
SSOAppName | App Name used with SSO for IdPs that require it. |
SSOAppPassword | App Password used with SSO for IdPs that require it. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
Scope | This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
CloudId | The Cloud ID for the Atlassian site that was authorized. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
CertificateStoreType | The type of certificate store used with Jira Service Desk Private Application authentication. |
CertificateStore | The certificate store used for JIRA Service Desk authentication. |
CertificateStorePassword | The password of the certificate store used with Jira Service Desk authentication. |
CertificateSubject | The subject of the certificate used with Jira Service Desk Private Application authentication. |
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Property | Description |
---|---|
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RequestLanguage | Use the requestLanguage to have column names translated in a specific language. |
ServiceDeskID | Service Desk ID of the currently authenticated user. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Jira Service Management. |
URL | The URL to your JIRA Service Desk endpoint. |
User | The Jira Service Management user account used to authenticate. |
Password | The password used to authenticate the user. |
APIToken | APIToken of the currently authenticated user. |
AuthScheme¶
The type of authentication to use when connecting to Jira Service Management.
Possible Values¶
Auto
, OAuth
, APIToken
, Basic
, Crowd
, OKTA
Data Type¶
string
Default Value¶
Auto
Remarks¶
- Auto: Lets the driver decide automatically based on the other connection properties you have set.
- OAuth: Set to this to perform OAuth authentication.
- APIToken: Set this to use basic User/APIToken authentication for Cloud instances.
- Basic: Set this to use basic User/Password authentication for Server instances.
- Crowd: Set this to perform Crowd SSO authentication.
URL¶
The URL to your JIRA Service Desk endpoint.
Data Type¶
string
Default Value¶
""
Remarks¶
The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net
.
User¶
The Jira Service Management user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Jira Service Management server.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
APIToken¶
APIToken of the currently authenticated user.
Data Type¶
string
Default Value¶
""
Remarks¶
APIToken of the currently authenticated user. You can retrieve an API Token in this link: https://id.atlassian.com/manage/api-tokens
SSO¶
This section provides a complete list of SSO properties you can configure.
Property | Description |
---|---|
SSOLoginURL | The identity provider's login URL. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
SSOExchangeUrl | The URL used for consuming the SAML response and exchanging it for service specific credentials. |
SSOAppName | App Name used with SSO for IdPs that require it. |
SSOAppPassword | App Password used with SSO for IdPs that require it. |
SSOLoginURL¶
The identity provider's login URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The identity provider's login URL.
SSOProperties¶
Additional properties required to connect to the identity provider in a semicolon-separated list.
Data Type¶
string
Default Value¶
""
Remarks¶
Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.
SSO configuration is discussed further in .
SSOExchangeUrl¶
The URL used for consuming the SAML response and exchanging it for service specific credentials.
Data Type¶
string
Default Value¶
""
Remarks¶
The Jitterbit Connector for Jira Service Management will use the URL specified here to consume a SAML response and exchange it for service specific credentials. The retrieved credentials are the final piece during the SSO connection that are used to communicate with Jira Service Management.
SSOAppName¶
App Name used with SSO for IdPs that require it.
Data Type¶
string
Default Value¶
""
Remarks¶
Along with SSOAppPassword, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.
SSOAppPassword¶
App Password used with SSO for IdPs that require it.
Data Type¶
string
Default Value¶
""
Remarks¶
Along with SSOAppName, may be be specified to identify and authenticate to your app configured in the SSO IdP. Currently only Crowd supports it.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthVersion | The version of OAuth being used. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
Scope | This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
CloudId | The Cloud ID for the Atlassian site that was authorized. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
AuthToken | The authentication token used to request and obtain the OAuth Access Token. |
AuthKey | The authentication secret used to request and obtain the OAuth Access Token. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
CertificateStoreType | The type of certificate store used with Jira Service Desk Private Application authentication. |
CertificateStore | The certificate store used for JIRA Service Desk authentication. |
CertificateStorePassword | The password of the certificate store used with Jira Service Desk authentication. |
CertificateSubject | The subject of the certificate used with Jira Service Desk Private Application authentication. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthVersion¶
The version of OAuth being used.
Possible Values¶
1.0
, 2.0
Data Type¶
string
Default Value¶
2.0
Remarks¶
The version of OAuth being used. The following options are available: 1.0,2.0
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
Scope¶
This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access.
Data Type¶
string
Default Value¶
""
Remarks¶
Specify scope to obtain the initial access and refresh token.
By default the connector will request that the user authorize all available scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
CloudId¶
The Cloud ID for the Atlassian site that was authorized.
Data Type¶
string
Default Value¶
""
Remarks¶
This will be determined automatically during OAuth 2.0 authentication and returned from the GetOAuthAccessToken stored procedure. Do not set a value for CloudId when using InitiateOAuth.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
AuthToken¶
The authentication token used to request and obtain the OAuth Access Token.
Data Type¶
string
Default Value¶
""
Remarks¶
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthKey in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
AuthKey¶
The authentication secret used to request and obtain the OAuth Access Token.
Data Type¶
string
Default Value¶
""
Remarks¶
This property is required only when performing headless authentication in OAuth 1.0. It can be obtained from the GetOAuthAuthorizationUrl stored procedure.
It can be supplied alongside the AuthToken in the GetOAuthAccessToken stored procedure to obtain the OAuthAccessToken.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
CertificateStoreType¶
The type of certificate store used with Jira Service Desk Private Application authentication.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_BLOB
, P10BFILE
, SSHPUBLIC_KEY_FILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
The name of the certificate store for the client certificate used in Jira Service Desk private application authentication. Jira Service Desk private application authentication uses SSL client authentication with digital certificates.
Specifying the Certificate Store Type¶
The CertificateStoreType
property can take one of the following values:
Property | Description |
---|---|
User - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
Machine | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFile | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBlob | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFile | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBlob | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKeyFile | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PublicKeyFile | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PublicKeyBlob | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPublicKeyBlob | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P10BFile | The certificate store is the name of a PKCS10 file containing certificates. |
SSHPublicKeyFile | The certificate store is the name of a file that contains an SSH-style public key. |
PPKFile | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFile | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBlob | The certificate store is a string that contains a certificate in XML format. |
Related Connection Properties¶
To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType
:
- CertificateStore: Set this to the name of the certificate store. For example, "MY" for a Windows certificate store or the file name of a file store.
- CertificateStorePassword: If the store is password-protected, provide the password here.
- CertificateSubject: Set this to the subject of the certificate. To locate the certificate in the store, the connector executes a search based on the specified subject. Refer to the CertificateSubject field for details.
CertificateStore¶
The certificate store used for JIRA Service Desk authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
The location of the certificate store for the client certificate used in Jira Service Desk application authentication.
CertificateStorePassword¶
The password of the certificate store used with Jira Service Desk authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
CertificateSubject¶
The subject of the certificate used with Jira Service Desk Private Application authentication.
Data Type¶
string
Default Value¶
""
Remarks¶
The subject of the client certificate used in Jira Service Desk private application authentication.
About the Jira Service Management Client SSL Auth Flow¶
Jira Service Desk private application authentication uses SSL client authentication with digital certificates.
Loading a Certificate¶
When loading a certificate the subject is used to locate the certificate in the store.
- If an exact match is not found, the store is searched for subjects containing the value of the property.
- If a match is still not found, no certificate is selected.
- The special value "*" picks the first certificate in the certificate store.
Specifying the Subject¶
The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=example@jbexample.com". Common fields and their meanings are displayed below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
Note: If a field value contains a comma it must be quoted.
Additional Connection Properties¶
To specify the private certificate, you need to set CertificateSubject
and the following additional properties:
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLClientCert¶
The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
Data Type¶
string
Default Value¶
""
Remarks¶
The name of the certificate store for the client certificate.
The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert
. If the store is password protected, specify the password in SSLClientCertPassword.
SSLClientCert
is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert
has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
Property | Description |
---|---|
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).
SSLClientCertType¶
The type of key store containing the TLS/SSL client certificate.
Possible Values¶
USER
, MACHINE
, PFXFILE
, PFXBLOB
, JKSFILE
, JKSBLOB
, PEMKEY_FILE
, PEMKEY_BLOB
, PUBLIC_KEY_FILE
, PUBLIC_KEY_BLOB
, SSHPUBLIC_KEY_FILE
, SSHPUBLIC_KEY_BLOB
, P7BFILE
, PPKFILE
, XMLFILE
, XMLBLOB
Data Type¶
string
Default Value¶
USER
Remarks¶
This property can take one of the following values:
Property | Description |
---|---|
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
SSLClientCertPassword¶
The password for the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
""
Remarks¶
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
SSLClientCertSubject¶
The subject of the TLS/SSL client certificate.
Data Type¶
string
Default Value¶
*
Remarks¶
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, E=support@company.com". The common fields and their meanings are shown below.
Field | Meaning |
---|---|
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\JiraServiceDesk Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\JiraServiceDesk Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
RequestLanguage | Use the requestLanguage to have column names translated in a specific language. |
ServiceDeskID | Service Desk ID of the currently authenticated user. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
IncludeCustomFields¶
A boolean indicating if you would like to include custom fields in the column listing.
Data Type¶
bool
Default Value¶
false
Remarks¶
Setting this to true will cause custom fields to be included in the column listing. To include the custom fields we need to make an individualized request per custom field and this may cause poor performance when listing metadata.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
RequestLanguage¶
Use the requestLanguage to have column names translated in a specific language.
Data Type¶
string
Default Value¶
""
Remarks¶
Use the requestLanguage to have column names translated in a specific language. By default, column names are translated based on the requesting user's language preference, or the Jira site default language if anonymous. The languages available are based on the installed languages in Jira. Provide an IETF BCP 47 language tag as described in this link: https://tools.ietf.org/html/bcp47
.
ServiceDeskID¶
Service Desk ID of the currently authenticated user.
Data Type¶
string
Default Value¶
""
Remarks¶
Service Desk ID of the currently authenticated user. By default we get the first ID returned from an extra call to get all service desks. You can get the ServiceDeskId by executing a Select query to the ServiceDesks view.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Requests WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.