storage.yaml - SharePoint Online
This section provides instructions on configuring the storage.yaml file to store documents from SAP S/4HANA through aqilink to a site in SharePoint Online (SPO). It includes detailed guidelines for specifying connection parameters and managing authentication to ensure successful integration with SharePoint Online (SPO) as respository.
To successfully connect to SharePoint Online, certain parameter values from the corresponding Microsoft Entra ID application are required. Before proceeding, refer to the chapter Create Microsoft Entra ID Application to ensure the application is available..
Parameter Overview
The table outlines the available parameters in storage.yaml for specifying a connection to Microsoft SharePoint Online.
Use the parameter name to introduce a new element in the context of YAML syntax. This can be useful for easier identification, as this name must be referenced in the related connection from SAP in the sapHttp.yaml.
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| name | Yes | string | The value must be unique and should not contain special characters; only alphanumeric characters (0-9, A-Z) and dashes are allowed. | |
| type | Yes | string | The type of the repository that should be connected. Since the connection routes to SharePoint Online, the value must be sharepoint. | |
| sharepointUrl | Yes | string | The URL pointing to the desired site in SPO. Example: https://YourCompany.sharepoint.com/sites/sap | |
| clientId | Yes | string | The Application (client) ID of the Microsoft Entra ID application. Refer to section Retrieving Authentication Values in the Create Microsoft Entra ID reference. | |
| tenantId | Yes | string | The Directory (tenant) ID of the Microsoft Entra ID application. Refer to section Retrieving Authentication Values in the Create Microsoft Entra ID reference. | |
| certPath | Yes | string | To authenticate aqilink against SharePoint, a certificate is required and must be uploaded to the container. This parameter specifies the location of the private key for the generated certificate within the container. Example: /app/configs/aqilinkCertificate.pfx. Refer to section Upload Certificate in the Create Microsoft Entra ID reference. | |
| certPass | Yes | string | The password used for the certificate in the certPath parameter. | |
| adminPath | Yes | string | Path to the admin folder under the specified site above in sharepointUrl where the certificates and repository files from SAP are stored. | |
| documentPath | Yes | string | The root path in the site specified in sharepointUrl for all documents arriving from SAP. | |
| ignoreArchiveId | No | boolean | false | Omit the archiveId parameter from the search. |
| ignoreSource | No | boolean | false | Omit the source parameter from the search. |
| certCache | No | Object | Caches the SAP certificate of the current storage configuration for a specified time. Refer to Parameter certCache below. |
Parameter certCache
If enabled, aqilink caches the SAP certificate of the current storage configuration until the cache expires. During this time, the cached certificate is used for signature validation.
Enabling the certificate cache for a storage configuration can improve performance when storing documents, as it reduces the number of requests by nearly half. However, it may also introduce security risks, as the SAP certificate remains valid in the cache for the specified time, even if it is deleted or deactivated in the repository during that period.
Use this setting with caution!
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| enabled | No | boolean | false | Enable or disable the certificate cache for the the current storage configuration. |
| expiration | No | duration | 1h | Specifies the time before the cache expires. Specifies the time before the cache expires. Use the duration format (e.g., h for hours, m for minutes, s for seconds) |
certCache:
enabled: true
expiration: 1d
Example Configuration
This sample configuration includes the minimum required properties as explained above.
- name: storage-sharepoint
type: sharepoint
sharepointUrl: https://mycompany.sharepoint.com/sites/sap-demo
tenantId: 10b5a9fa-149d-4fa2-aa8c-bdaa3f73112f
clientId: 64bc0b64-a83e-4c45-afd0-1b2c11216a00
certPath: /app/configs/aqilink.pfx
certPass: CertPassword
adminPath: SAPRepositories/Repositories
documentPath: SAPDocuments/ArchiveLink