Open Text® Transactional Content

Processing

Scenario Guide
08. Feb. 2010

This documentation describes the following scenarios: Open Text

Records Management, the Fulltext search scenario, Business
Activity Monitoring and dedicated attachments.

TCP100001-GCS-EN-2
Open Text® Transactional Content Processing
Scenario Guide
TCP100001-GCS-EN-2
Rev.: 08. Feb. 2010
This documentation has been created for software version 10.0.1.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
E-mail: [email protected]
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com

Copyright © by Open Text Corporation, Open Text Inc.

Open Text Corporation is the owner of the trademarks Open Text, The Content Experts, Great Minds Working Together,
Livelink, Livelink ECM, Livelink ECM-eDOCS, Livelink MeetingZone, MeetingZone, B2BScene, B2BScene.com, Client/Surfer,
Collaboration, Creative Desktop, Further Faster, Hyperinnovation, Internet Anywhere ,Livelink IRIMS, IRIMS, IXOS, Livelink
OnTime, OnTime, Livelink Remote Cache, Microstar, MyLivelink, O & Design, Odesta, Odesta Helix, Odesta Livelink, Open
Text Intranet, Open Text Web Index, Personality +, Putting Knowledge To Work, Techlib, The Hyperlinked Organization, The
Source For Business Knowledge, Worksmart, and World Of E among others. This list is not exhaustive.
ACKNOWLEDGEMENTS
SAP®, R/3® and SAP ArchiveLink® are registered trademarks of SAP AG.
Adobe® is a trademark of Adobe Systems Incorporated.
Lotus® and Lotus Notes® are registered trademarks of Lotus Development Corporation. Domino is a trademark of Lotus
Development Corporation.
Microsoft®, Microsoft SQL®, and Microsoft SharePoint® are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries.
Oracle® is a registered trademark of Oracle Corporation.
Netscape and the Netscape N and Ship's Wheel logos are registered trademarks of Netscape Communications Corporation in
the U.S. and other countries.
Firefox® is a registered trademark of the Mozilla Foundation.
Sentry Spelling-Checker Engine Copyright © 2000 Wintertree Software Inc.
WordNet 2.0 Copyright © 2003 by Princeton University. All rights reserved.
Outside In® Viewing Technology © 1992-2002 Stellent Chicago, Inc. All rights reserved. Outside In® HTML Export © 2002
Stellent Chicago, Inc. All rights reserved.
Portions of eDOCS DM are copyrighted by DataDirect Technologies, 1991-2002.
All other products or company names are used for identification purposes only, and are trademarks of their respective own-
ers. All rights reserved.
 Table of Contents

PRE Introduction 7
i What is Open Text Transactional Content Processing? .......................... 7
ii About this documentation ...................................................................... 10
ii.i Target Readership ................................................................................. 10
ii.ii Structure of this documentation ............................................................. 11
ii.iii Documentation overview........................................................................ 12
ii.iv Further documentation ........................................................................... 14
ii.v How to find documentation .................................................................... 14
ii.vi Conventions ........................................................................................... 14
iii Contact information ................................................................................ 16

Part 1 Open Text Records Management 17

1 Overview .................................................................................. 19
2 Customization Overview ......................................................... 23
3 Prerequisites ........................................................................... 25
4 Customizing classifications for Records Management ........ 27
5 Customizing Open Text Enterprise Library Services units
for TCP ..................................................................................... 29
5.1 Creating an application for TCP............................................................. 29
5.2 Defining item types................................................................................. 30
5.3 Importing the basic TCP folder type....................................................... 31

6 Installing the plug-in ............................................................... 33

7 Defining connections .............................................................. 35
7.1 Connecting Open Text Enterprise Library Services to TCP Context
Server..................................................................................................... 35
7.2 Connecting Livelink ECM – Enterprise Server to TCP Context Server . 36
7.3 Connecting TCP Context Server to Open Text Enterprise Library
Services ................................................................................................. 37

TCP100001-GCS-EN-2 Open Text Transactional Content Processing iii

Table of Contents

8 Customizing Records Management functionality for TCP ....39

9 Defining permissions ..............................................................43

Part 2 Fulltext solution for Open Text TCP 45

10 Installation of Livelink ECM – Enterprise Server 9.7.1 ..........47

10.1 Prerequisites .......................................................................................... 47
10.2 Installation .............................................................................................. 47
10.3 Configuration.......................................................................................... 47

11 Setup of the XML Activator .....................................................49

12 Configuring the fulltext engine ...............................................53
12.1 Configuration settings ............................................................................ 53
12.2 Fulltext server configuration on TCP Context Server side (Fulltext
server Configuration) ............................................................................. 55
12.3 Configuration of the fulltext query on Livelink ECM – Enterprise
Server..................................................................................................... 60
12.4 Specifying the search template ID in XML configuration file ................. 63
12.5 Enabling Fulltext for a Record Type with Open Text TCP Modeler....... 65

13 Configuring the fulltext carrier................................................69

13.1 Requirements......................................................................................... 69
13.2 Installation .............................................................................................. 69
13.3 Calling the fulltext carrier ....................................................................... 69
13.4 Configuring a carrier as job in Livelink ECM – Enterprise Server.......... 73

Part 3 Business Activity Monitoring 75

14 What is Business Activity Monitoring ....................................77

15 Configuring BAM .....................................................................81
15.1 Configuring a process for BAM .............................................................. 81
15.2 Creating a BAM report file...................................................................... 81
15.2.1 XML schema .......................................................................................... 82
15.2.2 Chart types............................................................................................. 84
15.2.2.1 Line chart ............................................................................................... 84
15.2.2.2 3D Column chart .................................................................................... 86
15.2.2.3 Multi-value chart..................................................................................... 87
15.2.2.4 Gauge chart ........................................................................................... 89
15.2.3 Expressions............................................................................................ 91
15.3 Deploying the BAM report file ................................................................ 93

16 Database tables .......................................................................95

16.1 Facts tables............................................................................................ 96

iv Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Table of Contents

16.2 Dimensions tables.................................................................................. 98

17 Examples of use .................................................................... 101

17.1 Average step duration per step and user............................................. 101
17.2 Finished processes of current year...................................................... 103
17.3 Finished processes per hour................................................................ 105
17.4 Average process duration per process in minutes............................... 107

Part 4 Customizing scenarios with dedicated attachments 109

18 Attachment scenarios ........................................................... 111

18.1 Attaching a record to a process when starting from the record ........... 111
18.2 Attaching a record to a process when starting from the process......... 111

IDX Index 113

TCP100001-GCS-EN-2 Scenario Guide v

Preface
Introduction

i What is Open Text Transactional Content

Processing?
Transactional content management is the basis of many core business processes in
any organization. These core business processes are high volume, and highly
repetitive in nature, therefore, requiring structured processing. They span from clerk
style user interaction to application integration.
Transactional Content Processing focuses the structured processing of transactional
content and addresses the following key problem areas:
Open Text Transactional Content Processing (or short TCP) addresses the following
main problem areas:
• Managing the paper burden
• Automating content-centric business processes
• Providing independent access to transactional content being stored by leading
applications (like SAP)
Businesses with a large number of relationships (e.g. customers) will benefit in
leveraging Open Text’s TCP technology. TCP is an application that has been
deployed in many businesses such as automotive, manufacturing, banking,
insurance and retail.
Managing the The act of manually retrieving information is a slow business process preventing
paper burden rapid access to content that might be used for critical, business decision support in a
customer case inquiry. Undoubtedly, this archaic approach of obtaining information
will render any organization uncompetitive.
Another real world scenario is the catastrophic event, for example, a fire, an
earthquake, or a flood where information will be lost irretrievably if business
continuity guidelines are not pre-established.
In all, paper based information must be available instantly to authorized personnel
throughout the entire organization regardless of whether they operate across
departments, in a centralized or even a distributed environment.
To manage millions of documents, critical metadata describing the documents or
document sections must to be captured and stored. This allows the fast and precise

TCP100001-GCS-EN-2 Open Text Transactional Content Processing vii

Introduction

retrieval of information by employees processing the business transactions. Sample

applications are enterprise archiving initiatives and folder solutions like Electronic
Case Management or Insurance Folders.
Automating Content-centric business processes are often customer facing (internal or external).
content-centric These customer facing processes are often highly repetitive, driven by fixed content
processes
and require integration into existing applications. To provide a faster customer case
management response, organizations are required to react immediately on changing
market requirements and new regulations. The management of transactional
content improves process efficiency, cuts processing cost (i.e. cost per transaction),
shortens elapsed time, enables change, and provides an audit log and management
overview of transactional processes. Sample applications are Accounts Payable,
Claims Management and Digital Mailroom solutions.
Independent Open Text TCP provides an infrastructure for access to transactional content,
access to independent of third-party software. For example, SAP documents can be accessed
transactional
content securely and consistent by internal or external business entities. Thus, the amount of
inquiries and paper mail will be drastically reduced, leading to cost reduction and
compliance with internal and mandated regulations. Sample applications are self-
service solutions, supplier portals, and compliant internal (or external) access to SAP
documents.
In addition, elaborate user management specifies access rights on various levels, to
meet security policies.
Web-based A TCP application is accessible via a Web browser. Thus, no client installation is
interface needed and you can access the application via intranet, extranet or internet.
System TCP consists of several components each with its unique functionality.
architecture

viii Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Introduction

Figure 1: TCP system architecture

Presentation layer
There are two ways to access a TCP application:
• TCP Web Client – TCP Web Client is what you see, when you access a TCP
application in a Web browser. It is your interface to the system and lets you
interact.
• Enterprise Connect – With Enterprise Connect, you can upload and access
Open Text TCP documents using Microsoft Office and Windows Explorer.
Application layer
TCP Application Server – TCP Application Server is the core of TCP. It controls
the services for document archiving and retrieving. The services communicate
with the connected repositories and handle requests, such as queries from the
TCP application.
Enterprise Process Services – As a member of the Open Text Content Services
family, Enterprise Process Services provides functionality for managing
structured business processes functionality. Enterprise Process Services is a
multi-purpose process engine that drives business processes and brings all
required documents to each process step. Through the technical interface of
Enterprise Process Services - available as Web Service (SOAP) - other systems
can interact and utilize its functionality. Enterprise Process Services is tightly

TCP100001-GCS-EN-2 Scenario Guide ix

Introduction

integrated into TCP and provides tools for designing, running, monitoring and
analyzing business processes.
Repository layer
TCP Context Server along with the process database and other external
repositories (databases and other data sources) stores all data except for attached
content files. These are stored by Open Text Enterprise Library Services.
Customization and Administration tools
Customization and Administration tools help you to set up, customize and
manage the system.
• TCP Modeler – creates and customizes a TCP application.
• Process Designer – implements business processes for a TCP application.
• Process Administrator – monitors and administers the process flow.
• TCP Configuration (Web-based) – allows the administrator to control
access to the system and to the documents contained within it. Furthermore,
general project administration and availability is handled here.
• TCP Context Server Administration / Context Server Configuration – are
two Web-based tools for administering TCP Context Server.
• User Management Client – manages users and user rights which are stored
on User Management Server.
• User Management Server Configuration – is a Web administration tool for
configuring User Management Server.

ii About this documentation

This documentation describes the customization of the following scenarios:
• Open Text Records Management for TCP documents
• Fulltext solution for Open Text TCP
• Business Activity Monitoring.
Each can be implemented optionally with Open Text TCP.
TCP product The TCP software is available in the Open Text Knowledge Center as product ISO
CD-ROM image; see
https://knowledge.opentext.com/knowledge/llisapi.dll/open/13000427. This
guide assumes that you burn the ISO image on a CD or DVD. Accordingly, this
documentation refers to the TCP product CD-ROM. Alternatively, you can also
mount the ISO image, however, this is not covered by this documentation.

ii.i Target Readership

This documentation is intended for customizers and system administrators of Open
Text TCP. It assumes knowledge of the administration of a network system, and a

x Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Introduction

basic knowledge of Open Text TCP and database administration corresponding to

the Open Text training course.
Recommended Open Text recommends that you read the following documentation before you start
reading administering Open Text TCP: Open Text Transactional Content Processing - User
Guide (TCP-UGD) and Open Text TCP Modeler - Customization Guide (TCP-CGD).

ii.ii Structure of this documentation

This documentation consists of parts, each describing an Open Text TCP scenario.

Part “Open Text Records Management”

This part describes the installation and customization of Open Text Records
Management. It consists of the following chapters:
Chapter “Overview”
This chapter describes the concept of the Records Management scenario.
Chapter “Customization Overview” on page 23
This chapter gives an overview of how to customize Open Text TCP for the
Records Management scenario.
Chapter “Prerequisites” on page 25
This chapter describes the prerequisites.
Chapter “Customizing classifications for Records Management” on page 27
This chapter explains how to customize classifications for Records Management.
Chapter “Customizing Open Text Enterprise Library Services units for TCP” on
page 29
This chapter describes how to customize Open Text Enterprise Library Services
units for Open Text TCP.
Chapter “Installing the plug-in” on page 33
This chapter describes how to install the Open Text TCP plug-in for Open Text
Enterprise Library Services.
Chapter “Defining connections” on page 35
This chapter explains how to connect the different systems to each other.
Chapter “Customizing Records Management functionality for TCP” on page 39
This chapter describes how to customize Records Management functionality for
TCP.
Chapter “Defining permissions” on page 43
This chapter explains how to define permissions.

Part “Fulltext solution for Open Text TCP”

This part describes the installation and configuration of a fulltext search scenario.

TCP100001-GCS-EN-2 Scenario Guide xi

Introduction

Chapter “Installation of Livelink ECM – Enterprise Server 9.7.1”

This chapter describes the installation and configuration of Livelink ECM –
Enterprise Server in a nutshell.
Chapter “Setup of the XML Activator”
This chapter describes how to configure the XML Activator.
Chapter “Configuring the fulltext engine”
This chapter describes how to set up the fulltext engine.
Chapter “Configuring the fulltext carrier”
This chapter describes how to configure the fulltext carrier.

Part “Business Activity Monitoring”

This part describes the concept of Business Activity Monitoring (short BAM) and
how to configure it. It consists of the following chapters.
Chapter “What is Business Activity Monitoring”
This chapter explains how BAM works.
Chapter “Configuring BAM”
This chapter explains how you customize TCP for the use of the BAM
functionality.
Chapter “Database tables”
This chapter lists the database tables containing available facts and dimensions.
Chapter “Examples of use”
This chapter contains sample configuration files.

Part “Customizing scenarios with dedicated attachments”

This part describes different scenarios for attaching processes to records or records
(documents) to processes.
Chapter “Attachment scenarios”
This chapter describes the customization steps of two scenarios for attaching a
record to a process.

ii.iii Documentation overview

The following documentation is available for TCP:
Release Notes
The Release Notes describe in detail the software supported by the product and
important dependencies, as well as any last-minute changes regarding the
documentation which should be made known. The current version of the Release
Notes is available in the Open Text Knowledge Center.
Open Text Transactional Content Processing - System Overview Guide (TCP-GGD)
This guide provides an initial overview of the concepts, components and the
environment of TCP.

xii Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Introduction

Open Text Transactional Content Processing - Installation Guide (TCP-IGD)

This guide describes the installation of all TCP components.
Open Text Transactional Content Processing - Upgrade Guide (TCP-DGD)
This guide describes the upgrade to the current version of TCP for all
components, also from BPM and the predecessor PDMS.
Open Text TCP Modeler - Customization Guide (TCP-CGD)
This guide describes the customization of TCP projects. It deals with conceptual
and practical topics, including the use of TCP Modeler.
Open Text Process Designer - Customizing Guide (PR-CPD)
This guide describes how processes can be designed graphically, for an
organization in general and for TCP Web Client in particular. Furthermore, it
provides information on Web Reporting.
Open Text Transactional Content Processing - Scenario Guide (TCP-GCS)
This guide describes:
• Installation and configuration of Records Management
• Installation and configuration of the fulltext solution for TCP.
• Implementation of Business Activity Monitoring
• Scenarios for attaching records (documents) to processes.
Open Text Transactional Content Processing - Administration Guide (TCP-AGD)
This guide describes the administration of all TCP components, such as Process
Administrator, TCP Context Server, TCP Configuration, User Management and
TCP Document Pipelines.
Open Text Transactional Content Processing - User Guide (TCP-UGD)
This guide describes how to use a TCP application. It describes the use with the
current TCP interface as well as with the PDMS UI.
API documentation
The API documentation introduces you into the concepts and basics of the
programming interfaces of TCP. It also provides references, programming
examples and other stuff that will help you getting started. The entry point to the
API documentation is the Open Text Transactional Content Processing -
Programming Guide (TCP-PGD).
The Open Text TCP Context Server - Programming Guide for the Open Text TCP
Context Server API (TCP-PDA) gives an introduction to the TCP Context Server
API. It helps the programmer to get a first overview of the comprehensive class
library and provides the basics and working principles as well as an overview of
the accompanying sample programs.
Note: The TCP Modeler Quick Start Guide is now integrated in the assistance
area of TCP Modeler, see section 3.2.1 "Main areas" in Open Text TCP Modeler -
Customization Guide (TCP-CGD).

TCP100001-GCS-EN-2 Scenario Guide xiii

Introduction

ii.iv Further documentation

Administrators who have no experience with Open Text Archive and Storage
Services (archive server) should read the Open Text Archive and Storage Services -
Administration Guide (AR-ACN).

ii.v How to find documentation

You can find the product documentation as follows:
• The product ISO image comprises the complete product CD-ROM in one *.iso
file. The product ISO image is available in the Open Text Knowledge Center:
Select the product family page and then click the Downloads link.
• The documentation of all products and all supported versions is available in the
Open Text Knowledge Center. See the Release Notes for details and links. In the
Knowledge Center, select the product family page, and then click the
Documentation link. In case, the required product belongs to the Livelink ECM
– Enterprise Server family, click the Livelink Module Documentation link and
select the product from the list.
Note: You can find the latest information on manuals and online help files for
each product in the corresponding Release Notes. This includes the
identification codes of the current documentation.

ii.vi Conventions
Read the following conventions before you use this documentation.
Typography In general, this documentation uses the following typographical conventions:
New terms
This format is used to introduce new terms, emphasize particular terms,
concepts, long product names, and to refer to other documentation.
User interface
This format is used for elements of the graphical user interface (GUI), such as
buttons, names of icons, menu items, names of dialog boxes, and fields.
Filename
command
sample data
This format is used for file names, paths, URLs, and commands in the command
line. It is also used for example data, text to be entered in text boxes, and other
literals.
Note: If a guide provides command line examples, these examples may
contain special or hidden characters in the PDF version of the guide (for
technical reasons). To copy commands to your application or command
line, use the HTML version of the guide.

xiv Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Introduction

Key names
Key names appear in ALL CAPS, for example:
Press CTRL+V.
<Variable name>
The brackets < > are used to denote a variable or placeholder. Enter the correct
value for your situation, for example: Replace <server_name> with the name of
the relevant server, for example serv01.
Hyperlink
Weblink (e.g. http://www.opentext.com)
These formats are used for hyperlinks. In all document formats, these are active
references to other locations in the documentation (hyperlink) and on the Inter-
net (Weblink), providing further information on the same subject or a related
subject. Click the link to move to the respective target page. (Note: The hyperlink
above points to itself and will therefore produce no result).
Cross- The documentation uses different types of cross-references:
references

Internal cross-references
Clicking on the colored part of a cross-reference takes you directly to the target
of the reference. This applies to cross-references in the index and in the table of
contents.
External cross-references
External cross-references are references to other manuals. For technical reasons,
these external cross-references often do not refer to specific chapters but to an
entire manual. If a document is available in HTML format, external references
can be active links though, that directly lead you to the corresponding section in
the other manual.1
Tip: Tips offer information that make your work more efficient or show
alternative ways of performing a task.
Note: Notes provide information that help you avoid problems.

Important
If this important information is ignored, major problems may be
encountered.

Caution
Cautions contain very important information that, if ignored, may cause
irreversible problems. Read this information carefully and follow all
instructions!

1 This applies, if target and source document are shipped together, e.g. on a product or documentation CD-ROM.

TCP100001-GCS-EN-2 Scenario Guide xv

Introduction

iii Contact information

Open Text Online is a single point of access for the product information provided by
Open Text. Depending on your role, you have access to different scopes of
information (see below for details).
You can access Open Text Online via the Internet at http://online.opentext.com/ or
the support sites at http://support.opentext.com/.
The following information and support sources can be accessed through Open Text
Online:
Knowledge Center
Open Text's corporate extranet and primary site for technical support. It is the
official source for:
• Open Text products and modules.
• Documentation for all Open Text products.
• Open Text Developer Network (OTDN): developer documentation and
programming samples for Open Text products.
• Patches for Open Text products.
The following role-specific information is available:
Partners
• Information on the Open Text Partner Program.
• Programs and support for registered partners.
Business Users
• Tips, help files, and further information from Open Text staff and other users
in one of the Open Text online communities
Administrators/developers
• Downloads and patches
• Documentation
• Product information
• Discussions
• Product previews
Feedback on If you have any comments, questions, or suggestions to improve our
documentation documentation, contact us by e-mail at [email protected].

xvi Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Part 1
Open Text Records Management
Part 1 Open Text Records Management

Open Text Records Management (in short: Records Management) enables

companies to control how and for how long enterprise content is retained, and
ensure its destruction when this time has elapsed.
Content This part contains the following chapters:
Chapter “Overview”
This chapter describes the concept of the Records Management scenario.
Chapter “Customization Overview” on page 23
This chapter gives an overview of how to customize Open Text TCP for the
Records Management scenario.
Chapter “Prerequisites” on page 25
This chapter describes the prerequisites.
Chapter “Customizing classifications for Records Management” on page 27
This chapter explains how to customize classifications for Records Management.
Chapter “Customizing Open Text Enterprise Library Services units for TCP” on
page 29
This chapter describes how to customize Open Text Enterprise Library Services
units for Open Text TCP.
Chapter “Installing the plug-in” on page 33
This chapter describes how to install the Open Text TCP plug-in for Open Text
Enterprise Library Services.
Chapter “Defining connections” on page 35
This chapter explains how to connect the different systems to each other.
Chapter “Customizing Records Management functionality for TCP” on page 39
This chapter describes how to customize Records Management functionality for
TCP.
Chapter “Defining permissions” on page 43
This chapter explains how to define permissions.

18 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 1
Overview
Enterprise Library Services Records Management (RM) ensures compliance and
reduces risk by enabling the full lifecycle management of all corporate information
assets in electronic or physical format. It enables companies to control how and for
how long enterprise content is retained, and ensure its destruction when this time
has elapsed.
Records Management maps record classifications to retention schedules. These
retention schedules fully automate the process of ensuring that records are kept as
long as legally required, and are assuredly destroyed when that time elapses. When
a retention schedule expires, final decisions can be made to destroy the object, retain
it for a period of time, or keep it indefinitely.
Note: In this chapter, records created by Records Management are called EL
(Enterprise Library) records to distinguish them from TCP records that are
simply called records in this documentation.
There are three ways to use the Records Management service functionality for TCP
documents:
• The TCP user declares individual TCP documents as EL records via the TCP user
interface (TCP Application Server).
• The customizer prepares TCP record types for the automatic creation of EL
records via the TCP Modeler. TCP documents of such record types are declared
as EL records by default.
• The process scenario is somewhat a combination of the two other scenarios. The
actual declaration is done automatically but the functionality is called in the
context of a business process. Therefore, declaring an (attached) document to a
record happens synchronously to the process execution. Consequently, the user
decision and/or implemented business logic leads to the if and how of declaring
a record.
Note: Only TCP documents can be put under Records Management control.
TCP data objects cannot be put under Records Management control, because
they cannot have content attached to them.
Records Management provides customer-specific Records Management types. A
Records Management type defines how long a document is retained, includes a
classification and some other definitions.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 19

Chapter 1 Overview

When you declare a TCP document as EL record or prepare a TCP record type for
EL record creation, you select one of these Records Management types. As a result
of the declaration, Records Management creates a corresponding record entry
within the Enterprise Library, linked to the TCP document.
After a TCP document was declared as EL record, the user will not be able to
perform any actions that change the record (e.g. delete, check-out). Only the
following actions are allowed for TCP documents that are under Records
Management control:
• Add notes
• Add and modify annotations
• Add and modify Add-On components (e.g. Pagelist)
• Add renditions
• Put a document under version control.
The TCP document may only be deleted by Enterprise Library Records
Management officers. If a Records Management officer deletes a TCP document, it
will be removed from Enterprise Library, TCP Context Server and archive server
(Archive and Storage Services). For details on the Records Management
functionality, see Livelink ECM™— Records Management - User's Guide (LLESRCM-
UGD).
This scenario requires components of the Enterprise Library that are not installed by
default. These have to be connected to the TCP Context Server and vice versa. For a
description of the installation of these components, see Open Text Enterprise Library
Services - Installation and Upgrade Guide (EL-IGD).

20 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Figure 1-1: TCP configuration for Records Management

How to put a TCP document under Records Management control:

1. There are two alternative ways to use the Records Management functionality for
TCP documents:
• Records Management scenario A: The customizer assigns a Records
Management type to a TCP document type in the TCP Modeler by selecting
one of the types defined in the Open Text Administration (Enterprise
Library). TCP documents of such record types are declared as EL records by
default. If customized, the user can modify or remove the record declaration
when creating a TCP document.
• Records Management scenario B: A TCP user (with the necessary
permissions) declares individual TCP documents as EL records via the TCP
user interface (TCP Application Server). The user selects one of the Records
Management types defined in the Records Management module.
As always, the TCP document (without its metadata) is stored by Open Text
Archive and Storage Services.
In both cases the ixos.dms:RMTypeID is set, it represents the Records
Management type.

TCP100001-GCS-EN-2 Scenario Guide 21

Chapter 1 Overview

2. For all TCP documents declared as records, TCP Context Server proceeds as
follows:
• TCP Context Server requests Enterprise Library Services to put the TCP
documents under Records Management control.
• TCP Context Server treats them as records. This means that these TCP
documents cannot be modified or deleted by standard means. Only
Enterprise Library Services can request TCP Context Server to delete such
TCP documents if the retention period is expired.
3. For each requested TCP document, Records Management creates a (logical) EL
record entry within the Enterprise Library, linked to the TCP document. This EL
record entry is stored on the Livelink ECM – Enterprise Server.
4. An Enterprise Library Services plug-in informs the TCP Context Server that the
EL record entry within the Enterprise Library is created. This is done by storing
the EL record entry creation date as property for each requested TCP document.
The EL record entry is now accessible in a special application workspace of the
Livelink ECM – Enterprise Server.

22 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 2
Customization Overview
Before you can use Records Management, the customization and configuration steps
have to be performed in different systems.

Major steps to customize Records Management for TCP

1. Customize classification for Records Management in Livelink administration:
a. Define codes for Records Management.
b. Define RM classifications.
2. Customize the following Enterprise Library units in the Open Text
Administration via the Customization node:
a. Create an Enterprise Library Services application (workspace) where the
records are be stored via the Applications sub-node, see “Creating an
application for TCP” on page 29.
b. Define item types (Records Management types) that define how a record is
treated by Records Management (for example duration of retention period)
via the Types sub-node, see “Defining item types” on page 30.
c. Import the TCP folder type (from the TCP product CD-ROM) that defines
how a record is treated by Records Management (for example duration of
retention period) via the Types sub-node, see “Importing the basic TCP
folder type” on page 31. .
3. Install the plug-in for Enterprise Library that informs TCP Context Server when
Enterprise Library records are created. Customize the plug-in in the Open Text
Administration via the Core Services – Configuration – Plugin Configurator
node.
4. Define connections between the systems:
a. Configure the connection from Enterprise Library to TCP Context Server in
the Open Text Administration (Enterprise Library) via the Core Services –
Configuration – Content Service node. You have to specify the server and
the port of TCP Context Server.
b. Configure the connection from the Livelink ECM – Enterprise Server to the
TCP Context Server in the Open Text Administration via the Enterpise

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 23

Chapter 2 Customization Overview

Services – Storage Providers node. You have to specify the server and the
port of TCP Context Server.
c. Configure the connection from TCP Context Server to Enterprise Library in
TCP Context Server Web configuration via the RM configuration package.
5. To view the item types (Records Management types) immediately that are
available on TCP Context Server, refresh the TCP Context Server
Administration window.
6. Assign Records Management types to record types in TCP Modeler.
7. Import the certificate of Livelink ECM – Enterprise Server into TCP Context
Server. In the User Management Client, assign the user that was generated
during the certificate import to the PropertyReadGrantees and RMGrantees
groups.

24 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 3
Prerequisites
• You have installed TCP Context Server and performed the post-installation steps
according to Open Text Transactional Content Processing - Installation Guide (TCP-
IGD).
• You have set up Open Text Enterprise Library Services and performed the post-
installation steps according to Open Text Enterprise Library Services - Installation
and Upgrade Guide (EL-IGD).

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 25

Chapter 4
Customizing classifications for Records
Management
You must customize at least one Records Management classification.
Note: For detailed information on configuring Records Management, see Open
Text Enterprise Library Services - Installation and Upgrade Guide (EL-IGD).

To define codes:
1. Log on to Livelink ECM – Enterprise Server (Enterprise Server for short) as
administrator.
2. From the Enterprise menu, choose Records Management.
3. On the Records Management page, click the Records Management
Administration link.
4. On the Records Management Administration page, click the Table
Maintenance link.
5. On the Records Management Table Maintenance page, add at least the
following codes to each for these tables:
Table Code to Add (Description)
Essential record ESS (Essential)
Status ACT (Active)
Storage Medium ARC (Archive)

a. Click the link for the table you want to add a code to.
b. Choose a code type from the Add item menu.
c. Enter a code and a description.
d. Click Submit.

To define RM classifications:
1. Log on to Enterprise Server as administrator.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 27

Chapter 4 Customizing classifications for Records Management

2. From the Enterprise menu, select Classifications. From the Add Item menu,
select RM Classification.
3. Enter the details for the classification:
• Name: Any name, e.g. Basic RM Classification.
• Description: Optional. Enter a description.
• Selectable: Select to specify that the classification can be applied to
Enterprise Server objects.
• File number: Select a unique value that does not exist yet in this part of the
classification tree, e.g. 0001.
• Creation date: Default is the current date.
• Status: Select one (see codes defined above).
• Status date: Default is the current date.
• Essential: Select one (see codes defined above).
• Storage medium: Select one (see codes defined above).
Add additional information if required.

28 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 5
Customizing Open Text Enterprise Library Services
units for TCP
Customize the following Enterprise Library units in the Open Text Administration
via the Customization node:
• Create an Open Text Enterprise Library Services application, see “Creating an
application for TCP” on page 29.
• Create item types, see “Defining item types” on page 30.
• Import the TCP folder type, see “Importing the basic TCP folder type” on
page 31.

5.1 Creating an application for TCP

To connect a client application for TCP to Open Text Enterprise Library Services you
create an Open Text Enterprise Library Services application. The application
provides a unique ID and a password that the client application uses for
authentication.

To create an application:
1. Start the Administration client, see section 8.1 "Working with Administration
Client" in Open Text Enterprise Library Services - Installation and Upgrade Guide
(EL-IGD).
2. In the console tree, expand Content Services and log on to the Library Server.
3. Select the Enterprise Library Services > Applications node.
4. From the action pane, select New Application....
5. In the New Application wizard, specify the following settings:
• Application name: Enter an application name, for example, TCP.
• Description: Optional: Enter a description of the application, for example
TCP Context Server.

• Active: Keep selected.

• Password/Confirm password: Enter the password to access the application.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 29

Chapter 5 Customizing Open Text Enterprise Library Services units for TCP

6. Click Next.
7. Optional: On the Audit interests page, specify the audit interests.
8. Click Finish.

For details on creating applications, see section 2.1 "Creating and modifying
applications" in Open Text Enterprise Library Services - Administration - Applications
and Document Model (ELWS-AGD)

5.2 Defining item types

Item types define how a record is treated by Records Management.

To create item types:

1. Start the Administration client.
2. In the console tree, expand Content Services and log on to the Library Server.
3. Select the Enterprise Library Services > Document Model node.
4. In the action pane, click New Item Type ....
5. In the New Item Type wizard, specify the following settings:
• Item type name: Enter a name together with a namespace. You can use the
namespace later to filter the available Records Management types in TCP,
see “Customizing Records Management functionality for TCP” on page 39.
• Description: Optional: Enter an explanation of the item.
• Indexing Mode: Select an indexing mode. You can also disable indexing.
6. Click Next.
7. On the Classification page, set a default classification:
a. Select Set Default classification.
b. Via Browse, select a classification you defined in “Customizing
classifications for Records Management” on page 27.
8. Click Next.
9. On the Variant Layout page, select the Version variant layout and then click
Add.
10. Click Next.
11. On the Summary page, check the settings and click Finish.
12. Create further item types if required.

30 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 5.3 Importing the basic TCP folder type

For details on creating item types, see section 4.2 "Creating and modifying item
types" in Open Text Enterprise Library Services - Administration - Applications and
Document Model (ELWS-AGD)

5.3 Importing the basic TCP folder type

Import the basic TCP folder type from the TCP product CD-ROM. This folder type
defines how a record is treated by Records Management (for example duration of
retention period).

To import the TCP folder type:

1. Start the Administration client.
2. In the console tree, expand Content Services and log on to the Library Server.
3. Select the Enterprise Library Services > Document Model node.
4. In the result pane, click the Folder Types tab.
5. In the action pane, select Import Types. To import the folder type, browse to the
following folder:
<TCP product CD-ROM>/EnterpriseLibrary/Plugin4context

Import the file com.opentext.tcp.folder.xml.

The new folder type com.opentext.tcp.folder is displayed on the Folder
types tab.
6. From the context menu of the new folder type, select Properties. Specify the
following settings on the General tab:
• Description: Optional: Enter an explanation of the folder.
• Default Classification: Select a classification you defined in “Customizing
classifications for Records Management” on page 27.
• Indexing Mode: Select an indexing mode. You can also disable indexing.
7. Save your entries with OK.

For details on importing folder types, see section 4.5.3 "Importing types" in Open
Text Enterprise Library Services - Administration Online Help - Applications and
Document Model (ELWS-H-AGD).

TCP100001-GCS-EN-2 Scenario Guide 31

Chapter 6
Installing the plug-in
The plug-in installed in Enterprise Library Services informs TCP Context Server that
the EL record entry within Enterprise Library is created.

To install and configure the plug-in:

1. On the machine running Enterprise Library Services copy the file
contextPlugins.jar from directory
<TCP product CD-ROM>/EnterpriseLibrary/Plugin4context
to directory
<TomcatHome of EL>/common/lib/csjars.

2. Start the Administration client.

3. In the console tree, expand Content Services and log on to the Library Server.
4. Select the Runtime and Core Services > Configuration > Plug-ins node.
5. To add a property:
a. From the actions pane, select New Property.
The New Property wizard opens.
b. Enter the property name, select Global as scope and select the datatype
according to the table below.
c. Click Next.
Enter or select the property value according to the table below.
Click Next and then Finish.
Add the following properties:

Property Name Scope Datatype Property Value

pluginservice.pl Global String AfterMakeRecord
ugins.RM_CONTEXT
_PLUGIN.events

pluginservice.pl Global Boolean False

ugins.RM_CONTEXT
_PLUGIN.isReentr
ant

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 33

Chapter 6 Installing the plug-in

Property Name Scope Datatype Property Value

pluginservice.- Global Boolean False
plugins.-
RM_CONTEXT_PLUGI
N.-
loadOnEveryReque
st

pluginservice.- Global String com.opentext.ecm

plugins.- .tcp.plugins.RMC
RM_CONTEXT_PLUGI ontextPlugin
N.systemName

6. Restart your Open Text Enterprise Library Services.

34 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 7
Defining connections
You define the following connections:
• From Open Text Enterprise Library Services to TCP Context Server, see
“Connecting Open Text Enterprise Library Services to TCP Context Server” on
page 35.
• From Livelink ECM – Enterprise Server to TCP Context Server, see “Connecting
Livelink ECM – Enterprise Server to TCP Context Server” on page 36.
• From TCP Context Server to Open Text Enterprise Library Services, see
“Connecting TCP Context Server to Open Text Enterprise Library Services” on
page 37.

7.1 Connecting Open Text Enterprise Library

Services to TCP Context Server
You connect Open Text Enterprise Library Services to TCP Context Server in the
Core Services object of Open Text Enterprise Library Services.

To connect Open Text Enterprise Library Services to TCP Context Server:

1. Start the Administration client.
2. In the console tree, expand Content Services and log on to the Library Server.
3. Select the Runtime and Core Services > Configuration node.
4. Select Content Service.
5. Modify the following settings to point to your TCP Context Server:
• DSHOST
• DS_RCPORT
To modify the setting:
a. Select the entry.
b. From the actions pane, select Properties.
c. Change the setting and save your entries with OK.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 35

Chapter 7 Defining connections

6. Restart your Open Text Enterprise Library Services.

7.2 Connecting Livelink ECM – Enterprise Server to

TCP Context Server
To connect Livelink ECM – Enterprise Server to TCP Context Server:
1. Start the Administration client.
2. In the console tree, expand Content Services and log on to the Library Server.
3. Select the Enterprise Library Services > Enterprise Services > Storage
Providers node.
4. In the results pane, select the Plug-ins tab.
a. Select Enterprise Archive Storage Provider.
b. From the actions pane, select Properties.
c. Modify the following settings:
• Server name: Enter the TCP Context Server name.
• Port: Enter the TCP Context Server ports.
• Protocol (in section Archive and Storage Services): Enter the TCP
Context Server protocol.
d. Save your entries with OK.
5. In the results pane, select the Storage Providers tab.
a. From the actions pane, select New Provider.
b. Specify the following settings:
• Name: Enter a name.
• Type: Select Enterprise Archive.
Click Next.
c. Specify the following settings:
• Logical Archive: Select an archive.
• Select Delete Documents from Archive.
d. Click Next and then Finish.
6. In the results pane, select the Storage Rules tab.
a. From the actions pane, select New Rule .

36 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 7.3 Connecting TCP Context Server to Open Text Enterprise Library Services

b. Specify the following settings:

• Description: Enter a description.
• Logical Storage Provider: Select the storage provider you created before.
• Rule: Select a rule, e.g. Always.
Click Next.
c. If the rule you selected requires an value enter it in the Value field and click
Finish. Click Next.
d. If required, click Next again and then click Finish.
e. If required define additional rules.
f. If you defined more than one rule, define the order of rules: Select the rule
in the results pane and use the arrows in the action pane to move the rule.

7.3 Connecting TCP Context Server to Open Text

Enterprise Library Services
To define settings for the RM package:
1. To start the application for configuring TCP Context Server, open a browser
window and enter the following address in the address bar:
<protocol>://<server>:<port>/archive_config

2. In the log-in window, enter Admin as the user name and geheim as the
password.
3. Select the RM package.
4. Specify the following settings:
• Enabled: select on to enable Records Management for TCP.
• Enterprise Library Services Application Name: Enter name and password
of the Enterprise Library application you created in “Creating an application
for TCP” on page 29.
• Enterprise Library Services Application Password: Enter the password you
specified for the application.
• Enterprise Library Services Folder Type: Enter the name of the folder type
you created in “Importing the basic TCP folder type” on page 31.
• Enterprise Library Services Host: Enter the host.
• Enterprise Library Services Port: Enter the port.
• Enterprise Library Services User: Enter the user.
• Enterprise Library Services User Password: Enter the password for the user.

TCP100001-GCS-EN-2 Scenario Guide 37

Chapter 7 Defining connections

• RMAdmin Password: Password of the RMAdmin user defined on the User

Management Server. Default is geheim.
5. Specify the following settings:
6. Save your entries.
7. Restart your TCP Context Server.

To check the settings:

1. To start TCP Context Server administration, open a browser window and enter
the following address in the address bar:
<protocol>://<server>:<port>/archive/admingui

2. In the log-in window, enter DMSAdmin as the user name and your password and
select Server Information.
The Context Server Info section shows the following:
• RM Enterprise Library Host
• RM Status
The Record Management Types show the item types you specified in “Defining
item types” on page 30.

38 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 8
Customizing Records Management functionality for
TCP
In TCP Modeler, you customize the Records Management functionality for record
types and projects.
The customization steps in TCP Modeler are different for the two Records
Management scenarios described in
Procedure 1.1, How to put a TCP document under Records Management control: on
page 21.
Records Management scenario A
Short scenario description: The customizer assigns a Records Management type
to a TCP record type in TCP Modeler.

To assign an EL Records Management type to an TCP record type

1. Click a record type in the internal data dictionary.
2. In the properties area, click the Records Management tab.
3. Select a Default records management type.

Note: You can only assign an EL Records Management type to an internal

TCP document type.
The selected default records management type is stored in the record type’s
ixos.dms:DefaultRMTypeID property.

Records Management scenario B

Short scenario description: A TCP user (with the necessary permissions) declares
individual TCP documents as EL records via the TCP user interface.

How to enable the Records Management convenience feature in a project

• Select the Enable records management check box on the project's Features
tab. By default, the Records Management convenience feature is disabled in
new TCP projects. Enabling this option has the following effects:
• The ixos.dms:RMType system record type is added to the Record Types
node of your project. This record type is read-only.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 39

Chapter 8 Customizing Records Management functionality for TCP

• For record types and query specification types below the Forms node in
GUI profiles, there is the Enable records management option on the
Features tab in the properties area.

How to enable the Records Management convenience feature in a form

Once you have enabled Records Management on project level, you have to
enable it for the forms where you want to offer this feature to the user. To this
end, proceed as follows:
1. Navigate to the Forms node of a GUI profile and select a record type node or
a query specification type node.
2. On the Features tab of the GUI Profile Record Type or the GUI Profile
Query Specification Type, select the Enable records management check
box.
Enabling this option adds different records management fields to the forms.
These additional fields allow the user to search for and to view records
management specific document properties.

Property types
• ixos.dms:RMDate: Date on which an object was technically declared as
record.
• ixos.dms:RMTypeName: Name of the item type defined in “Defining item
types” on page 30.
• ixos.dms:RMTypes: Name list of item types.

• ixos.dms:RMTypeId: Name of an item type with the name list of item

types.

Added fields
• Fields tab in list area: The fields for the ixos.dms:RMDate and
ixos.dms:RMTypeId property types are added as well as the
ixos.dms:RMTypes relationship. For the relationship field, the Displayed
property type is set to ixos.dms:RMTypeName.
• Inspect form: Property types ixos.dms:RMTypeId and ixos.dms:RMDate
become visible.
• Edit form: ixos.dms:RMTypes relationship becomes visible.
• New form: ixos.dms:RMTypes relationship becomes visible.
• Hit list form: Property types ixos.dms:RMTypeId and ixos.dms:RMDate
become visible.
• Query form: Property type ixos.dms:RMDate and relationship
ixos.dms:RMTypes become visible.

40 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 • Version History form: Property types ixos.dms:RMTypeId and
ixos.dms:RMDate become visible.

3. Optional: If you want to restrict the available Records Management types in

selection lists in the UI, you should define a qualifier type and assign this
type the Read Properties permission on record type ixos.dms:RMType.
a. Define a qualifier type with query condition [ixos.dms:RMTypeName]
like "your_namespace*"‘. Use the namespace you defined in “Defining
item types” on page 30.
b. Create a new permission profile and assign this qualifier type to the
Read Properties permission.

c. Select the record type ixos.dms:RMType and assign the permission

profile to each group that should have a filtered list of record
management types.

If you remove one of the fields, the Enable records management check box is
disabled.

TCP100001-GCS-EN-2 Scenario Guide 41

Chapter 9
Defining permissions

1. Import the certificate for the Livelink ECM – Enterprise Server. Proceed as
described in section 25.5.3 "Protecting the client connection" in Open Text
Transactional Content Processing - Administration Guide (TCP-AGD). When you
import the certificate, a user is created automatically.
2. Start the Open Text User Management Client. Proceed as described in section 28
"Working with User Management Client" in Open Text Transactional Content
Processing - Administration Guide (TCP-AGD).
3. Assign the generated user to the following groups:
• PropertyReadGrantees

• RMGrantees

Proceed as described in section 29.4.9 "Assigning users or groups to other

groups" in Open Text Transactional Content Processing - Administration Guide
(TCP-AGD).

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 43

 Part 2
Fulltext solution for Open Text TCP
Part 2 Fulltext solution for Open Text TCP

This part of the Scenario guide describes the installation and configuration of the
fulltext solution for Open Text TCP on all supported operating systems. For the
installation, operating system knowledge is required.
Recommended In this fulltext solution, Enterprise Server is used as fulltext search engine.
reading The complete fulltext concept is described in the following documents. You find
them in the Knowledge Center in subfolders of the following URL:
https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&objId=8848105.
• Livelink Search – Advanced Indexing and Searching Guide 9.7.0
• Livelink ECM - Enterprise Server 9.7.1 Online Help for Administrators
• Livelink ECM - Enterprise Server 9.7.1 Installation Guide
For a description how you use the error queues to monitor fulltext servers, see
section 25.10.2 "Using the Fulltext Server error queues" in Open Text Transactional
Content Processing - Administration Guide (TCP-AGD).
Content This part contains the following chapters:
Chapter “Installation of Livelink ECM – Enterprise Server 9.7.1”
This chapter describes the installation and configuration of Livelink ECM –
Enterprise Server in a nutshell.
Chapter “Setup of the XML Activator”
This chapter describes how to configure the XML Activator.
Chapter “Configuring the fulltext engine”
This chapter describes how to set up the fulltext engine.
Chapter “Configuring the fulltext carrier”
This chapter describes how to configure the fulltext carrier.

46 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 10
Installation of Livelink ECM – Enterprise Server
9.7.1
This chapter contains a brief description of the installation of Livelink ECM –
Enterprise Server 9.7.1.
The below-mentioned Livelink ECM - Enterprise Server Installation Guide is available
in the Knowledge Center at the following URL
https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&objId=13685329.

10.1 Prerequisites
For detailed prerequisites please refer to the Release Notes of Open Text
Transactional Content Processing and Livelink ECM – Enterprise Server.

10.2 Installation
Perform the Enterprise Server installation as described in Livelink ECM™ - Enterprise
Server - Installation Guide (LLESCOR-IGD).

10.3 Configuration
Perform the Enterprise Server configuration as described in section 6 "Configuring
Livelink" in Livelink ECM™ - Enterprise Server - Installation Guide (LLESCOR-IGD).

1. Start the Livelink Administration.

2. Select the Configure Server Parameter link and enter the Admin password, the
license key and the path to the upload directory. For details refer to section 6.6
"Configuring General Settings" in Livelink ECM™ - Enterprise Server - Installation
Guide (LLESCOR-IGD).
3. Select the Database Administration link and create a new database and a new
database user and create the database tables. For details, refer to section 7
"Creating the Livelink Database" in Livelink ECM™ - Enterprise Server -
Installation Guide (LLESCOR-IGD).
Note: Select the option to store the documents in a directory rather than in
the database.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 47

Chapter 10 Installation of Livelink ECM – Enterprise Server 9.7.1

4. Create the Enterprise Database Source. For details, refer to section 8.3 "Creating
the Enterprise Index" in Livelink ECM™ - Enterprise Server - Installation Guide
(LLESCOR-IGD)).
5. Change the Administrator password. For details, refer to section 8.6.1
"Changing the Admin User Password and Profile" in Livelink ECM™ - Enterprise
Server - Installation Guide (LLESCOR-IGD).

48 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 11
Setup of the XML Activator

1. Add the fulltext query user:

a. Log in to Enterprise Server as user Admin and open the Livelink Workspace.
b. Click User & Groups and then Add Item to add the fulltext query user, e.g.
user fulltext.
c. Confirm with the Submit button.
2. Add the XML Activator:
a. Go to the Livelink Administration Page (e.g.
http://ll_server/livelink/livelink.exe?func=admin.index) and open the
System Object Volume which can be found under the Search
Administration option.
Tip: It is a good idea to add this page to the Favorites, either of your
browser or the Enterprise Server.
Here you can see the data sources, search templates and slices.
b. Click the Add Item button and then XML Activator Producer Data Source.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 49

Chapter 11 Setup of the XML Activator

c. Define the settings for the XML Activator:

Processes Prefix
Enter a unique fulltext ID for all the objects associated with this index in
the Processes Prefix field.
Incoming Directory
In the Incoming Directory field, enter the absolute path of the directory
in which you want the XML Activator Producer process to read the XML
files. The XML files contain meta and content information from the TCP
Context Server which will be transported by the carrier.
Write Directory
In the Write Directory field, enter the absolute path of the directory in
which you want the XML Activator Producer process to write the data

50 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 that it extracts.
It is sufficient to define the Write Directory only in the XML Activator
Information section. When you move the cursor in the next field, the
corresponding directory field in the Intermediate Document
Conversion and Consumer Livelink Index sections are automatically
filled and must not be changed.
Tip: For detailed information about indexing and searching, see the
Livelink Search – Advanced Indexing and Searching Guide 9.7.0
(available in the Knowledge Center
(https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&
objid=13685329)
(https://knowledge.opentext.com/knowledge/llisapi.dll?func=ll&
objId=13685329)).
Operation Tag
The Operation Tag field must have the value Operation.
Identifier Tag
The Identifier Tag field must have the value OTURN.
If you are not very familiar with fulltext solutions, Open Text recommends
keeping the default settings for the rest. For details refer to the Livelink
Administration online help.
Click the Create Processes button.
d. When all processes have been created, click the Continue button to return to
the Livelink System page.
3. Define the scheduling and start the XML Activator:

a. Open the data source folder that you have added in the last step.
b. Click Data Flow Manager and then XML Activator.
The properties of the XML Activator are displayed.
c. Define the scheduling in Start Options and confirm with the Update button.
d. To start the scheduling of the XML Activator select the Start item in the
dropdown list of the XML Activator.

TCP100001-GCS-EN-2 Scenario Guide 51

Chapter 11 Setup of the XML Activator

52 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 12
Configuring the fulltext engine
For the configuration of the fulltext engine the installation directory of the fulltext
carrier must be known. For details refer to “Installation” on page 69.

Important terms
Data Source
A Data Source is a part (Slice) of the indexed data in an Enterprise Server. It
contains an indexing and search engine. There are several types of Data Sources,
each representing data from different sources (e.g. file system or data from other
systems).
Partitions
Partitions within a Data Source allow distributing the data to smaller sized
indexes.
Data Flow Manager
The Data Flow Manager of a Data Source controls the indexing of the data.
XML Activator
The XML Activator is reading the document content, which is stored as XML file,
and then writing the content to the document conversion process.
Document Conversion Process
A document conversion process extracts the raw data.
Fulltext Carrier
The fulltext carrier is transmitting the documents from the Context Server to the
fulltext engine data source.

12.1 Configuration settings

The configuration settings of the fulltext engine divide into three parts:
1. Settings on the Context Server side
2. Settings on the Enterprise Server side
3. Settings defining the communication between Context Server and Enterprise
Server
Some of these settings are defined in the Fulltext Server - Configuration, either as
individual values or as part of the XML configuration file (see step 6 in “Fulltext

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 53

Chapter 12 Configuring the fulltext engine

server configuration on TCP Context Server side (Fulltext server Configuration)” on

page 55).
Others are defined directly in the Enterprise Server Administration page.

Settings on Context Server side

Fulltext Id
The fulltext Id identifies the fulltext search engine on Context Server side. It must
be unique.
MIME types
The carrier does not index all content by default. The configuration allows
defining either an inclusion or exclusion list of MIME types to be indexed. An
inclusion list would be defined by setting the default to false and appends a list
of MIME types that should be indexed. The exclusion list is defined just the other
way round.
Content types
As with MIME types, it is also possible to define an inclusion or exclusion list for
content types that should or should not be indexed.
You can edit the MIME types and Content types settings in the XML configuration
file, see “Fulltext server configuration on TCP Context Server side (Fulltext server
Configuration)” on page 55.

Settings on Livelink ECM – Enterprise Server side

Data Source
The Data Source is already defined during the setup of the XML Activator.
Search Template
The search template defines the regions that are sent back upon a search request.
Regions
The regions must also be defined in the Search Manager of the Data Source.
Fetch Limit (Context Server)
A fetch limit can be defined to limit the number of hits returned by the fulltext
query. By default this is 500.

Communication settings between Context Server and Enterprise Server

As all of the communication between Context Server and Enterprise Server is
initiated by Context Server, these settings are defined and stored on the Context
Server side.

Enterprise The name of the Enterprise Server and the URL must be defined. The
Server URL is by default http://<Enterprise Server>/livelink/livelink.-
exe.
The mode for the requests to the Enterprise Server can also be defined.
By default, the mode is post. This mode is recommended.

54 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.2 Fulltext server configuration on TCP Context Server side (Fulltext server Configuration)

Admin User The configuration tool for the fulltext needs access to the Enterprise
Server as an Admin user. The name and the password for this user must
be defined.
Query User For the queries on the Enterprise Server, a fulltext query user must be
defined. Normally the name of the user is fulltext as described in
step 1 on page 49.
Slice(s) Each fulltext Id has an associated Data Source (Slice) on Enterprise
Server side. The name of the Slice and their input directory must be de-
fined. The input directory must be accessible from the computer where
the carrier is running.
Search Tem- The name of the search template used for the fulltext queries for this Id
plate can be defined for each fulltext Id. If not, the name of the first Slice is
used.

Note: The fulltext query user for the queries on the Enterprise Server is a
different user than the TCP Context Server fulltext user.
The filter settings for the fulltext server (filter on/off, log level, update configuration
interval, filter user password and fulltext user password) have default values which
you need only to reconfigure in rare cases, e.g. if you changed the fulltext user
password, see Open Text Transactional Content Processing - Administration Guide (TCP-
AGD).

12.2 Fulltext server configuration on TCP Context

Server side (Fulltext server Configuration)
To configure the connection to a Fulltext Server:
1. Open the TCP Context Server administration in a browser window by entering
http://<TCP Context Server>:<port>/archive/admingui in the address bar
and log on as user DMSAdmin.
2. In the External Servers section of the navigation area, click Fulltext Server -
Configuration.
The Fulltext Servers page opens with a list of the existing fulltext server
configurations.
3. Click Add new configuration to create a new Fulltext Server configuration.
The Add new configuration page opens.
4. Enter the following settings:
Configuration name
Descriptive name of the configuration.
Fulltext ID
ID of the configuration, for example My_Fulltext_Solution.

TCP100001-GCS-EN-2 Scenario Guide 55

Chapter 12 Configuring the fulltext engine

Enabled
Select this check box to enable this configuration.
Description
Short description of the fulltext engine
Host name
Name of the Enterprise Server fulltext host
Fulltext server URL
URL of the fulltext host, for example
http://ll_server/livelink/livelink.exe

Administration user name

Name of the Enterprise Server administration user. Default is Admin.
Administration user password
Password of the Enterprise Server administration user. Default is livelink.
Query user name
Name of the Enterprise Server fulltext query user. This user is used to
execute fulltext queries on Enterprise Server side. For a description how to
create this user, see “Setup of the XML Activator” on page 49.
Query user password
Password of the Enterprise Server fulltext query user.
Slice
Name of the associated Data Source (Slice) on Enterprise Server side, for
example My_Fulltext_Solution.
Slice path
Specifies the directory in the fulltext carrier from which the XML Activator
process reads data as XML file. The carrier writes the documents into this
directory.
Propagate regions
The propagate regions functionality forwards the definition of the properties
to be indexed to the Enterprise Server. This saves configuration efforts. Select
one of the following options:
• Propagate regions in case the Livelink fulltext server is already running
and the fulltext carrier is running on the same host as the Fulltext Server.
The bootstrap file is part of the carrier installation and must be manually
copied to the Slice directory. This file will be indexed as first file and will
make the regions (TCP properties) known on Enterprise Server side.
• Don't Propagate regions in case the Fulltext Server does not run yet. You
must propagate the regions later.
• Propagate regions and create bootstrap file to create a bootstrap file
which is sent to the Enterprise Server for indexing to make the regions
known there. This requires that the fulltext carrier runs on the Context
Server host.

56 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.2 Fulltext server configuration on TCP Context Server side (Fulltext server Configuration)

You can set this option also later.

5. Click OK to save your settings. You return to the Fulltext Servers overview
page.
If you want to delete a configuration, click Delete in front of the configuration
name.
Click the configuration name link of the configuration you want to view or edit
the configuration.
6. Click Show XML Configuration File to see and edit the full configuration as it
is used by TCP Context Server, carrier and fulltext search. This includes
information on the MIME types to be indexed and the Content types (TCP
Context Server component names).

TCP100001-GCS-EN-2 Scenario Guide 57

Chapter 12 Configuring the fulltext engine

Content of the elements

<host>
Information about the Enterprise Server host name and the URL to the
Livelink fulltext service
<admin>
Information about the name of the administration user and password
(encrypted)

58 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.2 Fulltext server configuration on TCP Context Server side (Fulltext server Configuration)

<query>
Information about name of the Enterprise Server fulltext query user,
password (encrypted) and query fetch limit
<id>
Information about the ID of the fulltext configuration. This element must
also contain the information about the corresponding search template ID, for
example <id name="My_Fulltext_Solution"
template="MY_FULLTEXT_OWNERID_208">, see “Specifying the search
template ID in XML configuration file” on page 63.
<mimetypes>
List of MIME types which should be indexed or not.
<contentnames>
List of TCP Context Server component names which should be indexed or
not
<propertymappings>
List of additional properties which should be indexed. This element is
currently not supported.
<slices>
List of slices. Currently, only one slice is supported.

Important
Follow these instructions after the fulltext configuration:
1. After creating the search template, you must specify the search template
ID in the <id name> tag (of the XML configuration file) to avoid errors,
for example <id name="My_Fulltext_Solution"
template="MY_FULLTEXT_OWNERID_208">. For details, see “Specifying
the search template ID in XML configuration file” on page 63.
2. The fulltext configuration must not be changed if it is already used for
indexing, that is a fulltext filter that uses this configuration is defined
and documents are created with this document type.
3. You can define only one fulltext filter for a document type (= record
type).
4. Define the filter for exactly that operation that TCP Modeler delivers via
the Fulltext button. For details, refer to section 2.2.4 "Filters - fulltext and
rendition jobs" in Open Text TCP Modeler - Customization Guide (TCP-
CGD).
5. New configurations may be added, but the new configuration can only
be used for document types that are not already used for storing
documents.
6. Use only one single fulltext carrier per fulltext configuration, even if the
other carrier runs on a different computer.

TCP100001-GCS-EN-2 Scenario Guide 59

Chapter 12 Configuring the fulltext engine

12.3 Configuration of the fulltext query on Livelink

ECM – Enterprise Server
1. Skip this step if you selected the Propagate regions and create bootstrap file
option, see “Propagate regions” on page 56.
Process the ftxtBootstrapEntity.xml file being initially stored in the
installation directory of the carrier, see “Configuring the fulltext carrier” on
page 69.
a. Remove the file read-only flag from the ftxtBootstrapEntity.xml file.
b. Copy the ftxtBootstrapEntity.xml file into the input directory of the
XML Activator.
c. Verify that the file is processed by the XML Activator and vanished from
the XML Activator directory some time later.
2. Login as Admin user. Go to the Livelink System Objects Volume folder and
open the respective Data Source Folder.
3. Select Properties and then Regions in the drop-down menu of the Search
Manager.

60 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.3 Configuration of the fulltext query on Livelink ECM – Enterprise Server

4. Check the items here according to the example below.

TCP100001-GCS-EN-2 Scenario Guide 61

Chapter 12 Configuring the fulltext engine

5. Click the Update button to save the new regions settings.

6. Logout and re-login to Enterprise Server as fulltext query user (e.g.
fulltext) that has been created in “Setup of the XML Activator” on page 49.

7. Select Search in the Tools menu item.

This opens the –System Default template.
8. Select the Change the Way Results are Displayed option and check the entries
according to the following example.

62 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.4 Specifying the search template ID in XML configuration file

9. Click the Save button to save the configuration and get back to the search
template.
10. Click the Save Template button and enter a name for this search template.
Open Text recommends using the same name as for the Slice (Data Source).
Otherwise you have to define the search template in the XML configuration file
on the Context Server side, see “Fulltext server configuration on TCP Context
Server side (Fulltext server Configuration)” on page 55.

12.4 Specifying the search template ID in XML

configuration file
Specify the search template ID in the <id> tag of the fulltext server XML
configuration file to avoid errors, see “To enter the search template ID in the XML
configuration file” on page 64. If you do not know the template ID, you can find it in
the Nickname field of the search template, see following procedure.

To find the search template ID

1. Login to the Livelink ECM – Enterprise Server as Admin and go directly to the
Livelink Administration page.
2. Open the System Object Volume which can be found under the Search
Administration option.
3. Click the Personal Search Templates folder.
4. Click the search template folder of your fulltext user.

TCP100001-GCS-EN-2 Scenario Guide 63

Chapter 12 Configuring the fulltext engine

5. Open the drop-down menu of your fulltext search template and select
Properties - General.

The Search Template Properties page for the selected template opens.
6. Note the template ID that is available in the Nickname field.

To enter the search template ID in the XML configuration file

1. Go to the TCP Context Server administration.
2. In the External Servers section of the navigation area, click Fulltext Server -
Configuration.
The Fulltext servers page opens with a list of the existing fulltext server
configurations.
3. Click your fulltext configuration. The Edit Fulltext server page opens.
4. Click the Show XML Configuration File button at the bottom.

64 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.5 Enabling Fulltext for a Record Type with Open Text TCP Modeler

5. Enter the template ID in the <id> tag, for example <id

name="My_Fulltext_Solution" template="MY_FULLTEXT_OWNERID_208">.

6. Click the OK button to save your changes.

12.5 Enabling Fulltext for a Record Type with Open

Text TCP Modeler
To enable a record type for fulltext search, use Open Text TCP Modeler.
Note: For detailed information about TCP Modeler, see Open Text TCP Modeler
- Customization Guide (TCP-CGD).

1. Add a filter to the record type with the FulltextHandler as action.

2. Select an RecordType, go to the Filter tab and choose New Filter with the right
mouse.

TCP100001-GCS-EN-2 Scenario Guide 65

Chapter 12 Configuring the fulltext engine

3. Enter the filter name and click Next.

4. Select the appropriate action handler, click Fulltext and then Edit.

66 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 12.5 Enabling Fulltext for a Record Type with Open Text TCP Modeler

5. Define the parameter that holds the Fulltext ID and click OK.

6. Click Finish to store the filter.

From now on, all changes on records of this record type are propagated to the
fulltext engine.

TCP100001-GCS-EN-2 Scenario Guide 67

Chapter 13
Configuring the fulltext carrier

13.1 Requirements
The carrier needs a Java Runtime 1.4.2.06 or higher installed on the machine.
Furthermore access to the Context Server via HTTP must be available and the slice
directories of the fulltext server must be accessible for writing. It is recommended to
install it on Enterprise Server.

13.2 Installation
Expand the otFulltextApp.zip file into any directory you want to install the
carrier. You find the zip file on the TCP product CD-ROM in the fulltext
directory.
Scheduled tasks must be configured on the computer which starts the fulltext
carrier. Scheduled tasks can be used on a Windows system and cron jobs on UNIX
systems. Open Text recommends configuring a job in Enterprise Server, see
“Configuring a carrier as job in Livelink ECM – Enterprise Server ” on page 73.
The access rights on UNIX systems should be at least read (and execute for the
directories) for the Enterprise Server user.

13.3 Calling the fulltext carrier

To call the fulltext carrier:
1. Make a copy of the carrier.template.properties file that is located in your
carrier installation directory and name it according to your fulltext
configuration, e.g. my_fulltext_solution.properties.
2. Open the copy with a text editor.
3. Define the connection to the TCP Context Server in the
my_fulltext_solution.properties file by editing the following lines:

Hosts=<connection URL(s) to the Context Server(s), e.g.

http://server:18080/archive>
Clientele=<clientele on the Context server>
Password=<encrypted password of the Context Server FulltextUser>

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 69

Chapter 13 Configuring the fulltext carrier

The default password of the TCP Context Server FulltextUser is geheim. The
encrypted version of this password is irokWj7rpDw=.
Note: The TCP Context Server FulltextUser is defined in Open Text User
Management.
4. Open the command prompt and change the current directory to
<CARRIER_HOME>: on the command line, enter cd <CARRIER_HOME>. The
directory is configured in the Enterprise Server field Start Directory, see
“Configuring a carrier as job in Livelink ECM – Enterprise Server ” on page 73.
5. To start the fulltext carrier, call:
Windows: <JAVA_HOME>\bin\java –jar Carrier.jar –
config=my_fulltext_solution.properties

UNIX: <JAVA_HOME>/bin/java –jar Carrier.jar –

config=my_fulltext_solution.properties

Note: It is also possible to replace -config=carrier.properties by

Hosts=<context servers> -Clientele=<clientele> -
Password=<password> in calls above. Open Text recommends using -
config=my_fulltext_solution.properties as argument instead of
specifying all options in the command line.

All possible command line options are

Hosts (required)
A comma separated list of the Context Server connections. Each entry in the list
has the format:
http://<Context Server host>:<Port>/archive

If you use SSL:

https://<Context Server host>:<SSLPort>/archive

You need more than one connection in the list if you have a Context Server
cluster. The carrier tries to establish each connection specified in the list until a
connection to a Context server is successful.
Examples:
Single Context Server with SSL:
https://host:18090/archive

Context Server cluster:

http://host1:18080/archive,http://host2:18080/archive

Clientele (required)
Clientele of the Context Server user FulltextUser
Password (required)
Password of the Context Server user FulltextUser. The password must be
encoded with the enc tool (use the second string in the result).

70 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 13.3 Calling the fulltext carrier

DMS_PROTOCOL
Connection protocol to be used. Can be http or https (default is http). All
connections specified in the Hosts option must start with this protocol. https
needs some additional configuration (see “To configure a carrier with SSL” on
page 72)
Threads
The amount of threads started to process the jobs.
LifeBeatPort
The port where the carrier sends a life beat signal (default is 6789)
Runs
The count of batches (default is 1)
MaxJobs
The maximum amount of jobs to be processed within one batch (default is 1000)
FtxtId
A comma separated list of fulltext configurations for which the carrier should
fetch jobs. If this parameter is not set, all fulltext configurations found on the
Context server are used.
LogFile
The location of the log file. The directory name on Windows must contain two
backslashes. The default log file is the file FulltextCarrier.log in the current
directory, i.e. the directory where the carrier is started. This is configured in
Enterprise Server in the field Start Directory.
MaxLogSize
The maximum size of the log file in bytes (default is 1000000).
LogLevel
The log level can be FATAL, ERROR, WARN, INFO or DEBUG. The DEBUG level gener-
ates maximum logging information, FATAL generates minimum logging informa-
tion. The default log level is WARN

Important
To use this option, you must call the carrier with the additional
command line option
–configStore=carrier.properties

Important
Run only one fulltext carrier per fulltext configuration at the same time. If
you use several carriers, specify the option FtxtId for each fulltext
configuration. On the other hand you can configure one carrier for all
fulltext configurations.

TCP100001-GCS-EN-2 Scenario Guide 71

Chapter 13 Configuring the fulltext carrier

Before the fulltext carrier begins to process jobs it checks if itself is already running.
This can be the case if the periods between scheduled tasks are too short to process
the configured amount of jobs. If it is already running it quits otherwise the fulltext
carrier begins its work.

To configure a carrier with SSL

Proceed as follows if you want to configure a carrier with SSL. To configure a carrier
with SSL, edit the my_fulltext_solution.properties file as follows:
1. Configure one or more connections with the Hosts option. Each entry must start
with https:
Hosts=https://host1:18090/archive,https://host2:18090/archive

2. Set DMS_PROTOCOL to https, i.e. the entry must be DMS_PROTOCOL=https.

3. Remove the comments from the following lines by deleting the # symbol:

#DS_CRYPTO_PROPERTIES=<<Path and file name to

ClientIxosCrypto.properties file>
#DS_PROTOCOL_HANDLER=JAKARTA #DMS_REMOTE_USER_MGMT=true
#HTTP_BUILTIN_SSL_TRUST_EXPIRED_CERTIFICATE=true
#HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER=false
#HTTP_INIT_BUILTIN_SSL=true

Alternatively, you can add the following options:

DS_CRYPTO_PROPERTIES=<ClientIxosCrypto.properties>
DS_PROTOCOL_HANDLER=JAKARTA

DMS_REMOTE_USER_MGMT=true
HTTP_BUILTIN_SSL_TRUST_EXPIRED_CERTIFICATE=true
HTTP_BUILTIN_SSL_TRUST_WRONG_SERVER=false
HTTP_INIT_BUILTIN_SSL=true

4. In the DS_CRYPTO_PROPERTIES option, set the path to

<CARRIER_HOME>/ClientIxosCrypto.properties. In Windows, the directory
name must contain two backslashes.
5. To start the Carrier with SSL, call:
Windows: <JAVA_HOME>\bin\java –jar Carrier.jar –
config=my_fulltext_solution.properties –
configStore=my_fulltext_solution.properties

UNIX: <JAVA_HOME>/bin/java –jar Carrier.jar –

config=my_fulltext_solution.properties –
configStore=my_fulltext_solution.properties

72 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 13.4 Configuring a carrier as job in Livelink ECM – Enterprise Server

13.4 Configuring a carrier as job in Livelink ECM –

Enterprise Server
1. Login to the Enterprise Server as Admin and go directly to the Livelink
Administration page.
2. Open the System Object Volume.
3. Open your data source folder.
4. Open your data flow manager.
5. In the upper right corner click Add Item and select Process.

6. Enter the settings:

a. Enter a name for your process.
b. Click Enable System Management.

TCP100001-GCS-EN-2 Scenario Guide 73

Chapter 13 Configuring the fulltext carrier

c. In the Command Line Template field enter the command to start the
carrier. If you start your carrier with a config file, enter the following
command:

<Java_Home>\bin\java –jar Carrier.jar -config=<configFile>

d. In the Start Directory field, enter the directory of your fulltext carrier
installation i.e. the directory where Carrier.jar is placed.
e. In the Start Options section (left bottom corner), select Scheduled in the
drop down menu. Select the check box Every and enter a time interval you
want to run your carrier e.g. every 20 Minutes.
f. In Stop Options section, select Terminate.
g. Click Add. The data flow manager page opens.
7. Open the context menu of the process (small arrow right of the name of your
process) and select Start.

74 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Part 3
Business Activity Monitoring
Part 3 Business Activity Monitoring

Business Activity Monitoring provides business intelligence to your TCP

environment
Content This part contains the following chapters:
Chapter “What is Business Activity Monitoring”
This chapter explains how BAM works.
Chapter “Configuring BAM”
This chapter explains how you customize TCP for the use of the BAM
functionality.
Chapter “Database tables”
This chapter lists the database tables containing available facts and dimensions.
Chapter “Examples of use”
This chapter contains sample configuration files.

76 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 14
What is Business Activity Monitoring
Business Activity Monitoring (short: BAM) provides business intelligence to your
TCP solution. With BAM you can retrieve multi-dimensional performance
indicators and thus monitor and optimize your processes.
Facts and With its modern data mining concept, BAM creates metrics where a fact is classified
dimensions by different dimensions. For details about facts and dimensions, see “Database
tables” on page 95.
In TCP, there are two different process metrics: Activities and process instances. For
each, you have dimensions such as duration or idle time.
With work items as the fact, the resulting data is called Activity metrics. With the
process instance as the fact, it is called Instance metrics.
Metrics You can use these metrics to find answers to the following questions:

With Activity metrics

• How long is the average duration of process step xy to be completed?
• How long is the longest time a process step abc is idle, i.e. waiting for
processing?
• Are there peaks in certain process steps and at what time of the day?
• Is there an overload of work for a certain user or user group and at what time of
the day?

With Process Instance metrics

• How long takes process YZ to be finished from the start to the end?
• How long is the average idle time during the life time of process AB?
• How many hours of work needs process CD until it is finished?
Aggregate You can aggregate your data to various degrees. For instance, you can view metrics
by the hour or by the day. If you are interested in an overall picture, you can view
metrics by the month or even by the year.
Technical The following explains the technical background that leads to BAM reports.
overview

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 77

Chapter 14 What is Business Activity Monitoring

Figure 14-1: Technical overview

(1) Customizing
Any process that has a Metrics Completion Action can be monitored with BAM.
You configure the process with Process Designer. For details, see “Configuring a
process for BAM ” on page 81.
In Process Administrator you can manage BAM reports. For details, see section
12 "Managing BAM reports" in Open Text Process Administrator - Administration
Guide (PR-AGD).
Presentation and query are controlled by an XML file which requires a strict
structure. For details, see “XML schema” on page 82.
In TCP Modeler, you configure users, user groups and GUI profiles so that only
a certain group of users has access to BAM reports.
(2) BAM data generation
There are two ways to transfer data from the process database to a dedicated
BAM database. In this procedure, TCP Application Server aggregates the data
and already calculates measures such as time durations.
• Create a process with a Completion Action of the type Metrics (for details, see
section 10 "Completion actions" in Open Text Process Designer - Customizing
Guide (PR-CPD)), or

78 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 • create a periodically executed automation task via a new job in Process
Administrator (see section 13.2 "Creating new jobs" in Open Text Process
Administrator - Administration Guide (PR-AGD)).
(3) Query
When a user calls a BAM report, TCP Application Server interprets the
underlying query and sends it to the BAM database.
(4) Presentation
The BAM database returns the requested data. TCP Application Server and TCP
Web Client handle them for presentation.

TCP100001-GCS-EN-2 Scenario Guide 79

Chapter 15
Configuring BAM
This chapter describes how you configure TCP so that you can use the BAM
functionality.
Configuration consists of the following steps:

1. In Process Designer configure a process triggering a data transfer for BAM or

create a periodically executed automation task (see “Configuring a process for
BAM ” on page 81).
2. Create a BAM report file (see “Creating a BAM report file” on page 81).
3. Deploy the BAM report file (see “Deploying the BAM report file” on page 93).

15.1 Configuring a process for BAM

To configure a process for BAM use one of these two options:
• Create process with a Completion Action of the type Metrics (for details, see
section 10 "Completion actions" in Open Text Process Designer - Customizing Guide
(PR-CPD))
• Create a periodically executed automation task via a new job in Process
Administrator (see section 13.2 "Creating new jobs" in Open Text Process
Administrator - Administration Guide (PR-AGD)). To do this, use create a Miner
job with the object type Process Instance, assign schedule settings (use non
business hours) and enter a condition for process class filtering.
Note: Ensure that no Completion Action is created for this process class. To
do this use the PMQL query where condition for job filtering (see step 4 in
section 13.2 "Creating new jobs" in Open Text Process Administrator -
Administration Guide (PR-AGD)).

15.2 Creating a BAM report file

To create a BAM report file:
• Create an XML schema which contains the query as well as information about
the presentation.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 81

Chapter 15 Configuring BAM

Tip: To create an XML schema more quickly, you can use one of the templates
provided on the TCP product CD-ROM. They are located in the <TCP product
CD-ROM>:\templates\bam directory. For a description of the templates, see
“Examples of use” on page 101.

15.2.1 XML schema

This section describes the XML schema and its elements.
<BAMReport>
<Id />
<ShortName />
<LongName />
<Description />
<Chart>
<Type>BamChart</Type>
<Axes>
<XAxis>
<Name />
<DisplayName />
<Expression />
</XAxis>
<YAxis>
<Name />
<DisplayName />
<Expression />
</YAxis>
</Axes>
<Values>
<Value>
<Name />
<DisplayName />
<Expression />
<Thresholds>
<Threshold>
<Status />
<Lower />
<Upper />
</Threshold>
</Thresholds>
</Value>
</Values>
</Chart>
<Query> … </Query>
</BAMReport>

Description of XML elements

<BAMReport>
Root element

82 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.2 Creating a BAM report file

<ID>
Unique ID of the report

Important
The ID has to be unique over all TCP reports, not only BAM.

<ShortName>
Short name of the report. This name is displayed in the Reports drawer of the
TCP application.
<LongName>
Long name of the report. Reserved for future use.
<Description>
Description of the report. Displays as a description in the report.
<Chart>
Definition of the displayed chart and the evaluation of the report. For details,
see “Chart types” on page 84.
<Type> – Type of the report chart.
<Axes> – The axes displayed in the chart. An axis has a <Name>, a
<DisplayName> and an <Expression>. The expression can be a single property
(e.g. “name”) or an expression. Supported are x and y axis. If multiple values
are used, only one axis is supported.
Note: The x-axis expression result must be a text. This can be achieved
using the Concat() operator.
<Values> – Values to be displayed in the chart. Each value is included in a
<Value> tag. A value contains a <Name>, a <DisplayName> and an
<Expression>. The expression can be a single property (e.g. count) or formula
containing operators. Example for a formula:
(Sum(durationIdle+durationExec)/Sum(count)/60) . The expression
must return a single value if the x axis and the y axis are defined. This
requires that mathematical operators in the formula must be included in an
aggregation operator like Sum(x) or Min(x), see “Expressions” on page 91.
BAM supports multiple values if only one axis is defined. Only one value
element is supported is if x and y axes are defined. Multiple values are
supported if only one axis is defined. Optionally, you can define a list of
thresholds.
For a Gauge chart, you can define thresholds. Thresholds define the green,
yellow and red segments of the gauge. A threshold contains a lower and an
upper value and a status.
<Query>
The query must be supported by the Repository Bridge search getHits
method.

TCP100001-GCS-EN-2 Scenario Guide 83

Chapter 15 Configuring BAM

For details on how to use the Query Language, see Open Text Transactional
Content Processing - Using the TCP Context Server Query (TCP-PQU).
Note: With the query you can retrieve properties from the BAM
database tables, see “Database tables” on page 95. To retrieve a specific
property, use the column name starting with a lower case letter, e.g. to
retrieve the ProcessInstanceId use processInstanceId.
To follow a relation use the column name and add a to as prefix and
remove the Id suffix, e.g. use toStartDate for StartDateId.

15.2.2 Chart types

The following chart types are available.

15.2.2.1 Line chart

The Line chart displays the report result in a two dimensional line chart with a
legend section.
Type
LineChart

Axes
Requires the X and the Y axis definition.
Values
Supports only one value definition.
Titles
The display name of the value definition is shown as Y axis title. The display
name of the X axis is shown as X axis title. The description of the report is shown
as report title.
Legend
The values are shown on the legend.

84 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.2 Creating a BAM report file

Code sample

<Chart>
<Type>LineChart</Type>
<Axes>
<YAxis>
<Name>Process</Name>
<DisplayName>Process name</DisplayName>
<Expression>name</Expression>
</YAxis>
<XAxis>
<Name>Hour</Name>
<DisplayName>Hour</DisplayName>
<Expression>Concat(hour)</Expression>
</XAxis>
</Axes>
<Values>
<Value>
<Name>Count</Name>
<DisplayName>Finished processes</DisplayName>
<Expression>Sum(count)</Expression>
</Value>
</Values>
</Chart>

Tip: To customize the layout of the chart (including the representation of

special characters like umlauts), edit the skins in the file
...tcpweb\App_Themes\Livelink\Livelink.skin.

TCP100001-GCS-EN-2 Scenario Guide 85

Chapter 15 Configuring BAM

You find the related skins in sections starting with

<igchart:UltraChart runat="server" SkinID="LineChart"....

15.2.2.2 3D Column chart

The 3D Column chart displays the report result in a three dimensional column chart.
Type
ColumnChart3D

Axes
Requires the X, and the Y axis definition
Values
Supports only one value definition
Titles
The display name of the X axis is shown as X axis title. The display name of the Y
axis is shown as Y axis title. The description of the report is shown as report title.

86 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.2 Creating a BAM report file

Code sample

<Chart>
<Type>ColumnChart3D</Type>
<Axes>
<YAxis>
<Name>Step</Name>
<DisplayName>Step name</DisplayName>
<Expression>name</Expression>
</YAxis>
<XAxis>
<Name>User</Name>
<DisplayName>User name</DisplayName>
<Expression>displayName</Expression>
</XAxis>
</Axes>
<Values>
<Value>
<Name>Duration</Name>
<DisplayName>Average duration in
minutes</DisplayName>

<Expression>(Sum(durationIdle+durationExec)/Sum(count)/60)</Expressio
n>
</Value>
</Values>
</Chart>

Tip: To customize the layout of the chart (including the representation of

special characters like umlauts), edit the skins in the file
...tcpweb\App_Themes\Livelink\Livelink.skin.

You find the related skins in sections starting with

<igchart:UltraChart runat="server" SkinID="ColumnChart3D"....

15.2.2.3 Multi-value chart

The Multi-value chart displays the report result in a two dimensional line chart with
a legend section. Different types of values can be displayed each in a separate chart
line.
Type
MultiValueChart

Axes
Requires either the X or the Y axis definition
Values
Supports more than one value definition. Each value definition is displayed as a
chart line.

TCP100001-GCS-EN-2 Scenario Guide 87

Chapter 15 Configuring BAM

Titles
The display name of the axis is shown as X axis title. The description of the
report is shown as report title.
Legend
The display name of the values are shown in the legend.

88 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.2 Creating a BAM report file

Code sample

<Chart>
<Type>MultiValueChart</Type>
<Axes>
<XAxis>
<Name>Process</Name>
<DisplayName>Process
name</DisplayName>
<Expression>name</Expression>
</XAxis>
</Axes>
<Values>
<Value>
<Name>Duration</Name>
<DisplayName>Overall
duration</DisplayName>

<Expression>(Sum(durationIdle+durationExec)/Sum(count)/60)</Expressio
n>
</Value>
<Value>
<Name>DurationExec</Name>
<DisplayName>Execution
duration</DisplayName>

<Expression>(Sum(durationExec)/Sum(count)/60)</Expression>
</Value>
</Values>
</Chart>

Tip: To customize the layout of the chart (including the representation of

special characters like umlauts), edit the skins in the file
...tcpweb\App_Themes\Livelink\Livelink.skin.

You find the related skins in sections starting with

<igchart:UltraChart runat="server" SkinID="MultiValueChart"....

15.2.2.4 Gauge chart

The gauge chart displays the report result in form of a gauge.
Type
GaugeChart

Axes
Requires either the X or the Y axis definition
Values
Supports more than one value definition. Each value definition is displayed as a
gauge. You can define up to four gauges. To define the color segments, use the
<Treshold> parameter; see “XML schema” on page 82.

TCP100001-GCS-EN-2 Scenario Guide 89

Chapter 15 Configuring BAM

Legend
The display name of the value is shown as gauge chart title.

90 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.2 Creating a BAM report file

Code sample

<Chart>
<Type>GaugeChart</Type>
<Axes>
<YAxis>
<Name>Year</Name>
<DisplayName/>
<Expression>year</Expression>
</YAxis>
</Axes>
<Values>
<Value>
<Name>Count</Name>
<DisplayName>Count of finished
processes.</DisplayName>
<Expression>Sum(count)</Expression>
<Thresholds>
<Threshold>
<Status>Green</Status>
<Lower>0</Lower>
<Upper>20</Upper>
</Threshold>
<Threshold>

<Status>Yellow</Status>
<Lower>20</Lower>
<Upper>50</Upper>
</Threshold>
<Threshold>
<Status>Red</Status>
<Lower>50</Lower>
<Upper>100</Upper>
</Threshold>
</Thresholds>
</Value>
</Values>
</Chart>

Tip: To customize the layout of the chart (including the representation of

special characters like umlauts), edit the skins in the file
...tcpweb\App_Themes\Livelink\Livelink.skin.

You find the related skins in sections starting with

<igchart:ultrachart runat="server" SkinID="GaugeChart"....

15.2.3 Expressions
The <Expression> element can contain the following properties:

TCP100001-GCS-EN-2 Scenario Guide 91

Chapter 15 Configuring BAM

Variable
A variable must be a property returned by the repository query (search).
Operator
With the operators you can execute typical calculations.
Note: The operator names are case-sensitive. This means, for example, that
only the notation Sum(x) is correct, but not sum(x).
The input variable x can be either an expression or a variable that contains a list
of values.
The following operators are available:
• Sum(x)
Returns the sum of x.
• Avg(x)
Returns the average value of x.
• Count(x)
Returns the number of values contained in x.
• Max(x)
Returns the maximum value contained in x.
• Min(x)
Returns the minimum value contained in x.
• Concat(x0, x1, x2, …)
Joins separate values into a single text string, where x0...xN are single text or
numeric values.
• Mathematical operators
Addition (+), Subtraction (-), Multiplication (*) and Division (/). In contrast
to the operators listed above, a mathematical operator can return a list of
values (array) if the input values are also lists.
Operators for parameter expressions
For these date/time related expressions it is possible to define an offset. x is the
offset unit and y is the offset value.
Offset units – y = year; M = month; d = day; h = hour; m = minute; s = second.
Note: The date/time related expressions must be used with either no
parameter or both.
• Year(x,y) – Returns the actual year.
• Month(x,y) – Returns the actual month (1-12).
• DayOfMonth(x,y) – Returns the actual day of month (1-31).

92 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 15.3 Deploying the BAM report file

• DayOfWeek(x,y) – Returns the actual day of week (1-7).

• DayOfYear(x,y) – Returns the actual day of year (1-366).
• Hour(x,y) – Returns the actual hour of day (0-23).
• Minute(x,y) – Returns the actual minute of hour (0-59).
• Second(x,y) – Returns the actual second of minute (0-59).
Bracket
( or )

Examples
• Calculate the average of the result of the expression (a*b).
Avg(a*b)

• Calculate the sum of the result of the expression (a-b)-c.

Sum((a-b)-c)

• Calculate the year in 100 days. For instance, on November 1, 2007, the result is
2008.
Year(d, 100)

• Calculate the last year.

Year() – 1

• Calculate the year a month ago. For instance, on January 1, 2008, the result is
2007.
Year(M, (0-1))

• Calculate the month seven days ago. For instance, on January 1, 2008, the result
is 12 (for December).
Month(d, (0-7))

• Concatenate the values for year, month, dayOfMonth to a single text that looks
like 1970/01/01.
Concat(year, "/", month, "/", dayOfMonth)

15.3 Deploying the BAM report file

GUI profile The group with BAM permissions must be assigned to a GUI profile in Open Text
Process Administrator (Process Administrator for short).

To deploy the BAM report file

Import the BAM report file into Process Administrator, see section 16.3.2 "Importing
report configurations" in Open Text Process Administrator - Administration Guide (PR-
AGD).

TCP100001-GCS-EN-2 Scenario Guide 93

Chapter 16
Database tables
From a technical point of view, BAM uses the star schema for its data warehouse
database model. In this model, a facts table is in the center of the star with
dimension tables around it.
For your query, you select a facts table together with one or more dimension tables.

Figure 16-1: Star schema

Fact tables Fact tables store numerical values of the process steps and process instances. They
are in the center of the star schema.
Dimension Dimension tables store data related to the axis of investigation of a fact. The most
tables popular tables of this type are information about time and users.
Note: With the query you can retrieve properties from the BAM database
tables, see “Database tables” on page 95. To retrieve a specific property, use the
column name starting with a lower case letter, e.g. to retrieve the
ProcessInstanceId use processInstanceId.
To follow a relation use the column name and add a to as prefix and remove
the Id suffix, e.g. use toStartDate for StartDateId.

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 95

Chapter 16 Database tables

16.1 Facts tables

BAM_F_SubActi Stores the time a work item is not worked on (idle state) and the duration of time
vity when a work item is being processed by a user (execution state). It provides the start
and end date and time information for these activities. If the step is a step of a sub-
process, all activities of the sub-process instance are aggregated in this table.
BAM_F_Process Stores the start and end date and time information for process instances. The overall
Instance duration as well as execution and idle time durations are aggregated over all
activities belonging to this process instance.

Table 16-1: BAM_F_SubActivity

Column Type Description Aggregation

name
ID String Primary key
Level Long Fact level (see Table 16-3)
Count Long Count of work items with a certain state
DurationIdle Long Seconds spent in idle status Add
Duration- Long Seconds spent in executing state Add
Exec
StartDateId Dimen- Reference to “BAM_D_Date”
sion

StartTimeId Dimen- Reference to “BAM_D_Time”

sion

EndDateId Dimen- Reference to “BAM_D_Date”

sion

EndTimeId Dimen- Reference to “BAM_D_Time”

sion

ProcessClas- Dimen- Reference to “BAM_D_ProcessClass”

sId sion

Proc- Dimen- Reference to “BAM_D_ProcessStep”

essStepId sion

UserId Dimen- Reference to “BAM_D_User”

sion

ProcessIn- String ID of process instance

stanceId

96 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 16.1 Facts tables

Column Type Description Aggregation

name
WorkItemId String ID of work item
Connection String Connection name

Table 16-2: BAM_F_ProcessInstance

Column Type Description Aggregation

name
ID String Primary key
Level Long Fact level (see “Aggregation level”)
Count Long Count of process instances with a certain Add
status
Duration Long Seconds the process instance existed Add
DurationIdle Long Sum of seconds of all activities in idle state Add
Duration- Long Sum of seconds of all activities in executing Add
Exec state
StartDateId Dimen- Reference to “BAM_D_Date” Add
sion

StartTimeId Dimen- Reference to “BAM_D_Time” Add

sion

EndDateId Dimen- Reference to “BAM_D_Date” Add

sion

EndTimeId Dimen- Reference to “BAM_D_Time” Add

sion

ProcessClas- Dimen- Reference to “BAM_D_ProcessClass”

sId sion

ProcessIn- String ID of process instance

stanceId

Level Aggregated data is stored in the Level column. This column identifies the raw
values or numeric values aggregated for the existing dimensions over a certain
period of time. The following table lists the supported aggregation levels:

TCP100001-GCS-EN-2 Scenario Guide 97

Chapter 16 Database tables

Table 16-3: Aggregation level

Level Description
0 Raw
3 Hour
4 Day
6 Month
8 Year

16.2 Dimensions tables

The following tables contain dimensions.

Table 16-4: BAM_D_Date

Column Type Description Level filter

name
ID String Primary key
Ticks Long Ticks since 1970–0–0 00:00:00
Year Int Calendar year Year
Quarter Int Quarter of calendar year (1–4)
Month Int Month (1–12) Month
WeekOfYear Int Week of year (1–53)
WeekOf- Int Week of month (1–5, 0 if not used)
Month
DayOfMonth Int Day (1–31) Day
DayOfWeek Int 1 = Sunday
7 = Saturday
DayOfYear Int Day (1–366)

Table 16-5: BAM_D_Time

Column Type Description Level filter

name
ID String Primary key
Hour Int Hour (0-23) Hour
Minute Int Minute (0–59) Minute
Second Int Second (0–59)

98 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 16.2 Dimensions tables

Column Type Description Level filter

name
SecondOf- Int Seconds since midnight
Day

Table 16-6: BAM_D_ProcessClass

Column name Type Description

ID String Primary key
Name String Process class name
Version String Process class name
GroupName String Process class name
ProjectID String Project id where there process class is used

Table 16-7: BAM_D_ProcessStep

Column name Type Description

ID String Primary key
Name String Process step name. Is unique in the process class.
Type String Type of process step

Table 16-8: BAM_D_User

Column name Type Description

ID String Primary key
Name String User name (login)
Domain String Domain name
DisplayName String User's display name

TCP100001-GCS-EN-2 Scenario Guide 99

Chapter 17
Examples of use
This chapter contains examples for BAM reports.
The XML templates of these examples are provided on the TCP product CD-ROM.
They are located in the <TCP product CD-ROM>:\templates\bam directory. Deploy
a BAM report file based on such a template like any other BAM report file, see
“Deploying the BAM report file” on page 93.

17.1 Average step duration per step and user

This example results in a 3D column chart which shows the average time a user
needs to process a single process step of the current month (per minute).

<BAMReport>
<Id>CC-AvgStepDuration</Id>
<ShortName>Step Duration</ShortName>

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 101

Chapter 17 Examples of use

<LongName>Average duration by step and user</LongName>

<Description>Displays the average duration per step and user of the current month
(per minute).</Description>
<Chart>
<Type>ColumnChart3D</Type>
<Axes>
<YAxis>
<Name>Step</Name>
<DisplayName>Step name</DisplayName>
<Expression>name</Expression>
</YAxis>
<XAxis>
<Name>User</Name>
<DisplayName>User name</DisplayName>
<Expression>displayName</Expression>
</XAxis>
</Axes>
<Values>
<Value>
<Name>Duration</Name>
<DisplayName>Average duration in minutes</DisplayName>

<Expression>(Sum(durationIdle+durationExec)/Sum(count)/60)</Expression>
</Value>
</Values>
</Chart>
<Parameters>
<Parameter>
<Name>endMonth</Name>
<Expression>Month()</Expression>
<Type>Integer</Type>
</Parameter>
</Parameters>
<Query>
<search>
<queries>
<query>
<from>
<itemtype name="/bam/BAM_F_SubActivity"
/>
<itemtype name="/bam/BAM_D_ProcessStep"
/>
<itemtype name="/bam/BAM_D_User" />
</from>
<select>
<property name="count" />
<property name="durationIdle" />
<property name="durationExec" />
<relationship name="toUser">
<property name="displayName"/>
</relationship>
<relationship name="toProcessStep">
<property name="name"/>
</relationship>
</select>
<where>
<and>
<equal>
<property name="level"/>
<literal value="4"
datatype="Integer"/>
</equal>
<equal>
<relationship
name="toEndDate">

102 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 17.2 Finished processes of current year

<property
name="month"/>
</relationship>
<parameter
name="endMonth" datatype="Integer"/>
</equal>
</and>
</where>
</query>
</queries>
</search>
</Query>
</BAMReport>

17.2 Finished processes of current year

This example results in a Gauge chart which shows the finished processes of the
current year.

<BAMReport>
<Id>GC-FinishedProcesses</Id>
<ShortName>Finished Processes Gauge</ShortName>
<LongName>Count of finished processes</LongName>
<Description>Displays the processes finished.</Description>
<Chart>
<Type>GaugeChart</Type>
<Axes>
<YAxis>
<Name>Year</Name>
<DisplayName/>
<Expression>year</Expression>
</YAxis>
</Axes>
<Values>
<Value>
<Name>Count</Name>
<DisplayName>Count of finished processes.</DisplayName>
<Expression>Sum(count)</Expression>
<Thresholds>
<Threshold>
<Status>Green</Status>
<Lower>0</Lower>

TCP100001-GCS-EN-2 Scenario Guide 103

Chapter 17 Examples of use

<Upper>20</Upper>
</Threshold>
<Threshold>
<Status>Yellow</Status>
<Lower>20</Lower>
<Upper>50</Upper>
</Threshold>
<Threshold>
<Status>Red</Status>
<Lower>50</Lower>
<Upper>100</Upper>
</Threshold>
</Thresholds>
</Value>
</Values>
</Chart>
<Parameters>
<Parameter>
<Name>currentYear</Name>
<Expression>Year()</Expression>
<Type>Integer</Type>
</Parameter>
</Parameters>
<Query>
<search>
<queries>
<query>
<from>
<itemtype
name="/bam/BAM_F_ProcessInstance" />
<itemtype name="/bam/BAM_D_ProcessClass"
/>
<itemtype name="/bam/BAM_D_Date" />
</from>
<select>
<property name="count" />
<relationship name="toEndDate">
<property name="year"/>
</relationship>
</select>
<where>
<and>
<equal>
<property name="level"/>
<literal value="6"
datatype="Integer"/>
</equal>
<equal>
<relationship
name="toEndDate">
<property
name="year"/>
</relationship>
<parameter
name="currentYear" datatype="Integer"/>
</equal>
</and>
</where>
</query>
</queries>
</search>
</Query>
</BAMReport>

104 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 17.3 Finished processes per hour

17.3 Finished processes per hour

The “Finished processes per process per hour” report results in a Line chart that
shows how many processes are finished at which time of the day (hour).

<BAMReport>
<Id>LC-FinishedProcesses</Id>
<ShortName>Finished Processes</ShortName>
<LongName>Finished processes by process and hour</LongName>
<Description>Displays the finished process by process and
hour.</Description>
<Chart>
<Type>LineChart</Type>
<Axes>
<YAxis>
<Name>Process</Name>
<DisplayName>Process name</DisplayName>
<Expression>name</Expression>
</YAxis>
<XAxis>
<Name>Hour</Name>
<DisplayName>Hour</DisplayName>
<Expression>Concat(hour)</Expression>
</XAxis>
</Axes>
<Values>

TCP100001-GCS-EN-2 Scenario Guide 105

Chapter 17 Examples of use

<Value>
<Name>Count</Name>
<DisplayName>Finished processes</DisplayName>
<Expression>Sum(count)</Expression>
</Value>
</Values>
</Chart>
<Query>
<search>
<queries>
<query>
<from>
<itemtype name="/bam/BAM_F_ProcessInstance" />
<itemtype name="/bam/BAM_D_ProcessClass" />
<itemtype name="/bam/BAM_D_Time" />
</from>
<select>
<property name="count" />
<relationship name="toProcessClass">
<property name="name"/>
</relationship>
<relationship name="toStartTime">
<property name="hour"/>
</relationship>
</select>
<where>
<and>
<equal>
<property name="level"/>
<literal value="3" datatype="Integer"/>
</equal>
</and>
</where>
<order>
<relationship name="toStartTime">
<property name="hour"/>
</relationship>
</order>
</query>
</queries>
</search>
</Query>
</BAMReport>

106 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 17.4 Average process duration per process in minutes

17.4 Average process duration per process in

minutes
This report results in a multi-value chart that shows the average execution duration
and the average overall duration per process in minutes. These average durations
are the averages of the durations of all process instances of one process.
The following screenshot displays the average durations for two processes.

<BAMReport>
<Id>MC-AvgProcessDuration</Id>
<ShortName>Process Duration</ShortName>
<LongName>Average duration by process</LongName>
<Description>
Displays the execution and overall duration per process in minutes.
</Description>
<Chart>
<Type>MultiValueChart</Type>
<Axes>
<XAxis>
<Name>Process</Name>
<DisplayName>Process name</DisplayName>
<Expression>name</Expression>
</XAxis>
</Axes>
<Values>
<Value>
<Name>Duration</Name>
<DisplayName>Overall duration</DisplayName>

TCP100001-GCS-EN-2 Scenario Guide 107

Chapter 17 Examples of use

<Expression>(Sum(durationIdle+durationExec)/Sum(count)/60)</Expression>
</Value>
<Value>
<Name>DurationExec</Name>
<DisplayName>Execution duration</DisplayName>

<Expression>(Sum(durationExec)/Sum(count)/60)</Expression>
</Value>
</Values>
</Chart>
<Query>
<search>
<queries>
<query>
<from>
<itemtype
name="/bam/BAM_F_ProcessInstance" />
<itemtype name="/bam/BAM_D_ProcessClass"
/>
<itemtype name="/bam/BAM_D_Date" />
</from>
<select>
<property name="count" />
<property name="duration" />
<property name="durationExec" />
<property name="durationIdle" />
<relationship name="toEndDate">
<property name="year"/>
</relationship>
<relationship name="toEndDate">
<property name="month"/>
</relationship>
<relationship name="toEndDate">
<property name="dayOfMonth"/>
</relationship>
<relationship name="toProcessClass">
<property name="name"/>
</relationship>
</select>
<where>
<and>
<equal>
<property name="level"/>
<literal value="3"
datatype="Integer"/>
</equal>
</and>
</where>
<order>
<relationship name="toProcessClass">
<property name="name"/>
</relationship>
</order>
</query>
</queries>
</search>
</Query>
</BAMReport>

108 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Part 4
Customizing scenarios with dedicated
attachments
Part 4 Customizing scenarios with dedicated attachments

TCP offers different scenarios for attaching records (documents) to processes.

110 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Chapter 18
Attachment scenarios
For both scenarios, create a record type in TCP Modeler, see section 4.2.1 "Creating
record types" in Open Text TCP Modeler - Customization Guide (TCP-CGD).

18.1 Attaching a record to a process when starting

from the record
From the user perspective, this scenario is described in section 5.8 "Submitting a
document" in Open Text Transactional Content Processing - Online help (TCP-H-UGD).
The user starts a new process from a hit list or inspect form.
The name of the attachment is created by using the short name of the record type
from which the user starts the process.
Notes:
• The access from the process to the properties of the record type is only
possible in very rare cases, because it requires that the short name of the
record type equals the data object name used in the process.
• If the short name of the record type is localized, the properties of the record
type are not available for all languages in the localized TCP GUI. For
information about localization, see section 15.2 "Localizing a TCP project" in
Open Text TCP Modeler - Customization Guide (TCP-CGD). Keep this in mind
when defining record types in TCP Modeler and data objects in Process
Designer.

18.2 Attaching a record to a process when starting

from the process
There are two different ways to attach a record (document) to a process. If you want
to enable the user to access the properties of the attached documents in the process,
customize the Add -< Specific attachment type> variant. In this case, the user can
only attach documents of the specific attachment type. Otherwise the user can use
Add - Attachments.
From the user perspective, this scenario is described in section 6.9 "Attaching a
document to a process " in Open Text Transactional Content Processing - User Guide
(TCP-UGD). The user opens a work item from the inbox or work queue and attaches

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 111

Chapter 18 Attachment scenarios

a document of a specific record type via Add -< Specific attachment type>, for
example Add Invoice.
The specifics of both variants are:
Add -< Specific attachment type>
Embed a record type in a process by specifying process attributes to add record
type properties in Open Text Process Designer (Process Designer for short), see
section 7.1 "Adding record type properties" in Open Text Process Designer -
Customizing Guide (PR-CPD). At this stage, you have to specify a data object
name for the attributes. The data object name cannot be localized. It appears in
the TCP GUI as defined in Process Designer.
TCP Web Client displays the data object name as a separate menu item in the
Add menu of work items. When the user selects this menu item, searches for
documents and selects a document for being added, the attachment is “filled”
with real content.
Note: The record type of the record (document) selected by the user must
match with the one used for the attachment. Otherwise the user receives an
error message.
Add - Attachments
The name of the attachment is created by using the short name of the record
(type) the user adds to the process.
Notes:
• The access from the process to the properties of the record type is only
possible in very rare cases, because it requires that the short name of the
record type equals the data object name used in the process.
• If the short name of the record type is localized, the properties of the
record type are not available for all languages in the localized TCP GUI.
For information about localization, see section 15.2 "Localizing a TCP
project" in Open Text TCP Modeler - Customization Guide (TCP-CGD).
Keep this in mind when defining record types in TCP Modeler and data
objects in Process Designer.

112 Open Text Transactional Content Processing TCP100001-GCS-EN-2

Index
BAM 81
Fulltext 47
Fulltext carrier 69
Fulltext engine 53
A Connect
Activator Enterprise Library Services to TCP
See “XML Activator” Context Server 35
Application for Records Management 29 Livelink ECM – Enterprise Server to TCP
Attachment scenarios 111 Context Server 36
TCP Context Server to Open Text
B Enterprise Library Services 37
BAM Connections for Records Management 35
chart types 84 Conventions
configuring 81 Conventions in this documentation 14
Configuring a process for BAM 81 Create application 29
expressions 91 Customization overview
operators 91 Records Management 23
report file 81 Customize classifications 27
BAM report file Customize EL units 29
deploying 93
BAM_D_Date 98 D
BAM_D_ProcessClass 99 Define item types 30
BAM_D_ProcessStep 99 Define permissions 43
BAM_D_Time 98 Documentation overview 12
BAM_D_User 99 Documentation structure 11
Business Activity Monitoring 77
E
C EL records 19
Carrier 73 Enterprise Library Services
CD-ROM connect to TCP Context Server 35
Product ISO image 14 plug-in 33
Charts Examples
BAM 84 BAM Report files 101
Classifications expressions
customizing for Records Management 27 BAM 91
Completion Action
BAM 81 F
Configuring Feedback 16
a process for BAM 81 Folder type 31

TCP100001-GCS-EN-2 Open Text Transactional Content Processing 113

Index

Fulltext Records Management 19

configuration overview 47 Technical schema BAM 78
configuration settings 53
configure engine 53 P
enable for a record type 65 Performance monitoring 77
installation 47 Plug-in for Records Management 33
prerequisites 47 Prerequisites
Fulltext carrier Records Management 25
calling 69 Process
configuring 69 attaching a record 111
installing 69 PropertyReadGrantees 43
requirements 69
R
G Record
GUI profile 93 attaching to process 111
Records Management 19
I create application 29
Import certificate 43 customization overview 23
Import folder type 31 customize classifications 27
Installation customize EL units 29
Enterprise Server 47 define connections 35
Fulltext 47 define item types 30
ISO image define permissions 43
Product ISO image 14 import certificate 43
Item types 30 import folder types 31
ixos.dms:RMDate 40 install plug-in 33
ixos.dms:RMTypeId 40 prerequisites 25
ixos.dms:RMTypeName 40 Report file
ixos.dms:RMTypes: 40 BAM 81
Requirements
J Fulltext 47
Job (carrier) 73 Fulltext carrier 69
Retention schedule 19
L RM 19
Livelink ECM – Enterprise Server RMGrantees 43
connect to TCP Context Server 36
Livelink ECM – Enterprise Server S
installation 47 Search template ID
finding 63
M specifying 63, 64
Metrics 77 Structure of documentation 11
System connections for Records
Management 35
O
Open Text Online 16
operators T
BAM 91 TCP Context Server
Overview connect to Open Text Enterprise Library
BAM 77 Services 37

114 Open Text Transactional Content Processing TCP100001-GCS-EN-2

 Index

Typography 14

X
XML Activator 49
XML schema
BAM 82

TCP100001-GCS-EN-2 Scenario Guide 115