Connect to an OpenText DMS

The OpenText sample is a json file split in five main sections. Some configuration parts of the sections are already hardcoded in the template so the sample will contain only some of the configurations, as follows:

• Authentication

• DmsConfiguration

• MetadataAIMContext

• AIMIngestion

• PipelineRunnerSettings

Authentication

In order to be able to authenticate using Oauth2 we must identify the:

• Tenant ID - this value can be found on the OpenText platform.

AuthorizeApi: URL for requesting the access token. https://<REGION>.api.opentext.com/tenants/<TENANT ID>/oauth2/token

• BasicLogin

  • username: Client ID

  • password: Client Secret

DmsConfiguration

DmsConfiguration is a section where we configure DMS-related settings such as formats, endpoints, query parameters, and so on.

• DMSBaseUrl: represents the base URL of the endpoints that will be used. It is the common part of all the URLs that will be consumed. For example https://<REGION>.api.opentext.com

• RootFolder: represents the root folder in the OpenText folder structure. Based on the configuration, if pagination and recursive pull are wanted, the application will get all the files in the folder's hierarchy, or all the documents in the first level of the given folder. It is represented by the folder ID, for example 057a1d3a-2876-11e8-b467-0ed5f89f718b

• DeltaQueryParameters: represents the parameters given to the document revision endpoint called. Opentext is using "items-per-page": 250 to specify the pagination of the pull.

• FolderQueryParameters: represents the parameters given to the folder query endpoint called. Opentext is using "items-per-page": 250 to specify the pagination of the pull.

• Filtering - optional - subsection will contain a list of FilteringItems and ValidationExpression.

  The FilteringItem - mandatory if Filtering is present - will contain:

  • Identifier: a unique identifier of the filteringItem, identifier that will be used in the ValidationExpression - mandatory if Filtering is present

  • Mapping: the actual property present in the incoming metadata for all DMSs - mandatory if Filtering is present

  • Value: the actual value against which the filtering is done, can contain a list of values separated by comma - mandatory if Filtering is present

    The ValidationExpression - mandatory if Filtering is present - will contain:

  • filtering condition based on the identifiers already created and the logical operators in use OR and AND.

    NOTE: Supported filters is entries0.mimeType. These are not configurable.

    Filtering can be configured by adding the following section within the DmsConfiguration section. The example is shown with sample values which must be replaced with actual values before adding to your configuration.

    "Filtering": {

    "FilteringItems": [

    {

    "Identifier": "identifier",

    "Mapping": "entries[0].mimeType",

    "Value": "text/plain"

    }

    ],

    "ValidationExpression": "{identifier}"

    }

• IsMetadataToStore: boolean. A flag that allows us to save the response from the MetadataDownloadLink as a regi file or not.

MetadataAIMContext

MetadataAIMContext is a section where we configure what we send to the ingestion, such as paths, groups, naming formats, extensions, and so on.

• context: a value sent to the ingestion and used to group files for clients with multiple tenants.

• ClassLibraryRegisterPath

  • DocumentMetadataRegister: a path for the document revisions.

  • ScrapedFileRegister: a path for scraped files.

AIMIngestion

AIMIngestion section is about ingestion configuration.

• BaseUrl: represents the base URL for the Ingestion API.

• AssetId: represents the ID of the asset for which the upload is done.

• ProcessingUnit: represents the processing units with the attached allowed extension type.

  Note: Document Connector now supports service to service integration with the Data Pipeline. If your configuration already has an Ingestion Token, it will be ignored with no impact to the processing. There is no need to remove the key from the configuration.

PipelineRunnerSettings

PipelineRunnerSettings is a section that will configure the flow of the program. Most of the configurations are already hardcoded in the template.

• DownloadFiles: boolean, a switch for toggling on and off the files transfer. Has to be TRUE for OpenText.