---
schema_version: "1"
id: 37b1585b1117d654ce2bc379ff48ea67b4ae9fcbd82a229e81118ac3dc7a19f6
title: sapHanaSettings Entity
collection: tableau
version: current
locale: en-us
portal_url: https://docs.salesforce.com/tableau/current/en-us/server-linux/entity_sapHanaSettings.md
canonical_url: https://help.tableau.com/current/server-linux/en-us/entity_sapHanaSettings.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 0e180d21e133f258043057f5690d28b2654d0b589fdf84fee19f1528367d9686
description: Reference for the sapHanaSettings entity to configure SAP HANA SAML delegation.
---
[Skip to main content](#main-content)

# sapHanaSettings Entity

Use the sapHanaSettings entity to configure SAML delegation for SAP HANA.

Review [Configure SAP HANA SSO](https://help.tableau.com/current/server-linux/en-us/config_sap_hana_sso.htm) before you continue.

Use the configuration file template below to create a json file. After you have filled in the options with the appropriate values, pass the json file and apply settings with the following commands:

`tsm settings import -f path-to-file.json`

`tsm pending-changes apply`

If the pending changes require a server restart, the `pending-changes apply` command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case there is no restart. You can suppress the prompt using the `--ignore-prompt` option, but this does not change the restart behavior. If the changes do not require a restart, the changes are applied without a prompt. For more information, see [tsm pending-changes apply](https://help.tableau.com/current/server-linux/en-us/cli_pending-changes.htm#pending-changes-apply).

### SAP HANA SAML settings

The settings in the template below specify the settings for Tableau Server in a SAML delegation scenario with SAP HANA.

### Configuration template

Use this template to configure trusted authentication settings.

All that are referenced in configEntities must be located on the local computer. Do not specify UNC paths.

**Important:** All entity options are case sensitive.

For more explanation about configuration files, entities, and keys see [Configuration File Example](https://help.tableau.com/current/server-linux/en-us/config_file_example.htm).

{
  "configEntities": {
	"sapHanaSettings": {
	"\_type": "sapHanaSettingsType",
	"enabled": "true",
	"usernameFormat": "username",
	"usernameCase": "preserve",
	"certFile": "path-to-cert\_file",
	"keyFile": "path-to-key\_file"
	 }
	}
}		

### Configuration file reference

This table includes all of the options that can be included with the `"gatewaySettings"` entity set.

enabled

Required.

Values: `true` or `false`

usernameFormat

Values: `username`, `domain_and_username`, or `email`

Specifies user name credential format.

usernameCase

Values: `lower`, `upper`, or `preserve`

Specifies user input name case.

certFile

Specifies file path and name for the certificate file on the local computer.

For example, `"/var/opt/tableau/tableau_server/data/saml/saml_cert.crt"`.

keyFile

Specifies file path and name for the certificate key on the local computer.

For example, `"/var/opt/tableau/tableau_server/data/saml/saml_key.der"`.