OpenText target connector

The OpenText CS target connector uses the OpenText CS REST API that is supported by all versions of OpenText CS on premise. Permissions can only be set with v2 of the API which is supported by OpenText CS versions 16 and higher.

Features

• Importing nodes. A node represents folders, documents, and other type of objects in OpenText CS.
• Importing versions
• Importing categories (metadata)
• Importing (record management) classifications
• Importing permissions (ACLs)

note

Only metadata of the current version of an object will be migrated.

Settings

mongoConnection

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

openTextUsername

The OpenText CS REST API username with write access to the OpenText CS locations that need to be migrated to.

openTextPassword

The OpenText CS REST API password.

openTextUrl

The base URL to the OpenText Content Server and its APIs.

Example: http://otcs162.xillio.com/otcs/cs.exe

authTicketExpirationPeriod

The authentication ticket expiration period in minutes. OpenText Content Server security settings determine the expiration period for issued authentication tickets. By default this period is 30 minutes. The connector will refresh the ticket 3 minutes before its expiration. Setting this value to 3 minutes or lower will result in constantly refreshing the authentication ticket.

Example: 30

Model

The OpenText CS metadata is populated from the Content Store. Below we describe the schemas with an explanation of how the fields are translated to the OpenText CS fields.

RECORD and CONTAINER

{
  "migration" : {
    // REQUIRED | BOOLEAN | DESCRIPTION: Only objects where this value is set to 'true' will be created in OpenText CS
    "migrate" : true
  },
  "target" : {
    // All the Content Store required fields + optional ones if required. Fields will be mapped to their OpenText CS counter part automatically.
    // For example target.contentType.systemName will be mapped to the type of the node (0 = folder, 144 = document) and target.description will be mapped to the description field
    "properties" : {
      "categories" : {
        // Categories metadata using their technical property names as defined in OpenText CS
        // Example categories object with 2 categories (1535353 and 1535699):
        // {
        //   "1535353" : {
        //     "1535353_3": "1994-12-09T00:00:00", // date
        //     "1535353_4": true, // flag
        //     "1535353_5": 123  // int
        //   },
        //   "1535699" : {
        //     "1535699_11_1_12": "set text", // set text
        //     "1535699_11_1_13": 1, // set int
        //     "1535699_7": "text", // text
        //     "1535699_8": "text\r\nmultiline\r\nfield" // multiline text
        //   }
        // }          
      },
      "classifications" : [
        // An array of classification identifiers. These identifiers can be retrieved from the Classifications volume under Enterprise in the navigation bar.
        // Example: [1535759]
      ],
      "rmclassification" : {
        // Record Management classification. Properties are visible under the Records Details tab in OpenText CS.
        "class_id" : "1535758", // REQUIRED | STRING | DESCRIPTION: The classification identifier. This identifier can be retrieved from the Classifications volume under Enterprise in the navigation bar.
        "cycle_period" : "1", // OPTIONAL | STRING | DESCRIPTION: 1=Monthly,2=Semi-annual based on calendar year,3=Quarterly based on calendar year,7=Weekly,12=Annual based on calendar year,365=Daily
        "official" : "true", // OPTIONAL | STRING | DESCRIPTION: "true" or "false"
        "status" : "1", // OPTIONAL | STRING | DESCRIPTION: The status identifier. These can be found here: /otcs/cs.exe?func=RecMan.TableMaintenance
        "essential" : "2", // OPTIONAL | STRING | DESCRIPTION: The essential record identifier. These can be found here: /otcs/cs.exe?func=RecMan.TableMaintenance
        "storage" : "3", // OPTIONAL | STRING | DESCRIPTION: The storage medium identifier. These can be found here: /otcs/cs.exe?func=RecMan.TableMaintenance
        "subject" : "some subject", // OPTIONAL | STRING
        "addressee" : "some addressee", // OPTIONAL | STRING
        "sent_to" : "some other addressee", // OPTIONAL | STRING
        "originator" : "some author", // OPTIONAL | STRING
        "establishment" : "xillio", // OPTIONAL | STRING
        "record_date" : "2025-01-08T00:00:00", // OPTIONAL | DATETIME
        "status_date" : "2025-01-08T00:00:00", // OPTIONAL | DATETIME
        "received_date" : "2025-01-08T00:00:00", // OPTIONAL | DATETIME
        "next_review_date" : "2025-01-08T00:00:00", // OPTIONAL | DATETIME
        "last_review_date" : "2025-01-08T00:00:00", // OPTIONAL | DATETIME
      }        
    }
  }
}

In order to find out about the technical names for the categories, go to http://(opentext_cs_host)/otcs/cs.exe?func=attributes.dump for the identifiers and read the instructions in the OpenText documentation.

ACL

{
  "migration" : {
    // REQUIRED | BOOLEAN | DESCRIPTION: Only objects where this value is set to 'true' will be created in OpenText CS
    "migrate" : true
  },
  "target" : {
    "permissions" : [
      // REQUIRED | ARRAY | DESCRIPTION: the available permissions are: see,see_contents,modify,edit_attributes,add_items,reserve,add_major_version,delete_versions,delete,edit_permissions
    ],
    "principals" : [
      // REQUIRED | ARRAY | DESCRIPTION: an array of principal objects. Only the first principal object will be processed. The systemName should reference an OpenText CS user identifier (to be retrieved with the source connector)
    ],
    "properties" : {
      "apply_to" : 0 // OPTIONAL | NUMBER | DESCRIPTION: 0=This Item,1=Sub-Items,2=This Item and Sub-Items,3=This Item And Immediate Sub-Items. Defaults to 0 when not provided.
    }
  }
}

An ACL object should only be associated with one RECORD or CONTAINER, as this will make it easier to track if the ACL was imported. Furthermore, for each principal a separate ACL object should be created as only the first one will be processed.