Adding a Connection to Jira Service Management

To add a connection to Jira Service Management:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Jira Service Management icon is not available, click the Add More icon to download and install the Jira Service Management connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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 Sync App surfaces only system fields. To access the custom fields for Issues, set IncludeCustomFields.

Authenticating to Jira Service Management

Basic

To authenticate with a local server account, specify the following connection properties:

• AuthScheme: Set this to Basic.
• User: Set this to the username of the authenticating user.
• Password: Set this to the password of the authenticating user.

API Token

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

Supply the following to connect to data:

• AuthScheme: Set this to APIToken.
• User: Set this to the username of the authenticating user.
• APIToken: Set this to your previously noted API token.

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

OAuth 2.0

You can leverage Jira Service Management's "three-legged" OAuth 2.0 support (3LO) to connect to data without providing your login credentials.

AuthScheme must be set to OAuth in all OAuth flows. Also, in all scenarios, you must create and configure a custom OAuth application. See Creating a Custom OAuth App for more information.

Crowd

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

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

The following is an example connection string:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Okta

To connect to Okta, set the AuthScheme to Okta, and set these properties:

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

If you are using a trusted application or proxy that overrides the Okta client request OR configuring MFA, you must use combinations of SSOProperties to authenticate using Okta. Set any of the following, as applicable:

• APIToken: When authenticating a user via a trusted application or proxy that overrides the Okta client request context, set this to the API Token the customer created from the Okta organization.
• MFAType: If you have configured the MFA flow, set this to one of the following supported types: OktaVerify, Email, 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 Sync App 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 Sync App 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 JiraServiceDesk instance>/plugins/servlet/samlconsumer;

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.

This section details a selection of advanced features of the Jira Service Management Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Jira Service Management and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Client SSL Certificates

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

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 Sync App 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 Sync App.

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 Sync App models the data in Jira Service Management as a list of tables in a relational database that can be queried using standard SQL statements.

Jira Service Management Connector for CData Sync 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 Sync App 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 Sync App.

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

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

• Id and Public support the following operator: =.

For example, the following query is processed server side:

SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002'
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the comment.
RequestId [KEY]	String	True	The Id of the request.
RequestKey	String	True	The Key of the request.
Body	String	False	The Body of the comment.
Public	Boolean	True	Shows if the comment is public or internal
AuthorKey	String	True	The key of the comment author.
CreatedAt	String	True	The datetime the comment was created.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Internal	Boolean	Specifies whether to return internal comments or not. Default: true.

This resource represents request participants.

Select

The Sync App 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 Sync App.

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

Jira Service Management Connector for CData Sync Views

Name	Description
Customers	This resource represents a customer.
KnowledgeBaseArticles	The articles which match the given query string across all service desks.
Organizations	This resource represents an organization.
QueueRequests	This resource returns the customer requests in a queue.
Requests	This resource represents a request.
RequestSLACycles	This resource represents the SLAs (service level agreements) on a customer request.
RequestStatusChangelog	This resource represents the status transitions for a customer request.
RequestTypeFields	The fields for a service desk's customer request type.
RequestTypeGroups	This resource represents a request type group.
RequestTypes	This resource represents a request type.
ServiceDesks	This resource represents a service desk. A service desk is based on a project in the JIRA platform, and is used to manage customer requests.
Users	This resource represents a user.

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 returns the customer requests in a queue.

The Sync App exposes each queue in your service desk as a view. The static columns below are exposed for all of these views. Set IncludeCustomFields to true in order to retrieve fields that may be specific to a queue.

Columns

Name	Type	Description
RequestId [KEY]	String	The ID of the request.
RequestKey [KEY]	String	The Key of the request.
Summary	String	The summary of the request.
Status	String	The status of the request.
Created	Datetime	The date the request was created.

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 Sync App 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 Sync App.

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

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

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

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

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

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

SSO

---

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.

OAuth

---

Property	Description
OAuthVersion	The version of OAuth being used.
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access.
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.
CertificateStoreType	The type of certificate store used with Jira Service Desk Private Application authentication.
CertificateStore	The certificate store used for JIRA Service Desk authentication.
CertificateStorePassword	The password of the certificate store used with Jira Service Desk authentication.
CertificateSubject	The subject of the certificate used with Jira Service Desk Private Application authentication.

SSL

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
IncludeCustomFields	A boolean indicating if you would like to include custom fields in the column listing.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RequestLanguage	Use the requestLanguage to have column names translated in a specific language.
ServiceDeskID	Service Desk ID of the currently authenticated user.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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.

Remarks

• Auto: Lets the driver decide automatically based on the other connection properties you have set.
• OAuth: Set to this to perform OAuth authentication.
• APIToken: Set this to use basic User/APIToken authentication for Cloud instances.
• Basic: Set this to use basic User/Password authentication for Server instances.
• Crowd: Set this to perform Crowd SSO authentication.

The URL to your JIRA Service Desk endpoint.

Remarks

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

The Jira Service Management user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Jira Service Management server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

APIToken of the currently authenticated user.

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

Remarks

The identity provider's login URL.

Additional properties required to connect to the identity provider in a semicolon-separated list.

Remarks

Additional properties required to connect to the identity provider in a semicolon-separated list. is used in conjunction with the SSOLoginURL.

SSO configuration is discussed further in .

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

Remarks

The CData Sync App 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.

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.

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
OAuthVersion	The version of OAuth being used.
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.
Scope	This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access.
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.
CertificateStoreType	The type of certificate store used with Jira Service Desk Private Application authentication.
CertificateStore	The certificate store used for JIRA Service Desk authentication.
CertificateStorePassword	The password of the certificate store used with Jira Service Desk authentication.
CertificateSubject	The subject of the certificate used with Jira Service Desk Private Application authentication.

The version of OAuth being used.

Remarks

The version of OAuth being used. The following options are available: 1.0,2.0

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This determines the scopes that the OAuth application requests from Jira Service Management. This determines the scopes that the OAuth application requests from Jira Service Management. The default scopes are: read:jira-work write:jira-work manage:jira-configuration read:jira-user write:jira-work manage:jira-project read:servicedesk-request write:servicedesk-request manage:servicedesk-customer offline_access.

Remarks

Specify scope to obtain the initial access and refresh token.

By default the Sync App will request that the user authorize all available scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes.

The authentication token used to request and obtain the OAuth Access Token.

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.

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.

The type of certificate store used with Jira Service Desk Private Application authentication.

Remarks

The name of the certificate store for the client certificate used in Jira Service Desk private application authentication. Jira Service Desk private application authentication uses SSL client authentication with digital certificates.

Specifying the Certificate Store Type

The CertificateStoreType property can take one of the following values:

User - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
Machine	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFile	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBlob	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFile	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBlob	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKeyFile	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PublicKeyFile	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PublicKeyBlob	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPublicKeyBlob	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P10BFile	The certificate store is the name of a PKCS10 file containing certificates.
SSHPublicKeyFile	The certificate store is the name of a file that contains an SSH-style public key.
PPKFile	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFile	The certificate store is the name of a file that contains a certificate in XML format.
XMLBlob	The certificate store is a string that contains a certificate in XML format.

Related Connection Properties

To specify the private certificate, you may need to set the following properties in addition to CertificateStoreType:

• CertificateStore: Set this to the name of the certificate store. For example, "MY" for a Windows certificate store or the file name of a file store.
• CertificateStorePassword: If the store is password-protected, provide the password here.
• CertificateSubject: Set this to the subject of the certificate. To locate the certificate in the store, the Sync App executes a search based on the specified subject. Refer to the CertificateSubject field for details.

The certificate store used for JIRA Service Desk authentication.

Remarks

The location of the certificate store for the client certificate used in Jira Service Desk application authentication.

The password of the certificate store used with Jira Service Desk authentication.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the certificate used with Jira Service Desk Private Application authentication.

Remarks

The subject of the client certificate used in Jira Service Desk private application authentication.

About the Jira Service Management Client SSL Auth Flow

Jira Service Desk private application authentication uses SSL client authentication with digital certificates.

Loading a Certificate

When loading a certificate the subject is used to locate the certificate in the store.

• If an exact match is not found, the store is searched for subjects containing the value of the property.
• If a match is still not found, no certificate is selected.
• The special value "*" picks the first certificate in the certificate store.

Specifying the Subject

The certificate subject is a comma-separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

Note: If a field value contains a comma it must be quoted.

Additional Connection Properties

To specify the private certificate, you need to set CertificateSubject and the following additional properties:

• CertificateStore
• CertificateStoreType
• CertificateStorePassword

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

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

The type of key store containing the TLS/SSL client certificate.

Remarks

This property can take one of the following values:

USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the TLS/SSL client certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

The subject of the TLS/SSL client certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

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

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

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 Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Jira Service Management and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\JiraServiceDesk Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

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.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RequestLanguage	Use the requestLanguage to have column names translated in a specific language.
ServiceDeskID	Service Desk ID of the currently authenticated user.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

A boolean indicating if you would like to include custom fields in the column listing.

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.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Use the requestLanguage to have column names translated in a specific language.

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.

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.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Requests WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.