sapHttp.yaml

The sapHttp.yaml file defines the inbound connections from the SAP S/4HANA system and maps them to the corresponding repository configuration of the desired storage connection in the storage.yaml.

Parameter Overview

The table below outlines the properties for each inbound connection, providing details on their function and expected values.

astuce

We strongly recommend using the name parameter as the first property in objects across all aqilink configuration files whenever possible. This name typically references other configuration parts, improving readability and ensuring clarity. Additionally, the name parameter must always be unique to prevent conflicts.

Parameter	Mandatory	Type	Default	Description
name	Yes	string		Unique name for each connection. The value must be unique and should not contain special characters; only alphanumeric characters (0-9, A-Z) and dashes are allowed. Refer to Parameter name below.
storage	Yes	string		Mapping to the desired storage. Must match to a storage definition in the storage.yaml. Refer to Parameter storage below.
signatureEnabled	No	boolean	true	Enables the signature check for the HTTP Content Server interface. If disabled, all incoming requests will be accepted, regardless of whether they are signed or not. Disabling this feature may pose a security risk, as unsigned requests will bypass validation.
checkExpiration	No	boolean	true	By default, this check ensures that signed requests are sent within the valid time window. If disabled, this validation will not be performed.

Parameter name

As highlighted in the tip above, the name must be unique and should be used to introduce a new element in the YAML file. This value must be referenced in the HTTP Script field during the SAP Content Repository creation in SAP. This defines the endpoint where SAP sends its requests. From the repository's perspective, it represents the source from which the document originates.

info

The value of the name parameter will be stored in a "source" field with each document that is transferred from SAP to the connected repository. This allows for easy identification of the document's origin and can be leveraged for further customizations, such as additional development, rules, or filters, providing deeper insights into the document's source or handling.

Naming Convention

astuce

We suggest prefixing all name parameter values with src- (for "source") and include the type of the repository, such as src-nuxeo, src-sharepoint, src-s3 or more specific src-aws-s3 or src-minio-s3.

In complex or mixed configurations, best practice is to append also an indicator for the system and even the SAP Content Repository name or functional area in SAP. For instance:

• src-nuxeo-dev-n1 - Store documents to Hyland Nuxeo development system from SAP Content Repository N1.
• src-sharepoint-mytenant-mysite-s1 - Store documents to SharePoint tenant myTenant on site mySite from SAP Content Repository S1.
• src-s3-archivelink - Store all ArchiveLink documents to an S3-compatible storage.

Parameter storage

This parameter defines the mapping to the related storage system as specified in the storage.yaml. Therefore, the value of the storage parameter must refer to an existing value of the name parameter in the storage.yaml. It is possible to route multiple configurations in the sapHttp.yaml to the same storage configuration.

Example Configurations

Below are sample configurations that include the parameters mentioned above.

Simple Configuration

This is the most basic configuration of the sapHttp.yaml, containing only the minimum required properties - in this case for a Hyland Nuxeo repository.

Example

- name: src-nuxeo
  storage: storage-nuxeo

Advanced Configuration

Here’s an example configuration for routing documents from two different SAP Content Repositories to two different storage connections, specifying all available properties in sapHttp.yaml. Naming conventions are based on the functional areas in SAP.

Example

- name: src-sharepoint-archivelink
  storage: storage-sharepoint-archivelink
  signatureEnabled: true
  checkExpiration: true
- name: src-sharepoint-attachments
  storage: storage-sharepoint-attachments
  signatureEnabled: true
  checkExpiration: true

Complex Configuration

Here is a more complex configuration which routes documents from different SAP Content Repositories to multiple storage systems.

• Hyland Nuxeo: The SAP Content Repositories pointing to src-nuxeo-dms and src-nuxeo-attachments store documents in the same Nuxeo storage system as they use the same storage configuration.
• Microsoft SharePoint: The SAP Content Repositories pointing to src-sharepoint-attachments store documents in a SharePoint library.
• Microsoft SharePoint: The SAP Content Repository M1 used for testing, stores documents through src-sharepoint-dev-m1 into a different SharePoint library.
• S3-compatible Storage: The SAP Content Repositories pointing to src-s3-archivelink store all ArchiveLink related documents in an S3-compatible storage (e.g., AWS S3 or MinIO).

Example

- name: src-nuxeo-dms
  storage: storage-nuxeo
  signatureEnabled: true
  checkExpiration: true
- name: src-nuxeo-attachments
  storage: storage-nuxeo
  signatureEnabled: true
  checkExpiration: true
- name: src-sharepoint-attachments
  storage: storage-sharepoint-attachments
  signatureEnabled: true
  checkExpiration: true
- name: src-sharepoint-dev-m1
  storage: storage-sharepoint-dev
  signatureEnabled: true
  checkExpiration: true
- name: src-s3-archivelink
  storage: storage-s3-archivelink
  signatureEnabled: true
  checkExpiration: true