Add a DMS Tenant to the Document Connector
- Last UpdatedFeb 04, 2025
- 3 minute read
Note: The following documentation includes the information required to onboard a new DMS tenant into AVEVA Document Connector. This is a CDO activity, so you can raise a ticket with the CDO team through CDO Service Desk. The instructions provided here enable you to create a meaningful and actionable CDO ticket.
The configuration for AVEVA Document Connector requires two set of information:
-
Onboarding configuration
-
DMS and Ingestion configuration
Onboarding Configuration
This configuration is required by AVEVA Document Connector to identify the tenant, setup the schedule, the source type and the AIM-A asset, the connector to which the data must be sent.
Include the following information in the CDO ticket:
|
Field |
Description |
|---|---|
|
TenancyId |
Unique identifier to manage tenancy of new source system. Use only lowercase letters, numbers and hyphen ( - ) characters. Any other character is not supported. A good tenancy ID can include information about the source type and the aim instance stage while maintaining uniqueness. If you do not provide a value for this field, CDO team assigns a value based on the rest of the information. For example, assai-teststage-projectcode-1 |
|
SourceType |
Valid values are (only lowercase letters are allowed):
|
|
ConnectAccountId |
CONNECT Account ID of AIM-A environment. If you are not aware of the CONNECT Account ID, you can share the CONNECT Account Name. |
|
ConnectAssetId |
CONNECT Folder ID of AIM-A environment. If you are not aware of the CONNECT Folder ID, you can share the CONNECT Folder Name. If the CONNECT AIM-A environment is at an account level, you can provide the CONNECT Account Name in this field as well. |
|
CronJobSchedule |
Cron job schedule for AVEVA Document Connector to run. Use https://crontab.cronhub.io for help in setting up a meaningful Cron Job schedule. For example, 0 6 * * * Note: The minimum frequency for the AVEVA Document Connector to run is 4 hours. |
|
IsEnabled |
Valid values are true or false. When true, AVEVA Document Connector pulls documents and push them to the Data Pipeline. When false, the field skips the schedules and not process file or metadata. |
|
IsFirstLoad |
Valid values are true or false. Please raise a request to change the value to true to perform a full data pull from the source system. This works in conjunction with the StartingDate field. Note: Once the first load successfully completes, the system will automatically revert back to a value of false (hence an extra CDO ticket is not required). |
|
StartingDate |
Starting date in a fixed format from when you want the files to be pulled from the source DMS system. For running a pull for all the documents, set this field to an empty string (““) and set IsFirstLoad to true. Having IsFirstLoad=false and StartingDate="" will result in an error. Format - yyyy-mm-ddThh:mm:ssZ |
DMS and Ingestion Configuration
This configuration provides the information that AVEVA Document Connector requires for authentication, API endpoints and class library register configuration for the DMS systems. It also covers the Ingestion API authentication, API endpoint and asset information.
This configuration must be provided in a fixed JSON formatted template and is specific to the type of DMS tenant you are trying to configure.
Use the following sections, and examples in the Additional Information section, to create a similar JSON configuration file for the DMS tenant you want to configure. Name this JSON file as the TenancyId mentioned in the onboarding configuration in the previous section and send it over as a part of the CDO ticket created.
Once both the configuration is complete and CDO onboards this tenant, AVEVA Document Connector starts pulling the files from the source DMS and send it to the Data Pipeline via Ingestion API for processing.
Note: Sharing any sensitive information such as credentials over any ticketing system is not advised as these systems may be publicly accessible. Ensure that you share the JSON file in an encrypted email with the intended CDO engineer only.