31. Jira
31.1. Connection Options
31.1.1. Authentication
Property
Description
AuthScheme
The type of authentication to use when connecting to Jira Service Desk.
URL
The URL to your JIRA Service Desk endpoint.
User
The Jira Service Desk user account used to authenticate.
Password
The password used to authenticate the user.
APIToken
APIToken of the currently authenticated user.
31.1.2. 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 with Jira Service Desk specific credentials.
SSOAppName
App Name used with SSO for IdPs that require it.
SSOAppPassword
App Password used with SSO for IdPs that require it.
31.1.3. OAuth
Property
Description
InitiateOAuth
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthVersion
The version of OAuth being used.
OAuthClientId
The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret
The client secret assigned when you register your application with an OAuth authorization server.
OAuthVerifier
The verifier code returned from the OAuth authorization URL.
AuthToken
The authentication token used to request and obtain the OAuth Access Token.
AuthKey
The authentication secret used to request and obtain the OAuth Access Token.
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.
31.1.4. 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.
31.1.5. 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.
31.1.6. Proxy
Property
Description
ProxyAutoDetect
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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 .
31.1.7. Logging
Property
Description
Logfile
A filepath which designates the name and location of the log file.
Verbosity
The verbosity level that determines the amount of detail included in the log file.
LogModules
Core modules to be included in the log file.
MaxLogFileSize
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCount
A string specifying the maximum file count of log files.
31.1.8. 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.
31.1.9. Caching
Property
Description
AutoCache
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProvider
The name of the provider to be used to cache data.
CacheConnection
The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data.
CacheLocation
Specifies the path to the cache when caching to a file.
CacheTolerance
The tolerance for stale data in the cache specified in seconds when using AutoCache .
Offline
Use offline mode to get the data from the cache instead of the live source.
CacheMetadata
This property determines whether or not to cache the table metadata to a file store.
31.1.10. Miscellaneous
Property
Description
DefaultDomain
This property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetection
Whether to detect the foreign keys in ODBC.
IncludeCustomFields
A boolean indicating if you would like to include custom fields in the column listing.
IncludeDualTable
Set this property to mock the Oracle DUAL table for better compatibility with Oracle database.
LimitKeySize
The maximum length of a primary key column.
MapBigintToVarchar
This property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToInt
This property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarchar
This property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarchar
This property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSize
The maximum column size.
MaxRows
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
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.
Readonly
You can use this property to enforce read-only access to Jira Service Desk from the provider.
RequestLanguage
Use the requestLanguage to have column names translated in a specific language.
RTK
The runtime key used for licensing.
ServiceDeskID
Service Desk ID of the currently authenticated user.
SupportEnhancedSQL
This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout
The value in seconds until the timeout error is thrown, canceling the operation.
UpperCaseIdentifiers
This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.