Sharepoint specific configuration

All instance parameters refer to a named instance, hence the common parent in the connect.yaml configuration file is always tia.instances.<name>.sharepoint, where <name> stands for the selected name for the instance.

At least one encryption key definition must be configured, see Sharepoint specific configuration | Encryption key definition parameter .

Archive path configuration

The parameter archiveFolder specifies the base location in tia Content Server. In addition, attributes from SharePoint request may be used to append to this path. This enables separation of archived data by site, library, or path.

The SharePoint request to tia Connect contains these meta properties path, pathPrefix, siteId, and libraryId. By true|false switches, each of these attribute can be included into the storage path. The sequence, however, is fixed.

For example:

When all meta properties are included: archiveFolder/siteId/libraryId/pathPrefix/path
When only libraryId and path are included: archiveFolder/libraryId/path

Parent	Parameter	Description of request attribute	Required	Supported values	Default

Parent	Parameter	Description of request attribute	Required	Supported values	Default
`tia.instances.<name>.sharepoint`	`archiveFolder`	CMIS folder in which the data is to be archived Example: `/cmis/instance1`	no	`<path on tia Content Server>`	`/`
`tia.instances.<name>.sharepoint.includeInPath`	`path`	SharePoint path	no	`true` \| `false`	`true`
`tia.instances.<name>.sharepoint.includeInPath`	`pathPrefix`	A prefix for the archive path	no	`true` \| `false`	`true`
`tia.instances.<name>.sharepoint.includeInPath`	`siteId`	Sharepoint Site ID	no	`true` \| `false`	`true`
`tia.instances.<name>.sharepoint.includeInPath`	`libraryId`	Sharepoint Library ID	no	`true` \| `false`	`false`

When path request attribute is not included, the storage path is not mirroring the SharePoint folder structure. This may result in collisions when files in different SharePoint folders have the same name, and tia Content Server is only archiving the first file, while then for other files with same name archiving results in error.

Create ShareLink configuration

A ShareLink is a link that can be sent to a recipient and allows him to access file from archive. By default, when opening the ShareLink, the recipient will have to authenticate against Microsoft Entra. The authentication mechanism is Open Identify Connect (OIDC).

Parent	Parameter	Description	Required	Supported values	Default

Parent	Parameter	Description	Required	Supported values	Default
`tia.instances.<name>.sharepoint`	`sharedLinks.accessMode`	Whether access documents via SharedLink should be secured via OIDC or publicly accessible	no	`public` or `oidc`	`oidc`

Reference data in the ShareLink is encrypted. The encryption is configured by encryption key definitions.

At least one encryption key definition must be configured.

When creating a ShareLink, tia Connect is always encrypting using the last encryptionkeydefinition in this list. All previous encryptionskeydefinition are required for decryption at time of opening a ShareLink. Therefore:

If the algorithm currently in use is no longer the most secure choice, configure a new encryptiondefinitions at the bottom of the list: The new key will then be used for all new links.
Keep old encryptiondefinitions in the configuration until no ShareLink created using this definition is entitled to access archive files anymore.

Encryption key definition parameter

Parent	Parameter	Description	Required	Supported values	Default

Parent	Parameter	Description	Required	Supported values	Default
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`id`	Identifier for the definition	yes	`<string>`	-
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`encryptionAlgorithm`	The encryption algorithm	no	`<encryption algorithm>`	`AES/CBC/PKCS5Padding`
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`encryptionKey`	The password for encryption and decryption	yes	`<user>`	-
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`secretKeyFactoryAlgorithm`	The secret-key algorithm	no	`<secret-key algorithm>`	`PBKDF2WithHmacSHA256`
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`iterationCount`	The iteration count	no	`<numeric>`	`65536`
`tia.instances.<name>.sharepoint.encryptionkeydefinitions[<n>]`	`keyLength`	The to-be-derived key length	no	`<numeric>`	`256`

Mapping Metadata

The SharePoint request to tia Connect contains meta properties that are stored in the tia Content Server CMIS as CMIS properties.

When no metadata mapping or type mapping applies to an meta property name, the CMIS property name is prefixed by the customPrefix parameter and stored as property of CMIS type specified by customType parameter. Only when the meta property name starts with cmis:, the prefix is not applied building the CMIS property name.

The metadata mapping allows direct mapping of a meta property name to a CMIS property name, and overrides the building process. However, for the metadata mapping, the CMIS property mapped must be known to the tia Content Server.

Example:

metadata-mappings:
  abstract: 'cmis:description'
  content: 'sapbo:basedocument:Document'

After the CMIS properties are mapped, the type mappings allow map CMIS types: When there is a type mapping for a CMIS property to be added, then the CMIS type is also added.

Example:

type-mappings:
  "[sapbo:basedocument:Document]": 'sapbo:basedocument'

Assuming both example mappings are active for the same instance, then if the meta property content is present in the request, it will be mapped to sapbo:basedocument:Document CMIS property because of the meta mapping. Then because of the type mapping the CMIS type sapbo:basedocument is also added.

Metadata mappings

Parent	Parameter	Description	Required	Supported values	Default

Parent	Parameter	Description	Required	Supported values	Default
`tia.instances.<name>.sharepoint`	`customType`	CMIS custom type for not mapped meta data	no	`<string>`	`tia:archiveProperties`
`tia.instances.<name>.sharepoint`	`customPrefix`	Prefix for for not mapped meta data	no	`<string>`	`tia:archiveProperty:`
`tia.instances.<name>.sharepoint`	`metadataIgnoreFields`	List of meta property names that should be ignored.	no	`<List of Strings>`	`[` `SharedWithUsers,` `SharedWithUsers@odata.type,` `SharedWithUsers#Claims,` `SharedWithUsers#Claims@odata.type` `]`
`tia.instances.<name>.sharepoint`	`metadata-mappings`	Mapping of meta property name to CMIS property name.	no	`<Map of configurations>`	-
`tia.instances.<name>.sharepoint`	`type-mappings`	Mapping of meta property name to CMIS property name.	no	`<Map of configurations>`	-