Skip to main content
Version: 4.61.0

eDOCS DB source connector

The eDOCS database connector uses a direct connection to the database. This connector has only been tested with eDOCS version 16.3 and currently only MSSQL and Oracle databases are supported.

note

To use this connector with an Oracle database, you will need to install some additional Oracle drivers. Please refer to the DB Query Component documentation for more information.

Supported Features​

  • Exporting content structure
  • Exporting versions
  • Exporting binaries
  • Exporting users and groups
  • Exporting relationships (linked objects)
  • Exporting access control lists

Features Currently Not Supported​

  • Records management metadata
  • Audit logs
  • Workflows
note

This connector does not calculate source.ancestors. If this accelerator is used with the Transformation Accelerator, be sure to run the Calculate Ancestors flow before transformation.

Settings​

mongoConnection​

The Mongo connection string including the database name to connect to.

eDOCSDBConnectionString​

The connection string to the eDOCS database.

Example: mssql://USERNAME:PASSWORD@edocs.yourcompany.com:1433/dm_default

eDOCSDBConnectionOptions​

The connection options to connect to the eDOCS database. Only required for MSSQL databases.

Example:

{
  "options": {
    "trustServerCertificate": true,
    "tdsVersion": "7_1",
    "encrypt": false,
    "packetSize": 16368
  }
}

eDOCSDBEngine​

The engine of the eDOCS database. Currently, only MSSQL and Oracle are supported.

eDOCSDBOwner​

The owner of the eDOCS database schema. Only required for Oracle databases. Example: DOCSADM.

eDOCSFileStoragePath​

The path where eDOCS stores the files. Example: C:/edocs/DM_DEFAULT.

pageSize​

Specifies the page size number that is used when paginating.

Example: 10000

selectedDocNumbers​

An array containing the eDOCS document numbers to be retrieved. When the array is empty, all objects will be retrieved.

Example: [279,280,281,282,283,284,285,287]

permissionMapping​

An object containing a mapping from the database integer value of a permission to an array of human readable permissions. Missing mappings are logged as a warning when the ACLs are retrieved and should be added to this object.

discardMetadata​

Cleans the source.properties object for all stored objects by removing default extracted metadata and unused properties.

Only a minimal set of metadata fields required by schemas and processing logic is retained.

Retained metadata per object type
Containers​
["PROFILE_SYSTEM_ID", "PROFILE_ABSTRACT", "PROFILE_DOCNAME", "PROFILE_PATH", "PROFILE_DOCSERVER_LOC", "PROFILE_KEYWORDS_DISPLAY", "PROFILE_PD_DOC_BARCODE", "PROFILE_PD_FILE_PART", "PROFILE_PD_BOX", "PROFILE_PD_ORGANIZATION", "PROFILE_PD_FILE_DATE", "PROFILE_PD_PUBLISH_DATE", "PROFILE_PD_EMAIL_BCC", "PROFILE_PD_EMAIL_CC", "PROFILE_PD_EMAIL_DATE", "PROFILE_PD_ADDRESSEE", "PROFILE_PD_ORIGINATOR", "PROFILE_PD_CLASSIFICATION", "PROFILE_PD_SUPSEDED_DATE", "PROFILE_PD_ACTIONED", "PROFILE_PD_VREVIEW_DATE", "PROFILE_PD_STATUSES", "PROFILE_EMAIL_RECEIVED", "PROFILE_EMAIL_SENT", "PROFILE_STORAGETYPE_VALUE", "PROFILE_BILLABLE_VALUE", "PROFILE_FULLTEXT_VALUE", "PROFILE_STATUS_VALUE", "PROFILE_DEFAULT_RIGHTS_VALUE", "PROFILE_READONLY_VALUE", "PROFILE_RECORD_VALUE", "PROFILE_RELATED_VALUE", "PROFILE_ITEM_TYPE_VALUE", "PROFILE_PD_OBJ_TYPE_VALUE"]
Records​

The same properties as containers and in addition the following properties are also retained:

["VERSIONS_DOCNUMBER", "VERSIONS_VERSION", "VERSIONS_SUBVERSION", "VERSIONS_COMMENTS", "VERSIONS_PATH"]
Principals​

For users the properties in source.properties is reduced to:

["PEOPLE_SYSTEM_ID", "GROUPS_GROUP_NAME"]

For users the properties in source.properties is reduced to:

["GROUPS_SYSTEM_ID"]
ACLs​
["SECURITY_THING", "SECURITY_PERSONORGROUP", "SECURITY_GROUP_NAME"]
Relations​

No metadata properties are retained.

origin​

Specifies the origin of the document in the Content Store.