OTDS Integration Administration Guide
OTDS Integration Administration Guide
LLESDSI220100-AGD-EN-02
OpenText™ Content Server
OpenText™ Directory Services Integration Administration
LLESDSI220100-AGD-EN-02
Rev.: 2021-Dec-02
This documentation has been created for OpenText™ Content Server CE 22.1.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Configuring Directory Services Integration ............................ 5
1.1 Configuring Directory Services ........................................................... 5
1.2 Configuring Directory Services Internal Process Settings ..................... 6
1.3 Configuring Integration Settings ......................................................... 8
1.4 Explaining the OTDS-specific Content Server installation pages ......... 14
1.5 Your Directory Services installation and Content Server .................... 17
OpenText Directory Services is an integral part of Content Server, and handles all
authentication for Content Server. During the installation of Content Server, the
administrator chose to install a particular version of Directory Services:
Internal OTDS
If your administrator selected an internal version of OTDS during the
installation of Content Server, you will be accessing the version of OTDS that
shipped with the Content Server installation files.
The internal OTDS installation creates and makes use of a Content Server
process in the System Object Volume. You can access this process directly from
the Content Server administration page, under the Directory Services
Integration Administration heading, click Configure Directory Services
Process. For more information about this process, see “To Edit an Internal OTDS
Process” on page 7.
Important
OpenText recommends the use of an external OTDS installation in order to
take advantage of high-availability capabilities.
Once you have completed the installation process for Content Server, you can
switch from an internal installation of OTDS to an external installation. For more
information, see “To Change from an Internal Installation of OTDS to an
External” on page 12.
External OTDS
If your administrator selected an external version of OTDS during the
installation of Content Server, you will be accessing a version of OTDS
downloaded from OpenText My Support (https://knowledge.opentext.com/go/
OTDS).
2. A new, separate page will open. This is the sign in page to either the internal or
the external OTDS user interface. By default, the user name is
“[email protected]”.
If you are signing in to the internal OTDS user interface, the password is the one
selected by your administrator during the installation of Content Server. When
signing in to the internal OTDS user interface, you can also use the Content
Server “Admin” userid.
If you are signing in to the external OTDS user interface, the password is the
one selected by your administrator during the installation of OTDS.
Enter your user name and password, and then click Sign in.
3. You can access the help for OTDS from the OTDS user interface by clicking the
help button at the top of the main page.
For more information on OpenText Directory Services, see OpenText Directory
Services - Installation and Administration Guide (OTDS-IWC) on OpenText My
Support (https://knowledge.opentext.com/go/OTDS). Select Documentation.
2. If you want to edit the ports that your internal installation of OTDS is using:
a. On the Internal OTDS page, under the Actions area, click Stop.
You will be returned to the administration page, click Configure Directory
Services Process.
b. On the Internal OTDS page, you can optionally change any of the port
fields. OpenText recommends that you do not edit any fields, other than
the port fields, unless directed by OpenText support.
c. Click Update.
d. Under the Actions area, click Start.
3. If you want to edit the ports that your internal installation of OTDS is using:
Tip: You can also access this page from the Content Server administration
page. Under the Search Administration heading, click Open the System
Object Volume. On the System page, click Process Folder.
2. If you want to delete your internal OTDS process, from the Internal OTDS
functions menu, select Delete.
Caution
Do not delete the Internal OTDS process if you intend to continue
using the version of Directory Services that installed as part of the
installation of Content Server. Only delete this process if you have an
externally installed and configured version of Directory Services.
Username Formatting
The Username Formatting area allows you to select how to format the value
in the above environment variable.
• Remove domain name: this will display the user name only. Choose this
option if uniqueness of user names is guaranteed across all domains in
your Windows domain registry. This is the default selection.
• Do not format: this will leave the user name unchanged. Choose this
option if uniqueness of user names is guaranteed only within each domain
in your Windows domain registry.
• Resolve through OTDS: the value from REMOTE_USER is sent to OTDS in
order to find the corresponding user name in Content Server. You must
configure OpenText Directory Services. For more information, see
OpenText Directory Services - Installation and Administration Guide (OTDS-
IWC) and the OTDS Release Notes on OpenText My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/KCProduct?
id=373), and then select Documentation.
Tip: You can use a shortcut to access this page directly, http://<fully_
qualified_server_name>/<Content Server_service_name>/cs.exe?
func=otdsintegration.settings.
An example of a URL is: http://machine1.opentext.com/OTCS/cs.exe?
func=otdsintegration.settings
• Remove domain name: this will display the user name only. This is the
default selection.
If you are using an internal installation of OTDS, leave Remove domain
name selected.
• Do not format: this will leave the user name unchanged.
• Resolve through OTDS: the value from REMOTE_USER is sent to OTDS
in order to find the corresponding user name in Content Server. You
must configure OpenText Directory Services. For more information, see
OpenText Directory Services - Installation and Administration Guide (OTDS-
IWC).
• Select Preserve Case to preserve the user name when the user signs in
to Content Server.
If you are using an internal installation of OTDS, leave Preserve Case
selected.
• Select Lowercase to change the user name to all lowercase letters when
the user signs in to Content Server.
a. In the OTDS Server URL box, enter the URL of the Directory Services
server.
The URL must include the fully-qualified domain and port number of the
Directory Services server. For example, the URL would be one of:
• http://<server_name>:<port_number>
• https://<server_name>:<port_number>
Note: The connection test does not check whether the OpenText
Directory Server is configured properly with Content Server. It only
checks that the URL provided in the OTDS Server URL box is valid.
a. In the OTDS Sign In URL box, specify a URL to which users are redirected
when they sign in. For an example of the URL convention, see Step 3.a.
Note: You might choose to select this option when OTDS is only
accessible to users through an external URL.
b. If you want to display a sign-out option for users that are authenticated
with single sign on, select Show log-out option for SSO users.
5. In the Web Administrator Password area, type the Content Server Web
Administrator Password in the box provided, and then click Save.
6. Next, do one of the following:
1. You must first create a database before you begin installing OTDS as an
external, stand-alone application. This database will contain all data that OTDS
manages. For more information, see OpenText Directory Services - Installation and
Administration Guide (OTDS-IWC).
Tip: You can use a shortcut to access this page directly, http://<fully_
qualified_server_name>/<Content Server_service_name>/cs.exe?
func=otdsintegration.settings.
An example of a URL is: http://machine1.opentext.com/OTCS/cs.exe?
func=otdsintegration.settings
a. In the OTDS Server URL field, enter the URL for the external installation
of OTDS.
For more information about this field and example URLs, see Step 3.a in
“To configure Directory Services integration settings:“ on page 10.
b. In the Resource Identifier field, ensure that the resource identifier
generated when you created a resource for Content Server in OTDS is
present.
If you need to retrieve the resource identifier from OTDS, see Editing a
synchronized resource (https://knowledge.opentext.com/knowledge/piroot/
otds/v210400/otds-iwc/en/html/jsframe.htm?s-editdelresource).
c. You can choose to click Test Settings to confirm that the URL entered in
the OTDS Server URL field is valid.
d. In the OTDS Sign In URL field, you can choose to specify a URL to
redirect users to sign in to OTDS.
For more information about this field and example URLs, see Step 3.a in
“To configure Directory Services integration settings:“ on page 10.
e. Type the Content Server Web Administrator Password in the field
provided, and then click Save Changes.
5. You can optionally choose to delete the internal OTDS process. For more
information, see “To Delete an Internal OTDS Process” on page 8.
• The administrator is required to select their OTDS server type during installation
on the http://MyContentServer.com/<CS_service_name>/cs.exe?func=
admin.otds page. For more information, see “The Configure OTDS Integration
Settings Content Server installation page” on page 14.
• Optionally, the administrator can choose to apply their Content Server license(s)
during installation on the http://MyContentServer.com/<CS_service_name>/
cs.exe?func=admin.licensesetup page. For more information, see “The
License Setup Content Server installation page” on page 16.
1. From the Server Type list, choose whether your OTDS installation is an internal
or an external installation.
The next fields that appear on this page depend on your selection in this field.
a. If you selected “External OTDS Server” in 1, you will see the following:
i. The Server URL box. A value in this box is required if you are setting up
an external OTDS installation. You need to enter the host name (or IP
address) and port of your OTDS server. For example, enter http://
MyOtdsServer.corp.com:8080
ii. The Resource ID box. A value in this box is required if you are setting up
an external OTDS installation. You need to enter the Resource Identifier
of the OTDS Resource that has been set up for use with Content Server.
An example of a resource ID is: dba563af-b01d-4f88-
bc42-2493c97dbc87.
iii. You can choose to click Test Settings to confirm that the URL entered in
the OTDS Server URL box is valid.
Note: The connection test does not check whether the OpenText
Directory Server is configured properly with Content Server. It
only checks that the URL provided in the OTDS Server URL box is
valid.
b. If you selected “Internal OTDS Server” in 1, you will see the following:
i. The JDBC URL box. A value in this box is required if you are setting up
an internal OTDS installation. You need to provide the direction to the
database that was set up for your OTDS server.
For example, if you are using an SQL server database, enter
jdbc:sqlserver://MyOtdsServer.corp.com;databaseName=
livelink
Important
You must take care when entering values to the three JDBC boxes.
These values cannot be validated at the time you enter them. Any
error in one of these three values will result in errors in the OTDS
logs.
ii. The JDBC Username box. A value in this box is required if you are
setting up an internal OTDS installation. Type the userid of a user with
the required privileges to access the database that you entered in i.
iii. The JDBC Password box. A value in this box is required if you are
setting up an internal OTDS installation. Type the password for the
userid that you entered in ii.
iv. The HTTP Port, HTTPS Port, and Stop Port boxes. A value in each port
box in the Jetty Parameters area is required if you are setting up an
internal OTDS installation.
2. Optionally, you can choose to enable Set OTDS login URL if you want to
explicitly set the OTDS URL to which users should be redirected, enter that URL
in this field.
If you have structured either a proxy or a containerized environment, then you
will need to ensure that the Login URL box contains that URL. If you do not
have either a proxy or a containerized environment, then you do not need to
enable this setting.
The following are two examples of the format of the URL that you will enter to
this field:
• https://servername.domain.com
• https://servername.domain.com:8443
You may need to put the port number after the base URL depending on how you
set up your proxy.
For more information, see OpenText Content Server - Installation Guide (LLESCOR-
IGD) on OpenText My Support (https://knowledge.opentext.com/knowledge/
llisapi.dll/open/2120999). Select Documentation.
• The Content Server License Overview area contains information about your
Content Server license, if one is applied. For information about the fields in this
area, see OpenText Content Server - Content Server Administration (LLESWBA-AGD)
on OpenText My Support (https://knowledge.opentext.com/knowledge/
llisapi.dll/open/2120999). Select Documentation and view the admin online help
collection.
• The Module License(s) Overview area contains information about your Content
Server module(s) license(s), if any is applied. For example, if you have licenses
for ObjectImporter or for WebReports, this area will display information about
those licenses.
• The System Fingerprint area provides you with your Content Server system
fingerprint. If you will be licensing Content Server, or any Content Server
module, you will need to copy the value in the System Fingerprint field to use
below. For more information, see OpenText Content Server - Content Server
Administration (LLESWBA-AGD) on OpenText My Support (https://
knowledge.opentext.com/knowledge/llisapi.dll/open/2120999). Select
Documentation and view the admin online help collection.
• The License Management area provides the OpenText Product Activation
website for Content Server (http://productactivation.opentext.com/
ContentServer) URL, and a License Location field so that you can apply a
Content Server license or a license to a Content Server module. To apply your
licenses during installation, on the License Setup page, do the following:
1. Click the product activation link to open the OpenText product activation
website, and then, do the following:
a. Sign in to the product activation website using the userid and password
provided to you when you purchased your OpenText product.
b. If you have more than one Content Server environment, select the
environment to which you will be applying the license.
d. You need to copy the value in the System Fingerprint field, as detailed
above, in order to generate a license file. You will be prompted to enter
your system fingerprint in the OpenText product activation website.
e. OpenText will send you the license file that you must apply to Content
Server. You may have multiple license files depending on the number of
OpenText products for which you chose to acquire license(s).
2. Return to the License Setup page. In the License Location field, click Choose
File.
Browse to the location that you saved the license file, and then click that
filename to select it. The license file will be a “<filename>.lic” file.
3. Click Apply to apply that license file to Content Server.
4. If you have more license(s) to apply, use the Choose File and Apply buttons
as detailed in 2 and 3 above to apply all licenses.
Important
You must apply each license file one at a time. In other words, use the
Choose File button to find and then select the license, and then click
Apply before proceeding to select and apply the next license.
5. Once you have finished applying your license(s), restart your Content Server
admin servers, and then click Continue.
If you choose not to license your Content Server installation, or your Content Server
module(s), at this time, you will need to follow the procedure found in OpenText
Content Server - Content Server Administration (LLESWBA-AGD) on OpenText My
Support (https://knowledge.opentext.com/knowledge/llisapi.dll/open/2120999).
Select Documentation and view the admin online help collection.
Important
If you change your Content Server database, or if you upgrade Content Server,
and you are using an internal installation of OTDS, you must follow the steps
in “To migrate OTDS data:“ on page 18 and “To Change from an Internal
Installation of OTDS to an External” on page 12 to point Content Server to the
database that contains your OTDS data.
1. If your Content Server installation uses an internal installation of OTDS and you
want to change your Content Server database, or you are upgrading your
installation of Content Server, you need to follow these instructions.
During the process of changing your Content Server database or upgrading
your Content Server installation, you will see the User and group migration
page.
2. On the User and group migration page, in the OTDS Partition box, type the
name of the OTDS partition that will be used by Content Server. This is the
OTDS partition that stores any users and groups created in Content Server or
migrated from the Content Server database.
Note: The partition name you enter will only be used when users and/or
groups are migrated from the Content Server database, or when users
and/or groups are created directly in Content Server instead of being
created through OTDS.
3. The Migrate option applies if you have an installation of Content Server with
CSDS, an internal installation of OTDS, or an external installation of OTDS:
b. If OTDS has never been used with Content Server, select the Migrate box to
migrate users and groups from the Content Server database to OTDS. The
Migrate option applies to migration of users and groups only.
Important
The migration function cannot distinguish users synchronized from
OTDS from internal Content Server users. If you have already
synchronized new users and/or groups from OTDS to Content Server,
and you use the migration option, you will end up with duplicate
users and groups.
There are three options associated with the Migrate option. You can select
any of the following:
Note: The migration function does not migrate CSDS users and
groups. It migrates the CSDS sync profile into OTDS, which can
then be used to import the same set of users.
If your internal Content Server groups have synchronized CSDS
members, you need to ensure that synchronized users and
groups exist in OTDS prior to migrating the internal Content
Server groups into OTDS. You can check to see if any of your
Content Server groups, that are not synchronized by CSDS,
contain synchronized CSDS members.
This is necessary so that the migration can find the DN of the
synchronized user or group in OTDS in order to create or
designate that user or group as a member of the migrated internal
group.
Under these circumstances, run the migration to migrate your
CSDS synchronized sources only. When all your synchronized
users and groups exist in OTDS, you can run the migration tool a
second time to migrate the internal users and groups.
4. Type the Content Server Web Administrator Password in the box provided,
and then click Continue. This process may take a few minutes.