CONTENT TRANSFORMATION SERVICES WITH BRANCH OFFICE CACHING SERVICES SETUP

ABSTRACT

This white paper explains how to install and configure CTS with 7.3 BOCS content

server setup .This paper is organized in a set of steps that needs to be followed in

sequence. It also covers various behaviors of CTS with respect to the BOCS settings

December, 2016

2

The information in this publication is provided “as is.” Dell Inc. makes no representations or warranties of any kind with respect to the

information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a particular purpose.

Use, copying, and distribution of any software described in this publication requires an applicable software license.

Copyright © 2016 Dell Inc. or its subsidiaries. All Rights Reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its

subsidiaries. Other trademarks may be the property of their respective owners. Published in the USA 12/16 White Paper H15702

Dell EMC believes the information in this document is accurate as of its publication date. The information is subject to change without

notice.

3

TABLE OF CONTENTS

EXECUTIVE SUMMARY ...........................................................................................................4

AUDIENCE ........................................................................................................................................ 4

ABBREVIATION ................................................................................................................................ 4

PRE REQUISITES ............................................................................................................................ 4

CTS-BOCS ENVIRONMENT SETUP ........................................................................................5

BOCS INSTALLATION ..............................................................................................................6

DMS INSTALLATION ............................................................................................................. 11

CONFIGURATIONS ................................................................................................................ 15

NETWORK LOCATION ................................................................................................................... 15

ACS CONFIGURATION .................................................................................................................. 16

BOCS CONFIGURATION ............................................................................................................... 18

DMS CONFIGURATION ................................................................................................................. 19

DISTRIBUTED TRANSFER CONFIGURATION ............................................................................. 20

CTS CONFIGURATION .................................................................................................................. 21

WDK CONFIGURATION ................................................................................................................. 22

CTS BEHAVIOUR IN BOCS ENVIRONMENT. ...................................................................... 23

TESTS ............................................................................................................................................. 24

Global and local settings behaviour ......................................................................................................... 25

TESTS on PARKED and NON PARKED CONTENTS ............................................................................. 25

TROUBLE SHOOTING ........................................................................................................... 26

ISSUE: ............................................................................................................................................ 26

Solution: ................................................................................................................................................... 26

ISSUE: ............................................................................................................................................ 26

Solution: ................................................................................................................................................... 26

REFERENCES ........................................................................................................................ 27

CONCLUSION ........................................................................................................................ 27

4

EXECUTIVE SUMMARY

This white paper is intended for D7.3 CTS users. It explains the step by step procedure to install and configure the CTS on a BOCS

Content server environment. Once the CTS is configured with BOCS, you can perform the transformation on both parked and non-

parked source contents. Parked content is one which is available on the BOCS server, and non-parked content is one that is not

available on the BOCS server.

With this setup, users can understand the behavior of CTS when it is configured with BOCS. This document covers the following points.

1. Installing BOCS and DMS.

2. Configuring BOCS,ACS and DMS using Documentum Administrator.

3. Installing and configuring CTS in a BOCS enabled repository.

4. Behavior of CTS with various options and parameters present in CTS with respect to BOCS.

AUDIENCE

This white paper is intended for DELL EMC customers, partners, internal developers and engineers. It is organized in a set of steps that

are easy to follow.

ABBREVIATION

Special terms, abbreviations and acronyms that may appear in this guide are defined below.

1. CS Content Server.

2. CTS Content Transformation Services.

3. BOCS Branch Office Caching Services.

4. DMS Documentum Messaging Server.

5. ACS Accelerated Content Servers.

6. DA Documentum Administrator.

7. DQL Documentum Query Language.

PRE REQUISITES

1. Install the 7.3 Content Server and create a repository. Refer the CS installation guide for the steps.

2. Install the DA and point it to the created repository.

All information included in this document is provided "as-is" and does not guarantee DELL EMC's support or approval. Please consult

the official product documentation or the Product Support team regarding any questions of supportability.

5

CTS-BOCS ENVIRONMENT SETUP

The below Figure explains the pictorial representation of CS-BOCS setup environment.

Figure 1. CTS-BOCS Environment Setup

6

BOCS INSTALLATION

Step by step installation procedure is given below to install the BOCS.

Download and extract the compressed distribution file.

Run the “bocsSetup.exe” installation file.

On the ‘License Agreement’ screen, choose the ‘I accept terms of the license agreement’, and click on the Next button.

7

In the Installation directory screen, specify the destination directory. For example, C:\Documentum and click Next.

In the ‘Installation owner password’ screen, type the installation owner’s password and click Next.

8

In the application server credentials window, assign a password to the administrative user. The default port is 8086. Change the

port number if this is different for your setup.

In the BOCS options screen, keep the default values for cache location, cache size and prime store location and click “Next”.

9

On the BOCS Pull Mode screen, keep the 'Enable Pull Mode' un-checked, and click next. This will keep BOCS in Push Mode.

On the BOCS Proxy Settings screen, select 'No' for 'Will there be a proxy server between BOCS and the Content Server?

10

On the Install preview screen, click on the Install button to start the installation.

Once the installation is complete, click on the 'Done' button, to close the installer wizard.

11

Check the URL http://<BOCS machine IP>:8086/bocs/servlet/ACS. This URL will be up once the BOCS is correctly installed.

DMS INSTALLATION

Step by step installation procedure is given below to install the Documentum Messaging Service (DMS). Please make sure that the ‘Pre

Requisites’ mentioned in this document are met with.

Select Start > All Programs > Documentum > Documentum Server Manager and on the Utilities tab, click Server Configuration, and

then select Documentum Messaging Service (DMS). Then Click “Next”

12

In the Installation owner screen, enter the installation owner’s password and click on “Next”.

In the DMS client - application server credentials window, assign a password to the administrative user and Click on “Next’.

13

In the next screen, enter the database information and DMS password and click on “Next”.

Further next, enter the connection broker information and click on “Next”.

14

In the global registries screen, provide the global registry password and click on “Next”

The installation will take some time, allow this to complete.

Once the DMS service is available, the URL http://<CSIP>:8489/dms-ws will start working. Check whether the DMS service is up, by

loading this URL.

15

CONFIGURATIONS

Login into Documentum Administrator and Navigate to “Distributed Content Configuration” and perform the following configuration.

NETWORK LOCATION

Create a one network location for ACS and one for BOCS.

Keep the IP address Range as <BOCS machine IP>-<BOCS machineIP>

16

ACS CONFIGURATION

Navigate to ACS Configuration and Click on Properties.

Then Mention the ACS URL http://<CSIP>:9080/ACS/servlet/ACS

17

In the “Projections & Stores” Tab, choose the option: “Associated Content Server”

18

BOCS CONFIGURATION

Navigate to BOCS Configuration page and Click on Properties and set the following

1. Network Location : BOCS network location

2. Content Access: Read, synchronous and asynchronous write.

3. Set the BOCS base URL as http://<Bocs machine Ip>:8086/bocs/servlet/ACS

19

DMS CONFIGURATION

Navigate to Messaging Server Configuration page and Click on Properties and set the following

1. Post URL : http://<CS machine ip>:8489

2. Consume URL : http://<CS machine ip>:8489

3. Check the option: “Enable content transfer messaging from repositories to this server”.

20

DISTRIBUTED TRANSFER CONFIGURATION

Navigate to Distributed Transfer settings and click on properties and set the following.

1. Check the “ACS Read” checkbox

2. Choose “Synchronous and Asynchronous write” in “ACS Write” Drop down.

3. Check the option “Enable pre-caching of content in this repository to BOCS servers “ check box

4. Under the options for “BOCS Encryption”, choose “Use BOCS encryption setting”.

21

CTS CONFIGURATION

Run the CTS configurator in CTS machine. Please refer the Content Transformation Services Installation guide for configuration steps.

Since the docbase is configured with BOCS, You will see the below new screen in the CTS configuration right after you entered the

docbase credentials.

Choose a Network Location and check all the Check boxes

Note: These information are captured in <CTS_HOME>/config/CTSServerService.xml file. These settings can be changed later.

Proceed with the CTS installation and complete it.

22

WDK CONFIGURATION

Make the below settings in the wdk/app.xml to enable the read write mode.

After completing the above configurations, Restart CS,BOCS,CTS and App server machine.

Figure 2. WDK Configurations

23

CTS BEHAVIOUR in BOCS ENVIRONMENT.

There are two types of content available in the BOCS environment

Parked Content: Imported document sits or is parked, in the BOCS server, and later moved to the CS based on Synchronous or

Asynchronous mode of write. For such a setting, the content in the BOCS machine is called parked content.

Non-parked Content: Content(Document) in the CS machines are called non parked content.

Once the CTS is configured with BOCS. Then you can perform the transformation in both parked and non-parked source contents.

These settings can be configured using the CTSServerService.xml file which is located in <CTS_HOME>\config folder.

The following parameter need to be made for CTS to work with BOCS setup

• processOnlyParked: If this is set to true, then CTS will transform only the parked contents .’false’ will process both parked

and non-parked contents.

• networkLocationId: Preferred network location identifier, if multiple network locations can be applied to the machine. The

network location identifiers need to be configured in the global registry repository. If this is not set, the first available network

location identifier will be used.

• allowBocsTransfer: Specifies whether BOCS content transfer is allowed (default: true).

• preferAcsTransfer: Sets the accelerated content transfer preference (default: true).

• allowSurrogateTransfer: Specifies whether surrogate transfer is allowed (default: true).

• parkingServerName: object_name of the BOCS config object associated with the BOCS server.

Note: If allowBocsTransfer = true, then preferAcsTransfer must be set to "true”, if the content has

to be retrieved through BOCS. This is a DFC requirement.

24

TESTS

The BOCS parameters can be set globally(common to all QueueProcessor) or locally (specific to the single QueueProcessor) in the

CTSServerService.xml file.

Global values can be set under “BocsConfig” tag which is present under <CTSServerConfig> tag.

<BocsConfig allowBocsTransfer="true" allowSurrogateTransfer="true" networkLocationId="" parkingServerName=""

preferAcsTransfer="true" processOnlyParked="false"/>

Local Values can be set directly under the corresponding queue processor.

Location of Global settings and local settings in the <CTS_HOME>\config\CTSServerService.xml are marked in the below picture.

Figure 3. BOCS Global and Local Settings

25

GLOBAL AND LOCAL SETTINGS BEHAVIOUR

When both global and local, then local values are taken into consideration.

Global values are taken into consideration only when there both dm_autorender_win31 and dm_mediaserver context are

empty.

When the global values and local’s dm_mediaserver values are set and dm_autorender_win31 value is are set to empty, then

both dm_mediaserver and dm_autorender_win31 uses the values which is set in dm_mediaserver.

When the global values and local’s dm_autorender_win31 values are set and the local’s dm_mediaserver is are set to empty,

then both dm_mediaserver and dm_autorender_win31 uses the values which is set in dm_autorender_win31.

Note: If local values are not defined, then global values are used as a fallback option.

Note: Ensure that you replicate the same values under all QueueProcessorContext nodes for a repository or define these settings in

one of the QueueProcessorContext nodes for a repository. If different set of values are specified in different QueueProcessorContext

nodes for the same repository, then the behavior will not be as required.

TESTS ON PARKED AND NON PARKED CONTENTS

To transform only parked contents, Set the values as below.

<CTSServer AttributeName="networkLocationId" AttributeValue="BOCS"/>

<CTSServer AttributeName="allowBocsTransfer" AttributeValue="true"/>

<CTSServer AttributeName="preferAcsTransfer" AttributeValue="true"/>

<CTSServer AttributeName="allowSurrogateTransfer" AttributeValue="true"/>

<CTSServer AttributeName="processOnlyParked" AttributeValue="true"/>

<CTSServer AttributeName="parkingServerName" AttributeValue="BOCSConfig"/>

In this case, CTS will pick the transformation request only from parked contents. Non Parked content will not be signed-off.

To transform only non-parked contents, Set the values as below.

<CTSServer AttributeName="networkLocationId" AttributeValue="ACS"/>

<CTSServer AttributeName="allowBocsTransfer" AttributeValue="false"/>

<CTSServer AttributeName="preferAcsTransfer" AttributeValue="true"/>

<CTSServer AttributeName="allowSurrogateTransfer" AttributeValue="true"/>

<CTSServer AttributeName="processOnlyParked" AttributeValue="false"/>

<CTSServer AttributeName="parkingServerName" AttributeValue="BOCSConfig"/>

In this case, CTS will pick the transformation request only from non-parked contents. Parked content will not be signed-off.

26

To transform both parked and non- parked contents, Set the values as below.

<CTSServer AttributeName="networkLocationId" AttributeValue="BOCS"/>

<CTSServer AttributeName="allowBocsTransfer" AttributeValue="false"/>

<CTSServer AttributeName="preferAcsTransfer" AttributeValue="true"/>

<CTSServer AttributeName="allowSurrogateTransfer" AttributeValue="true"/>

<CTSServer AttributeName="processOnlyParked" AttributeValue="false"/>

<CTSServer AttributeName="parkingServerName" AttributeValue="BOCSConfig"/>

In this case, CTS will pick the transformation request from both parked and non-parked contents.

Note: Transformation using the profiles like merge collection,merge virtual documents need the source documents (both child and

parent)either in parked or in non-parked location. If not, then CTS will not process it. It will throw the message “The content for the

queue item (xxxx) is not available” message in the CTS logs.

TROUBLE SHOOTING

ISSUE:

CTS is unable to pick a transformation request.

SOLUTION:

Check whether the time and the time zone is same in all the below machines. If not, then set same time.

1. CS machine

2. CTS machine

3. BOCS machine

4. Appserver machine(DA/DAM)

ISSUE:

Error message in CTS log “Could not download content file for document xxx.txt because content is temporarily parked. It will be

available when content is moved to a permanent storage area.”

SOLUTION:

Check whether the correct global registry details present in the dfc.properties which is location in c:\Documentum\config folder in CTS

machine. Make sure that the global repository mentioned in the properties file is this one which is configured with BOCS.

27

REFERENCES

1) Documentum Content Transformation Services Transformation Suite 7.3 Administration Guide.pdf

2) Distributed Content Configuration and Troubleshooting Guide.pdf(White Paper)

CONCLUSION

This white paper provides the complete procedure of setting up CTS in a BOCS enabled repository. With this setup, Users can

transform the parked and non-parked contents using various options provided in CTS. It also helps the user to trouble shoot the

common issues occur in the CTS-BOCS Setup.