This page provides a guide to Establishing a Connection to Jira Service Management in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Jira Service Management

Establishing a Connection shows how to authenticate to Jira Service Management and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Jira Service Management through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Jira Service Management by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting 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).

Accessing Custom Fields

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

Authenticating to Jira Service Management

Jira Service Management supports authentication through Basic, API Token, Crowd, OAuth 2.0, or Okta.

Basic

In Basic authentication the user logs in with credentials for a local server account. Set these connection properties:

• AuthScheme: Basic.
• User: The username of the authenticating user.
• Password: The authenticating user's password.

API Token

API Token authentication, used to connect to a Cloud account, requires you to generate and retrieve an APIToken. To do this, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token is displayed.

After you have created and obtained the API Token, set these connection properties:

• AuthScheme: APIToken.
• User: The username of the authenticating user.
• Password (Sever Instances only): The password of the authenticating user.
• APIToken: The API token you just retrieved.

Crowd

Set the AuthScheme to Crowd, then configure these connection properties:

• User: The CROWD user account.
• Password: The password associated with the Crowd account.
• SSOLoginURL: The login URL associated with the Crowd account. You can find the IDP URL by navigating to your application > SSO > SSO information > Identity provider single sign-on URL.
• 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 Jira Service Management cookies. This URL may have the following formats:
  • https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer
  • https://<authority of Jira Service Management instance>/plugins/servlet/samlsso

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 Jira Service Management instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

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. Using OAuth 2.0 authentication requires you to create and configure a custom OAuth application, as described in Creating a Custom OAuth Application.

Okta

To connect to Okta, set these properties:

• AuthScheme: Okta.
• User: The authentiating Okta user.
• Password: The password of the authenticating Okta user.
• SSOLoginURL: The SSO provider's login URL.
• SSOExchangeURL: The URL used used to exchange the SAML token for Jira Service Management cookies. This URL may have the following formats:
  • https://<authority of Jira Service Management instance>/plugins/servlet/samlconsumer
  • https://<authority of Jira Service Management instance>/plugins/servlet/samlsso

If you are either 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, or SMS.
• 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 Cloud 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 Cloud sends a device token to extend MFA authentication lifetime. If you do not want MFA to be remembered, set this variable to False.

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 Jira Service Management instance>/plugins/servlet/samlconsumer;

Creating a Custom OAuth Application

Jira Service Management uses the OAuth 2.0 authentication standard, which requires the authenticating user to interact with Jira Service Management via the browser.

To obtain the OAuth client credentials, consumer key, and consumer secret:

1. Log in to your Jira Service Management site.
2. Navigate to your application management: https://developer.atlassian.com/apps/.
3. Select Create new app.
4. Name the new application.
5. Navigate to APIS AND FEATURES. Click + Add then select Add OAuth 2.0 (3LO).
6. Still in APIS AND FEATURES, click + Add and add JIRA Service Management platform REST API.
7. To get all the functionalities of the driver, click + Add and add the JIRA application to your custom application.
8. Add the desired scopes to your custom application.
9. To set up your Callback URL, navigate to APIS AND FEATURES > OAuth 2.0 (3LO). Enter a callback URL that is accessible to your application.
10. Save your changes.

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.

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Jira Service Management Cloud 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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to Jira Service Management APIs.

Key Features

• The Cloud 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 Cloud.

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.

The Cloud models the data in Jira Service Management as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - 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.

Returns a list of transitions that customers can perform on the request.

Select

The Cloud 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 Cloud.

• 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.

This resource represents a request approval.

Select

Note: This resource is marked as EXPERIMENTAL and may change without notice.

The Cloud 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 Cloud.

• 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.

This resource represents request comments.

Select

The Cloud 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 Cloud.

• Id, Public and Internal 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'

When Public and Internal are specified as filters in the query, the API knows whether to include Public/Internal columns in the response.

The following query will include both public and internal comments in the response:

SELECT * FROM RequestComments WHERE RequestId = '10001'

The following query will include only internal comments in the response:

SELECT * FROM RequestComments WHERE RequestId = '10001' AND Public = false

The following query will include all public comments but not the internal ones:

SELECT * FROM RequestComments WHERE RequestId = '10001' AND Internal = false

The following query will include neither internal nor public comments in the response:

SELECT * FROM RequestComments WHERE RequestId = '10001' AND Internal = false AND Public = false

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.

This resource represents request participants.

Select

The Cloud 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 Cloud.

• 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 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.

CData Cloud - 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.
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.
SampleQueueRequests	This resource returns the customer requests in a queue.
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.

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.

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.

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.

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 Cloud 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 Cloud.

• 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.

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.

This resource represents the status transitions for a customer request.

Select

The Cloud 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 Cloud.

• 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.

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.

This resource represents a request type group.

Select

The Cloud 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 Cloud.

• 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.

This resource represents a request type.

Select

The Cloud 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 Cloud.

• 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.

This resource returns the customer requests in a queue.

The Cloud exposes each queue in your service desk as a view. The static columns below represent a template for the columns that are exposed for all of these views. Set IncludeCustomFields to true to retrieve fields that are 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.

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 Cloud 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 Cloud.

• 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.

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 are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - 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.

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.

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.

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.

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 Cloud 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.

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.

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.

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.

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.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

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.

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

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SampleProcedure' AND IncludeResultColumns='True'

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.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric 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.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native Jira Service Management procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

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.

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.

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.

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.

Returns information on the available connection properties and those set in the connection string.

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.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

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
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
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 CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData 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.

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.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string 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 in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Jira Service Management.
URL	The URL to your JIRA Service Management endpoint.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
APIToken	APIToken of the currently authenticated user.

SSO

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as 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.

OAuth

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
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.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Jira Service Management.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RequestLanguage	Use the requestLanguage to have column names translated in a specific language.
ServiceDeskID	Service Desk ID of the currently authenticated user.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	The type of authentication to use when connecting to Jira Service Management.
URL	The URL to your JIRA Service Management endpoint.
User	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.
APIToken	APIToken of the currently authenticated user.

The type of authentication to use when connecting to Jira Service Management.

Possible Values

OAuth, APIToken, Basic, Crowd, OKTA

Data Type

string

Default Value

"Basic"

Remarks

• 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.
• OKTA: Set this to perform OKTA SSO authentication.

The URL to your JIRA Service Management endpoint.

Data Type

string

Default Value

""

Remarks

The URL to your JIRA Service Management endpoint; for example, https://yoursitename.atlassian.net.

Specifies the authenticating user's user ID.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Data Type

string

Default Value

""

Remarks

The authenticating server requires both User and Password to validate the user's identity.

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

This section provides a complete list of the SSO properties you can configure in the connection string for this provider.

---

Property	Description
SSOLoginURL	The identity provider's login URL.
SSOProperties	Additional properties required to connect to the identity provider, formatted as 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.

The identity provider's login URL.

Data Type

string

Default Value

""

Remarks

The identity provider's login URL.

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

Data Type

string

Default Value

""

Remarks

Additional properties required to connect to the identity provider, formatted as a semicolon-separated list.

This is used with the SSOLoginURL.

SSO configuration is discussed further in .

The URL used for consuming the SAML response and exchanging it for service specific credentials.

Data Type

string

Default Value

""

Remarks

The CData Cloud 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.

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.

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.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
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.

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Data Type

string

Default Value

""

Remarks

This property is required in two cases:

• When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
• If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Data Type

string

Default Value

""

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

• This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
• Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

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.

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.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Jira Service Management.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RequestLanguage	Use the requestLanguage to have column names translated in a specific language.
ServiceDeskID	Service Desk ID of the currently authenticated user.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the maximum number of records per page the provider returns when requesting data from Jira Service Management.

Data Type

int

Default Value

5000

Remarks

When processing a query, instead of requesting all of the queried data at once from Jira Service Management, the Cloud can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Cloud requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

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 .

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.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.