MTA Module Types, Resource Types, and Parameters for Applications in the Neo Environment

Remember:

SAP Business Technology Platform, Neo environment will sunset on December 31, 2028, subject to terms of customer or partner contracts.

For more information, see SAP Note 3351844.

Tip:

This documentation refers to SAP Business Technology Platform, Neo environment. If you are looking for documentation about other environments, see SAP Business Technology Platform ↗️.

Tip:

This section contains collapsible subsections. By clicking on the arrow-shaped icon next to a subsection, you can expand it to see additional information.

This section contains the parameters and options that can be used to compose the structure of an MTA deployment descriptor or an MTA extension descriptor.

Note:

As both descriptor types use the YAML file format, strictly adhere to the following syntax practices:

The parameter names are case-sensitive

The indents and spacing are specific

Supported Target Platform Options

The supported target platform options describe general behavior and information about the deployed Multitarget Application. The according options are placed within the primary part of the МТА deployment descriptor or МТА extension descriptor. That is, they are not placed within any modules or resources.

Note:

Note that any sensitive data should be placed within the MTA extension descriptor.

To ensure that numeric values, such as product version and IDs, are not automatically interpreted as numbers, always wrap them in single quotes.

Option		Description	Type	Default Value	Mandatory
`_schema-version`		Version of the MTA specification to which the MTA deployment descriptor complies. The current supported versions by the SAP Business Technology Platform(SAP BTP) are: `2.1` `3.1`	Enclosed String, use single quotes	n/a	yes
`ID`		The identifier of the deployed artifact. The ID should follow the convention for a reverse-URL dot-notation, and it has to be unique within a particular subaccount.	String	n/a	yes
`extends`		Used in MTA extension descriptor to denote which MTA deployment descriptor should be extended. Applicable only in extension descriptors.	String	The ID of the deployment descriptor that is to be extended	yes
`version`		Version of the current Multitarget Application. The format of the version is a numeric string of `<major>.<minor>.<micro>` Note: The value must not exceed 64 symbols.	Enclosed String, use single quotes	n/a	yes
`parameters:`	`hcp-deployer-version`	Version of the deploy service of the (SAP BTP) . This version differs from the schema version. The current supported versions are: `1.0.0` `1.1.0` `1.2.0` Note: Deployer version `1.0.0` is going to be deprecated. Use version `1.1.0` and higher. During a solution update, a different technical approach is employed. For more information, see General Information About Solution Updates.	Enclosed String, use single quotes	n/a	yes
	`title`	Human-readable title of the application.	The ID of the Multitarget Application	n/a	no
	`description`	Human-readable description of the application.	String	n/a	no
	`logo`	Base64-encoded logotype image. Optimize your image to be displayed for size 45x45 pixels. The supported formats are: png jpeg gif The following syntax is for a `.png` logotype that has been encoded in Base64: Example: `logo: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFoAAABaCAMAAAAPdrEwAAAAnFBMVEX///..."`	String	n/a	no

Supported Multitarget Application Module Types

This section contains the modules that are supported by the SAP BTP and their parameters and properties.

Note:

The relation between a module and the entities created in the SAP BTP is not one-to-one, that is, it is possible for one module to contain several SAP BTP entities and vice versa.

Any security-sensitive data, such as user credentials and passwords, has to be placed in the MTA extension descriptor.

Supported Module Types and Parameters

Tip:

Expand the following subsections by clicking on the arrow-shaped element to see the available parameters and values.

The following module types are currently supported:

`com.sap.hcp.html5` - used for deploying HTML5 applications

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`name`	HTML5 application name, which has to be unique within the current subaccount.	String	n/a	yes
`display-name`	Human-readable name of the application. Note: The `display-name` and `name` parameters belong to an application level that is different from the one of the application versions. If another application version is defined in the MTA deployment descriptor, then its display name has to be identical to display names of other already defined versions of the application or has to be omitted.	String	n/a	no
`version`	Application version to be used in the HTML5 runtime. Java HTML5 modules that are used for deploying and have the same version can be deployed only once. In the `version` parameter, the usage of a <timestamp> read-only variable is supported. Thus, a new version string is generated with every deploy. For example, version: `'0.1.0-${timestamp}'`.	String	n/a	yes
`active`	This flag indicates whether the related version of the application should be activated or not. The default value is `true`.	Boolean	`true`	no
`description`	Application description.	String	n/a	no
`subscribe`	When a provided solution is consumed, а subscription and designated entities might be created in the consumer subaccount, unless the parameter is set to `false`.	Boolean	`true`	no
`sfsf-idp-access`	If true, the extension application is registered as an authorized assertion consumer service for the SAP SuccessFactors system. This way the application is enabled to use the SAP SuccessFactors identity provider (IdP) for authentication.	Boolean	`false`	no
`sfsf-home-page-tiles`	Registers SAP SuccessFactors Employee Central (EC) home page tiles in the SAP SuccessFactors company instance. This parameter is a YAML dictionary with one element with key `resource` and value `<path to resource>`. The resource is a descriptor file that defines the SAP SuccessFactors tiles. The resource has to be in JSON format. For more information, see Home Page Tiles JSON File. Ensure that each tile `name` is unique within the current subaccount.	Binary	n/a	no
`permissions`	HTML5 role assignment to specified permissions. The parameter is applicable for both a standard HTML5 application, as well as for subscribing to one as a consumer. `name` - name of the permission `role` - the role to which the permission is assigned to	List	n/a	no

`com.sap.java` - used for deploying Java applications with the full Java EE 7 Web Profile container.

For more information about runtime containers, see Application Runtime Container.

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`name`	Java application name, which has to be unique within the current subaccount. The `name` value length has to be between 1 and 255 symbols.	String	n/a	yes
`runtime`	Only runtime `neo-javaee7-wp` is supported.	String	`neo-javaee7-wp`	no
`runtime-version`	Only runtime version `1` is supported.	Enclosed String, use single quotes	`1`	no
`java-version`	Only java version `JRE 8` is supported.	String	`JRE 8`	no
`compute-unit-size`	The virtual machine computing unit size. The available sizes are `LITE`, `PRO`, `PREMIUM`, `PREMIUM_PLUS`. For more information, see Compute Units.	String	`LITE`	no
`minimum-processes`	Minimum number of process instances. The allowed range is from `1` to `99`. Note: You either have to use both the `minimum-processes` and `maximum-processes` parameters, or neither. The `minimum-processes` should be equal to or lower than the `maximum-processes` value.	Integer	`1`	no
`maximum-processes`	Maximum number of process instances. The allowed range is from `1` to `99`. Note: You either have to use both the `minimum-processes` and `maximum-processes` parameters, or neither. The `maximum-processes` should be equal to or higher than the `minimum-processes` value.	Integer	`1`	no
`rolling-update`	Performs update of an application without downtime in one go. Note: At least `hcp-deployer-version` 1.2.0 is required.	Boolean	`false`	no
`rolling-update-timeout`	Defines how long the old process will be disabled before it is stopped. Note: At least `hcp-deployer-version` 1.2.0 is required.	Integer	`60`	no
`running-processes`	Specifies how many processes will run at the end of the state of the Java application. If not specified, the minimum number is used.	Integer	n/a	no
`jvm-arguments`	The relevant JVM arguments employed by the customer application.	String	n/a	no
`max-threads`	The maximum allowed number of threads.	Integer	`200`	no
`connection-timeout`	The maximum timeout period for the connection, in milliseconds.	Integer	`20000`	no
`encoding`	The used Uniform Resource Identifier (URI) encoding standard.	String	`ISO-8859-1`	no
`compression`	The use of gzip compression for optimizing HTTP response time between the Web server and its clients. The available values are `on`, `off`, `forced`. Note: Explicitly specify the `compression-mime-types` and `compression-min-size` parameters only when you use the value `on`.	String	`off`	no
`compression-mime-types`	The used compression mime type, for example `text/json text/xml text/html`	String	n/a	no
`compression-min-size`	The threshold size above which an HTTP response package is compressed to reduce traffic.	Integer	n/a	no
`role-provider`	Defines the application that provides the role for the Java application. Use one of the following: `sfsf` `hcp`	String	n/a	no
`roles`	Maps predefined Java application roles to the groups they have to be assigned to. It has to specify the following parameters: `name` - its value has to be the name of the role `groups` - its value has to be a list of group names to which the role is assigned to	List	n/a	no
`subscribe`	When a provided solution is consumed, а subscription and designated entities might be created in the consumer subaccount, unless the parameter is set to `false`.	Boolean	`true`	no
`sfsf-idp-access`	If true, the extension application is registered as an authorized assertion consumer service for the SAP SuccessFactors system. This way the application is enabled to use the SAP SuccessFactors identity provider (IdP) for authentication.	Boolean	`false`	no
`sfsf-connections`	Use this to configure the connectivity of a Java extension application to an SAP SuccessFactors system. It creates the required HTTP destination and registers an OAuth client for the Java application in SAP SuccessFactors. Note: Note that SFSF connections can only be created after the corresponding Java application has been deployed and started. This means that an `sfsf-connections` module depends on a `com.sap.java` module. You can create connections to one or more applications, and employ one or more connection types. Registers the SAP SuccessFactors Employee Central (EC) home page. Note that existing SAP Fiori custom roles are skipped during deployment. The `sfsf-connections` parameter is a YAML list comprised of entries with the following attributes: `type` - values can be `default` or `technical-user`. Note that if you choose `default`, you cannot define a `technical-user-id`. `sfsf-module` - possible value is `BizX` (default value) . Use this parameter to configure a connection to the SAP SuccessFactors BizX Suite. `additional-properties` - any additional properties defining the connection, specified as name-value pairs. `technical-user-id` - if you use the `technical-user` value for the `type` parameter, you have to define a technical user ID. You can create more than one SAP SuccessFactors connections. For a comprehensive example of a `sfsf-connections`, see Modeling SAP SuccessFactors Extensions.	List	n/a	no
`sfsf-home-page-tiles`	Registers SAP SuccessFactors Employee Central (EC) home page tiles in the SAP SuccessFactors company instance. This parameter is a YAML dictionary with one element with key `resource` and value `<path to resource>`. The resource is a descriptor file that defines the SAP SuccessFactors tiles. The resource has to be in JSON format. For more information, see Home Page Tiles JSON File. Ensure that each tile `name` is unique within the current subaccount.	Binary	n/a	no
`destinations`	This parameter is a YAML list comprised of one or more connectivity destinations. To see the available parameters and values, see the table “Destination Parameters” below. Note: If you have sensitive data, all destination parameters have to be moved to the MTA extension descriptor. When you redeploy a destination, any parameter changes performed after deployment of the destination are removed. Your custom changes have to be performed again.	List	n/a	no

`java.tomcat` - used for deploying Java applications with the Java Web Tomcat runtime container.

For more information about runtime containers, see Application Runtime Container.

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`name`	Java application name, which has to be unique within the current subaccount. The `name` value length has to be between 1 and 255 symbols.	String	n/a	yes
`runtime-version`	If defining a specific runtime version is required, use one of the following: `3` (Tomcat 8). `4` (Tomcat 9).	Enclosed String, use single quotes	`3`	no
`java-version`	If defining a specific `java-version` is required, use one of the following: `JRE 8` (default). `JRE 17` (in `runtime-version` 4.16 or higher). `JRE 11` (in `runtime-version` 4.15 or lower).	String	`JRE 8`	no
`compute-unit-size`	The virtual machine computing unit size. The available sizes are `LITE`, `PRO`, `PREMIUM`, `PREMIUM_PLUS`. For more information, see Compute Units.	String	`LITE`	no
`minimum-processes`	Minimum number of process instances. The allowed range is from `1` to `99`. Note: You either have to use both the `minimum-processes` and `maximum-processes` parameters, or neither. The `minimum-processes` should be equal to or lower than the `maximum-processes` value.	Integer	`1`	no
`maximum-processes`	Maximum number of process instances. The allowed range is from `1` to `99`. Note: You either have to use both the `minimum-processes` and `maximum-processes` parameters, or neither. The `maximum-processes` should be equal to or higher than the `minimum-processes` value.	Integer	`1`	no
`rolling-update`	Performs update of an application without downtime in one go. Note: At least `hcp-deployer-version` 1.2.0 is required.	Boolean	`false`	no
`rolling-update-timeout`	Defines how long the old process will be disabled before it is stopped. Note: At least `hcp-deployer-version` 1.2.0 is required.	Integer	`60`	no
`running-processes`	Specifies how many processes will run at the end of the state of the Java application. If not specified, the minimum number is used.	Integer	n/a	no
`jvm-arguments`	The relevant JVM arguments employed by the customer application.	String	n/a	no
`max-threads`	The maximum allowed number of threads.	Integer	`200`	no
`connection-timeout`	The maximum timeout period for the connection, in milliseconds.	Integer	`20000`	no
`encoding`	The used Uniform Resource Identifier (URI) encoding standard.	String	`ISO-8859-1`	no
`compression`	The use of gzip compression for optimizing HTTP response time between the Web server and its clients. The available values are `on`, `off`, `forced`. Note: Explicitly specify the `compression-mime-types` and `compression-min-size` parameters only when you use the value `on`.	String	`off`	no
`compression-mime-types`	The used compression mime type, for example `text/json text/xml text/html`	String	n/a	no
`compression-min-size`	The threshold size above which an HTTP response package is compressed to reduce traffic.	Integer	n/a	no
`role-provider`	Defines the application that provides the role for the Java application. Use one of the following: `sfsf` `hcp`	String	n/a	no
`roles`	Maps predefined Java application roles to the groups they have to be assigned to. It has to specify the following parameters: `name` - its value has to be the name of the role `groups` - its value has to be a list of group names to which the role is assigned to	List	n/a	no
`subscribe`	When a provided solution is consumed, а subscription and designated entities might be created in the consumer subaccount, unless the parameter is set to `false`.	Boolean	`true`	no
`sfsf-idp-access`	If true, the extension application is registered as an authorized assertion consumer service for the SAP SuccessFactors system. This way the application is enabled to use the SAP SuccessFactors identity provider (IdP) for authentication.	Boolean	`false`	no
`sfsf-connections`	Use this to configure the connectivity of a Java extension application to an SAP SuccessFactors system. It creates the required HTTP destination and registers an OAuth client for the Java application in SAP SuccessFactors. Note: Note that SFSF connections can only be created after the corresponding Java application has been deployed and started. This means that an `sfsf-connections` module depends on a `com.sap.java` module. You can create connections to one or more applications, and employ one or more connection types. Registers the SAP SuccessFactors Employee Central (EC) home page. Note that existing SAP Fiori custom roles are skipped during deployment. The `sfsf-connections` parameter is a YAML list comprised of entries with the following attributes: `type` - values can be `default` or `technical-user`. Note that if you choose `default`, you cannot define a `technical-user-id`. `sfsf-module` - possible value is `BizX` (default value) . Use this parameter to configure a connection to the SAP SuccessFactors BizX Suite. `additional-properties` - any additional properties defining the connection, specified as name-value pairs. `technical-user-id` - if you use the `technical-user` value for the `type` parameter, you have to define a technical user ID. You can create more than one SAP SuccessFactors connections. For a comprehensive example of a `sfsf-connections`, see Modeling SAP SuccessFactors Extensions.	List	n/a	no
`sfsf-home-page-tiles`	Registers SAP SuccessFactors Employee Central (EC) home page tiles in the SAP SuccessFactors company instance. This parameter is a YAML dictionary with one element with key `resource` and value `<path to resource>`. The resource is a descriptor file that defines the SAP SuccessFactors tiles. The resource has to be in JSON format. For more information, see Home Page Tiles JSON File. Ensure that each tile `name` is unique within the current subaccount.	Binary	n/a	no
`destinations`	This parameter is a YAML list comprised of one or more connectivity destinations. To see the available parameters and values, see the table “Destination Parameters” below. Note: If you have sensitive data, all destination parameters have to be moved to the MTA extension descriptor. When you redeploy a destination, any parameter changes performed after deployment of the destination are removed. Your custom changes have to be performed again.	List	n/a	no

`com.sap.fiori` - used for deploying SAP Fiori configurations

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`owner`	Indicates in which subaccount the content should be imported. The possible values are `provider` or `consumer`.	String	`provider`	no
`mta-id`	The same as the global ID. Note: To reduce the risk of being out of sync, we recommend that you use YAML anchors. The value must not exceed 64 symbols.	String	n/a	no
`mta-version`	The same as the global version. Note: To reduce the risk of being out of sync, we recommend that you use YAML anchors. The value must not exceed 64 symbols.	Enclosed String Note: Use single quotes.	n/a	no
`back-end-ppms-product-version-id`	ID of the PPMS product version backend.	Enclosed String Note: Use single quotes.	n/a	no
`back-end-ppms-support-package-stack-id`	ID of the PPMS support-package stack backend.	Enclosed String Note: Use single quotes.	n/a	no
`back-end-cross-product-stack-id`	ID of the cross product stack backend.	Enclosed String Note: Use single quotes.	n/a	no
`back-end-cross-product-stack-solution-id`	ID of the cross product stack solution backend.	Enclosed String Note: Use single quotes.	n/a	no
`release`	If it is set to `true`, it marks a released product.	Boolean	`false`	no
`target-site-id`	It specifies the target site in which the content will be deployed.	String	n/a	no
`minimum-sapui5-version`	Version of the minimum required SAPUI5 Runtime. The format of the version is a numeric string of `<major>.<minor>` or `<major>.<minor>.<micro>`.	Enclosed String Note: Use single quotes.	n/a	no

Note:

You have to ensure that the back-end-*-id parameter values are numeric strings of exactly 20 digits.

`com.sap.fiori.app` - used for deploying SAP Fiori applications

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`html5-app-name`	SAP Fiori application name, which has to be unique within the current subaccount.	String	n/a	yes
`html5-app-display-name`	Human-readable name of the application. Note: The `html5-app-display-name` and `html5-app-name` parameters belong to an application level that is different from the one of the application versions. If another application version is defined in the MTA deployment descriptor, then its display name has to be identical to display names of other already defined versions of the application or has to be omitted.	String	n/a	no
`html5-app-version`	SAP Fiori application version Note: The same rules apply as for the `sap.com.hcp.html5 version` parameter with the difference that this parameter is optional. Default value: `'${timestamp}'` .	String	`${timestamp}`	no
`html5-app-active`	This flag indicates whether the related version of the application should be activated or not. The default value is `true`.	Boolean	`true`	no
`html5-app-permissions`	HTML5 role assignment to specified permissions. The parameter is applicable for both an HTML5 standard application, as well as for subscribing as a consumer. `name` - name of the permission `role` - the role to which the permission is assigned to	List	n/a	no

`com.sap.fiori.role` - used for deploying custom SAP Fiori roles

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`name`	SAP Fiori custom role name, which has to be unique within the current subaccount. The `name` value length has to be between 1 and 255 symbols.	String	n/a	yes
`groups`	List of group names to which the role has to be assigned.	List	n/a	no

For more information, see Role Assignment of Fiori Roles to Security Groups.

`com.sap.hcp.html5.role` - used for deploying custom HTML5 application roles

Supported Parameter	Parameter Description	Type	Default Value	Mandatory
`name`	HTML5 application custom role name, which has to be unique within the current subaccount. The `name` value length has to be between 1 and 255 symbols.	String	n/a	yes
`groups`	List of group names to which the role has to be assigned.	List	n/a	no

For more information, see Role Assignment of HTML 5 Roles to Security Groups.

`com.sap.odp.config` - used for deploying OData Provisioning configuration

Remember:

The use of this module type with parameters valid for hcp-deployer-version: '1.0.0' will soon be de-supported. We recommend that you use the parameters valid for hcp-deployer-version: '1.1.0', or adapt your module type accordingly.

Supported parameters when used with hcp-deployer-version: '1.0.0'

Remember:

This deployer version will soon be de-supported. We recommend you use 1.1.0.

Supported Parameter

Parameter Description

Type

Default Value

Mandatory

metadata-validation-setting

Enable or disable metadata validation, for example true.

Boolean

n/a

yes

metadata-cache-setting

Enable or disable metadata cache, for example false.

Boolean

n/a

yes

services

List of OData services. Parameters required for an OData service are:

name - name of the service from the SAP on-premise back-end system that needs to be registered, for example EPM_DEVELOPER_SCENARIO_SRV. This name has to be unique within the current subaccount.
namespace - namespace for the above service being registered from the SAP on-premise back-end system, for example IWBEP.
version - version of service being registered from the SAP on-premise back-end system, for example 1.
description - description of the service being registered, for example /IWBEP/CL_EPM_DEVELOPE_DPC_EXT.
initial-status - status of the service registered in the OData Provisioning Administration cockpit that is set during the initial deployment of the OData service, whether it is active or inactive, for example true.
overwrite-existing - this flag declares whether an existing OData service is going to be updated or not, for example false.
model-id - the model ID corresponding to the metadata of the service being registered, for example /IWBEP/EPM_DEVELOPER_SCENARIO_MD_0001.
initial-default-destination - the SAP on-premise back-end system destination where the service exists that is set during the initial deployment of the OData service. Default means that if the service does not specify any origin in the URL, then the metadata and data requests are going to be fulfilled from the destination mentioned against initial-default-destination, for example AP2.

List

n/a

yes

Supported parameters when used with hcp-deployer-version: '1.1.0':

Supported Parameter

Parameter Description

Type

Default Value

Mandatory

metadata-validation-setting

Enable or disable metadata validation, for example true.

Boolean

n/a

yes

metadata-cache-setting

Enable or disable metadata cache, for example false.

Boolean

n/a

yes

services

List of OData services. Parameters required for an OData service are:

name - name of the service from the SAP on-premise back-end system that needs to be registered, for example EPM_DEVELOPER_SCENARIO_SRV. This name has to be unique within the current subaccount.
namespace - namespace for the above service being registered from the SAP on-premise back-end system, for example IWBEP.
version - version of service being registered from the SAP on-premise back-end system, for example 1.
status - status of the service registered in the OData Provisioning Administration cockpit. To make the service active use true, or false to keep it inactive.
initial-description – description of the service. For example /IWBEP/CL_EPM_DEVELOPE_DPC_EXT. Use only when the service is created for the first time.

Note:

If a service with the same name/namespace/version combination already exists but has different description, the import will fail.
initial-model-id - the model ID corresponding to the metadata of the service, for example /IWBEP/EPM_DEVELOPER_SCENARIO_MD_0001. Use only when the service is created for the first time.

Note:

If a service with the same name/namespace/version combination already exists but has different model-id, the import will fail.
initial-default-destination - the name of the default SAP on-premise back-end system destination that is going to be used by the OData Provisioning service when no-multi origin composition (MOC) is specified as a parameter in the OData URL. Use only when the service is created for the first time.

Note:

If a service with the same name/namespace/version combination already exists but has different default destination, the import will fail.

List

n/a

yes

`com.sap.hcp.sfsf-roles` - used for uploading and importing SAP SuccessFactors HCM Suite roles from the SAP BTP system repository into the SAP SuccessFactors customer instance.

The role definitions must be described in a JSON file. For more information about creating roles.json file, see Create the Resource File with Role Definitions.

Ensure that each role has a unique roleName within the current subaccount.

`com.sap.hcp.group` - used for modeling the SAP BTP authorization groups.

Supported Parameter	Parameter Description	Type	Default	Mandatory
`name`	Group name, which has to be unique within the current subaccount. The `name` value length has to be between 1 and 255 symbols.	String	n/a	yes

`com.sap.hcp.destination` - A generic subaccount-level destination.

To see the available parameters and values, see the table Destination Parameters below.

`com.sap.hcp.portal.destination` - A service-level destination for theSAP Cloud Portal service.

To see the available parameters and values, see the table Destination Parameters below.

`com.sap.hcp.odp.destination` - A service-level destination for the SAP OData Provisioning.

To see the available parameters and values, see the table Destination Parameters below.

`com.sap.integration` - used for modeling the content for the SAP Cloud Integration.

Supported Parameter	Parameter Description	Type	Default	Mandatory
`resource-type`	Type of the resource	String	n/a	yes
`resource-id`	ID of the resource	String	n/a	yes
`version`	Version of the `com.sap.integration` module type	String	n/a	yes
`technical-name`	Technical name of the `com.sap.integration` module type	String	n/a	yes

Note:

To use the com.sap.integration module type, first you have to:

Enable the SAP Solution Lifecycle Management service for SAP BTP service in a subaccount that supports SAP Cloud Integration. For more information, see Content Transport in the SAP Cloud Integration documentation.

Create a destination with named CloudIntegration with the following properties:

Type - HTTP

URL - URL pointing to the /itspaces of the TMN node for the SAP Cloud Integration tenant in the current subaccount

Proxy Type - Internet

Authentication - BasicAuthentication

User and password - credentials of a user that has the AuthGroup.IntegrationDeveloper role for the above-mentioned TMN node

For more information, see Using Services in the Neo Environment.

Supported Multitarget Application Resource Types

This section contains the resource types and their parameters that are supported by the SAP BTP.

Note:

The relation between a module and the entities created in the SAP BTP is not one-to-one, that is, it is possible for one module to contain several SAP BTP entities.

Any security-sensitive data, such as user credentials and passwords, has to be placed in the MTA extension descriptor.

Resource Type

Description

com.sap.hcp.persistence

Used for binding a database with a specified identifier to a Java application

<untyped>

Used for adding any properties that you might require and which you define. It does not have a lifecycle.

Note:

The untyped resource is unclassified, that is, it does not have a type.

Resource types support the following parameters:

Resource type	Parameter	Parameter Description	Type	Default	Mandatory
`com.sap.hcp.persistence`	`id`	Identifier of the database that will be bound to a deployed Java application. You can model a named data source by using the parameter Note: If you want to use a `<DEFAULT>` database binding, the standard data source `jdbc/DefaultDB` has to be set up at the stage of the Java application development.	String	n/a	yes
	`user-id`	The user ID parameter allows a database to be bound to a preexisting schema. If not used, a new schema has to be created. Note: We recommend that you place this parameter in the MTA extension descriptor, if you are using one.	String	n/a	no
	`password`	You can model a named data source by using the parameter. The password parameter allows a database to be bound to a preexisting schema. If not used, a new schema has to be created. Note: We recommend that you place this parameter in the MTA extension descriptor, if you are using one.	String	n/a	no
	`account`	This is the provider subaccount of the database. The subaccount parameter is needed only when the database is consumed from another subaccount. Note: The provider subaccount must meet the following criteria: It has to be part of the same global account. It has to provide permissions that allow a database to be used from another subaccount. For more information, see Add New Access Permissions ↗️.	String	n/a	no

binding-name that is added to the database binding resource required in the requires section of the com.sap.java and java.tomcat module types.

Required Sections

Parameter

Parameter Description

Type

Default

Mandatory

com.sap.java and java.tomcat

binding-name

Data source name

Note:

If you want to use a named database binding, the corresponding data source jdbc/<name> has to be set up at the stage of the Java application development.

For more information, see Modeling Database Bindings.

String

n/a

yes

Supported Metadata Options

The MTA specification _schema-version 3.1 introduces the notion for metadata, which can be added to a certain property or parameter.

Metadata Option	Description	Type	Default Value	Mandatory
`consumer-optional`	Used when you want to provide your Multitarget Application for consumption by other subaccounts. You can add the `consumer-optional` metadata to a property to indicate that it should be populated with an MTA extension descriptor when your subscribers consume the Multitarget Application. If you do not provide the `consumer-optional` metadata, the deployment of the MTA deployment descriptor within your subaccount will fail due to missing data. The following example will require the consumer of your Multitarget Application to provide a user and a password value: Example: `resources: - name: example-resource properties: user: password: properties-metadata: user: optional: true consumer-optional: false password: optional: true consumer-optional: false ...` Note: The `optional` parameter has to be explicitly defined and set to `true` if you want to use the option `consumer-optional`. See the MTA specification for additional information. Тhis option is available for Multitarget Application schema 3.1.0 and higher	Boolean	`true`	no
`description`	If it is used as metadata about a parameter without a value, it provides a user-friendly description of the missing parameter in the cockpit. Example: `resources: - name: example-resource properties: user: properties-metadata: user: description: Еxample resource user name ...`	String		no
`sensitive`	If it is used as metadata about a parameter without a value, it prompts the cockpit to use a password input field, that is, with hidden content. Example: `resources: - name: example-resource properties: password: properties-metadata: password: sensitive: true ...`	Boolean	`false`	no
`complex`	If it is used as metadata about a parameter without a value, it prompts the cockpit to use an input field for free text, for example, a description of a solution in several lines of text. Example: `resources: - name: example-resource properties: description: properties-metadata: description: complex: true ...` Note: This parameter is not taken into account if you use it in conjunction with the `sensitive` parameter. The Password input field is used instead.	Boolean	`false`	no
`default-value`	If it is used as metadata about a parameter without a value, it provides a cockpit-relevant default value of the missing parameter. Example: `resources: - name: example-resource properties: user: properties-metadata: user: default-value: John Doe ...`	String		no

Destination Parameters

Depending on the type of the destination that you wish to create (subaccount-level, application-level, subscription destination, and so on), the destination can be modeled as a module com.sap.hcp.destination, or as a parameter of the modules com.sap.java or java.tomcat. However, the options available when you create a destination are the same for all of the destination types.

MTA Parameter	Type	Mandatory	Possible Values	Default Value	Description or Comment
`force-overwrite`	String		`true` or `false`	`false`	If `true`, an already existing destination with the same name will be overwritten.
`owner`	String			`provider`	Indicates in which subaccount the destination should be created. The possible values are `provider` or `consumer`.
`name`	String	Yes		n/a	Technical name of the destination. It can be used later on to get an instance of that destination programmatically.
`type`	String	Yes	`HTTP, LDAP, MAIL, RFC`	HTTP
`description`	String
`url`	URL	Yes			Use when the parameter `type` has the `HTTP` or `LDAP` values. Mandatory only for these types.
`proxy-type`	Enumeration		`Internet, OnPremise`	Internet	Use with `HTTP` or `LDAP` destination `type`.
`authentication`	Enumeration		`NoAuthentication, BasicAuthentication, AppToAppSSO, ClientCertificateAuthentication, OAuth2SAMLBearerAssertion, PrincipalPropagation, SAPAssertionSSO`	`NoAuthentication`	Use with `HTTP` or `LDAP` destination `type`.
`user`	String				When to use: if `BasicAuthentication` is the `Authentication` type. Mandatory only for this type. if the parameter `type` has the values `MAIL`, or `RFC`.
`password`	String				When to use: if `BasicAuthentication` is the `Authentication` type. Mandatory only for this type. if `MAIL`, or `RFC` are the destination `type`.
`audience`	String	Yes			Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type. Mandatory only for this authentication.
`client-key`	String	Yes			Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type. Mandatory only for this authentication.
`token-service-url`	URL	Yes			Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type. Mandatory only for this authentication.
`token-service-user`	String				Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type.
`token-service-password`	String				Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type.
`system-user`	String				Use when `OAuth2SAMLBearerAssertion` is the `Authentication` type.
`issuer-sid`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`issuer-client`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`recipient-sid`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`recipient-client`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`certificate`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`signing-key`	String	Yes			Use when `SAPAssertionSSO` is the `Authentication` type. Mandatory only for this type.
`system-user`	String				Use when `OAuth2SAMLBearerAssertion` or `SAPAssertionSSO` are the `Authentication` type.
`repository-user`	String				Use with the `RFC` parameter `type`.
`repository-password`	String				Use with the `RFC` parameter `type`.
`client`	String	Yes	3 digits, in single quotes		Use with the `RFC` parameter `type`. Mandatory only for this type.
`client-ashost`	String		00-99, in single quotes		Use with the `RFC` parameter `type`. Either this or `client-mshost` must be specified.
`client-sysnr`	String				Use with the `RFC` parameter `type`, if `client-ashost` is specified.
`client-mshost`	String				Use with the `RFC` parameter `type`. Either this or `client-ashost` must be specified.
`client-r3name`	String		3 letters or digits		Use with the `RFC` parameter `type`, if `client-mshost` is specified.
`client-msserv`	String				Use with the `RFC` parameter `type`., if `client-mshost` is specified.
`additional-properties`	Map				Use this section to define arbitrary properties as a map of keys and values used in the destination. and are also validated by the SAP BTP. The additional parameters are denoted as follows: Example: `ldap. mail. jco.client. jco.destination.`
`location-id`	String				The value defines the location ID identifying the Cloud Connector over which the connection is opened. The default value is an empty string identifying the Cloud Connector that is connected without any location ID.

Note:

The additional-properties values are not strictly verified during deployment, since they may vary excessively. For example, such values might depend on the destination type or authentication type. In case you are using such additional values, after deployment you have to ensure that the required elements have been properly created, and they operate as expected.

Destinations Target Platform Keyword Options

In regard to modeling destinations the SAP BTP offers several keyword properties, which you can use to optimize your declaration about deploying a destination. You can have the following destination types:

Keyword Option

Description

application-url

This keyword can be placed only within the properties category of the provides section of the com.sap.java and java.tomcat module types. It is used when you want to extract the URL of the Java Application and link it to a destination that you have modeled.

The following example contains a Java application that has a destination that leads to itself. Note that this example uses the MTA placeholder concept. For more information, see “Destination with Specific Target Platform Data Options” below.

Example:

modules:
  - name: java-module
    type: com.sap.java
    provides:
      - name: java-module
        properties:
          application-url: ${default-url}
    requires:
      - name: java-module
    parameters:
      name: exampleapp
      destinations:
        - name: ExampleWebsite
          type: HTTP
          url: ${java-module/application-url}
      ...

Destinations with Target Platform Specific Data Options

When modeling destinations the SAP BTP offers several keyword properties that allow you to express your intention when deploying a destination more clearly. There might be cases in which some of the destination data prior deploying the MTA archive is not known to you. Such data might be, for example, the URL of a Java Application that you want your destination to point to. To address these cases, SAP BTP provides several placeholders that you can use when you model your MTA. Placeholders are part of the Multitarget Application specification, and are strings resolved depending on the scope in which they are used. They have the syntax ${<name>}.

Currently all types of destinations support the following placeholders, which are automatically resolved with their valid values during deployment.

Placeholder Option	Description
`${default-url}`	Instructs SAP BTP to resolve the placeholder value to the default Java Application URL when deploying the destination. Тhis placeholder can be part only of the property named `application-url`, which serves as a `provided` dependency of the `com.sap.java` and `java.tomcat` module types. This example shows the usage of the `${default-url}` placeholder. The modeled java-module provides the `application-url` dependency: Example: `modules: - name: java-module type: com.sap.java provides: - name: java-module properties: application-url: ${default-url} parameters: name: exampleapp ...` Note: This placeholder can be used only with destination types that have a URL within their properties, that is, destination types such as an HTTP destination. This URL can be automatically resolved only if the Java Application has only one URL.
`${account-name}`	Instructs SAP BTP to resolve the placeholder value to your subaccount name when deploying the destination. This placeholder can be used only in the `url` parameter for a destination, the `token-service-url` parameter, and in the `application-url` property, which serves as a `provided` dependency of the `com.sap.java` and `java.tomcat` module types. Example: `modules: - name: java-module type: com.sap.java provides: - name: java-module properties: application-url: ${default-url}/accounts/${account-name}/example parameters: name: exampleapp ... - name: abc-java type: com.sap.java parameters: destinations: - name: ExampleWebsite type: HTTP url: http://abc.example.com/accounts/${account-name} ....`
`${provider-account-name}`	Instructs SAP BTP to resolve the placeholder value to the subaccount name of the provider when deploying the destination. This placeholder can be used only in the `url` parameter for a destination and the `token-service-url` parameter. You can use it if you want to employ a model, where a destination is created within your subscriber subaccount and you want it to point to a URL in your provider subaccount. Example: `modules: - name: abc-java type: com.sap.java parameters: destinations: - name: ExampleWebsite type: HTTP url: http://abc.example.com/accounts/${provider-account-name} owner: consumer ....` Note: In the example the subscriber subaccount is consuming a Solution that is provided by you. The consumer property of the destination indicates that this destination is going to be deployed into the subaccount of the consumer.
`${landscape-url}`	Instructs the SAP BTP to resolve the placeholder value to the current landscape URL when deploying the destination. This placeholder can be used only in the `url` property for a destination, the `token-service-url` parameter, and in the `application-url` property that serves as a `provided` dependency of the `com.sap.java` and `java.tomcat` module types. Example: `modules: - name: java-module type: com.sap.java provides: - name: java-module properties: application-url: myjava.${landscape-url}/ parameters: name: exampleapp ... - name: abc-java type: com.sap.java parameters: destinations: - name: ExampleWebsite type: HTTP url: abc.${landscape-url}/ ....`

Files

mta-module-types-resource-types-and-parameters-for-applications-in-the-neo-environment-f1caa87.md

Latest commit

History

mta-module-types-resource-types-and-parameters-for-applications-in-the-neo-environment-f1caa87.md

File metadata and controls

MTA Module Types, Resource Types, and Parameters for Applications in the Neo Environment

Remember:

Tip:

Tip:

Note:

Supported Target Platform Options

Note:

Note:

Note:

Example:

Supported Multitarget Application Module Types

Note:

Supported Module Types and Parameters

Tip:

com.sap.hcp.html5 - used for deploying HTML5 applications

Note:

com.sap.java - used for deploying Java applications with the full Java EE 7 Web Profile container.

Note:

Note:

Note:

Note:

Note:

Note:

Note:

java.tomcat - used for deploying Java applications with the Java Web Tomcat runtime container.

Note:

Note:

Note:

Note:

Note:

Note:

Note:

com.sap.fiori - used for deploying SAP Fiori configurations

Note:

Note:

Note:

Note:

Note:

Note:

Note:

Note:

Note:

com.sap.fiori.app - used for deploying SAP Fiori applications

Note:

Note:

com.sap.fiori.role - used for deploying custom SAP Fiori roles

com.sap.hcp.html5.role - used for deploying custom HTML5 application roles

com.sap.odp.config - used for deploying OData Provisioning configuration

Remember:

Remember:

Note:

Note:

Note:

com.sap.hcp.sfsf-roles - used for uploading and importing SAP SuccessFactors HCM Suite roles from the SAP BTP system repository into the SAP SuccessFactors customer instance.

com.sap.hcp.group - used for modeling the SAP BTP authorization groups.

com.sap.hcp.destination - A generic subaccount-level destination.

com.sap.hcp.portal.destination - A service-level destination for theSAP Cloud Portal service.

com.sap.hcp.odp.destination - A service-level destination for the SAP OData Provisioning.

com.sap.integration - used for modeling the content for the SAP Cloud Integration.

Note:

Supported Multitarget Application Resource Types

Note:

Note:

Note:

Note:

Note:

Note:

Note:

Supported Metadata Options

Example:

Note:

Example:

Example:

Example:

`com.sap.hcp.html5` - used for deploying HTML5 applications

`com.sap.java` - used for deploying Java applications with the full Java EE 7 Web Profile container.

`java.tomcat` - used for deploying Java applications with the Java Web Tomcat runtime container.

`com.sap.fiori` - used for deploying SAP Fiori configurations

`com.sap.fiori.app` - used for deploying SAP Fiori applications

`com.sap.fiori.role` - used for deploying custom SAP Fiori roles

`com.sap.hcp.html5.role` - used for deploying custom HTML5 application roles

`com.sap.odp.config` - used for deploying OData Provisioning configuration

`com.sap.hcp.sfsf-roles` - used for uploading and importing SAP SuccessFactors HCM Suite roles from the SAP BTP system repository into the SAP SuccessFactors customer instance.

`com.sap.hcp.group` - used for modeling the SAP BTP authorization groups.

`com.sap.hcp.destination` - A generic subaccount-level destination.

`com.sap.hcp.portal.destination` - A service-level destination for theSAP Cloud Portal service.

`com.sap.hcp.odp.destination` - A service-level destination for the SAP OData Provisioning.

`com.sap.integration` - used for modeling the content for the SAP Cloud Integration.