CData Cloud offers access to Jira Service Management across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Jira Service Management through CData Cloud.
CData Cloud allows you to standardize and configure connections to Jira Service Management as though it were any other OData endpoint, or standard SQL Server/MySQL database.
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.
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 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.
You can establish a connection to any Jira Service Management Cloud account or Jira Service Management Server instance. To connect set the following property:
By default, the Cloud surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields.
To authenticate with a local server account, specify the following connection properties:
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:
Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.
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.
Set the AuthScheme to Crowd. The following connection properties are used to connect to Crowd:
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;
To connect to Okta, set the AuthScheme to Okta, and set these properties:
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:
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;
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.
To obtain the OAuth client credentials, consumer key, and consumer secret:
You can use the following properties to gain more control over the data returned from Jira Service Management:
By default, the Cloud 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.
The Jira Service Management Cloud also supports setting client certificates. Set the following to connect using a client certificate.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Jira Service Management APIs.
Tables describes the available tables. Tables are statically defined to model Jira Service Management entities such as RequestApprovals, RequestComments, and RequestParticipants.
Views describes the available views. Views are statically defined to model Jira Service Management entities such as Users, Organizations, and ServiceDesks.
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.
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.
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.
SELECT * FROM CustomerTransitions WHERE RequestID = '10001'
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.
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.
SELECT * FROM RequestApprovals WHERE RequestID = '10001' AND Id = '10002'
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.
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.
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002' SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'
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 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.
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.
SELECT * FROM RequestParticipants WHERE RequestID = '10001'
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.
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. |
This resource represents a customer.
Note: This resource is available only for Cloud instances.
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.
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 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.
Note: This resource is marked as EXPERIMENTAL and may change without notice.
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 returns the customer requests in a queue.
The Cloud 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.
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 request.
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.
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'
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 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.
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.
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.
SELECT * FROM RequestStatusChangelog WHERE RequestID = '10001' SELECT * FROM RequestStatusChangelog WHERE RequestKey = 'TEST-1'
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.
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 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.
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.
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.
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.
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.
SELECT * FROM RequestTypes WHERE ServiceDeskId = '1' SELECT * FROM RequestTypes WHERE Id = '10012' SELECT * FROM RequestTypes WHERE GroupIds = '12'
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 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 represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests.
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.
SELECT * FROM ServiceDesks WHERE Id = '1'
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.
Note: This resource is marked as EXPERIMENTAL and may change without notice.
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.
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.
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. |
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.
Name | Type | Required | Description |
Source | String | False | The path of the file. |
Name | Type | Description |
TemporaryAttachmentId | String | The Id of the temporary attachment. |
FileName | String | The file name. |
Creates a new customer.
Name | Type | Required | Description |
String | False | The Email of the new customer. | |
FullName | String | False | The full name of the new customer. |
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.
The following tables return database metadata for Jira Service Management:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
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
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'
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. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
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
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. |
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'
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'
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
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'
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.
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 <> ''
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.
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.
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
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. |
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.
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 |
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. |
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. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
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. |
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. |
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 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. |
The type of authentication to use when connecting to Jira Service Management.
string
"Basic"
The URL to your JIRA Service Desk endpoint.
string
""
The URL to your JIRA Service Desk endpoint; for example, https://yoursitename.atlassian.net.
The Jira Service Management user account used to authenticate.
string
""
Together with Password, this field is used to authenticate against the Jira Service Management server.
The password used to authenticate the user.
string
""
The User and Password are together used to authenticate with the server.
APIToken of the currently authenticated user.
string
""
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 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. |
The identity provider's login URL.
string
""
The identity provider's login URL.
Additional properties required to connect to the identity provider in a semicolon-separated list.
string
""
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 .
The URL used for consuming the SAML response and exchanging it for service specific credentials.
string
""
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.
string
""
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.
string
""
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 | 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. |
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. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
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.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
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.
The authentication token used to request and obtain the OAuth Access Token.
string
""
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.
string
""
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 | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
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.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the 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 | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
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. |
A boolean indicating if you would like to include custom fields in the column listing.
bool
false
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.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
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, "*=*".
Use the requestLanguage to have column names translated in a specific language.
string
""
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.
string
""
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.
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
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 Cloud throws an exception.