sapConnection.yaml
The sapConnection.yaml specifies the outbound connections from aqishare to the SAP systems. It also includes the type of the connection, meaning, whether a Rest (OData) service or a SAP function module through Remote Function Calls (RFC) is invoked. Depending on the type, different properties are required. The below tables lists all available properties for an outbound connection to the SAP system.
RFC Connections
The following properties allows to create a connection through RFC. It is possible to invoke any remote enabled function module in the SAP system. Note that the most important parameter is the name, as it introduces a new item in the context of YAML syntax.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| - name | Yes | string | Specifies a new item in the YAML definition, which, in the context of aqishare, represents a new storage definition. All other parameters below in this table are its children. Additionally, the value for name must be unique and should not contain special characters; only alphanumeric characters (0-9, A-Z) and dashes are allowed. |
| type | Yes | string | As this chapter describes the RFC connection to invoke SAP function modules, the value must be rfc. |
| user | Yes | string | The SAP user used to log in to the SAP system. It is recommended to use a technical user rather than a dialog user for the connections. |
| passwd | Yes | string | The password of the user above. Use Password Encryption to increase security. |
| ahost | No | string | SAP server host name or IP address to identify the location of the SAP system. Depending on the network setup, this could be a DNS-resolvable host name or a direct IP address. Ensure the specified host name or IP address is accessible from the environment where aqishare is running. |
| sysnr | No | string | SAP System Number. Unique identifier for the SAP application server, used to log in to the SAP system. It helps route connection requests to the correct SAP instance. |
| client | No | string | Client used for the logon. |
| lang | No | string | Language used for the logon. |
was ist damit? aqilink supports all properties of the SAP Netweaver RFC communication (such as Logon Groups, Gateway, Proxy, ...). For a full list of the supported properties refer to Reference [SAP NetWeaver RFC SDK].
REST / Odata Connections
The following properties are related to a Rest (OData) connection to the SAP system. Make sure the desired OData service is enabled and active in the SAP system.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| - name | Yes | string | Specifies a new item in the YAML definition, which, in the context of aqishare, represents a new storage definition. All other parameters below in this table are its children. Additionally, the value for name must be unique and should not contain special characters; only alphanumeric characters (0-9, A-Z) and dashes are allowed. |
| type | Yes | string | As this chapter describes the REST connection, therefore the value must be rest. |
| host | No | string | The host name or IP address of the SAP S/4HANA system (or SAP Cloud System). Ensure the specified host name or IP address is accessible from the environment where aqishare is running. |
| port | No | string | Port number of the SAP system. |
| auth | No | Object | Authentication section containing login credentials below. |
| user | Yes | string | The OData user used to login to the system. Remember the text indentation in the YAML-syntax for this property, as it is child of auth. |
| password | Yes | string | The password of the user. Use Password Encryption to increase security. Remember the text indentation in the YAML-syntax for this property, as it is child of auth. |
kann auch keycloak sein, extra MD unter Reference???
Example Configurations
These sample configurations include the most relevant properties as explained above.
Using RFC Connections
An example of connecting from aqishare to the SAP system via RFC.
- name: sapRFC
type: rfc
user: AQIPRO
password: myS3crEtpAssw0rd!
ashost: 11.211.124.243
sysnr: 00
client: 100
lang: en
Using REST Connections
An example of connecting from aqishare to the SAP system via REST, using Password Encryption for the credentials.
- name: sapREST
type: rest
host: 11.2.0.112
port: 8090
auth:
user: AQIPRO_REST
password: ENC(fuervr4564gTZ670cS5mf/W/yHY1ptCvkwKrjdLY)