REST API OpenText Content Server

On This Page

Overview

The OpenText Content Server connector in DryvIQ allows you to analyze, migrate, copy, and synchronize files to your OpenText enterprise content management solution from cloud storage repositories and on-premise network file shares. The first step is to create the OpenText Content Server connection by providing the connection information required for DryvIQ to connect to the server. The connector can be created using any OpenText user account with permissions to access the content.

DryvIQ supports OpenText Content Server 10.5 and 16.x.

Create Connection | User Interface

Select Connections > Add connection.
Select OpenText Content Server as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Select Test connection to ensure DryvIQ can connect using the information entered.
You will see a "Connection test succeeded" message on the Add connection modal when DryvIQ establishes connection. (If you don't see this message, verify the information you entered.)
Select Done.

Add Connection Modal - OpenText Content Server

Field	Description	Required
Display as	Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists. If you do not add a display name, the connection will automatically be named using the OpenText server URL entered. For example, OpenText (https://{servername}/otcs/cs.exe/).	Optional
Url	Enter the URL to access the server. This will look similar to the following example: https://{servername}/otcs/cs.exe/.	Required
User name	Enter the username that should be used to log on to the server. This needs to be an account with permissions to access the content that will be processed.	Required
Password	Enter the password for the username added in the previous field.	Required
DS Service name	Enter the directory service name. This defines how DryvIQ can access the user/group directory. DryvIQ will use “otdsws” as the default name. Specify a different name if needed.	Optional
CS CGI	Enter the connection information for the content services common gateway interface. The entry will look similar to the following example: http://{servername}/otcs/cs.exe.	Optional
Extension module installed?	Select if the Syntergy extension module is installed. This indicates if you use Syntergy API extensions for managing timestamps and author information. Learn more about Syntergy API Extensions.	Optional

Connection Test Succeeded

Features and Limitations

Platforms all have unique features and limitations. DryvIQ’s transfer engine manages these differences between platforms and allows you to configure actions based on Job Policies and Behaviors. The information below is platform specific. Use the Platform Comparison tool to see how your integration platforms may interact regarding features and limitations.

Supported Features	Unsupported Features	Other Features/Limitations
Version preservation	Segment path length	File size maximum: No maximum
Timestamp preservation	Permission preservation	Path length maximum: No maximum
Author/Owner preservation	Tags map	No leading spaces in file name/folder name (See Invalid Characters and Spaces below)
File lock propagation		No trailing spaces before or after file extensions
Mirror lock ownership		Invalid characters: \| \ / < > : ? * (See Invalid Characters and Spaces below)
Account map		Restricted types: none
Group map
User impersonation
Metadata map

Email Folders

OpenText supports email folders (subtype 751). DryvIQ cannot see the email folders and therefore, will not migrate content in these folders.

Invalid Characters and Spaces

DryvIQ verifies file and folder names to identify unsupported characters based on the platform. It then replaces invalid characters with an underscore (_) so the files and folders can be transferred. Similarly, DryvIQ will sanitize file names that contain combined Unicode characters by replacing the characters with an underscore (_).

The logic includes leading and trailing spaces in file and folder names. DryvIQ replaces the space rather than trimming it because trimming the space could cause duplicate file names. Adding the underscore ensures the name remains unique.

Create Connection | REST API

Creating a basic OpenText Connection

Create a basic OpenText connection at the following endpoint.

GET {{url}}v1/connections/platforms/opentext-cs/new

Creating a Connection with Applicable Authorization Type

{
  "name": "OpenText",
  "platform": {
    "id": "opentext-cs"
  },
  "auth": {
    "uri":"http://url",
    "username":"USER",
    "password":"PASSWORD",
    "auth_type":"ntlm"   
  }
}

Create a Job | REST API Job Configuration Example

Example Job: OpenText connection created as standard user, no impersonation

POST {{url}}v1/jobs

{
    "name":"Simple Job",
    "kind": "transfer",
    "transfer": {
      "transfer_type": "copy",
        "source": {
            "connection": { "id": "{{OpenText_Connection_sourceID}}" },
            "target": {
                "path": "/sourceDocumentLibrary"
            }
        },
        "destination": {
            "connection": { "id": "{{Box_Connection_destinationID}}" },
            "target": {
                "path": "/destinationFolder"
            }
        },
        "simulation_mode": false
    },
    "schedule": {
        "mode": "manual"
    },
    "stop_policy": {
        "on_success": 5,
        "on_failure": 5,
        "on_execute": 25
    },
    "category": {
      "name": "Report {Name}"
    }
}