OpenText™ AppWorks Platform

Installation Guide for Windows

Release 22.3
This documentation has been created for software version OpenText™ AppWorks
Platform CE 22.3.
It is also valid for subsequent software releases unless OpenText has made newer
documentation available with the product, on an OpenText website, or by any other means.
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
Support: https://support.opentext.com
For more information, visit http://www.opentext.com
Copyright © 2022 Open Text. All Rights Reserved.
Trademarks owned by Open Text.
One or more patents may cover this product. For more information, please visit
https://www.opentext.com/patents
Disclaimer
No Warranties and Limitation of Liability
Every effort has been made to ensure the accuracy of the features and techniques presented
in this publication. However, Open Text Corporation and its affiliates accept no responsibility
and offer no warranty whether expressed or implied, for the accuracy of this publication.
Last updated: 6/26/2022
Table of Contents

Chapter 1 Introduction 1
Components 1
Audience 1
Installation overview 2
Chapter 2 System requirements 3
AppWorks Platform installation considerations 4
Environment support 4
Server requirements 4
Client requirements 5
Chapter 3 Installation checklist 6
Pre-installation checklist 6
Installation and configuration checklist 7
Installation worksheet 8
Chapter 4 Getting started with AppWorks Platform installation 11
Downloading the installation bundle 11
Chapter 5 Configuring third-party software 13
Java configuration 13
Configuring environment variable post Java installation 14
Database configuration 15
Prerequisites 16
Prerequisites for an existing database 17
Prerequisites for an existing MS SQL server database 17
Prerequisites for an existing Oracle database 17
Prerequisites for an existing PostgreSQL database 19
Tomcat configuration 19
Configuring Apache Tomcat properties 20

iii
 Editing Tomcat connector definition 21
TomEE configuration 21
Downloading TomEE 22
Creating a TomEE user 23
Granting TomEE access to the installation directory 24
Adding a default value environment variable 24
Installing the TomEE service 25
Updating the TomEE configuration 26
Configuring JDBC driver for TomEE 27
Configuring for MS SQL 27
Configuring for Azure SQL Database 28
Configuring for Oracle 29
Configuring for PostgreSQL 30
Configuring TomEE ports 30
Chapter 6 Installing AppWorks Platform 32
Installing CARS 33
Installing AppWorks Platform baseline 35
Deploying AppWorks Platform applications 42
Verifying AppWorks Platform installation 44
Hardening AppWorks Platform security 44
Chapter 7 Installing OpenText Directory Services 45
Installing OpenText Directory Services 46
Verifying the OTDS installation 47
Chapter 8 Configuring OpenText Directory Services 48
Configuring AppWorks Platform for OTDS authentication 49
Creating a resource for AppWorks Platform 49
Configuring AppWorks Platform for OTDS authentication 52
AppWorks Platform OTDS authentication 52
AppWorks Platform trusted sites 53
Configuring OTDS authentication per organization 54
Creating a user to push users and groups into AppWorks Platform 55
Creating an organization-specific partition for groups and roles 56
Creating an organization-specific resource for AppWorks Platform in OTDS 56

iv
 Linking the organization-specific partition to the organization-specific resource 59
Synchronizing roles 59
Creating a process administrator user 60
Managing users and group membership for a specific organization 61
Consolidating the resource 62
Verifying the configuration 62
Configuring OTDS for AppWorks Platform 63
Adding the Company AD partition 63
Adding an OTDS user 64
Disabling the authentication handler 65
Appendix A Installing AppWorks Platform on a single instance through
command line 66
Installing AppWorks Platform on a single instance 66
Installing CARS 66
Installing AppWorks Platform baseline 68
Installing AppWorks Platform application packages 68
Appendix B Installing AppWorks Platform on primary-distributed
computers through command line 72
Command line installation on primary-distributed computers 72
Installing AppWorks Platform on the primary computer 72
Installing AppWorks Platform on the distributed computer 72
Installing baseline on a distributed computer 73
Installing applications on a distributed computer 74
Appendix C Uninstalling AppWorks Platform through command line 76
Uninstalling AppWorks Platform on a single instance 76
Uninstalling AppWorks Platform on primary-distributed computers 76
Uninstalling application packages on the distributed computer 77
Uninstalling baseline on the distributed computer 77
Uninstalling baseline on the primary computer 78
Uninstalling OpenText CARS 78
Dropping database tables 78
Appendix D Uninstalling AppWorks Platform through a wizard 81
Uninstalling AppWorks Platform on a single instance 81

v
 Uninstalling AppWorks Platform on primary-distributed computers 81
Uninstalling application packages on the distributed computer 82
Uninstalling baseline on the distributed computer 82
Uninstalling baseline on the primary computer 83
Dropping database tables 83
Appendix E Troubleshooting 86
General troubleshooting 86
Troubleshooting OTDS 86
Installing AppWorks Platform on primary-distributed computers 88
Installation on primary-distributed computers 88
Installing AppWorks Platform on the primary computer 89
Installing AppWorks Platform on the distributed computer 89
Installing baseline on a distributed computer 90
Installing application packages on a distributed computer 91
Appendix F Configuring online help on a Private Help Server 92
Providing the online help on a local help server (Private Help Server) 92
Configuring AppWorks Platform to use a local help server (Private Help Server) 93

vi
 Chapter 1 Introduction

Chapter 1
Introduction
AppWorks Platform enables users to design, build, test, deploy, and monitor business
applications. It provides low-code development capabilities that enable users to quickly
model business objects using a compositional approach to application development, instead
of traditional way of programming a functionality.
The AppWorks Platform Installation Guide explains how to install new versions of AppWorks
Platform on Windows with MS SQL Server, Oracle, or PostgreSQL as the database and
TomEE as the Web server.
Topics include:
l Components
l Audience
l Installation overview

Components
Component Description
AppWorks Enables users to design, build, test, deploy, and monitor business
Platform applications. It provides low-code development capabilities that enable
users to quickly model business objects using a compositional approach to
application development, instead of traditional way of programming a
functionality.
OTDS Used as a centralized authentication mechanism and for user and role
management.

Audience
Note: The AppWorks Platform Installation Guide is written for system administrators or
users with administrative privileges who are responsible for installing AppWorks Platform. It
is highly recommended that users have a good knowledge of configuring MS SQL server,
Oracle, or PostgreSQL databases, configuring OpenText Directory Services (OTDS), and
administering web servers such as TomEE.

Installation Guide for Windows 1

Chapter 1 Introduction

Installation overview
The AppWorks Platform installation comprises two stages - baseline and application. You can
perform the installation on each stage in two different modes:
n Graphic User Interface (GUI) or Wizard
n Command line (non-GUI)

The following illustration provides a high-level overview of the steps required for installing
AppWorks Platform on a single instance in GUI mode. See Appendixes for instructions on
other modes of installations.

2 Installation Guide for Windows

 Chapter 2 System requirements

Chapter 2
System requirements
Before installing AppWorks Platform, ensure that all hardware, software, and database
requirements are met. Additionally, complete the prerequisites and obtain the necessary
configuration information before proceeding with the installation.

Important: For optimal utilization of resources, OpenText recommends that you install the
database server and OTDS on separate servers.
The following sections list the minimum hardware and software requirements for installing
AppWorks Platform.
System requirement information includes:
l AppWorks Platform installation considerations on page 4
l Environment support on page 4

Installation Guide for Windows 3

Chapter 2 System requirements

l Server requirements on page 4

l Client requirements on page 5

AppWorks Platform installation considerations

Multiple instances of AppWorks Platform can be installed on the same computer. Each
instance is identified with a unique name and is independent of other instances.
Possible installation scenarios include:
n Host multiple instances of AppWorks Platform on a single computer pointing to a single
CARS.
n Host multiple instances of AppWorks Platform on a single computer pointing to different
instances of CARS.
n Host AppWorks Platform along with earlier versions on a single computer.

Note: Although AppWorks Platform supports using a single CARS instance for multiple
AppWorks Platform instances, it is strongly recommended that you use one CARS instance
per AppWorks Platform instance. This is useful in backup and restore scenarios, where you
need to stop CARS to restore LDAP content of a AppWorks Platform instance. This results in
other AppWorks Platform instances being stopped as well. Therefore, having a dedicated
CARS instance for each AppWorks Platform instance helps avoid such situations.
Two or more installations of AppWorks Platform can share the same directory service
(CARS) and distribute the load of service requests between themselves. This setup is
preferred in high availability required environments. To configure AppWorks Platform in high
availability mode to manage failover, see the AppWorks Platform High Availability
Deployment Guide available on My Support.

Environment support
See the AppWorks Platform Supported Environments on My Support for a comprehensive list
of environments supported for AppWorks Platform.

Server requirements
The following table lists the minimum server requirements necessary to host AppWorks
Platform services.

System Minimum requirements

Production 24 GB RAM, modern high-
end multi-core CPU
Development 16 GB RAM, modern high-
end multi-core CPU

4 Installation Guide for Windows

 Chapter 2 System requirements

System Minimum requirements

Test 16 GB RAM, modern high-
end multi-core CPU

Note: Based on your application needs, you can increase the above requirements.

Client requirements
The following table lists the minimum hardware requirements necessary to access AppWorks
Platform services installed on a server.

Hardware Specification
Processor Dual core
Processor speed 2 GHz or faster
RAM 8 GB
Monitor resolution 1280x1024
Color depth 32 bits or higher
Monitor DPI 96

Installation Guide for Windows 5

Chapter 3 Installation checklist

Chapter 3
Installation checklist
This topic provides a high-level overview of the steps for installing AppWorks Platform.

Topics include:
l Pre-installation checklist on page 6
l Installation and configuration checklist on page 7
l Installation worksheet on page 8

Pre-installation checklist
Before beginning the installation process, do the following:

6 Installation Guide for Windows

 Chapter 3 Installation checklist

Task Description
❑ Satisfy all system requirements System requirements on page 3
❑ Set administrative privileges Grant administrative privileges on the computer
where the installations are to be performed for the
user performing the install and that this user has
WRITE privileges.
❑ Verify AppWorks Platform Verify that all computers where AppWorks
installation environments Platform is to be installed are in the same domain
and the administrator has appropriate permissions
on the Active Directory.
❑ Verify the third-party software Verify if the relevant versions of Java, database,
installations and web server are installed.
See the AppWorks Platform Supported
Environments guide on My Support for the list of
supported environments for AppWorks Platform.
If not installed, see the installation guide of the
corresponding software vendor for instructions on
installing the required software.
❑ Obtain installation information Print and complete the Installation worksheet on
page 8 before you begin installation. This
worksheet is used throughout the installation
process.
Additionally, use it to track information generated
during the installation, which is needed later in the
process.
Note: Open a text file editor, such as Notepad, to
record information generated during the
installation. You can reuse this information during
the install process.
❑ Download the installation zip file Getting started with AppWorks Platform
bundle to the AppWorks Platform installation on page 11
installation directory. This is
referred as <extracted
installation folder>

Installation and configuration checklist

The following checklist provides the sequence of steps required to install AppWorks
Platform.

Installation Guide for Windows 7

Chapter 3 Installation checklist

Task See
q Complete pre-installation checklist Installation checklist on page 6
q After installing the third-party Configuring third-party software on page 13
software or if already installed,
configure them as specified.
Note: For supported versions,
see the AppWorks Supported
Environments guide in OpenText
MySupport.
n Configure Java Java configuration on page 13

n Configure Database Database configuration on page 15

n Configure TomEE TomEE configuration on page 21

n Configure Tomcat Tomcat configuration on page 19

(Required only if you use
OTDS on another node)

q Initiate the AppWorks Platform Installing AppWorks Platform on page 32

Installation
q Install CARS Installing CARS on page 33
q Install AppWorks Platform
n Install AppWorks Platform Installing AppWorks Platform baseline on page
Baseline 35
n Install AppWorks Platform Deploying AppWorks Platform applications on
Applications page 42

q Install OpenText Directory Installing OpenText Directory Services on page

Services (OTDS) 45
(Required for Identity Package
and if OTDS is used as the
authentication mechanism)
q Configure OpenText Directory Configuring OpenText Directory Services on page
Services 48

Installation worksheet
Print this page and obtain the values for these items before or during the installation
process. These values are used in various configuration steps so it is vital that you note
these values as you go for a successful installation. All values required to be recorded are
identified in the procedures.
Caution: Before you start installing AppWorks Platform, ensure the following:

8 Installation Guide for Windows

 Chapter 3 Installation checklist

n Any user input you provide to the installer does not contain more than one dollar
character '$'. The installer ignores any content between the dollar characters including
the dollar characters.
n Any user input you provide to the installer does not contain more than one consecutive
forward slash '/' characters. The installer treats this as an escaping sequence.

Recommendation: Open a file in Notepad to copy various values, as some are lengthy
numeric values. By doing so, you can copy and paste long strings of information without
having to retype it.

Item Value
q Host server name / ID
q Extracted Installation Folder name
(where the installation bundle is
downloaded and files extracted)
q JDK or JRE installation directory
q Absolute path to the JDBC driver.
For example: for SQL Server database
driver, type the path of mssql-jdbc-
7.2.1.jre11.jar
q Absolute path to x64 folder
q TomEE
l User ID
l Password
l Port number

Important: Tomcat and TomEE are

different and cannot use the same
ports. Recommended to use port 81
for TomEE.
Note: If the TomEE user password
has character single quote, the single
quote character should be written
twice while providing the input. For
example, if the password is
Tom'c@t'EE, it should be entered as
Tom''c@t''EE.
q Tomcat
l Administrator Login ID
l Password

Installation Guide for Windows 9

Chapter 3 Installation checklist

Item Value
l Port number

q OTDS User Name and Passwords

l Admin name
l Password
l User name
l Password

q CARS
l Instance name
l Port number
l User name
l Password

q AppWorks Platform License

Information (most likely provided by
sales)
l Registered Customer Name
l Registered Site Name (found in
Sales materials)

q Password for the site (SITE) Value

provided by OpenText.
q AppWorks Platform Resource
Identifier
(You can save this value in a text
editor for later use)
q Database Details
l Server name
l Instance name
l Port number
l User name
l Password

10 Installation Guide for Windows

 Chapter 4 Getting started with AppWorks Platform installation

Chapter 4
Getting started with AppWorks
Platform installation
Before proceeding with the AppWorks Platform installation, download the installation bundle
from My Support and then stage for installation. A link to this site is available from your
sales representative or the Customer Support department.

Downloading the installation bundle

To download the installation bundle:

1. Create a AppWorks Platform Install folder on your desktop. This is the destination
location where the installer zip file is to be copied.
2. Access My Support and navigate to the folder containing the latest AppWorks Platform
installer.

Installation Guide for Windows 11

Chapter 4 Getting started with AppWorks Platform installation

3. Click the AppWorks Platform installer link to download the installer. The installer will be
downloaded to a temporary location.
4. Copy the installer zip file, OpenText_AppWorks_Platform_<version>.zip, to the
destination installation folder just created in step 1.
5. Extract the contents of the zip file to this install folder.

12 Installation Guide for Windows

 Chapter 5 Configuring third-party software

Chapter 5
Configuring third-party software
AppWorks Platform requires the support of a number of third-party applications. This section
provides the special considerations or configurations for implementing these software
packages to suit AppWorks Platform requirements.
Note: For supported versions, see the AppWorks Platform Supported Environments guide
in OpenText MySupport.
Topic includes:
l Java configuration on page 13
l Database configuration on page 15
l Tomcat configuration on page 19
l TomEE configuration on page 21

Java configuration
This section provides instructions for configuring Java as it applies to AppWorks Platform.

Installation Guide for Windows 13

Chapter 5 Configuring third-party software

Configuring environment variable post Java installation

After you complete the Java installation, configure the environment variable.
Set the JAVA_HOME system environment variable to <JDK_installdir>.
To configure the environment variable:

1. From the Start menu, select Run. Type sysdm.cpl, and then click OK.
The System Properties dialog box opens.

2. Click Advanced > Environment Variables.

The Environment Variables dialog box opens.

3. In System variables:
n Scroll to see whether an existing JAVA_HOME variable is available. If one exists, select
the JAVA_HOME variable, and then click Edit.
n If the JAVA_HOME directory does not exist, click New.

An Edit or New System Variable dialog box opens.

14 Installation Guide for Windows

 Chapter 5 Configuring third-party software

4. Enter the following information:

Variable name JAVA_HOME

Variable value C:\Program Files\Java\jdk11.0.6

5. Click OK.
The Environment Variables dialog box refreshes with the updated information.
6. In System variables, repeat the process for the Path variable:
n Scroll to see whether an existing Path variable is available. If one exists, select the
Path variable, and then click Edit.
n If the Path variable does not exist, click New.

An Edit New System Variable dialog box opens.

7. Type or modify the Path variable with the Variable value set with the absolute path to
the bin folder for the <JDK_installdir>.
Note: If the Path variable exists, move to the end of the existing variable value and
append the following path to this variable value:
;<JDK_installdir\bin>
For example:

Variable name Path

Variable value C:\Windows;C:\Program Files\Java\jdk11.0.6\bin

8. Click OK to accept the change, and then close the System Variable dialog box.
9. Click OK to exit the Environment Variables.
10. Click OK again to exit the System Properties dialog box.

Database configuration
AppWorks Platform supports the following databases:
n MS SQL Server
n Oracle
n PostgreSQL

Installation Guide for Windows 15

Chapter 5 Configuring third-party software

The following section provides information on the configuration requirements for each
database.

Prerequisites
Ensure that your database satisfies the following:

Database The database name used for installing AppWorks Platform must not
naming contain '.' (dot character) in the name.
convention
Database size The initial sizes of a data file in a database and its growth rate affect
requirements the performance of database operations. This in turn affects the
performance of AppWorks Platform during design time and runtime.
The actual data file size depends upon the volume of transactions. The
minimum recommended data file sizes are as follows:
Production Environment:
n Initial data file size of 5 GB and Auto growth of 1 GB
n Log file initial size of 2 GB and Auto growth of 1 GB

Development Environment:

16 Installation Guide for Windows

 Chapter 5 Configuring third-party software

n Initial data file size of 500 MB and Auto growth of 100 MB

n Log file initial size of 250 MB and Auto growth of 100 MB
n If the size of your project is higher than the recommended sizes,
allocate higher sizes.

Prerequisites for an existing database

If you are using an existing database to connect to AppWorks Platform, based on your
database, you must ensure the following before installing AppWorks Platform. Refer to the
appropriate section as it applies to your database:
n Prerequisites for an existing MS SQL server database on page 17
n Prerequisites for an existing Oracle database on page 17
n Prerequisites for an existing PostgreSQL database on page 19

Prerequisites for an existing MS SQL server database

n AppWorks platform requires SQL Server to be installed with SQL_Latin1_General_CP1_
CI_AS collation.
n AppWorks platform requires the existing database to have SQL_Latin1_General_CP1_
CI_AS collation. This applies to cases where DBA or administrator creates a database
and then installs AppWorks Platform using that database. If the database is created
during the AppWorks Platform installation, the installer sets the required collation.
n The MS SQL Server user has all the permissions on the database and that the user
has the db_owner role.
n The READ_COMMITTED_SNAPSHOT option is set to true on the database. Contact DBA
for further assistance.
n The MS SQL Server database must be configured to use the dbo schema. This is required
for the Entity runtime feature in AppWorks Platform.

Note: SQL Server instance needs to be configured with static ports. AppWorks does not
support dynamic ports with SQL server during installation.

Prerequisites for an existing Oracle database

n The Oracle user has necessary privileges. AppWorks Platform requires privileges to do
the following operations on the schema:
l SESSION - Create/Alter

l TABLE - Create/Alter/Drop
l INDEX - Create/Alter/Drop
l VIEW - Create/Alter/Drop
l PROCEDURE - Create/Alter/Drop/Execute

Installation Guide for Windows 17

Chapter 5 Configuring third-party software

l TRIGGER - Create/Alter/Drop
l SEQUENCE - Create/Alter/Drop
l DBMS_LOCK - Execute
l TYPE - Create

n The compression at Oracle database server level is not supported. Therefore, OpenText
recommends disabling compression before performing installation. Contact your
database administrator on disabling compression at database server level.

n Optionally, to enable XA settings, grant the following rights to the user who connects to
the database:
l Grant select on sys.dba_pending_transactions to <user name>;

l Grant select on sys.pending_trans$ to <user name>;

l Grant select on sys.dba_2pc_pending to <user name>;
l Grant execute on sys.dbms_system to <user name>;

n Optionally, to use SSL for Database connectivity with JDBC, you must configure the
Oracle service name as TCPS. See Oracle documentation for the procedure.

n The following parameters and the default values or characteristics are set:
l NLS_CALENDAR: GREGORIAN
l NLS_CHARACTERSET: AL32UTF8 for multibyte support
l NLS_COMP: BINARY
l NLS_CURRENCY: $
l NLS_DATE_FORMAT: DD-MON-RR
l NLS_DATE_LANGUAGE: AMERICAN
l NLS_DUAL_CURRENCY: $
l NLS_ISO_CURRENCY: AMERICA
l NLS_LANGUAGE: AMERICAN
l NLS_LENGTH_SEMANTICS: BYTE
l NLS_NCHAR_CHARACTERSET: AL16UTF16
l NLS_NCHAR_CONV_EXCP: FALSE
l NLS_NUMERIC_CHARACTERS: .,
l NLS_SORT: BINARY
l NLS_TERRITORY: AMERICA
l NLS_TIME_FORMAT: HH.MI.SSXFF AM
l NLS_TIME_TZ_FORMAT: HH.MI.SSXFF AM TZR
l NLS_TIMESTAMP_FORMAT: DD-MON-RR HH.MI.SSXFF AM
l NLS_TIMESTAMP_TZ_FORMAT: DD-MON-RR HH.MI.SSXFF AM TZR

18 Installation Guide for Windows

 Chapter 5 Configuring third-party software

Prerequisites for an existing PostgreSQL database

n The database has UTF8 characterset/encoding.
n The PostgreSQL user has the privileges to perform the following operations on the
database:
l CONNECT

l CREATE TEMPORARY
l SELECT
l INSERT
l UPDATE
l DELETE
l TRUNCATE
l EXECUTE
l REFERENCES

Tomcat configuration
Before you begin: You must provide the port number during the Tomcat installation,
because this port number is required for subsequent configurations. Refer to the installation
worksheet for details.
Important: This port number must be different from TomEE because these are two
different software components.

Installation Guide for Windows 19

Chapter 5 Configuring third-party software

Configuring Apache Tomcat properties

The following instructions provide the configuration information needed to set the automatic
startup routine and memory pool.
To configure Apache Tomcat properties:

1. Open the Monitor Apache Tomcat tool. Click All Programs > Apache Tomcat >
Monitor Tomcat.
The Apache Tomcat Properties dialog box opens.

2. If you did not select Service Startup when you installed Tomcat, set the Startup type to
Automatic. On the General tab, for Startup type, select Automatic and click Apply.
3. Click the Java tab.
The Java Properties tab opens.

4. Set the Initial memory pool to 512.

5. The Maximum memory pool is the maximum amount of virtual memory that the Tomcat
process can use. OpenText recommends that you enter the following value or a greater
one as needed:

20 Installation Guide for Windows

 Chapter 5 Configuring third-party software

n If your number of users is 25,000 or less, enter a value of 1024 MB or more

n If your number of users is 25,000 to 50,000, enter a value of 2048 MB or more
n If your number of users is 50,000 to 100,000+, enter a value of 4096 MB or more

6. Click OK.

Editing Tomcat connector definition

To edit the connector definition:

1. Navigate to the <Tomcat_installdir>\conf, right-click server.xml and select Edit.

2. Search for the Connector definition line. For example, locate the following lines:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" />

Note: The Port number must match the port number defined in the Tomcat installation.
Refer to the Installation Worksheet if needed.

4. Add a new attribute called maxHttpHeaderSize="65536" at the end of this definition. For
example:
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443" maxHttpHeaderSize="65536" />

5. Save and close the file.

6. From the Start menu, select Run.
7. Type services.msc, and then click OK.
The Services window opens.
8. Right-click Apache Tomcat Service and select Start.

TomEE configuration
This section provides instructions on configuring TomEE.

Installation Guide for Windows 21

Chapter 5 Configuring third-party software

Topic includes:
l Downloading TomEE on page 22
l Creating a TomEE user on page 23
l Granting TomEE access to the installation directory on page 24
l Adding a default value environment variable on page 24
l Installing the TomEE service on page 25
l Configuring JDBC driver for TomEE on page 27
l Configuring TomEE ports on page 30

Downloading TomEE
To download TomEE:

1. Navigate to the Apache TomEE installer: http://tomee.apache.org/download-ng.html

2. Download a version of TomEE that is compatible with your AppWorks Platform version.
3. Unzip to C:\Program Files\
4. Rename the TomEE folder to TomEE.

22 Installation Guide for Windows

 Chapter 5 Configuring third-party software

Creating a TomEE user

To create a user named TomEE:

1. From the Start menu, select Run.

2. Type lusrmgr.msc and click OK.
The Local Users and Groups window opens.
3. Right-click Users and select New User.
The New User window opens.
4. For:

User name Type a user name of your choice.

For example: TomEE.
Password Type a password of your choice.
Confirm password For example: 123#TomEE.
User must change Clear the check box.
password at next
logon
User cannot change Select this check box.
password
Password never Select this check box.
expires
Account is disabled Leave this check box unselected.

5. Click Create.
The User is created.
6. Write the user ID and password details on the Installation Worksheet.
7. Click Close.
8. On the Local Users and Groups window, select Users to view the newly created User
(TomEE).
The Local Users and Groups window opens.

9. Right-click the TomEE user and select Properties > Member Of.

10. Select Users and click Remove.

The list must now be empty.
11. Click OK to save changes and exit the TomEE Properties.
12. Close the Local Users and Groups window, and then continue with Granting TomEE
access to the installation directory on page 24.

Installation Guide for Windows 23

Chapter 5 Configuring third-party software

Granting TomEE access to the installation directory

To grant the TomEE user access to the installation directory:

1. Navigate to C:\Program Files\

2. Right-click the TomEE folder and select Properties > Security > Edit.
The Permissions for TomEE dialog box opens.

3. Click Add.
The Select Users or Groups dialog box opens.

4. For:

Object Types In the Object Type dialog box, clear all object types except for
Users, and then click OK.
Locations In the Locations dialog box, select your local server name, and then
OK.
Check Names In the Object names to select section, type TomEE, and then
click Check Names to verify the user name.

5. Click OK.
The Permissions for TomEE dialog box returns with TomEE already selected in the Group
or user names box.

6. Under Group or user names, select TomEE and then, under Permissions for TomEE,
grant Full control, and click OK.
7. Click OK to exit the TomEE Properties dialog box.

Adding a default value environment variable

To add an environment variable that provides default values to the AppWorks
Platform installer:

1. From the Start menu, select Run.

2. Type sysdm.cpl, and then click OK.
The System Properties dialog box opens.

3. Click Advanced > Environment Variables.

The Environment Variables dialog box opens.

4. Under System variables:

n Scroll to see whether an existing CATALINA_HOME variable is available. If one exists,
select the CATALINA_HOME variable, and then click Edit.
n If the CATALINA_HOME variable does not exist, click New.

24 Installation Guide for Windows

 Chapter 5 Configuring third-party software

The Edit or New System Variable dialog box opens.

5. For:

Variable name Type:

CATALINA_HOME

Variable value Set the value to:

C:\Program Files\TomEE

6. Click OK to save the variable.

7. Click OK to exit the Environment Variables dialog box.
8. Click OK to close the System Properties dialog box.

Installing the TomEE service

To install TomEE service:

1. Open a command prompt with Administrator privileges in C:\Program

Files\TomEE\bin
2. To install the Apache TomEE service, type service.bat install, and then press Enter.
A message indicating TomEE has been installed appears on the command prompt.
3. Close the command prompt.
4. From the Start menu, select Run.
5. Type services.msc and then click OK.
6. Right-click Apache TomEE and click Properties > Log On.
The Log On tab displays.

7. For:

This account Click Browse to select the TomEE user. The Select User
dialog box opens.
Object Types Click this option to select Users. Clear all object types
except for Users, and then click OK.
Note: The TomEE user must be in the following format:
<domain name>\<user name>.
AppWorks Platform does NOT support the following
users:
n Local System

n User names in the User Principal Name

(UPN) format. For example: <user name>@<domain
name> is not supported.

Installation Guide for Windows 25

Chapter 5 Configuring third-party software

Locations Click this option to select your local server.

Object names to select Type TomEE, click Check Names to verify the user
name, and then click OK.
Password Type the password specified while creating the TomEE
user, and then click OK. See the Installation Worksheet
for the user and password details.
A dialog box opens indicating the account .\TomEE has
been granted the Log On As A Service right.

8. Close the Service Manager window.

Updating the TomEE configuration

To update the TomEE configuration:

1. Navigate to the <TomEE_installdir>\bin and double-click TomEE.exe.

The Apache TomEE Properties Window opens.
2. Click the Java tab.
3. Under Java Options, add the following text:
-Dcom.sun.management.jmxremote.port=9090
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false
-XX:MaxRAMPercentage=75.0
-Dbus.xml.vm.maxsize=<25% of server memory in MB>

Note:
n The property -XX:MaxRAMPercentage sets the maximum Java heap size as a percentage
of the available memory. The default value for this property is set to be 75.0. For
example, on a server with 24GB of memory, 18GB is available for TomEE. This property
can be changed if required.
n The property -Dbus.xml.vm.maxsize sets the memory available for NOM XML
processing. The default value for this property is set to 25% of the available server
memory in MB. For example, on a server with 24GB of memory, set this property to
6144 (25% of 24GB is 6GB, which is 6144MB).

n The VM flag -XX:+UseParallelGC is removed while installing or updating AppWorks

Platform, so that the garbage collector in use changes to the Java default garbage
collector. You can modify the TomEE configuration after installation or upgrade to switch
to any other garbage collector that the application requires.

4. Leave the Initial memory pool and Maximum memory pool fields empty, because
the TomEE memory configuration is already done using the above mentioned properties.
5. Click OK.

26 Installation Guide for Windows

 Chapter 5 Configuring third-party software

Configuring JDBC driver for TomEE

Use the appropriate procedures below based on your database to configure the JDBC driver
for TomEE. It ensures that the JDBC driver can be used with all the AppWorks Platform
components.

Configuring for MS SQL

Note: The SQL JDBC driver 10.x is not supported (for example: mssql-jdbc-
10.2.0.jre8.jar).
To configure JDBC driver for TomEE on MS SQL:

1. From the link https://www.microsoft.com/en-in/download/default.aspx, search and

download the required JDBC driver for SQL Server. See the Database: Mainstream
section in the AppWorks Platform Environment Support guide on My Support for the
supported driver details.
2. Extract the Microsoft JDBC driver to a location.
3. In the extracted location, navigate to the sqljdbc_<version>\enu\ folder, and then
copy the mssql-jdbc-<version>.jre11.jar to the <TomEE_installdir>\lib folder.
For example: C:\Program Files\TomEE\lib

Note: Ensure that the lib folder contains only the supported version of the JDBC driver.

4. Add the <TomEE_installdir>\lib\mssql-jdbc-<version>.jre11.jar file to the

system CLASSPATH variable.

Note: Ensure that the CLASSPATH contains only the supported version of the JDBC
driver.

5. Optional: If MS SQL Server is used in Windows Authentication mode:

n Navigate to the sqljdbc_<version>\enu\auth\x64 folder, and then copy the 64-bit
DLL file to the <TomEE_installdir>\bin folder.
n Navigate to the <TomEE_installdir>\bin, and then double-click TomEE.exe. The
Apache TomEE Properties window opens.
n Navigate to the Java tab > Java options. Ensure that the -Djava.library.path
contains the AppWorks Platform’s lib, in addition to the jdbc_auth dll’s path.
Example: Djava.library.path=C:\Program Files\sqljdbc_
4.0\enu\auth\x64;C:\Program
Files\OpenText\AppWorksPlatform\defaultInst\lib
n Add the <TomEE_installdir>\bin folder to the system PATH variable.
n Ensure that the user under which TomEE/AppWorks Platform runs is authorized in MS
SQL Server. For details, see Using Windows Authentication to access SQL Server topic
in the product documentation.

Installation Guide for Windows 27

Chapter 5 Configuring third-party software

6. Optional: Enable XA transaction settings as follows:

n Copy the 64- bit sqljdbc_xa.dll from the <JDBC_driver_installdir>/xa/x64 to
the <MS SQL Server_installdir>\Binn folder of every MS SQL Server computer.
n Execute the database script xa_install.sql available in the <JDBC_driver_
installdir>\xa folder. You need administrative privileges on SQL Server to
execute/register a DLL.
n Enable XA Transaction for MSDTC on the MS SQL Server computer and restart the MS
SQL Server.

Configuring for Azure SQL Database

To configure JDBC driver for TomEE on Azure SQL Database:

1. From the link https://www.microsoft.com/en-in/download/default.aspx, search and

download the required JDBC driver for Azure SQL Database. See the
Database: Mainstream section in the AppWorks Platform Environment Support guide on
My Support for the supported driver details.
2. Extract the Microsoft JDBC driver to a location.
3. In the extracted location, navigate to the sqljdbc_<version>\enu\ folder, and then
copy the mssql-jdbc-<version>.jre11.jar to the <TomEE_installdir>\lib folder.
For example: C:\Program Files\TomEE\lib

Note: Ensure that the lib folder contains only the supported version of the JDBC driver.

4. Add the <TomEE_installdir>\lib\mssql-jdbc-<version>.jre11.jar file to the

system CLASSPATH variable.

Note: Ensure that the CLASSPATH contains only the supported version of the JDBC
driver.

5. Optional: If Azure SQL Database is used in Azure AD Integrated Authentication mode:

n Navigate to the sqljdbc_<version>\enu\auth\x64 folder, and then copy the 64-bit
DLL file to the <TomEE_installdir>\bin folder.
n Navigate to the <TomEE_installdir>\bin, and then double-click TomEE.exe. The
Apache TomEE Properties window opens.
n Navigate to the Java tab > Java options. Ensure that the -Djava.library.path
contains the AppWorks Platform’s lib, in addition to the jdbc_auth dll’s path.
Example: Djava.library.path=C:\Program Files\sqljdbc_
4.0\enu\auth\x64;C:\Program
Files\OpenText\AppWorksPlatform\defaultInst\lib
n Add the <TomEE_installdir>\bin folder to the system PATH variable.
n Ensure that the user under which TomEE/AppWorks Platform runs is authorized in
Azure SQL Database.

28 Installation Guide for Windows

 Chapter 5 Configuring third-party software

6. Optional: Enable XA transaction settings as follows:

n Copy the 64- bit sqljdbc_xa.dll from the <JDBC_driver_installdir>/xa/x64 to
the <MS SQL Server_installdir>\Binn folder of every Azure SQL Database
computer.
n Execute the database script xa_install.sql available in the <JDBC_driver_
installdir>\xa folder. You need administrative privileges on Azure SQL Database to
execute/register a DLL.
n Enable XA Transaction for MSDTC on the Azure SQL Database, contact your Azure
SQL Database administrator.

Configuring for Oracle

The Oracle OCI driver support is deprecated. However, OpenText recommends using Oracle
thin driver for database connectivity.
To configure JDBC driver for TomEE on Oracle:

1. From the link https://www.oracle.com/database/technologies/appdev/jdbc-ucp-19-7-c-

downloads.html, select Accept License Agreement to download the version 19c
(ojdbc10.jar) file.

2. Copy the JAR to the <TomEE_installdir>\lib folder.

Note: Ensure that the lib folder contains only the supported version of the JDBC
driver.

3. Add the <TomEE_installdir>\lib\ojdbc10.jar file to the system CLASSPATH

variable.

Note: Ensure that the CLASSPATH contains only the supported version of the JDBC
driver.

4. Optional: Enable XA settings as follows:

a. Start Oracle SQL command prompt.
b. Connect with the credentials: sys as sysdba.
c. Grant the following rights:
l Grant select on sys.dba_pending_transactions to <user name>;

l Grant select on sys.pending_trans$ to <user name>;

l Grant select on sys.dba_2pc_pending to <user name>;
l Grant execute on sys.dbms_system to <user name>;

Note: <user name> refers to the credentials of the AppWorks Platform user who
connected to the database (as specified in the AppWorks Platform Database
configuration).

Installation Guide for Windows 29

Chapter 5 Configuring third-party software

Configuring for PostgreSQL

To configure JDBC driver for TomEE on PostgreSQL:

1. From the following link, https://jdbc.postgresql.org/download.html, download the

relevant jar. For example, postgresql-42.2.23.jar

2. Copy the jdbc driver jar(for example, postgresql-42.2.23.jar) to the \lib

folder of TomEE installation.

Note: Ensure that the lib folder contains only the supported version of the JDBC
driver.

3. Add the <TomEE_installdir>\lib\postgresql-42.2.23.jar file to the system

CLASSPATH variable.

Note: Ensure that the CLASSPATH contains only the supported version of the JDBC
driver.

4. Edit \opt\PostgreSQL\9.4\data\pg_hba.conf and add the following line under IPV4

local connections:
host all all 0.0.0.0\0 md5
5. Save and close the file.
6. Optional: Enable XA transaction settings by specifying the max_prepared_
transactions parameter in the <PostgreSQL_installdir>\postgresql.conf file. The
value must be at least as large as the max_connections value.

Configuring TomEE ports

To modify the TomEE port:

1. Navigate to <TomEE_installdir>\conf.
2. Right-click server.xml and select Edit.
The server.xml file opens.
3. Edit the following items:
n Change the Server shutdown port from 8005 to 8006.
n Change the Connector port from 8080 to 81 (recommended).
n Change the AJP 1.3 Connector port from 8009 to 8010.

Note: Port 8080 is typically reserved for Tomcat OTDS installation and port 80 for other
programs that use IIS during installation.

4. Save and close the file.

Important: If running a monolithic system, verify ports and ensure that Tomcat, TomEE,
and IIS are running on different ports. If you change the default port number of the
Connector port to any other port number, you must change the redirectPort, serverPort, and

30 Installation Guide for Windows

 Chapter 5 Configuring third-party software

the Connector port of AJP to other ports that do not conflict with the Tomcat ports. Write the
port you use on the Installation Worksheet.
To update the AppWorks Platform configuration:
After changing the port number in TomEE, you must update the AppWorks Platform
configuration. The property com.cordys.node.url must point to the localhost URL including
protocol and port number. It must be updated when SSL is enabled on the Web server or
when the port number is changed.

1. Navigate to <AppWorks Platform_installdir>/config folder, open wcp.properties,

and then enter the following:

Property Value
com.cordys.node.url http://localhost:<port number>

If a non-default port number is used, you must include

it in the URL.
For example: http://localhost:81
Note: See Using HTTPS in AppWorks Platform
Advanced Development guide on My support for more
information.
web.server.portnumber <port number>

Installation Guide for Windows 31

 Chapter 6 Installing AppWorks Platform

Chapter 6
Installing AppWorks Platform
The next step for installing AppWorks Platform is to initiate the AppWorks Platform
installation in the following order:
l OpenText CARS
l AppWorks Platform baseline
l AppWorks Platform application packages

To initiate the AppWorks Platform installation:

1. Navigate to the AppWorks Platform 22.3 installation folder, right-click OpenText_CARS_

2.7.exe and run as Administrator.

The CARS Install Anywhere dialog box opens initiating the AppWorks Platform
installation.

2. Continue with Installing CARS on page 33

Installation Guide for Windows 32

Chapter 6 Installing AppWorks Platform

Installing CARS

AppWorks Platform requires a repository where it can store all its information about
organizations, users, service containers, services, and other objects. CARS is a Lightweight
Directory Access Protocol (LDAP) service provided and supported by AppWorks Platform.
CARS can be installed on the same computer where AppWorks Platform is installed or on a
different computer.
Before you begin: Ensure that the location of the JDBC driver jar of your database is set in
the classpath.
To install OpenText CARS:

1. Extract the contents of the installer zip file (for example, OpenText_AppWorks_Platform_
<release>.zip) to a local folder.
2. Navigate to the extracted folder and double-click Open_Text_CARS_2.7.exe
The Welcome page of OpenText CARS installer wizard opens.

3. Click Next.
The Third-Party Software License Agreements dialog box opens.

4. Review the license agreement. Select the I accept the terms of the License
Agreement option and click Next.
The Instance Name dialog box opens.

33 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

3. Accept the default or type an Instance Name for this instance and click Next.

Note: This can be a name of your choice. Write this name on the Installation Worksheet
for future reference.
The Installation Folder page opens.

4. Accept the default folder location and click Next.

Note: If installing CARS on a separate computer, type the absolute path to where the
service is created.
The Server Configuration dialog box opens.

5. Do the following:

Network enabled installation Select the option.

Note: OpenText recommends that you do
NOT change to a Standalone installation.
However, if you change it, you can enter your
own user information on the next dialog box.
Server Identifier Type the Fully Qualified Domain Name (FQDN)
location for the CARS installation if different from
the default.
Server Port Accept the default port value.
Suffix Accept the default suffix value.

6. Write the port number on the Installation Worksheet.

Note: This might be required if you are installing AppWorks Platform in a Primary-
Distributed environment.

7. Click Next.
The User Credentials dialog box opens.
8. Accept the default user name or provide a desired user name.
Where: cn=<username>,o=<domainSuffix>
For example: cn=Directory Manager,o=mycompany.com

9. Type a value for Password and Confirm Password.

10. Write the User Name and Password on the Installation Worksheet.

11. Click Next.

The LDAP configuration user details page opens.
12. Type a value for Password and Confirm Password, and then click Next.
The Pre-installation Summary dialog box opens.
13. Review the details in the dialog box and click Install.
The installation begins and when complete, the Installation status dialog box opens with

Installation Guide for Windows 34

Chapter 6 Installing AppWorks Platform

a Congratulations message.
14. Click Done.
The CARS installation is complete.
15. Continue with Installing AppWorks Platform baseline on page 35.

Installing AppWorks Platform baseline

The next step of the AppWorks Platform installation is to install the AppWorks Platform
baseline. The following instructions resume the procedures in Installing CARS on page 33,
which ended on the previous page.
See the Installation Worksheet during these steps for field parameter values.
To install AppWorks Platform:

1. Navigate to the installation folder and double-click AppWorks Platform22.3.exe.

The Welcome page appears.
2. On the AppWorks Platform Welcome dialog box, click Next.
The License Agreement dialog box opens.
3. Review the license agreement for AppWorks Platform by scrolling to the bottom of the
agreement, select I accept the terms of the License Agreement, and click Next.
The Third-party Software License Agreements dialog box opens.
4. Review the license agreement for third-party software by scrolling to the bottom of the
agreement. Select I accept the terms of the License Agreement, and click Next.
The CARS Information dialog box opens.

35 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

5. For:

CARS installed on this computer Select this option.

CARS installed on a different Select this option only if you are using multiple
computer computers and have installed CARS on a
different computer.
CARS is running under secure Automatically selected.
mode
CARS Host Automatically populated.
Port Number Automatically populated.
Suffix Automatically populated.
CARS Certificate Path Automatically populated.
User Name Automatically populated.
Password Type the CARS password. See the Installation
Worksheet for details.

6. Click Next.
The Advanced Configurations dialog box opens.
7. For:

Installation mode n Network enabled installation - Select this

option.
n Standalone installation -

Install application packages Automatically selected.

Minimize memory footprint Clear this check box.
Enable caching of web content Automatically selected.
Maximum age Default age is 15 Minutes.

8. Click Next.
The Instance Information dialog box opens.
9. Accept the default value or type a name for this instance, and then click Next.
The License Information dialog box opens.
10. For:

License Mode Select Single.

Installation Guide for Windows 36

Chapter 6 Installing AppWorks Platform

Registered Customer Name Type the name of the customer associated with
this product.
Registered Site Name Type the site name provided with the purchase
of the product. Refer to the Installation
Worksheet or your sales materials.

11. Click Next.

The License Key Information dialog box opens.
12. For the License Key information, do one of the following:
n Leave the check box selected if you know the password for the site, and then type the
password provided by OpenText in Password for the site (<site name>).
n Clear this check box if you have the license key, and then type the key provided by
OpenText in License Key.

Tip: Refer to the Installation Worksheet or your sales materials for the relevant details.

13. Click Next.

The Please Wait dialog box opens indicating that AppWorks Platform is being configured.
The Installation Folder dialog box opens.
14. Click Next.
The TomEE Details dialog box opens.
15. Accept the default values for the following values.

CATALINA HOME Automatically populated.

CATALINA BASE Automatically populated.
Tomcat service Automatically populated.
Tomcat connector Automatically populated.
Tomcat OS service name Type the Tomcat OS service name.
Note: The default value of Tomcat OS service name is
TomEE. However, if you have already installed TomEE with
another service name, you must enter that name here.

16. Click Next.

The Administrator Settings dialog box opens.
17. Type an appropriate User Name and Password to create the AppWorks Platform
Administrator user.
18. Write the administrator password on the Installation Worksheet.
19. Click Next.
The Database Information dialog box opens.
20. Enter the required values as specified below. The fields vary based on the Database Type
selected.

37 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

n For MS SQL server:

Note: SQL Server instance needs to be configured with static ports. AppWorks Platform
does not support dynamic ports with SQL server during installation.

Database Type Select MS SQL Server from the Database Type list.
Server name Type the full computer name of the database where the
installation is taking place. (From the Desktop, right-click and
select Properties. Obtain the Computer name.) Optionally,
you can also type the SQL instance name along with the server
name as <computername>/[instancename].
For example: AppWorksplatform.opentext.net/SQL2012.
Note: The database might not be the local computer where
you are installing AppWorks Platform.
Port Accept the default of 1433.
Authentication type Accept the default of SQL Authentication.
User Name and Type a new name and password for this AppWorks Platform
Password installation. If SQL Server database is used with Windows
Authentication as the Authentication type, the database user
details are hidden. The user name and password details given
in the Monitor Service User panel shall be used to connect to
the database.
Database Name Type a unique database name.
Use SSL for Leave check box cleared.
connectivity Note: If you want to use secured connectivity using SSL,
ensure that the database server is configured to use SSL and
import a valid certificate into Java trust store, and then select
this check box.
Create New Database Select this check box. When selected the DBA User name and
Password fields are displayed.
Use same DB for Select this check box.
Logger
DBA User Name and Type a user name and password for the database
DBA Password administrator.

n For Azure SQL Database:

Database Type Select Azure SQL Database from the Database Type list.
Server name Type the Azure SQL Database server name.
For example: awpazureinst.database.windows.net

Installation Guide for Windows 38

Chapter 6 Installing AppWorks Platform

Port Accept the default of 1433.

Authentication type Select the required authentication type.
n SQL Authentication - This is the default authentication
type. When selected, the User Name and Password fields
appear.
n Azure AD Integrated Authentication - Select this
option when you want to use the Azure Cloud SQL
database.

User Name and Applicable only when SQL Authentication is selected as the
Password authentication type.
Type a new name and password for this AppWorks Platform
installation. If Azure SQL Database is used with Azure
AD Integrated Authentication, the database user details are
hidden. The user name and password details given in the
Monitor Service User panel will be used to connect to the
database.
Database Name Type a unique database name.
Use SSL for By default, this option is selected and cannot be modified.
connectivity
Create New Database Select this check box. When selected the DBA User name and
Password fields are displayed.
Use same DB for Logger Select this check box.
DBA User Name and Applicable only when SQL Authentication is selected as the
DBA Password authentication type.
Type a user name and password for the database
administrator.

n For Oracle:

Database Type Select Oracle from the Database Type list.

User Name and Password Type a new name and password for this AppWorks Platform
installation.
Database Service Name Type the unique database name of the service, which is
used to connect to this database, entered during
installation or database creation.
Use thin client Select this check box. When checked, the Server name and
Port fields are enabled.
Use SSL for connectivity Leave check box cleared.

39 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

Note: If you want to use secured connectivity using SSL,

ensure that the database server is configured to use SSL
and import a valid certificate into Java trust store, and then
select this check box.
Server name Type the full computer name of the database where the
installation is taking place. For example: sales.acme.com
Port Accept the default of 1521.
Create New User Select this check box. When checked the DBA User name
and Password fields are displayed.
Use same DB for Logger Select this check box.
DBA User Name and DBA Type a user name that has SYSDBA privilege in the format,
Password <user name> as sysdba, and password for this user.

n For PostgreSQL

Database Type Select PostgreSQL from the Database Type list.

Server name Type the fully qualified name of the database server. For
example: sales.acme.com
Port Type the port number of database server. Default is 5432
User Name and Password Type an existing PostgreSQL user name and password.
Database Name Type a unique database name for new database.
Use SSL for connectivity Leave check box cleared.
Note: If you want to use secured connectivity using SSL,
ensure that the database server is configured to use SSL
and import a valid certificate into Java trust store, and then
select this check box.
Create New Database Select this check box. When checked, the DBA User Name
and Password fields are displayed.
Note: AppWorks Platform creates all database objects in
the default schema. For example, by default, public is the
default schema in PostgreSQL and all database objects will
be created in this schema.
Use same DB for Logger Select this check box.
DBA User Name and DBA Type PostgreSQL user name and password for the
Password database administrator.

21. Click Next.

The Monitor Service User Details dialog box opens.

Installation Guide for Windows 40

Chapter 6 Installing AppWorks Platform

22. The TomEE service logon user name is populated automatically. Type the appropriate
password and click Next.
The Please Wait dialog box opens advising to wait while AppWorks Platform is
configured.
The Database Settings dialog box opens.

23. Click Next. The PostgreSQL DB Tablespace Info page appears.

Optional: This page appears only if you selected PostgreSQL as the database in the
Database Information page. Do one of the following:
n To create a new tablespace, select Create new tablespace and type a name and
path where the tablespace will be located in the database.
n To use an existing tablespace, select Use existing tablespace option and type the
name of the tablespace.

24. Click Next.

The Please Wait page appears advising to wait while AppWorks Platform is configured.
A Database Settings dialog box opens displaying the recommended database
configuration. Read the recommendation and click OK.
The JMX Settings page appears.
25. Click OK to continue.
The JMX Settings dialog box opens.
26. Enter the User Name and Password to define the user details for the JMX console and
click Next.
The Please Wait dialog box opens advising to wait while AppWorks Platform is
configured.
When the process is complete, the Pre-installation Summary dialog box opens.

27. Review the installation summary list and click Install.

The installation procedure continues automatically. A series of progress screens appear
including a TomEE script execution bar.

When complete, the Congratulations dialog box opens indicating successful installation.

28. Click Done.

The Please Wait dialog box opens.
A browser window opens to the AppWorks Platform Explorer and begins deploying
mandatory applications. Numerous applications are deployed and can take several
minutes.
29. Proceed with deploying applications as explained in Deploying AppWorks Platform
applications on page 42.

41 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

Deploying AppWorks Platform applications

The following instructions resume the procedures from the previous page. Refer to the
Installation Worksheet during these steps for various field parameter values.
If you selected AppWorks Platform authentication during the baseline installation, you must
provide the same user name and password to proceed and load the application packages.
To deploy AppWorks Platform applications:

1. From the AppWorks Platform Explorer that launched at the conclusion of the prior
section, the Deploying mandatory application displays.

The Enter User Credentials dialog box opens.

2. Type the AppWorks Platform Administrator User Name and Password and click Sign In.
Refer to the Installation Worksheet for the user details.
The installer prepares to deploy product applications.

After deploying a number of applications, the database connection is deployed.

During this deployment, the screen updates displaying a Loading message.
The User Inputs window opens to the CWS Core options.

3. Do one of the following:

n Select Use same inputs for all applications if you want to use the same database
configuration details for all the applications listed under Select Package To Configure
Details.
n Select Configure different inputs for Applications if you want to provide
different database configuration details for different applications listed under Select
Package To Configure Details.
Ensure that the following special considerations are met when you select this option.

For applications Do the following

Cordys CWS Core Select Cordys System as the database
configuration.
Cordys Business Activity Monitoring Select the same database configuration
for Cordys Business Process Engine and
Cordys Notification applications.
OpenText Entity Runtime Select the same database configuration
for Cordys Business Process Engine,
Cordys Notification, OpenText Entity
Runtime, and OpenText Document Store
Services applications.

Installation Guide for Windows 42

Chapter 6 Installing AppWorks Platform

For applications Do the following

Cordys MDM For a production environment, select a
different database configuration from the
database configuration selected for
Cordys Business Activity Monitoring. In
this event, specify the options for the
new database configuration.

4. For Select Database Configuration, select the relevant database configuration.

All other fields are automatically populated.

5. Click Next.
A summary page appears with the details of each application.

6. Optional: Check the Revert on Failure check box.

n If checked and the deployment fails, the application package that failed is reverted to
its previous state. The subsequent deployment attempt proceeds from the failed
application package. Default 15 minutes – timeout in minutes
n If unchecked and an application fails to load, the application moves into an
Incomplete state and the subsequent attempt of installation resumes from the point
of failure.

7. Click Deploy.
The deployment of the application packages starts.
Deployment can take more than 30 minutes to complete.

Note: If any issues arise during the deployment of the CAP files, increase the JVM size.
Go to System Resource Manager > Cap service container and increase the JVM
size to 512 in the JRE configuration tab.
After deploying all the applications, a summary page displays a list of all deployed
application packages.

8. Click Finish.
Deployment of the application packages is complete and the AppWorks Platform
installation is complete.
The AppWorks Platform page appears.
9. Enter the AppWorks Platform User Name and Password and click OK.
The AppWorks Platform Explorer opens.

The default screen must be displayed.

10. Continue with Verifying AppWorks Platform installation on page 44.

43 Installation Guide for Windows

 Chapter 6 Installing AppWorks Platform

Verifying AppWorks Platform installation

Verify that AppWorks Platform is configured properly and the database tables are initiated.
To verify the application link:

1. Open Internet Explorer and type:

https://<server>:<port>/home/<organization>/app/start
Where:

<server> is the server where AppWorks Platform is installed

<port> is the port number associated with the installation
<organization> is the organization where the installation is installed

For example: http://localhost:81/home/system/app/start

The Enter User Credentials dialog box opens.

2. Type the User name and Password and click Sign In.
The default layouts page displays.

Tip: When you test the application, if the browser freezes with a screen that displays
‘Loading application’, you must close the browser and test again.

Hardening AppWorks Platform security

After the installation of AppWorks Platform, ensure to secure the environment. For
information on securing AppWorks Platform and related components including OTDS, see
the Hardening the Security of AppWorks Platform topic in the help ( ) accessible from the
shortcut bar on the AppWorks Platform interface.

Installation Guide for Windows 44

Chapter 7 Installing OpenText Directory Services

Chapter 7
Installing OpenText Directory
Services

Before you begin:

l Open Text recommends that the user installing or upgrading OTDS has administrative
privileges.
l Ensure that the <TomEE user> has Read and Write access on the OTDS installation
directory.

45 Installation Guide for Windows

 Chapter 7 Installing OpenText Directory Services

Installing OpenText Directory Services

To install OTDS:

1. Navigate to the OpenText Directory Services installation directory in My Support.

2. Download the required <OTDS installer for Windows>. For the list of supported
OTDS versions, see the OTDS section in the AppWorks Platform Environment Support
guide on My Support.
3. Double-click the installer.
The OpenText Directory Services Welcome dialog box opens.

4. Click Next.
The License Agreement page appears.

5. Review the license information by scrolling to the bottom of the text. Check the I accept
the terms in the License Agreement check box and click Next.
The Destination Folder dialog box opens.

6. Accept the default location and click Next.

The Application Server dialog box opens.

7. Leave the default, Apache Tomcat, and click Next.

The Installation Type dialog box opens.

8. Leave the Please check this box if you wish to setup the server as a replication
server check box unchecked and click Next.
The Java Virtual Machine dialog box opens.
9. Click Next.
The Apache Tomcat Directory dialog box opens.
10. Accept the default value and click Next.
The Directory Services Parameters dialog box opens.
11. Accept the default port numbers and click Next.

Note: Make sure that no other programs are using the default directory services ports.
If another program is using these ports, the installer does not allow you to proceed.
The OTDS Administrator dialog box opens.

12. For:
n Enforce a complex password for otadmin@otds.admin - Clear this check box.
n Password - Type the OTDS Administrator user name as otadmin@otds.admin and
password per the Installation Worksheet.

13. Click Next.

The Data Import page appears.

Installation Guide for Windows 46

 Chapter 7 Installing OpenText Directory Services

14. Do one of the following:

n If this is a new installation, accept the default (No import) option and click Next.
n If data exists, check Import Data from OpenText Directory Services <version>,
type the relevant path, and then click Next.
See OTDS Administrator's Guide for details on importing data from the applicable
version.
The Ready to Install dialog box opens.
15. Click Install to initiate the OTDS installation.
The Installing the product dialog box opens displaying a progress bar.
Note: Depending on the server configuration, the installation can take more than 5
minutes.
When complete, the Completing dialog box opens.

16. Click Finish.

The OTDS installation completes.

Verifying the OTDS installation

To verify OTDS installation:

1. Open a browser and type the following URL:

http://<server name>/otds-admin
The OTDS sign in dialog displays.
2. In the User name box, type otadmin@otds.admin
3. In the Password box, type the password as provided in the Installation Worksheet.
4. Click Sign in.
The OTDS web administration page appears.

This concludes the OpenText Directory Services installation process.

Note: After installing and verifying OTDS, you can configure OTDS as the authentication
mechanism for AppWorks Platform. See the Configuring OTDS for AppWorks Platform topic
in the help ( ) accessible from the shortcut bar on the AppWorks Platform interface for more
details.

47 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

Chapter 8
Configuring OpenText Directory
Services
This section identifies the configuration of OTDS required to support AppWorks Platform.

Topics include:
n Configuring OTDS for AppWorks Platform on page 63
n Configuring AppWorks Platform for OTDS authentication on page 49
n Configuring OTDS authentication per organization on page 54
n Disabling the authentication handler on page 65

Installation Guide for Windows 48

Chapter 8 Configuring OpenText Directory Services

Configuring AppWorks Platform for OTDS

authentication
To enable single sign-on for the users across these products, you must integrate directory
services such as Active directory, LDAP, and so on with OpenText Directory Services and
register the OpenText products as resources to centralize the users.
This section includes:
n Creating a resource for AppWorks Platform on page 49
n Configuring AppWorks Platform for OTDS authentication on page 52

Creating a resource for AppWorks Platform

After the users are imported from Active Directory to OTDS or created in OTDS, you must
create and activate resources for each component of the AppWorks. The following sections
provide instructions to configure the resources of each component.
Important: The AppWorks Platform Hostname (server ID), port ID, user name and
password values are required for this procedure.
To create and configure a user in AppWorks Platform:

1. Open the AppWorks Platform explorer.

2. Click User Manager.
The User Manager window opens.
3. Click Add (plus sign) on the toolbar.
The Create User page appears.
4. For:

Authentication type Select Platform.

User Name Type the unique name of the user.
Description Type the description or the full name of the user.
User ID Type the operating system identity of the user in the User
ID field. This acts as a unique user identifier, which is
used to sign in to the AppWorks Platform environment. If
the User ID of an organizational user being created exists,
you can map it to the existing authenticated user.
Default Organization Select the default organization for the user.
Password Expand Assign Password and type the password for the
user and confirm it.

5. Click Save.
The user is created and displays on the Users pane.

49 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

6. Select Include Internal Roles.

The Roles pane on the right displays the available roles.
7. Click Search and type OTDS Push Service.
8. Right-click OTDS Push Service and select Assign to selected Users.
The OTDS Push Service role is assigned to the created user.
To create a resource for AppWorks Platform in OTDS:

1. Connect to OTDS server using the OTDS Web Administration and log on as
Administrator.
The OTDS Administration page appears.
2. Click Resources on the navigation bar.
The Resources page appears.

3. Click Add (plus sign) to create a resource.

The New Resource page appears.

4. For:

Resource name Type a descriptive name for this resource.

For example: AppWorksPlatform
Display Name Type the name for how you want this resource to be displayed.
Description Optional. Type a description for this resource.
Login UI Version Retain the default value.
Login UI Style Leave the box empty.

5. Click Next.

Important: Do not click Save. Wait to save this resource until all parameters are
configured.
The New Resource > Synchronization page appears.

Installation Guide for Windows 50

Chapter 8 Configuring OpenText Directory Services

6. For:

User and group synchronization Select this check box.

Synchronization connector Select Rest (Generic) connector from the
list.
This connector will Leave selected defaults:
l Create users and groups
l Modify users and groups

Note: OpenText recommends not selecting

Delete users and groups operation in
production environments.

7. Click Next.

Important: Do not click Save. Wait to save this resource until all parameters are
configured.
The New Resource > Connection Information page appears.
Note: See the Installation Worksheet for the AppWorks Platform information generated
during the installation process. Use this information in the next step.

8. For:

Base URL Type the AppWorks Platform server URL to access

AppWorks Platform.
The URL comprises the protocol, host name, and port of
the AppWorks Platform server, including the (URL
encoded) name of the organization to push to, and the
fixed name of the push connector application
('otdspush').
For example:
http://<my appworks-platform-
server.domain.com>/home/acme%20corp/app/otdspush

User Name Type the user name of the user created for OTDS push
connector above.
This user name is used to push users from OTDS to
AppWorks Platform.
Password Type the password of the user created during the
AppWorks Platform installation.

9. Click Test Connection to verify that the details provided above are correct and a
connection between AppWorks Platform and OTDS can be established.
When successful, a Connected Successfully message is displayed.

51 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

10. Click Next.

The New Resource > User Attribute Mapping page appears.

11. Accept the default values and click Next.

Note: If the page does not display any values, click Reset to Default.
The New Resource > Group Attribute page appears.

12. Accept the default values and click Save to create the resource.

Note: If the page does not display any values, click Reset to Default.
The Resource Activation – AppWorks Platform dialog opens displaying the resource
identifier.
Important: Do not click Verify Activation because more configuration is required.

13. Highlight and copy the resource identifier and paste it into a text editor or write this
identifier on the Installation Worksheet so you can copy it later when configuring
AppWorks Platform to use OTDS for authentication.
14. Click OK.
The resource is created for AppWorks Platform.

Configuring AppWorks Platform for OTDS authentication

This section describes the steps for AppWorks Platform OTDS Authentication.
Topics include:
n AppWorks Platform OTDS authentication on page 52
n AppWorks Platform trusted sites on page 53

AppWorks Platform OTDS authentication

To configure AppWorks Platform OTDS Authentication:

1. Open a browser and access AppWorks Platform Explorer > Security

Administration > OTDS Resources > Platform.
The Platform information is displayed.

2. In Shared Configuration, specify the values for the below fields:

OTDS Server URL Type the URL to access the OTDS Server in the following format:
http://<computer name>:<port number>
This must be a valid URL, starting with either http or https, for
example: http://server1:8080
Resource ID Enter the resource identifier of the AppWorks Platform resource
created in OTDS.

Note: The Shared configuration can be used in all organizations. However, the
Organization configuration can only be used in the current organization.

Installation Guide for Windows 52

Chapter 8 Configuring OpenText Directory Services

3. Click Save, and then click Activate.

A Notification page appears indicating the Resource was successfully activated.
4. Click Close on the message notification.
5. Click Authenticators > Shared.
The Authenticators tab appears.

6. Click Add (plus sign) on the Shared Authenticators table.

The Authenticator Details page appears.

7. For:

Id Type an ID for the Authenticator.

For example: OTDS
Default or Test Only Select the Default check box.
Type Select 'OTDS' from the list.

Note: Leave all other values or modify as needed.

8. The OTDS Properties tab is automatically populated with the OTDS resource information.

9. Optional. If the public URL of the OTDS server is different from the internal URL, for
example when a proxy is used, then specify the Public OTDS login URL. Use the public
URL of the OTDS server and concatenate /otdsws/login.
For example: https://otds.acme.com:8443/otdsws/login

10. Click Save and close the Security Administration page.

11. Continue with AppWorks Platform trusted sites on page 53.

AppWorks Platform trusted sites

For authentication, the domain level URL for AppWorks Platform must be registered as
trusted sites in OTDS to ensure that OTDS can redirect back to the products after the user
has been authenticated. Without configuring this, you are likely to receive an error "Not a
trusted referral site, please contact your administrator" after the user has been
authenticated and before returning to the originally requested application.
To add a trusted site:

1. Open a browser and access OTDS Admin through http://<hostname>:<tomcat port

no>/otds-admin.
The OTDS home page displays.
2. Click Trusted Sites.
3. Click Add.
4. Under Addresses Directory Services will redirect requests to, type an appropriate
URL in the format <protocol>://<FQDN>:<AppWorksPlatformPort>.

53 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

For example: http://AppWorksPlatformServer.domain.suffix:81

5. Click Save.
6. In the left frame, click Access Roles.
The Access Roles page appears.

7. Select Access to AppWorksPlatform and click Actions > View Access Role
Details.

The Access to AppWorksPlatform > User Partitions tab page appears.

8. Click Add.
The Add Partitions – Access to AppWorksPlatform page appears.

9. Select the AppWorksPlatform Partition that was previously created and click Add
Selected Items to Access Role.
10. Click Close Dialog to close the page.
11. Click Save.
The page is refreshed.

Note: Adding the User Partition automatically pushes all the users and groups to
AppWorks Platform. Users in OTDS are pushed as authenticated users to AppWorks
Platform and groups in OTDS are pushed as roles to AppWorks Platform.

12. Optional: If you have multiple partitions added to Access Roles, select the Access to
AppWorksPlatform role and click Actions > Include Groups from OUs.
The Include/Exclude Groups from OUs message displays.

13. Click OK.

The Access Roles page refreshes showing this selection is now included.

14. Close this page.

Note: To push the AppWorks Platform package roles to OTDS, use the OTDS Push roles
functionality available in Security Administration. For more information, see the
Synchronizing roles from AppWorks Platform to OTDS topic in the AppWorks Platform
Administration Guide.

Configuring OTDS authentication per organization

To configure the OTDS authentication per organization, you must do the following:
n Creating a user to push users and groups into AppWorks Platform on page 55
n Creating an organization-specific partition for groups and roles on page 56
n Creating an organization-specific resource for AppWorks Platform in OTDS on page 56
n Linking the organization-specific partition to the organization-specific resource on page
59

Installation Guide for Windows 54

Chapter 8 Configuring OpenText Directory Services

n Synchronizing roles on page 59

n Creating a process administrator user on page 60
n Managing users and group membership for a specific organization on page 61
n Consolidating the resource on page 62
n Verifying the configuration on page 62

Note: This section assumes that the name of the organization is System.

Creating a user to push users and groups into AppWorks

Platform
The push connector runs in OTDS and connects to AppWorks Platform to sync users. This
must be done under a user context that is allowed to do so. Therefore, we must create a
user in AppWorks Platform with a specific role and configure this user in the OTDS REST
push connector.
To create and configure a user for the OTDS push connector:

1. Open a browser and access AppWorks Platform Explorer > User Manager.
The User Manager window opens.
2. Click + (Add a User) on the toolbar.
The Create User page appears.
3. For:

Field Value
Authentication Type Select Platform.
User Name Type the unique name of the user. For example: JDoe
User Full Name Type the full name of the user. For example: John Doe
User ID Type the operating system identity of the user in the
User ID field. This acts as a unique user identifier, which
is used to sign in to AppWorks Platform.
Note: If the User ID of an organizational user being
created already exists (because you have set up
another organization already), you can map it to the
existing authenticated user in the dialog box that pops
up.
Password Type the password for the user.
Confirm Password Confirm the password.

4. Click Save.
The user name displays on the Users pane. Ensure that the user is selected.

55 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

5. Select Include Internal Roles.

The Roles pane on the right displays the available roles.
6. On the Roles pane, click Search and type OTDS Push Service.
7. Right-click OTDS Push Service, and then select Assign to selected User(s).

The OTDS Push Service role is assigned to the created user.

Creating an organization-specific partition for groups and roles

To create an organization-specific partition for groups and roles:

1. Launch a browser and type the following URL:

http://<hostname>:<tomcat port no>/otds-admin
For example:
http://localhost:8080/otds-admin

2. Sign in with appropriate credentials.

Tip: Retrieve this user name and password from the Installation Worksheet or contact
your system administrator.
The OTDS Administration page appears.

3. Click Partitions.
The Partitions page appears.
4. Click Add > New Non-synchronized User Partition.
5. Type a name, for example: AppWorks Platform Groups for System, and then click Save.
The partition is added.

Creating an organization-specific resource for AppWorks

Platform in OTDS

Important: During the resource creation, do NOT click Save until all parameters are
configured and it is explicitly stated to save. When you click Save, OTDS schedules a
synchronization task. Therefore, synchronizing a resource without completing the required
configurations might result in duplicate or lost data in AppWorks Platform.
To create a resource for AppWorks Platform in OTDS:

1. Connect to OTDS server using the OTDS Web Administration by launching a browser,
type the following URL, and then sign in as an administrator:
https://<hostname>:<port no>/otds-admin

2. Click Resources on the navigation bar.

The Resources page is displayed.

Installation Guide for Windows 56

Chapter 8 Configuring OpenText Directory Services

3. Click + (Add) to create a resource.

The New Resource page appears.

4. For:

Resource name Type a descriptive name for this resource.

For example: AppWorks Platform Resource for System
Display Name Type the name by which the resource displays.
Description Optional. Type a description for this resource.
Sign in UI Version Retain the default value to accept the default value of the
resource.
Sign in UI Style Leave the box empty.
Sign out URL Leave the box empty.
Sign out Method Leave the box empty.

5. Click Next.

Important: Do not click Save. Wait to save this resource until all parameters are
configured.
The New Resource > Synchronization page appears.

6. For:

User and group Select this check box.

synchronization
Synchronization Select Rest (Generic) connector from the list.
connector
This connector Leave selected defaults:
will l Create users and groups
l Modify users and groups

Note: OpenText recommends not selecting Delete users and

groups operation in production environments.

7. Click Next.

Important: Do not click Save. Wait to save this resource until all parameters are
configured.
The New Resource > Connection Information page appears.
Note: Refer to the Installation Worksheet for the AppWorks Platform information
generated during the installation process. Use this information in the next step.

57 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

8. For:

Base URL Type the AppWorks Platform server URL to access

AppWorks Platform.
The URL comprises the protocol, host name, and port of
the AppWorks Platform server, including the (URL
encoded) name of the organization to push to, and the
fixed name of the push connector application
(otdspush).
For example:
http://<my appworks-platform-
server.domain.com>/home/acme%20corp/app/otdspush

User Name Type the user name of the user created for the
OTDS push connector. For example:
JDoe
This user name is used to push users from OTDS to
AppWorks Platform.
Password Type the password of the user created during the
AppWorks Platform installation.

9. Click Test Connection to verify that the details provided are correct and a connection
between AppWorks Platform and OTDS can be established.
When successful, a Connected Successfully message displays.

10. Click Next.

The New Resource > User Attribute Mappings tab is displayed.
Note: If the page does not display any values, click Reset to Default.
The New Resource > Group Attribute page appears.

11. Accept the default values and then click Next.

The New Resource > User Attribute Mappings tab is displayed.

Note: When you use the OTDS Migrator tool, ensure that the OTDS attribute for the '__
NAME__' resource attribute is set to oTExternalID1.

12. Accept the default values and click Save to create the resource.
The Resource Activation – AppWorks Platform dialog box displays the resource identifier.

13. Click OK to dismiss this dialog box because resource activation is not required for the
push connector.

The resource is created for AppWorks Platform.

Installation Guide for Windows 58

Chapter 8 Configuring OpenText Directory Services

Linking the organization-specific partition to the organization-

specific resource
To provide users access to an organization, you must link them to the organization-specific
resource. This can be achieved in multiple ways, but the preferred way is to add the entire
organization-specific partition (AppWorks Platform Groups for System) created above to the
access role of the System organization.
To link the partition to the access role:

1. Connect to OTDS server using the OTDS Web Administration by launching a browser,
type the following URL, and then sign in as an administrator:
https://<hostname>:<port no>/otds-admin

The OTDS Admin page is displayed.

2. Click Access Roles on the navigation bar.

The Access Role page appears.
3. In the table, find the Access to AppWorks Platform Resource for System access role.
4. Click Actions, and then select Include groups if they are not included.
5. Click OK in the confirmation dialog box that opens.
6. Click Actions > View Access Role Details.
The Access Role Details page appears.
This view contains several tabs for the kind of types that can be granted access to the
resource: User Partitions, Organizational Units, Groups, and Users. The Resources tab
provides information on the resources to which this access roles grants access. This can
remain limited to the AppWorks Platform Resource for Acme resource only.
7. Navigate to the User Partitions tab, and then click Add.
The Add Partitions - Access to AppWorks Platform Resource for System window opens.
8. Search for the AppWorks Platform Groups for System partition, select it, and then click
Add Selected Items to Access Role.
9. Click Close Dialog, and then click Save.

Synchronizing roles
This topic describes the procedure to synchronize AppWorks Platform package roles with
OTDS. Functional and application roles from packages that are available in the shared space
and in the specified organization context are created in OTDS.
The package roles in AppWorks Platform are created in the <Package Name>#<Role Name>
format, for example, Case Management#Case Worker.
To synchronize roles from AppWorks Platform to OTDS:

1. On the Welcome page, click (Security Administration).

The Security Administration window opens and the Certificates tab is displayed by

59 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

default.
2. Click the OTDS Resources tab.
3. Click the OTDS Push Roles tab.
The OTDS push role page opens and the OTDS server URL is prefilled from the
configured Platform resource.
4. Type a name for the OTDS partition in OTDS partition name.
5. Optional. Select Delete roles if you want the package roles not found in AppWorks
Platform to be deleted from OTDS.

Note: This is useful when you renamed a role. Since the OTDS Push Roles feature does
not support renaming roles, you can first push without selecting the Delete roles option,
copy the membership from the old role to the new role, and then push the role again
with the Delete roles option selected.

6. Click (Save) to save the configuration.

7. Click Push roles.
The status field displays the progress of the role synchronization. You can click to
obtain the latest status and to see if the role synchronization is complete.

Creating a process administrator user

Create a user and link the user to the partition that was created above.
To create a process administrator user:

1. Launch a browser and type the following URL:

http://<hostname>:<tomcat port no>/otds-admin
For example:
http://localhost:8080/otds-admin

2. Sign in with appropriate credentials.

Note: Retrieve this user name and password from the Installation Worksheet or contact
your system administrator.
The OTDS Administration page appears.

3. Click Partitions.
The Partitions page appears.
4. Find the AppWorks Platform Groups for System partition.
5. Click Actions > View Members.
A page appears with a list of users.
6. Click Add > New User.
The new user page appears.
7. Type the user name as ProcessAdmin, and then click Save.
The user is created and added to the partition.

Installation Guide for Windows 60

Chapter 8 Configuring OpenText Directory Services

8. Click Actions > Edit Membership.

The Member Of page appears.
9. Click Add To Group.
The Users and Groups Associations dialog box opens.
10. Search for Cordys@Work#Administrator, select the corresponding group for the user
partition AppWorks Platform Group for System, and then click Add Selected.

The ProcessAdmin user is assigned to the Cordys@Work#Administrator group.

Managing users and group membership for a specific

organization
You can add users and groups to the System organization using the AppWorks Platform
Groups for System partition.
n Adding a user to a group in the partition.
n Adding a group to another group in the partition.

Important: OpenText recommends that you do NOT add a user to the access role directly.
If there is a requirement to have additional users in AppWorks Platform without any role in
an organization, you can follow the steps below to add a user to an access role. However, to
simplify and reduce the overhead, do the following:

1. Create an extra group called Guest users in the partition AppWorks Platform Groups for
System (which is part of the access role already).
2. Add the users not having a role in AppWorks Platform to that group.

To add a user or group to a group:

1. Launch a browser and type the following URL:

http://<hostname>:<tomcat port no>/otds-admin
For example:
http://localhost:8080/otds-admin

2. Sign in with appropriate credentials.

Note: Retrieve this user name and password from the Installation Worksheet or contact
your system administrator.
The OTDS Administration page appears.

3. Click Partitions.
The Partitions page appears.
4. Find the AppWorks Platform Groups for System partition.
5. Click Actions > View Members.
A page appears with a list of users.
6. Click the Groups tab.
A page appears with a list of groups.

61 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

7. Find the group to add members, and then click Actions > Edit Membership.
The membership page appears, showing a list of all current members.
8. Click Add Member.
The Users and Groups Associations dialog box opens.
9. Search for required users in the AppWorks Platform Groups for System partition. For
example, John Doe.
10. Select the user, and then click Add Selected on the toolbar.
11. Similarly, you can repeat the above step for groups.
Note: Ensure that you select the groups from the AppWorks Platform Groups for
System only.

12. After adding all users and groups, click Close to close the dialog box.

Consolidating the resource

When a change is made to a user, group, or resource, it must automatically be pushed to
AppWorks Platform. If you realize that users are not automatically pushed to AppWorks
Platform, or you want to ensure that the changes are pushed, you can consolidate a
resource.
To consolidate a resource:

1. Launch a browser and type the following URL:

http://<hostname>:<tomcat port no>/otds-admin
For example:
http://localhost:8080/otds-admin

2. Sign in with appropriate credentials.

Note: Retrieve this user name and password from the Installation Worksheet or contact
your system administrator.
The OTDS Administration page appears.

3. Click Resources on the navigation bar.

The Resources page appears.
4. For the AppWorks Platform Resource for System resource, click Actions >
Consolidate.
5. Click Consolidate.
The consolidation is triggered, but depending on the number of users and groups, it
might take some time. Consolidation checks every user and group, and pushes updates
to AppWorks Platform.

Verifying the configuration

After all the configurations are complete, you can verify the configuration.

Installation Guide for Windows 62

Chapter 8 Configuring OpenText Directory Services

To verify the configuration:

1. Open a browser and type the AppWorks Platform URL.

2. Sign in with the credentials of the user created above.

The OTDS authentication now is configured and when users open AppWorks Platform, they
are redirected to OTDS to sign in.

Configuring OTDS for AppWorks Platform

Configuring OTDS for AppWorks Platform consists of the following tasks:
n Adding the Company AD partition
n Adding an OTDS user

Adding the Company AD partition

To add a partition in OTDS:

1. Connect to OTDS server using the OTDS Web Administration by launching a browser,
type the following URL and sign in with the appropriate credentials:
https://<hostname>:<port no>/otds-admin and sign in with the appropriate
credentials.
For example:
https://localhost:8433/otds-admin
Note: Retrieve this user name and password from the Installation Worksheet or contact
your system administrator.
The OTDS Administration page opens.

2. Click Partitions.
The Partitions page displays a list of existing partitions.

Note: The otds.admin partition was created during the installation.

3. Based on your requirement, do one of the following:

a. If you have an existing AD/LDAP to use, click Add > New Synchronized User
Partition and follow the wizard to set it up.
b. If you do not have an existing AD/LDAP, click Add > New Non-synchronized User
Partition.

Note: The remainder of this document assumes that the name of the partition is
Company AD, but you can use another name.

4. Click Save. The partition is added.

5. Optional, but recommended for non-synchronized user partitions: For the new
partition you created, click Actions > Password Policy.

63 Installation Guide for Windows

 Chapter 8 Configuring OpenText Directory Services

Note: If you did not specify a secure global policy, then configure it, or clear the Use
global policy check box, and set the Password Quality and Security Options to the
required settings for your environment.

6. Click OK.
The Partitions dialog box displays the newly created partition.

Adding an OTDS user

1. Click Add > New User.
The Users & Groups > AppWorks Platform Partition dialog box opens displaying the new
user configuration fields.

2. Type the new User ID.

For example: ProcessAdmin

Note: This user ID and password must be the same as the user created during the
AppWorks Platform installation. Refer to the Installation Worksheet for this information.
The following rules apply when creating a User ID:

n Can include upper and lowercase letters, numerals, blanks, and special characters.

n Cannot contain any reserved special characters, such as: , + " \ < > ; = /

n Cannot contain a blank or # at the beginning.

n Cannot contain a blank at the end.

3. Type values in other fields as needed. All other fields are optional. For example:
n First name - Process
n Last name - Admin
n Email – ProcessAdmin@appworks.com

4. Click Next.
The Account Options configuration information for the new user is displayed.
5. For:

Do not require a password change on Select this option.

reset
User cannot change password Select this option.
Password never expires Select this option.
Password Type a value.
Confirm Password

Installation Guide for Windows 64

Chapter 8 Configuring OpenText Directory Services

6. Click Next.
The Organization dialog box opens.
7. Click Next as information is not required in this dialog box.
The User Attribute dialog box opens.
8. Click Next.
The Custom Attributes dialog box opens.
9. Click Save as information is not required in this dialog box.
The Partitions > AppWorks Platform Partition dialog box opens displaying the user just
created.

10. Write the OTDS User name and Password on the Installation Worksheet.
The user is now created in OTDS.

Disabling the authentication handler

You must disable the http.negotiate authentication handler because Kerberos
authentication is not being used.
To configure authentication handlers:

1. Open a browser and access OTDS Admin through http://<hostname>:<tomcat port

no>/otds-admin.
The OTDS home page displays.
2. Select Authentication Handlers.

3. Select http.negotiate > Actions > Disable.

The window refreshes showing http.negotiate is disabled.

65 Installation Guide for Windows

 Appendix A Installing AppWorks Platform on a single instance through command line

Appendix A
Installing AppWorks Platform on a
single instance through command
line
AppWorks Platform can be installed using the command line mode on a single instance and
on primary-distributed instances.
n Installing AppWorks Platform in single instance mode
n Installing AppWorks Platform in a primary-distributed mode

Installing AppWorks Platform on a single instance

This topic includes:
n Installing CARS
n Installing AppWorks Platform Baseline
n Installing AppWorks Platform Application Packages

Installing CARS
OpenText CARS can be installed in command line mode by setting the required input
properties in the OpenText CARS.installer.properties file. The input properties file is
generated and shipped along with the AppWorks Platform installer package OpenText_
AppWorks_Platform_22.3.zip.
The filename for the input properties is OpenText CARS.installer.properties.
A sample follows.

Installation Guide for Windows 66

Installing CARS

To install CARS:

1. Navigate to the folder where the OpenText_AppWorks_Platform_22.3.zip is extracted.

2. Open the OpenText CARS.installer.properties file and edit the following parameters
according to your computer specifications:
n Instance name
n User Install Folder
n LDAP Host
n LDAP Port
n LDAP Suffix

67 Installation Guide for Windows

 Installing AppWorks Platform baseline

n LDAP User Name

n LDAP Password
n LDAP Confirmation Password
n INSTALLMODE whose value must be SSL_MODE
n Installation Type (Network enabled or Standalone)

3. Save and close the file.

4. Open Command prompt and type the following silent installation command: OpenText_
OpenText CARS_2.7.exe -i silent -f OpenText CARS.installer.properties

5. The installation proceeds with the information provided in the input properties file.

Installing AppWorks Platform baseline

To install AppWorks Platform baseline on a single instance

1. Navigate to the location of the extracted folder of the OpenText_AppWorks_Platform_

22.3.zip file.
2. Open the cordys.installer.properties file in a text editor.
See the inline documentation and set the values according to the configuration of the
computer.
3. Ensure that you set all the required parameters and save the file.
Note: If you are using MS SQL Server as the database, ensure to comment other
database fields in the properties file.

4. Run the command-prompt as Administrator and enter the following command:

OpenText_AppWorks_Platform_22.3.exe -i silent -f
cordys.installer.properties.
The AppWorks Platform baseline installation will be launched.
Note: If the installation is successful, the installation logs will be stored in the following
location: <AppWorks Platform_installdir>/install_log.
Note: If the installation is not successful, the debug log (cordys_custom_log.log) will
be available in the Temp space or Desktop Directory of the user who is installing.

5. Continue with installing the Application Packages.

Installing AppWorks Platform application packages

1. Ensure that TomEE is running on your computer.
2. Open the application installation template file (/captemplates/AppWorks Platform
Full Product) from the extracted OpenText_AppWorks_Platform_ 22.3.zip folder.

Installation Guide for Windows 68

Installing AppWorks Platform application packages

3. Modify the following properties according to the configuration of your computer:

a. For each <url> node, replace server:port parameter with the corresponding
servername:portnumber on which the AppWorks Platform instance will be running.
For example: <url>http://<yourMachineName>:<portnumber>/cordys/wcp/cap
content/packages/ com.cordys.web.cap.DownLoadCAP.wcp? capName=Cordys
WS-AppServer.cap</url>
b. Modify the attribute skip to true for the application packages that must not be
loaded.
This step is used only when some packages are already deployed. The following is the
sample of the inputs in the (/captemplates/AppWorks Platform Full Product)
template:
<capcommands timeout="900000">
<cap name="Cordys XMLStore" skip="false">
<DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys XMLStore</url>
</DeployCAP>
</cap>
<cap name="Cordys Security Admin Core" skip="false">
<DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys Security Admin
Core</url>
</DeployCAP>
</cap>
<cap name="Cordys XForms Runtime" skip="false">
<DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys XForms
Runtime</url>
</DeployCAP>
</cap>
</capcommands>

c. Optional: Set the required timeout value in the root node <capcommands> for
installing application packages.

4. From the extracted zip folder, open the cap-silent-install.properties file in a text
editor.

69 Installation Guide for Windows

 Installing AppWorks Platform application packages

5. Modify the following properties according to the configuration of your computer.

Properties Description
cordys.cap.silent.template.inputfile The file path, which contains the
template of the required
application packages to be
configured.
You must provide the AppWorks
Platform Full Product template
path to install all the generated
application packages.
Note: Ensure that there are two
backslashes as path separator in
the file path.
cordys.cap.silent.userinputfile The file path, which contains user
inputs for the packages.
<captemplates>\CAPUserInputfile While installing, you need to
update the Organization and User
related details for the user inputs.
Similarly, add user inputs for any
new components, if required.
Note: Ensure that there are two
backslashes as path separator in
the file path.
cordys.cap.silent.deployment.server The computer on which the
AppWorks Platform baseline
installation is performed.
Add the name of the computer.
cordys.cap.silent.deployment.port The port number of the Web site on
which the AppWorks Platform
baseline installation is performed.
cordys.cap.silent.deployment.failOnError To stop or continue the deployment
of application packages, if any of
the application packages failed to
install or upgrade.
This is an optional property and the
default value is false.

6. Optionally, if you want to configure multiple databases for loading the application
packages, you must do the following:

Installation Guide for Windows 70

Installing AppWorks Platform application packages

a. Modify the multipledso file, as per the inline documentation, to configure the
databases for different application packages. Refer to multipledso.xml for more
information. This step will create the database configurations based on the inputs
provided.
Note: Ensure to remove the datasource configurations which you do not intend to
use.

b. Update the template file (/captemplates/CAPUserInput) based on the inputs

provided in the previous step.
For example, replace the name of the database configuration in
UserInputs/inputItem name xpath tag with DSO_NAME#system for the applications
to be configured with a different database configuration.
<inputItem key="databaseConfig.component.datasource.name">Cordys
System#system</inputItem>

c. Add the following properties to the cap-silent-install.properties file:

l cordys.cap.silent.deployment.Dsocreation.needed=<true or false>
l cordys.cap.silent.deployment.dso.inputs.file = <Location of the
multipledso.xml>

Note: The cordys.cap.silent.deployment.Dsocreation.needed must be set to

true This is an optional property and the default value is false
Note: The cordys.cap.silent.deployment.dso.inputs.file is needed only
when the cordys.cap.silent.deployment.Dsocreation.needed property is set to
true. It refers to the path of the multiple database configuration input file.

7. Set the environment variable CORDYS_HOME pointing to the AppWorks Platform

installation directory.
8. Set PATH=%PATH%;%CORDYS_HOME%/lib
9. Set CLASSPATH=%CLASSPATH%;%CORDYS_HOME%/cordyscp.jar
10. Run the following java command: java -Duser.name=<ldapuser> -cp <AppWorks
Platform_installdir>\cordyscp.jar
com.cordys.cap.tool.silentdeployment.SilentCAPDeployer <Location of cap-
silent-install.properties file>
where, ldapuser is the user created during the AppWorks Platform baseline installation.

The application packages are installed. The status of each application package is displayed in
the command prompt as it is being installed.

71 Installation Guide for Windows

 Appendix B Installing AppWorks Platform on primary-distributed computers through command line

Appendix B
Installing AppWorks Platform on
primary-distributed computers
through command line
AppWorks Platform can be installed using the command line mode on Primary-Distributed
computers. Primary-Distributed installation is the installation process in which there will be a
single OpenText CARS instance and a multiple number of AppWorks Platform instances
distributed over different computers. The first instance that is installed is called the Primary
Instance and the consecutive instances are referred as Secondary or Distributed Instances.

Command line installation on primary-distributed

computers
This topic includes:
n Installing AppWorks Platform on the Primary computer
n Installing AppWorks Platform Baseline on the Distributed computer
n Installing AppWorks Platform Application Packages on the Distributed computer

Installing AppWorks Platform on the primary computer

To install OpenText CARS, Baseline, and Applications on the primary computer, follow the
procedure described in Installing AppWorks Platform on a single instance through command
line on page 66.

Installing AppWorks Platform on the distributed computer

Note: While adding a new instance to an existing setup, ensure that the right version is
used. For instance, if the existing setup has AppWorks Platform 22.3, you must add a new
node of the same version. Occasionally, it might be possible that for a specific version, after
applying certain fix packs, an equivalent full build may not be available to add a new node.
In such scenarios, to add a new node, you must install the last available full build from the

Installation Guide for Windows 72

Installing baseline on a distributed computer

Downloads area and then apply relevant fix packs to make the new instance consistent with
existing setup. This is applicable for all fix pack versions.
For example:

1. The primary instance has a full build (AppWorks Platform 22.3) installed and a fix pack
(Fix Pack 1), that is AppWorks Platform 22.3.
2. On the distributed computer, you must do the following:
n Install the equivalent of the full build in the Downloads area, say AppWorks Platform
22.3 in this case.
n Apply the Fix Pack 1, the applicable fix pack in this case.

If the Downloads area contains a full build version higher than the primary instance version,
follow the procedure described in the next point.
If you are planning to install a higher version on a distributed computer, you must ensure
that the primary computer already has that version installed. If not, you must upgrade the
primary instance to the higher version first and then install this version on the distributed
computer. This is applicable for all the fix pack versions.
Before you begin:
Copy the following folders from the primary computer to the distributed computer(s):
n OpenText CARS certificates folder at <OpenText CARS_installdir>/certificates
n AppWorks Platform certificates folder at <AppWorks Platform_
installdir>/certificates
n wcp.properties file at <AppWorks Platform_installdir>/config/wcp.properties

Installing baseline on a distributed computer

To install baseline on a Distributed Computer:

1. Navigate to the location where the extracted folder of the OpenText AppWorks Platform
22.3.zip file is stored.
2. Open cordys.installer.properties in a text editor. See the inline documentation and
set the values according to the configuration of the computer.
3. Remove the details of the database from the property file in the Distributed computer(s).
4. Run the Command Prompt as Administrator and enter the following command:
OpenText_AppWorks_Platform_22.3.exe -i silent -f
cordys.installer.properties

The baseline installation starts with the data available in the input properties file.
After the baseline installation is complete, continue with application package installation.

73 Installation Guide for Windows

 Installing applications on a distributed computer

Installing applications on a distributed computer

To install applications using the command-line:

1. Ensure that TomEE is running on your computer.

2. Open the application installation template file (/captemplates/AppWorks Platform
Full Product) from the extracted OpenText AppWorks Platform 22.3.zip folder.
3. Modify the following properties according to the configuration of your computer:
a. In each url node, replace server:port parameter with the corresponding
machinename:portnumber on which the AppWorks Platform instance will be running.
For example: <url>http://<yourMachineName>:<portnumber>/cordys/wcp/cap
content/packages/ com.cordys.web.cap.DownLoadCAP.wcp? capName=Cordys
WS-AppServer.cap</url>
b. Modify the attribute skip to true for the application packages that must not be
loaded. This step is used only when some packages are already deployed. The
following is the sample of the inputs in the (/captemplates/AppWorks Platform
Full Product) template:

<capcommands timeout="900000"> <cap name="Cordys XMLStore"

skip="false"> <DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys XMLStore</url>
</DeployCAP> </cap> <cap name="Cordys Security Admin Core"
skip="false"> <DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys Security Admin
Core</url> </DeployCAP> </cap> <cap name="Cordys XForms Runtime"
skip="false"> <DeployCAP xmlns="http://schemas.cordys.com/cap/1.0"
revertOnFailure="true">
<url>http://server:port/cordys/wcp/capcontent/packages/
com.cordys.web.cap.DownLoadCAP.wcp?capName=Cordys XForms
Runtime</url> </DeployCAP> </cap> </capcommands>

c. Optional: Set the required timeout value in the root node <capcommands> for
installing application packages.

4. Set the environment variable CORDYS_HOME pointing to the AppWorks Platform

installation directory.
5. Set PATH=%PATH%;%CORDYS_HOME%/lib
6. Set CLASSPATH=%CLASSPATH%;%CORDYS_HOME%/cordyscp.jar
7. Run the following java command: java -Duser.name=<ldapuser> -cp <AppWorks
Platform_installdir>\cordyscp.jar
com.cordys.cap.tool.silentdeployment.SilentCAPDeployer <Location of cap-

Installation Guide for Windows 74

Installing applications on a distributed computer

silent-install.properties file>
where, ldapuser is the user created during the AppWorks Platform baseline installation.

The application packages are installed. The status of each application package is displayed in
the command prompt as it is being installed.

75 Installation Guide for Windows

 Appendix C Uninstalling AppWorks Platform through command line

Appendix C
Uninstalling AppWorks Platform
through command line
AppWorks Platform can be uninstalled using the command line mode on a single instance
and on primary-distributed instances.
n Uninstalling AppWorks Platform on a single instance on page 76
n Uninstalling AppWorks Platform on primary-distributed computers on page 76

Uninstalling AppWorks Platform on a single

instance
Note: Before you start uninstalling either the applications or the baseline, take a backup of
the database scripts listed in the Dropping database tables on page 78 section.
To uninstall AppWorks Platform using command-line on a single instance:

1. Navigate to <AppWorks Platform_installdir>/silent_properties, open the

cordys.uninstaller.properties file in a text editor.
2. See the inline documentation and set the properties according to the configuration of the
computer.
3. Run the Command Prompt as Administrator and enter the following command:
<AppWorks Platform_installdir>_uninst\"Uninstall OpenText_AppWorks_
Platform_22.3.exe" -i silent -f <Path of cordys.uninstaller.properties
file>

AppWorks Platform is uninstalled.

Uninstalling AppWorks Platform on primary-

distributed computers
To uninstall AppWorks Platform in a Primary-Distributed setup, you must first uninstall
AppWorks Platform on the Distributed computers and then uninstall on the Primary
computer.

Installation Guide for Windows 76

Uninstalling application packages on the distributed computer

Do the following sequentially:

1. Uninstall Application Packages on the Distributed computer.

2. Uninstall Baseline on the Distributed computer.
3. Repeat Step 1 and Step 2 for all the distributed computers in the setup.
4. Uninstall Baseline on the Primary computer.
5. Uninstall OpenText CARS.

Uninstalling application packages on the distributed computer

Before you begin:
n Uninstalling a computer from the AppWorks Platform cluster with a running Collaborative
Workspace (CWS) service container on that computer breaks the remaining
environment. To prevent this, all the CWS service containers on the computer to be
uninstalled must be stopped and deleted before uninstalling that computer from the
cluster.

To uninstall application packages on the distributed computer:

n Uninstall the application packages using the following URL:
http://<computername>:<portnumber>/cordys/com/cordys/cap/install/productu
ninstall.caf?data=organization=o=system,<LDAP root>
where,
l <computername> is the name of the node to be removed
l <portnumber> is the port to access AWP instance on the node
l <LDAP root> is the root of OpenText CARS database. This can be obtained from the
property ldap.root in the wcp.properties file. For example,
cn=cordys,cn=defaultInst,o=lab.opentext.com

Continue with uninstalling baseline in distributed computer.

Uninstalling baseline on the distributed computer

To uninstall the baseline of AppWorks Platform on a distributed computer:

1. Navigate to <AppWorks Platform_installdir> and open the

cordys.uninstaller.properties file.
2. See the inline documentation and set the properties according to the configuration of the
computer.
3. Set DELETE_ENTIRE_OpenText CARS_CONTENT and DROP_TABLES to false.

77 Installation Guide for Windows

 Uninstalling baseline on the primary computer

4. Run the Command Prompt as Administrator and enter the following command:
<AppWorks Platform_installdir>_uninst\"Uninstall OpenText_AppWorks_
Platform_22.3.exe" -i silent -f <Path of
cordys.uninstaller.distributed.properties file>
The AppWorks Platform baseline is uninstalled on the Distributed computer.

5. After uninstalling AppWorks Platform on the Distributed computer, do the following on

the Primary computer:
a. Open the System Resource Manager from the AppWorks Platform start page.
b. Right-click all the LDAP service containers and select Reset.

Repeat the steps for all the Distributed computers.

Uninstalling baseline on the primary computer

Before uninstalling the AppWorks Platform instance on the Primary computer, ensure that it
is uninstalled in all the Distributed computers.
After uninstalling on the Distributed computers, start the uninstallation on the Primary
computer as described in the Uninstalling AppWorks Platform on a single instance on page
76 section.

Uninstalling OpenText CARS

To uninstall OpenText CARS, open Command Prompt as Administrator and run the following
command:
"<Path of OpenText CARS_installdir>_uninst\uninstaller.exe" -i silent

Dropping database tables

You can use this option in any of the following scenarios:
n You uninstalled the applications but left the database tables used by those applications
intact (that is, if you did not select the Drop Database Tables option).
n You do not intend to uninstall the baseline of AppWorks Platform 22.3. However, you
want to remove the tables used by the uninstalled applications that reside in the same
database.
n The baseline and applications are installed on the same database. However, you have
uninstalled the baseline without uninstalling the application, and without dropping the
database (that is, you did not select the Drop Database Tables check box).
n You have installed the baseline on one database and the applications on several different
databases. The uninstallation of the baseline does not remove the tables from other
databases.

Installation Guide for Windows 78

Dropping database tables

Depending on the application and database in use, select and run the appropriate script from
those listed in the table below to drop the database content.

Component Database
Path of the script file Scripts
application vendor
Cordys CoBOC <AppWorks Platform_ n MS SQL n DROP_TABLES_
installdir>\components\ n Oracle MSSQL.sql
coboc\database\dropscripts n DROP_TABLES_
ORACLE.sql

Cordys Business <AppWorks Platform_ n MS SQL n DROP_BPM_

Process Engine installdir>\components\ n Oracle MSSQL.sql
bpmengine\database\dropscripts n DROP_BPM_
ORACLE.sql

Cordys Business <AppWorks Platform_ n MS SQL n BAM_MSSQL_

Activity installdir>\components\ n Oracle DROP.sql
Monitoring bam\database\dropscripts n BAM_ORACLE_
DROP.sql

Cordys Data <AppWorks Platform_ n MS SQL n DROP_TABLES_

Transformation installdir>\components\ n Oracle MSSQL.sql
datamapper \database\dropscripts n DROP_TABLES_
ORACLE.sql

Cordys MDM <AppWorks Platform_ n MS SQL n MDM_

installdir>components\ n Oracle SQLSERVER_
mdm\dbscripts\repository DROP.sql
n MDM_ORACLE_
DROP.sql

Cordys MDM <AppWorks Platform_ n MS SQL n MDM_

installdir>components\ n Oracle SQLSERVER_
mdm\dbscripts\application DROP.sq
n MDM_ORACLE_
DROP.sql

Cordys <AppWorks Platform_ n MS SQL n DROP_TABLES_

Notification installdir>\components\ n Oracle MSSQL.sql
ruleengine\database\dropscripts n DROP_TABLES_
ORACLE.sql

Cordys Scheduler <AppWorks Platform_ n MS SQL n DROP_TABLES_

installdir>\components\ n Oracle MSSQL.sql
scheduler\database\dropscripts

79 Installation Guide for Windows

 Dropping database tables

Component Database
Path of the script file Scripts
application vendor
n DROP_TABLES_
ORACLE.sql

Cordys Tag <AppWorks Platform_ n MS SQL n DROP_

Server installdir>components\ n Oracle TAGSERVER_
tagserver\dbschema\dropscripts MSSQL.sql
n DROP_
TAGSERVER_
ORACLE.sql

Installation Guide for Windows 80

Appendix D Uninstalling AppWorks Platform through a wizard

Appendix D
Uninstalling AppWorks Platform
through a wizard
AppWorks Platform can be uninstalled in the GUI mode (wizard) on a single instance and on
primary-distributed instances as follows:
n Uninstalling AppWorks Platform on a single instance on page 81
n Uninstalling AppWorks Platform on primary-distributed computers on page 81

Uninstalling AppWorks Platform on a single

instance
Note: Before you start uninstalling either the applications or the baseline, take a backup of
the database scripts listed in the Dropping database tables on page 83 section.
To uninstall AppWorks Platform on a single instance:

1. Click Start > All Programs > <AppWorks Platform version> > <instance name>
> Uninstall. The AppWorks Platform uninstaller wizard appears and guides you through
the uninstallation process.
2. Follow the steps specified in the wizard. The uninstaller will uninstall the AppWorks
Platform installation from the computer. If you are uninstalling AppWorks Platform on a
single instance, it is adequate to uninstall only the baseline. The uninstaller uninstalls all
the application packages deployed.

AppWorks Platform is uninstalled.

Uninstalling AppWorks Platform on primary-

distributed computers
To uninstall AppWorks Platform on a primary-distributed setup, you must uninstall
AppWorks Platform on the distributed computers, and then uninstall on the primary
computer.

81 Installation Guide for Windows

 Uninstalling application packages on the distributed computer

To uninstall:

1. Uninstall application packages on the distributed computer.

2. Uninstall baseline on the distributed computer.
3. Repeat Step 1 and Step 2 for all the distributed computers in the setup.
4. Uninstall Baseline on the Primary computer.
5. Uninstall OpenText CARS.

Uninstalling application packages on the distributed computer

Before you begin:
n Uninstalling a computer from theAppWorks Platform cluster with a running Collaborative
Workspace (CWS) service container on that computer breaks the remaining
environment. To prevent this, all the CWS service containers on the computer to be
uninstalled must be stopped and deleted before uninstalling that computer from the
cluster.

To uninstall application packages on the distributed computer:

n Uninstall the application packages using the following URL:
http://<computername>:<portnumber>/cordys/com/cordys/cap/install/productu
ninstall.caf?data=organization=o=system,<LDAP root>
where,
l <computername> is the name of the node to be removed
l <portnumber> is the port to access AWP instance on the node
l <LDAP root> is the root of OpenText CARS database. This can be obtained from the
property ldap.root in the wcp.properties file. For example,
cn=cordys,cn=defaultInst,o=lab.opentext.com

Continue with uninstalling baseline in distributed computer.

Uninstalling baseline on the distributed computer

To uninstall the AppWorks Platform baseline on a distributed computer:

1. Click Start > All Programs > <AppWorks Platform version> > <instance name>
> Uninstall. The AppWorks Platform uninstaller wizard appears and guides you through
the uninstallation process.
2. Click Next.
A prompt is displayed for AppWorks Platform uninstallation.
3. Click Uninstall baseline.

Repeat the uninstalling application packages and uninstalling baseline steps for all the
distributed computers.

Installation Guide for Windows 82

Uninstalling baseline on the primary computer

Note: After uninstalling AppWorks Platform on the distributed computer, do the following
on the primary computer:
n Open the System Resource Manager from the AppWorks Platform start page.
n Right-click all the LDAP service containers and select Reset.

Continue with uninstalling baseline on the primary computer.

Uninstalling baseline on the primary computer

Before uninstalling the AppWorks Platform instance on the primary computer, ensure that it
is uninstalled in all the distributed computers.
After uninstalling on the distributed computers, start the uninstallation on the Primary
computer as described in the Uninstalling AppWorks Platform on a single instance on page
81 section.

Dropping database tables

You can use this option in the following scenarios:
n You uninstalled the applications but retained the database tables used by those
applications unchanged, that is, if you did not select the Drop Database Tables option.
n You do not want to uninstall the baseline of AppWorks Platform 22.3. However, you want
to remove the tables used by the uninstalled applications that reside in the same
database.
n The baseline and applications are installed on the same database. However, you have
uninstalled the baseline without uninstalling the application, and without dropping the
database (that is, you did not select the Drop Database Tables option).
n You have installed the baseline on one database and the applications on several different
databases. The uninstallation of the baseline does not remove the tables from other
databases.

Depending on the application and database in use, select and run the appropriate script from
those listed in the table below to drop the database content.

Component Database
Path of the script file Scripts
application vendor
Cordys CoBOC <AppWorks Platform_ n MS SQL n DROP_
installdir>\components\ TABLES_
n Oracle
coboc\database\dropscripts MSSQL.sql
n DROP_
TABLES_
ORACLE.sql

83 Installation Guide for Windows

 Dropping database tables

Component Database
Path of the script file Scripts
application vendor
Cordys Business <AppWorks Platform_ n MS SQL n DROP_BPM_
Process Engine installdir>\components\ MSSQL.sql
n Oracle
bpmengine\database\dropscripts
n DROP_BPM_
ORACLE.sql

Cordys Business <AppWorks Platform_ n MS SQL n BAM_MSSQL_

Activity installdir>\components\ DROP.sql
n Oracle
Monitoring bam\database\dropscripts
n BAM_ORACLE_
DROP.sql

Cordys Data <AppWorks Platform_ n MS SQL n DROP_

Transformation installdir>\components\ TABLES_
n Oracle
datamapper \database\dropscripts MSSQL.sql
n DROP_
TABLES_
ORACLE.sql

Cordys MDM <AppWorks Platform_ n MS SQL n MDM_

installdir>components\ SQLSERVER_
n Oracle
mdm\dbscripts\repository DROP.sql
n MDM_
ORACLE_
DROP.sql

Cordys MDM <AppWorks Platform_ n MS SQL n MDM_

installdir>components\ SQLSERVER_
n Oracle
mdm\dbscripts\application DROP.sq
n MDM_
ORACLE_
DROP.sql

Cordys <AppWorks Platform_ n MS SQL n DROP_

Notification installdir>\components\ TABLES_
n Oracle
ruleengine\database\dropscripts MSSQL.sql
n DROP_
TABLES_
ORACLE.sql

Cordys <AppWorks Platform_ n MS SQL n DROP_

Scheduler installdir>\components\ TABLES_
n Oracle
scheduler\database\dropscripts MSSQL.sql

Installation Guide for Windows 84

Dropping database tables

Component Database
Path of the script file Scripts
application vendor
n DROP_
TABLES_
ORACLE.sql

Cordys Tag <AppWorks Platform_ n MS SQL n DROP_

Server installdir>components\ TAGSERVER_
n Oracle
tagserver\dbschema\dropscripts MSSQL.sql
n DROP_
TAGSERVER_
ORACLE.sql

85 Installation Guide for Windows

 Appendix E Troubleshooting

Appendix E
Troubleshooting
General troubleshooting
Following are a few questions and answers that can help you troubleshoot problems that
may occur.
What is the general recommended approach for User Management?
Open Text recommends that you use the OTDS for user management. Configure OTDS Push
connectors to synchronize users, groups, and membership to AppWorks Platform. Use the
OTDS Push roles functionality available in Security Administration to synchronize the
functional roles from AppWorks Platform into OTDS. See the 'Configuring OTDS Push
Connector for OpenText CARS and Identity components' topic in the help ( ) accessible
from the shortcut bar on the AppWorks Platform interface and the 'Synchronizing roles from
AppWorks Platform to OTDS' topic in the AppWorks Platform Administration Guide.
What should I do if I get access denied errors?
If the following error occurs:
Access is denied for the Web service operation.
Access is denied for the Web service operation 'GetToDoListItems'.
Access denied on Initiation of Process:'prcCaseManagement' for user 'userid'.
The probable cause is that the user is not assigned the required roles to perform the
operation. Also, the users and roles must be available in AppWorks Platform and OTDS as
required. Verify if the users and roles are synchronized correctly.

Troubleshooting OTDS
This section answers a few questions that can help you troubleshoot some OTDS problems
that might occur.
I have allocated users and groups to my resources, but they don't appear to be in
my application. Why not?
Ensure that the resource is configured correctly to synchronize with the application.
Select the OTDS Activity Feed for any errors when attempting to push updates to your
application.

Installation Guide for Windows 86

Troubleshooting OTDS

Be sure that the users, groups, and user partitions are associated with an access role that is
associated with the resource.
Review the OTDS log directory-access.log for failure messages. If you have an error
Authentication failure [MULTIPLE_IDENTITIES_FOR_USER_NAME], you will have two accounts
in different partitions with the same sign in name as you are using for the resources
synchronization configuration. You will have to remove one of these users.
Review the OTDS log directory-provenance.log for any failure messages that appear
related.
Why don't my roles and role members appear in my application?
If you are seeing users in the application, the resource synchronization appears to be
working. Check that the access role with the associated groups is marked to Include Groups
from Organizational Users.
AppWorks Platform will also interpret a role with a hash character in the group ID as a
AppWorks Platform package role, for example ‘Case Worker#Case Management’, that will
match the role created as a part of a AppWorks Platform solution. Do not use a hash
character in the group ID for other roles being sent to AppWorks Platform.
I have added additional AppWorks Platform solutions with roles, but I do not see
the roles in OTDS, why not?
AppWorks Platform does not dynamically create new roles in OTDS for you. Use the OTDS
Push roles functionality available in Security Administration. For more information, see the
Synchronizing roles from AppWorks Platform to OTDS topic in the AppWorks Platform
Administration Guide.
I have created my custom roles in OTDS as groups, but anyone I have associated
with the group does not appear in AppWorks Platform, what has gone wrong?
Ensure that the resource is configured to synchronize to the application, and that the
configuration is correct.
Review the OTDS Activity Feed for any errors when attempting to push updates to your
application.
Be sure that there are no spelling mistakes in the group in OTDS for the Group ID, and that
the Group ID reflects the package name followed by a period and then the name with no
additional spaces.
I experienced some errors during a resource synchronization operation and now
some users or group membership information may not have reached my
applications, how do I resubmit the changes?
You cannot resubmit the changes themselves, but you can request a consolidate operation
on the user partition, user, or group which will force that object and its components to be
resubmitted to the application for synchronization. It is not recommended to do this
frequently as this may take a long time to complete depending on the size of the user
partition or group.
Note: This does not re-submit any deletion notifications so a user that was removed from
OTDS or your enterprise user store may still exist in the application user store. Because

87 Installation Guide for Windows

 Installing AppWorks Platform on primary-distributed computers

OTDS is performing the authentication requests, even though the user will remain in the
products user store, that user would not be able to get access to the system.
Are the AppWorks Platform User Management Connector or low level LDAP
Connector supported with OTDS?
AppWorks Platform enables applications to create roles through the User Management
Connector as well as the low level LDAP Connector. These Connectors are not adapted to
work with OTDS and the AppWorks Platform User tools are supported when AppWorks
Platform is installed and used without the rest of AppWorks Platform and OTDS for
authentication and user management.
What should I do if I get the following error?
The deployment for 'OpenText Inbox Task Management' has failed. The package
deployment cannot proceed further. Verify the application log file in the 'install_log' folder of
the installation.
n Ensure that the DB JAR is placed in the <TomEE>\lib folder.
n If the DB uses the Windows authentication mode, then you must configure sqljdbc_
auth.dll as mentioned in Configuring for MS SQL on page 27.

Note: If there are multiple versions of database drivers added to PATH or classpath, then
ensure that the required supported version of the DB JAR is used during deployment.
How do I manage my OTDS environment?
Two clients are available to manage your OTDS environment.
n The Administration Client, an MMC based client that is installed on an administrator's
computer and configured to point to OTDS.
n Web Administration Client, introduced in OTDS 10.5 SP1, enables you to maintain your
OTDS environment from a web browser. The Web Administration client is installed as
part of the application.

Installing AppWorks Platform on primary-

distributed computers
Primary-distributed installation is the installation process in which there will be a single
OpenText CARS instance and a multiple number of AppWorks Platform instances distributed
over different computers. The first instance that is installed is called the Primary instance
and the consecutive instances are referred as Secondary or Distributed instances.

Installation on primary-distributed computers

This topic includes:

Installation Guide for Windows 88

Installing AppWorks Platform on the primary computer

n Installing AppWorks Platform on the Primary computer

n Installing AppWorks Platform baseline on the Distributed computer
n Installing AppWorks Platform application packages on the Distributed computer

Installing AppWorks Platform on the primary computer

To install OpenText CARS, baseline, and applications on the primary computer, follow the
instructions provided in Installing AppWorks Platform on page 32

Installing AppWorks Platform on the distributed computer

Note: While adding a new instance to an existing setup, ensure that the right version is
used. For instance, if the existing setup has AppWorks Platform 22.3, you must add a new
node of the same version. Occasionally, it might be possible that for a specific version, after
applying certain fix packs, an equivalent full build may not be available to add a new node.
In such scenarios, to add a new node, you must install the last available full build from the
Downloads area and then apply relevant fix packs to make the new instance consistent with
existing setup. This is applicable for all fix pack versions.
For example:

1. Assume that the primary instance has a full build (AppWorks Platform22.3) installed and
a fix pack (Fix Pack 1), that is AppWorks Platform 22.3
2. On the distributed computer, you must do the following:

n Install the equivalent of the full build from the Downloads area, say AppWorks
Platform22.3 in this case.
n Apply the Fix Pack 1, the applicable fix pack in this case.

If the Downloads area contains a full build version higher than the primary instance version,
you must upgrade the primary instance to the higher version first and then install this
version on the distributed computer. This is applicable for all the fix pack versions.
Before you begin:
n Ensure that the primary installation is started and running.
n Ensure that all the Prerequisites are met.
n Copy the following folders from the primary computer to the distributed computer(s):
l OpenText CARS certificates folder at <OpenText CARS_installdir>/certificates

l AppWorks Platform certificates folder at <AppWorks Platform_

installdir>/certificates
l wcp.properties file at <AppWorks Platform_
installdir>/config/wcp.properties

Note: Specify the path where the files are copied while installing the baseline.

89 Installation Guide for Windows

 Installing baseline on a distributed computer

Installing baseline on a distributed computer

To install baseline on a Distributed Computer:

1. Navigate to the location where the extracted folder of the OpenText_AppWorks_

Platform_22.3.zip file is stored.
2. Double-click OpenText_AppWorks_Platform_22.3.exe. The Baseline installer
wizard opens.

3. In the OpenText CARS Information screen, select OpenText CARS installed on a

different computer option and provide the following details:

4. Open wcp.properties in the <AppWorks Platform_installdir>/config folder of the

primary computer and provide the values in the corresponding fields:

Field Description
OpenText CARS Host Value of bus.ldap.processor.host
Port Number Value of bus.ldap.processor.port
Suffix Value of 'o=' in ldap .root. It refers to the root of
the OpenText CARS database.
OpenText CARS Certificate Path of the folder in the distributed computer where
Path the OpenText CARS certificates are copied.
User Name Value of bus.ldap.processor.user
Password Password of the OpenText CARS host in the primary
computer.

If OpenText CARS is installed in Secured mode, you must select the OpenText CARS is
running under secure mode option.
Note: In a distributed setup, the screens requiring the license and other database
information will not appear.

5. In the Instance Name field on the Installation Information window, ensure to provide the
instance name of the primary installation.

Note: The AppWorks Platform instance name must match in both the computers.
6. In the Location of Primary Installation Folder field, enter the path of the folder in
the distributed computer where the AppWorks Platform certificates and the
wcp.properties file are copied.
7. Follow the default steps in the next screens of the baseline installation wizard. The
baseline installation is completed successfully.

After the baseline installation is complete, the Application Packages installer initiates
automatically and appears in your browser. If it does not appear, type
http://<computername :
portnumber>/cordys/wcp/cap/install?nodeName=<computername> in the address bar of

Installation Guide for Windows 90

Installing application packages on a distributed computer

your browser to start installing application packages. <computername> refers to the

computer on which the installation is done and <portnumber> is the port that has been
specified when installing the TomEE instance.
Note: If you have selected AppWorks Platform Authentication during baseline
installation, you need to provide the same user name and password to proceed with the
application packages loading.

Installing application packages on a distributed computer

To install application packages:

1. Click Next on the application package installer wizard. A Summary screen appears,
displaying the details of each application.
2. Select the Revert on Failure option, if required.
n When this option is selected, if the deployment fails at a certain point, then the
application package that failed will be reverted to its previous state. The subsequent
deployment attempt will proceed from this failed application package.
n When this option is cleared and if an application fails to load, the application will go
into Incomplete state and the subsequent attempt of installation will resume from the
point of failure.

3. Click Deploy. The application packages deployment starts. After deploying all the
applications, a summary page containing list of all the deployed application packages
appears.
4. After deploying all the applications, a summary page containing the list of all the
deployed application packages appears.
5. Click Finish to complete the deployment process. The application packages installation
is complete and the Explorer appears displaying the start page.

91 Installation Guide for Windows

 Appendix F Configuring online help on a Private Help Server

Appendix F
Configuring online help on a Private
Help Server
Providing the online help on a local help server
(Private Help Server)
The online help for this product is delivered using the OpenText Global Help Server (GHS)
system, which provides your users with live access to the latest version of the help. If you
cannot use the GHS system (for example, if your site does not have Internet access), you
can install the OpenText Private Help Server (PHS), a local version of the help system that
can host your OpenText product online help on your organization’s network. After the PHS is
installed, you can then configure your OpenText product(s) to forward all online help
requests to your PHS.
For detailed information about installing the PHS, see OpenText™ Help System - Private
Help Server Administration Guide (OTHS-AGD).
Note:
n The Private Help Server can support multiple OpenText products. If the Private Help
Server has already been installed within your organization to support another OpenText
product, you can add additional OpenText product online helps to that installation.
n If you are replacing a previous PHS installation, see OpenText™ Help System - Private
Help Server Administration Guide (OTHS-AGD).
n If the server you want to use for the PHS installation cannot connect to the Internet, see
OpenText™ Help System - Private Help Server Administration Guide (OTHS-AGD).
n If you want to use Apache TomEE as the web server, while installing PHS for AppWorks
Platform, you can provide TomEE details in sections that require web server details.

After the PHS is installed or upgraded, you can use its Online Help Deployer to download
online helps from the GHS system by entering the deployment code(s) listed in the table
below. For more information about using the codes, see OpenText™ Help System - Private
Help Server Administration Guide (OTHS-AGD).

Installation Guide for Windows 92

Configuring AppWorks Platform to use a local help server (Private Help Server)

Code Product
otags-223- OpenText AppWorks
help Platform documentation

Configuring AppWorks Platform to use a local help

server (Private Help Server)
After you install a PHS and deploy the OpenText AppWorks Platform online help, you must
redirect help requests to it.
To redirect help requests:
After all the guides are deployed, you must configure the PHS URL in AppWorks Platform. If
you have multiple organizations, the following steps must be performed in all the
organizations individually.

1. Open AppWorks Platform explorer and click XML Store Explorer.

2. Navigate to /Cordys/WCP/Desktop/CUSPShortcuts/documentation.
3. For the url node, enter http://<FQDN>:<web server port
number>/OTHelpServer/mapper/
For example:
<url>http://myhelpserver.opentext.net:81/OTHelpServer/mapper</url>
4. Click Save.
5. Refresh the browser.
6. Click the documentation icon in the shortcuts panel of the application.

The landing page of the AppWorks Platform online help opens.

93 Installation Guide for Windows