AdditionalServerProperties

Additional data source connection properties and settings used OPTIONALLY for different server types.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

customTrustStore

Path to custom java trust store (in Pyramid server filesystem)

 -

string

certValidationCustomRootCaType

The type of the custom root CA to use when validating the server's certificate

 -

CustomRootCAType

disableDBTables

Disable database tables - SAP HANA

 -

boolean

hierarchyType

Hierarchy treatment - SAP HANA

 -

HierarchyType

defaultTrustStorePassword

Password for the default trust store

 -

string

salesforceSecurityToken

Salesforce security token

 -

string

krbServiceName

service principal name for kerberos authentication

 -

string

disableAnalyticViews

Disable analytic views - SAP HANA

 -

boolean

googleAnalyticsType

Google Analytics version

 -

GaType

msOlapConnectionType

Configure the manner in which the SSAS server is configured to receive used for OLAP and Tabular

 -

MsOlapConnectionType

bwSupportStructures

Elect whether to "enable" characteristic structures, for SAP BW

 -

boolean

messageServerHost

Sap BW "Message server" connection - Server host

 -

string

ftpSettings

settings for FTP server connections

 -

FtpSettings

customKeyStoreType

Custom keystore type (JKS / PKCS12)

 -

string

sapBwServerConnectionType

Sap BW connection types: the typical "application server" connection or the "Message server" connection

 -

SapBwServerConnectionType

sharedFolderPath

Shared Folder Path for temporary file for bulk uploads

 -

string

showInfoAreaTree

Deprecated: use BwInfoAreaViewType

 -

boolean

shouldValidateServerCertHostname

Should validate the server certificate's hostname

 -

boolean

hdfsPort

Hadoop HDFS port number

 -

integer

int32

hdfsIP

Hadoop HDFS IP address

 -

string

mdxCompatibility

MDX compatibility mode

 -

integer

int32

keytabPath

The name of the keytab to use

 -

string

s3StagingDir

s3 destination for Athena query results

 -

string

systemR3Name

Sap BW "Message server" connection - System (R3) Name

 -

string

customJdbcId

Required when serverType is CustomJdbc and specifies which custom jdbc it is

-

string

uuid

sysNumber

Sys number connection parameter for SAP BW

 -

string

bringNonOleDbComponents

Include components eithout 'OLE DB for OLAP' access, for SAP BW

 -

boolean

messageServerService

Sap BW "Message server" connection - Server service

 -

string

quotaProjectId

quota project id for bigquery

 -

string

bulkWritingType

Bulk copy method (Synapse connection only)

 -

BulkWritingType

useClientCertificate

Should the client use an ssl certificate?

 -

boolean

isCustomTrustStore

Using a different java trust store than the java VM trust store?

 -

boolean

awsBucketName

Bucket name for uploading temp files for Redshift, BigQuery and Synapse

 -

string

customJdbcProps

Key:Value collection of custom properties for custom JDBC connection (as defined by Custom JDBC admin page)

-

[string] [string]

clientKeyPath

Path to the client's key

 -

string

bwDataBaseListTechnique

Choose which type of Database ('info-provider') listing technique to use

 -

BwDatabaseListType

warehouse

Warehouse name (required for Snowflake connection only)

 -

string

accessToken

Access token for facebook connection

 -

string

customTrustStorePassword

Trust store password

 -

string

isOperatingSystemTrustStore

Using a Operating System trust store instead of java VM trust store

 -

boolean

isDatabaseSchema

Treat schemas names as database names in Pyramid

 -

boolean

useSSL

Use SSL to connect

 -

boolean

accountId

Account ID

 -

string

odbcDirectQueryOptions

Direct query options for ODBC direct query connections

 -

OdbcDirectQueryOptions

avoidMultiPassAuthentication

Multi Pass Authentication can be used to cascade through multiple authentication options, such as username/ password. for OLAP and Tabular

 -

boolean

urlPortal

URL portal property for SAP BW

 -

string

privateCertId

Id of private/public certificate pair associated with imdb instance

 -

string

supportsBwFlatQueries

Elect whether to enable the optimized execution modes, for SAP BW

 -

boolean

bwInfoAreaTreeViewType

Configures the SAP BW server instance to support different views in the databases panel

 -

BwInfoAreaTreeViewType

shouldValidateServerCert

Should validate Server certificate

 -

boolean

sapRouter

SAP Router property for SAP BW

 -

string

timezone

Override timezone for session

 -

string

disableCalculationViews

Disable calculation views - SAP HANA

 -

boolean

sncPartnerName

SNC partner name parameter for SAP BW

 -

string

groupServer

Sap BW "Message server" connection - Group/Server

 -

string

isOverrideConnectionString

Should we override the connection string - if so, use optionalJdbcParameters to specify the full JDBC connection string

 -

boolean

consumerSecret

Consumer secret for facebook and salesForce connection

 -

string

isCustomKeyStore

Using a different keystore than the java VM keystore?

 -

boolean

customTrustStoreType

Custom truststore type (JKS / PKCS12)

 -

string

azureTabular

Mark true if it is Azure Tabular

 -

boolean

disableAttributeViews

Disable attribute views - SAP HANA

 -

boolean

customCertHostname

Hostname in certificate that we should validate

 -

string

consumerKey

Customer key for SalesForce connection

 -

string

clientCertPath

Path to the client's certificate

 -

string

awsSecretAccessKey

Secret access key for Redshift, Athena and Synapse

 -

string

isCustomCertHostname

Should validate a different hostname than the server hostname

 -

boolean

oauthDataSourceSettings

oAuth settings

 -

OauthDataSourceSettings

hiveIP

Hadoop HIVE IP address

 -

string

defaultCulture

Language option for SAP HANA and BW

 -

string

awsRegion

Region of Athena connection

 -

string

bwInfoAreaIconIds

Custom data source types to include in info area tree, for SAP BW

 -

string

useCustomCertificateConfig

Specify whether to customize the certificate configuration

 -

boolean

awsAccessKeyId

Access key for Redshift, Athena and Synapse

 -

string

roleId

Role ID

 -

string

hivePort

Hadoop HIVE port number

 -

integer

int32

clientNumber

Custom client parameter for SAP HANA and BW

 -

string

keytabId

The id of the keytab to use

 -

string

uuid

proxyAccountInUse

Relevant for OLAP, Tabular, Snowflake and SAP BW; specify the effective proxy account to use for connection when supported by the auth type

 -

ServerEffectiveUserName

relativeFolderName

Relative Folder Path

 -

string

customKeyStore

Path to custom keystore (in Pyramid server filesystem)

 -

string

sparkTransportMode

Transport mode for Spark connection: Binary, SASL or HTTP or HTTPS

 -

SparkTransportMode

clientKeyPassword

Password for the client's key

 -

string

allowHighDataRate

allow using BigQuery Storage API for faster (but more expensive) data extraction

 -

boolean

customKeyStorePassword

Keystore password

 -

string

machineAccountFallback

Allow fallback of multi-pass authentication for olap to the machine account

 -

boolean

authMethod

relevant to olap datasources, specify the auth method used against the cube for end user

 -

CubeAuthMethod

customRootCaCert

Custom root CA certificate used to validate the server's certificate

 -

string