## 5.6.2.2.3 Communication Arrangement JSON/YAML File Properties
Learn how to construct a JSON or YAML file for the SAP S/4HANA Cloud APIs, including parameters such as system name, communication arrangement, authentication type, communication system, outbound services, and additional properties. It also provides guidelines and rules for each property.
## Context
To construct the JSON file for the Cloud Foundry environment or the YAML file for the Kyma environment for the SAP S/4HANA Cloud APIs you want to use, you can use these parameters. To access the specific documentation of these APIs, see SAP S/4HANA Cloud APIs at SAP API Business Hub .
The information that you need to construct the JSON or the YAML file is available in the Display Communication Scenario application in the corresponding SAP S/4HANA Cloud system. It contains information such as scenario details and properties, and supported inbound and outbound authentication methods. See Display Communication Scenarios.
For specific sample JSON files, see Communication Arrangement JSON File - Examples [page 2129].
For specific sample YAML files, see Communication Arrangement YAML File - Examples [page 2133].
## Properties
| Parameter   | Description                                                                                                                                             |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
| systemName  | The name of the system you have registered in SAP BTP global account.  Note The system must be in status Registered . Rules/Guidelines • Required: Yes |
## Parameter
## Description
| communicationArrangement     | Represents a communication arrangement in SAP S/4HANA Cloud.                                                                                                                                                                       |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| communicationArrangementName | A communicationArrangement property. Meaningful name of the communication arrangement that will be created for the SAP S/4HANA Cloud tenant. Rules/Guidelines • Allowed characters: [a-zA-Z0-9_-] • Max length: 80 • Required: Yes |
| scenarioId                   | A communicationArrangement property. The ID of the SAP S/4HANA Cloud communication scenario. Rules/Guidelines • Required: Yes                                                                                                      |
## Parameter
## Description
| inboundAuthentication   | A communicationArrangement property. The authentication type for the SAP S/4HANA Cloud                                                                                                                                                                                                                                                                              |
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|                         | API access.                                                                                                                                                                                                                                                                                                                                                         |
|                         |  Note Currently, the following authentication methods are sup- ported: • Basic Authentication • SAML Bearer Assertion Authentication  Note The generated X.509 certificate that is used to configure the trust between the cloud platform and SAP S/4HANA Cloud system expires two years after you have created the instance. • Client Certificate Authentication |
|                         | Rules/Guidelines • Required: Yes, if there is no outboundAuthentication defined • Allowed values: BasicAuthentication , and                                                                                                                                                                                                                                         |
|                         | OAuth2SAMLBearerAssertion ,                                                                                                                                                                                                                                                                                                                                         |
|                         | ClientCertificateAuthentication                                                                                                                                                                                                                                                                                                                                     |
## Parameter
## Description
| outboundAuthentication      | A communicationArrangement property.                                                                                                                                                                                    |
|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|                             | The type of the authentication used by SAP S/4HANA Cloud to call SAP BTP APIs.                                                                                                                                          |
| communicationSystem         | A communicationArrangement property. This represents the Communication System view of the com- munication arrangement. Rules/Guidelines                                                                                 |
| communicationSystemHostname | • Required: No A communicationSystem property. The URL of the remote system hosting the APIs that will be consumed in case the scenario contains outbound commu- nication. For SAP S/4HANA Cloud extensions on SAP BTP, |
| Parameter                 | Description                                                                                                                                                                                                                                                                                        |
|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| port                      | A communicationSystem property. The port for outbound calls to the remote system hosting the APIs that will be consumed in case the scenario contains outbound communication. Rules/Guidelines • Required: No If not specified, the default 443 port is used for the communication. • Type: String |
| oAuthAuthEndpoint         | A communicationSystem property. The OAuth authorization endpoint of the remote OAuth service in case the communication scenario contains out- bound communication. This is equivalent to Technical Data OAuth 2.0 Settings Auth. Endpoint in the Communication System view. Rules/Guidelines       |
| oAuthTokenEndpoint        | A communicationSystem property. The OAuth token endpoint. This is equivalent to Technical Data OAuth 2.0 Settings Token Endpoint in the Communication System view. Rules/Guidelines • Required: No                                                                                                 |
| outboundCommunicationUser | A communicationSystem property. The communication user used for outbound authentication. This is equivalent to an entry under the Users for Outbound Communication table in the Communication System view in the SAP S/4HANA Cloud system.                                                         |
|                           |  Note Currently, only users with authentication method User Name and Password are supported.                                                                                                                                                                                                      |
## Parameter
## Description
| username         | An outboundCommunicationUser property. The username of the communication user. Rules/Guidelines • Required: Yes, if the                                                                                                        |
|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| password         | An outboundCommunicationUser property. The password of the communication user. Rules/Guidelines • Required: Yes, if the outboundCommunicationUser property is speci-                                                           |
| outboundServices | A communicationArrangement property. A list of outbound service objects. This is equivalent to the Outbound Services section in the SAP S/4HANA Cloud Communication Arrangement view. Rules/Guidelines                         |
| outboundService  | An outboundServices object. A specific outbound service object. Rules/Guidelines                                                                                                                                               |
| id               | An outboundService property. The id of the outbound service. It must match the Outbound Service ID displayed in the SAP S/4HANA Cloud system. Rules/Guidelines • Required: Yes, if the outboundServices property is specified. |
| id               |  When you specify the id property of the outbound service, you can skip the name property.                                                                                                                                    |
| id               | Note                                                                                                                                                                                                                           |
| Parameter       | Description                                                                                                                                                                                                                                                                                                                         |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name            | An outboundService property. The name of the outbound service. It must be an exact match of the name displayed in the SAP S/4HANA Cloud system. Rules/Guidelines • Required: Yes, if the outboundServices property is specified, and the id property is not specified.  Note If the id property is specified, the name property is |
| urlPath         | An outboundService property. This is equivalent to the Path field in the SAP S/4HANA Cloud system. It is used to configure the API path in the outbound service URL. Rules/Guidelines                                                                                                                                               |
| isServiceActive | An outboundService property. This is equivalent to the Service Status checkbox in the SAP S/4HANA Cloud system. In some communication scenarios, some outbound services must be disabled. You can achieve that by setting this parameter to false . Rules/Guidelines • Required: No • Default value: true                           |
| attributes      | An outboundService parameter. A list of attribute objects. This is equivalent to the Additional Properties section of the outbound service. Rules/Guidelines                                                                                                                                                                        |
| Parameter   | Description                                                                                                                                                                                                                                                                                                                                                               |
|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| attribute   | An attributes object. A specific attribute object. Represents an additional prop- erty in the outbound service. Rules/Guidelines • Required: No                                                                                                                                                                                                                           |
| name        | An attribute property. The name of the additional property of the outbound service. It is equivalent to the Technical Property Name column in the Additional Properties section in the Display Communication Scenarios app in the SAP S/4HANA Cloud system. See Dis- play Communication Scenarios. Rules/Guidelines • Required: Yes, if an attribute object is specified. |
| value       | An attribute property. Enter value for the additional property of the outbound serv- ice. Rules/Guidelines                                                                                                                                                                                                                                                                |
| attributes  | A communicationArrangement parameter. A list of attribute objects. This is equivalent to the Additional Properties section of the communication arrangement in SAP S/4HANA Cloud. Rules/Guidelines                                                                                                                                                                        |
| attribute   | An attributes object. A specific attribute object. Represents an additional prop- erty in the communication arrangement. Rules/Guidelines • Required: No                                                                                                                                                                                                                  |
| Parameter   | Description                                                                                                                                                                                                                                                                                                                                     |
|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| name        | An attribute property. It is equivalent to the Technical Property Name section in the Additional Properties table in the Display Communication Scenarios application in the SAP S/4HANA Cloud system. See Display Communication Scenarios. Rules/Guidelines • Required: Yes, if an attribute object is specified for communicationArrangement . |
| value       | An attribute property. Enter a value for the additional property of the communica- tion arrangement. Rules/Guidelines • Required: Yes, if an attribute object is specified for communicationArrangement .                                                                                                                                       |
## Related Information
Communication Arrangement JSON File - Examples [page 2129] Communication Arrangement YAML File - Examples [page 2133]