OpenText Exstream 16.4 - Installation Guide English (CCM160400-IGD-EN-01)

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 34

OpenText™ Exstream

Installation Guide

This guide describes how to install OpenText™ Exstream using


the Exstream Runtime installer and the Exstream Design Tools
installer.

CCM160400-IGD-EN-01
OpenText™ Exstream
Installation Guide
CCM160400-IGD-EN-01
Rev.: 2018-Apr-13
This documentation has been created for software version 16.4.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2018 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

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.
Table of Contents
1 Getting started ........................................................................... 5
1.1 Exstream overview ............................................................................ 6
1.2 Installation components ................................................................... 10
1.3 Typical installation steps .................................................................. 11

2 Installing on Linux ................................................................... 13


2.1 Extracting setup files ....................................................................... 13
2.2 Downloading files ............................................................................ 14
2.3 Installing Runtime (attended install) .................................................. 14
2.4 Installing Runtime (silent install) ....................................................... 15
2.5 Linux installation log files ................................................................. 16

3 Installing on Windows ............................................................. 17


3.1 Installing Runtime (attended install) .................................................. 17
3.2 Installing Design Tools (attended install) ........................................... 18
3.3 Installing Runtime and Design Tools (silent install) ............................ 20
3.3.1 Installing Communications Server silently ......................................... 21
3.3.2 Installing Web Applications silently ................................................... 22
3.3.3 Installing Communications Builder silently ......................................... 22
3.3.4 Installing Control Center silently ....................................................... 23
3.3.5 Installing Design and Production silently ........................................... 24

4 Removing components on Windows ..................................... 27

5 Steps after the installation ...................................................... 29


5.1 Post-installation steps ...................................................................... 29
5.2 Upgrading to Exstream 16.4 ............................................................ 30

6 Installing updates and applying hotfixes .............................. 31


6.1 Registering an Exstream Engine version .......................................... 31

OpenText Exstream – Installation Guide iii


CCM160400-IGD-EN-01
Chapter 1
Getting started

This guide describes how to install OpenText Exstream software using the Exstream
Runtime and Design Tools installers. It includes the following information:
• A high-level overview of the Exstream solution.
• A list of components included in the Runtime and Design Tools installers.
• The typical installation steps for different environments.
• How to install Runtime on Linux®.
• How to install Runtime and Design Tools on Windows®.
• How to remove components on Windows.
• A high-level list of the steps to be performed after the installation.

Important
The Runtime and Design Tools installers are available only on Windows and
Linux. For information about supported software and versions, see OpenText
Exstream 16.4 Release Notes.

For information about how to install Exstream on another operating system,


or install an Exstream component not included in the common installer, see
the installation guide for the specific component.

Related documentation
For component specific prerequisites before running an installer and post-
installation steps after installing a component, see the user documentation for the
component as listed below. The documentation is available at the Exstream product
area on OpenText My Support (https://support.opentext.com).
• Communications Server
• OpenText Exstream - Communications Server Administration Guide (CCMSYS-
AGD)
• OpenText Exstream - Upgrading Projects and Migration Reference Guide (CCM-
DRG)
• Design and Production
The following sections in Design and Production documentation:
• Installation and Upgrade Information
• System Administration
• Empower Server and Editor

OpenText Exstream – Installation Guide 5


CCM160400-IGD-EN-01
Chapter 1 Getting started

• Installing and Upgrading OpenText Exstream Empower Editor

Automated installation and configuration


For information about how to use the bootstrap to install and set up a demonstration
environment for Exstream, see OpenText Exstream - Automated Installation and
Deployment Guide (CCMBSP-IGD).

Note that not all Exstream components can be installed with the bootstrap.

1.1 Exstream overview


OpenText Exstream lets your organization create, manage, and deliver personal,
targeted customer communications.

This section provides a high-level overview of the Exstream components. The way
your company installs and implements Exstream depends on your business needs.

Figure 1-1: Exstream overview

Exstream desktop applications


• Design Manager and Designer

6 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
1.1. Exstream overview

Design Manager and Designer are desktop tools used in Design and Production.
Design Manager lets users manage the design objects that make up an
application, including data files, variables, printers, and production equipment.
Additionally, system administrators can perform administration tasks, such as
managing user and design groups and defining design components. In Design
Manager, application developers compile applications, and configure test and
production runs for delivery to customers.
Designer provides the graphic design interface for the applications. With this
tool, document designers create and format content for pages and messages,
design graphic elements, insert variables to customize documents, and put
together the overall design and layout for customer communications.
• Communications Builder
Communications Builder is the main tool for modelling communication flows. In
Communications Builder, system administrators and document designers define
how Communications Server will produce customer communications.
Communications Builder provides an extensive selection of connectors, filters,
and queues, used to define the collection and delivery of data, and a number of
tools for designing the output. The configurations made in Communications
Builder are stored in Project files.
• StoryTeller
StoryTeller is a design tool that is accessed from within Communications Builder.
StoryTeller is where document designers set up the basic structure and layout of
the templates, which are the basis for the customer communications.
• Control Center
Control Center is a desktop tool used by system administrators to deploy, run,
and administer Exstream applications and repositories. In this tool,
administrators deploy Communications Builder Projects to Communications
Server applications.

Exstream web applications


The Exstream web applications are intended for many different scenarios, such as
campaign and resource management, interactive editing, business content
authoring, and job monitoring. Each web application is available as a standalone
application and can be hosted in an existing business application or as part of a
workflow.
• WorkShop
Workshop provides a graphical interface for managing design resources, such as
image assets, text resources, and templates, which are stored in the common
asset service (CAS).
• Content Author
Content Author lets business users add content to and modify Design and
Production designs by creating and modifying themes based on Design and
Production applications.

OpenText Exstream – Installation Guide 7


CCM160400-IGD-EN-01
Chapter 1 Getting started

• Empower Editor
Empower Editor is a browser-based, controlled editing experience for
personalizing communications based on customer interactions. In Empower
Editor, business users interact with documents created in Design and Production.
These interactions can include making selections from pre-defined options,
changing text and images, updating variable data, adding additional documents
and recipients, previewing the communications, and initiating the fulfillment
process.
• StoryBoard
In StoryBoard, business users can further enhance StoryTeller templates and
personalize communications by adding text, images, and rules. With the device
preview, they can see how communications look in print and email format, and
on different devices.
• ReTouch editor
ReTouch is a lightweight web application that lets business users edit documents
generated from StoryBoard templates.
• Supervisor
Supervisor is a web application that lets system administrators track and manage
jobs and documents as they move through the Exstream repositories and queues
during their lifecycle. The application also provides a basic statistics view where
the administrators can monitor processing statistics.
• Control
Control is a web application that lets users monitor and manage Exstream
applications such as Communications Server and Service Gateway. It gives an
overview of which applications are running, and lets users start and stop
applications as well as deploy Communications Builder Projects to the
Communications Server.

Communications Server layer


Communications Server is a central component of Exstream that connects to
business systems, creates customer communications, and delivers communications
in print or electronic format. Communications Server generates output based on the
Projects configured in Communications Builder.

The following processing engines are available in Communications Server:


• Exstream Engine
Exstream Engine is a high-throughput, multichannel engine used to generate
communications by processing Design and Production applications.
• StoryTeller Engine
Communications Server automatically invokes StoryTeller to generate customer
communications based on configurations made in StoryTeller, StoryBoard, and
ReTouch.

8 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
1.1. Exstream overview

Shared platform services


Communications Server applications and other Exstream applications, such as
service gateways, run on the Exstream framework, which contains a management
gateway and core platform services.

• Management gateway
The management gateway connects the Exstream desktop applications to the
OpenText Directory Services user management component, the common asset
service, and the Exstream repositories.
• Service gateway
The service gateway connects the web applications to the OpenText Directory
Services user management component, the common asset service, and the
Exstream repositories.

Repositories and common asset service


• Common asset service (CAS)
The common asset service (CAS) provides central access to and storage for the
resources used in Exstream solutions. This includes StoryBoard templates and
the text, images, and rules used in these templates, projects from
Communications Builder, and application packages from Design Manager.
• Exstream repositories
Exstream provides the option of using repositories for input and output queues,
tracking jobs, and for other scenarios. The types of repositories used in each
environment will depend on what kind of solutions will be run. All
environments with the Communications Server require repositories to store
information about the environment, central resources used by the applications,
and processing statistics.

External applications
The following external software applications are used for user management and
analytics functions and are installed separately from the Exstream platform:

• OpenText Directory Services


OpenText Directory Services (OTDS), the OpenText identity management
system, provides access control for the Exstream tools and web applications.
OTDS can synchronize with identity providers like Microsoft Active Directory to
retrieve user and group information which is mapped to access roles providing
secure access to each component. OTDS is installed separately from Exstream.
• OpenText™ Experience Analytics
Experience Analytics is used for end-to-end tracking of communications via the
document tracking framework. Experience Analytics is installed separately from
Exstream.

OpenText Exstream – Installation Guide 9


CCM160400-IGD-EN-01
Chapter 1 Getting started

1.2 Installation components


This section provides a list of the components that are installed in the Exstream
platform.

Runtime components
The Exstream Runtime installer includes the server environment for Exstream and
the necessary tools to operate the environment. You can install the runtime
components on Linux or Windows.

Note: Empower Server and Empower Editor are not included in the Runtime
installer. For information about how to install Empower, see Installing and
Upgrading OpenText Exstream Empower Editor.

Content Author is not included in the Runtime installer. For information about
how to install Content Author, see Installation and Upgrade Information in
Design and Production documentation.

The Runtime installer includes the following installation options:

• Communications Server
The Communications Server option includes the following components:

• Communications Server
• Framework, including the management gateway and the core platform
services.
• Exstream Engine
The Exstream Engine option includes the production engine for Design and
Production.
• Web Applications
The Web Applications option includes the following components:

• WorkShop
• Supervisor
• StoryBoard
• ReTouch
• Writer
• Rule Editor
• CAS Browser
• Control

10 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
1.3. Typical installation steps

Design Tools components


The Exstream Design Tools installer includes the tools used to design the customer
communications. You can install the design tools on Windows.

The Design Tools installer includes the following installation options:


• Design Manager
The Design Manager option includes the following components:
• Design Manager
• Designer
• Logic Designer
• Communications Builder
The Communications Builder option includes the following components:
• Communications Builder
• StoryTeller
• TDTransformation
• Windows Driver Tool
• UTF Edit
• Control Center
The Control Center option includes the following components:
• Control Center
• Describer

1.3 Typical installation steps


This section describes the steps you can follow to install Exstream software using the
Exstream Runtime and Design Tools installers.

Steps before the installation


• Confirm that you have the software and hardware required for each Exstream
component you want to install. For information about supported software and
versions, see OpenText Exstream 16.4 Release Notes.
• Download the Runtime and Design Tools installers from the Exstream product
area on OpenText My Support (https://support.opentext.com).

Installation steps
The procedures below describe the high-level installation steps. The order of the
steps may differ in your environment depending on the specific requirements of the

OpenText Exstream – Installation Guide 11


CCM160400-IGD-EN-01
Chapter 1 Getting started

Exstream solution, the Exstream components you will run, the hardware used, and
whether you want to install in different environments, such as development, testing,
and production.

In the steps below, the names of the installation options are used. For information
about the components installed with each option, see “Installation components”
on page 10.

To install Exstream Runtime

1. Install Communications Server on the computers you want to use to run


Communications Server and other types of Exstream applications.
Typically you install Communications Server on several computers, such as
development, testing, and production computers. In production environments,
you may also install and run Communications Server on more than one
computer for scalability and performance reasons.
You can install and run Communications Server on the same computer as other
Exstream components or on a separate computer.
2. Install Exstream Engine on the computers you want to use to process Design
and Production applications.

Important
To enable Communications Server to invoke Exstream Engine, you must
install Communications Server before you install Exstream Engine. You
must then install Exstream Engine on the same computer as
Communications Server.
3. Install Web Applications on a computer from which you can access the
computer that runs the Java Application Server.

To install Exstream Design Tools

1. Install Communications Builder on the computers used to develop and test


Communications Builder Projects.
You can install and run the design tools on the same computer as other Exstream
components or on a separate computer. In production environments, the design
tools are typically installed on other computers than the production computers.
2. Install Design Manager on the computers used to develop and test Design and
Production applications.

Important
To enable Design and Production to connect to the CAS, you must install
Communications Builder before you install the Design Manager
component. You must then install Design Manager on the same
computer as Communications Builder.
3. Install Control Center on the computers used to administer the environment.
You can install and run Control Center on the same computer as other Exstream
components or on a separate computer.

12 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
Chapter 2

Installing on Linux

The Runtime installer on Linux includes the components below. For detailed
information, see “Runtime components” on page 10.

• Communications Server
• Exstream Engine
• Web Applications

Steps to install on Linux

1. Extract the setup files. See “Extracting setup files” on page 13.

2. Run the setup script to install the components. See “Installing Runtime (attended
install)” on page 14.

3. Check the log files. See “Linux installation log files” on page 16.

2.1 Extracting setup files


The setup files are archived in a gzipped file:

Exstream-<Version>.GA.<Build>-<Platform>.tar.gz

Tip: For information about the structure of the Exstream directory, see the
README file in the directory created when extracting the setup files.

To extract the setup files

1. Create a directory for the setup files. For example:


/opt/Exstream

2. Copy the gzipped file to the new directory.

3. From the Exstream directory, extract the gzipped file:

gunzip < Exstream-<Version>.GA.<Build>-<Platform>.tar.gz | tar


xf -

The files are extracted to a new directory in the Exstream directory called
Exstream-<Release_and_build_nr>. For example:

/opt/Exstream/Exstream-<Version>.GA.<Build>

OpenText Exstream – Installation Guide 13


CCM160400-IGD-EN-01
Chapter 2 Installing on Linux

2.2 Downloading files


Prerequisites
• The setup files must be extracted. See “Extracting setup files” on page 13.

To download files

1. Go to the Exstream Product area on OpenText My Support (https://


support.opentext.com).
2. Download the files for the components you want to install to the /Downloads
directory. The directory resides in the directory with the extracted setup files.
For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>/Downloads

2.3 Installing Runtime (attended install)


You can either run a typical install, which installs all components on one machine, or
you can run an advanced install and select the components to install.

You can run the setup script without root privileges.

Prerequisites
• The setup files must be extracted on the machine. See “Extracting setup files”
on page 13.
• A supported Java™ Runtime Environment or Java™ Development Kit must be
installed on the machine where you install Communications Server.
• You must install Communications Server before you install Exstream Engine.
You must then install Exstream Engine on the same machine as Communications
Server.

Related documentation
• For Exstream Engine specific prerequisites and post-installation steps, see
Installing the Production Environment in Installation and Upgrade Information in
Design and Production documentation.

Note: The installer unpacks the Exstream Engine ZIP file and extracts the
engine files for you.

To install Runtime on Linux

1. Browse to the directory created when extracting the setup files. For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>

2. Enter ./setup
3. Read the End User License Agreement text, and then enter q to continue.

14 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
2.4. Installing Runtime (silent install)

4. Accept by entering Yes.

5. Do one of the following:

• Enter 1 to select the Typical install.


• Enter 2 to select the Advanced install, and then enter the numbers for the
options to install.

6. Follow the prompts to complete the installation. For parameters, see below.
Installation parameters

• Location for Communications Server Projects – This directory is used for


the working directories for Exstream applications. When you deploy a
Communications Builder Project to a Communications Server, the Project is
deployed to the working directory.
• Management Gateway Port Range Start – The start of the port range used
by the management gateway. Two ports are used. The first port is used for
communication between the management gateway, the Exstream
applications, Exstream repositories, and OTDS. The second is used for
communication with the management gateway that is made via the REST
API.
• Distributed Notifications Port – The port used by the management gateway
for internal notifications. If you set this to 0, the internal notifications are
switched off.
• Java Environment – JAVA_HOME – The path to the Java Runtime
Environment or Java Development Kit. After you enter the path, the installer
validates the path and the Java version.
• Deployment Directory (Web Applications) – The directory where you want
to deploy the WAR files for the component. You must specify an existing
directory.
A supported Java Application Server and a supported Java Runtime
Environment must be installed on the machine where you will run the web
applications. Depending on the accessibility of the Java Application Server,
you might be able to deploy the web applications directly from the installer.

2.4 Installing Runtime (silent install)


When you run the Linux setup script, a file called .operatorInput is created with
the values you entered during the setup. You can use this file to run the setup again
without being prompted for any values.

To run the setup script using a file

1. Browse to the folder created when extracting the setup files. For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>

OpenText Exstream – Installation Guide 15


CCM160400-IGD-EN-01
Chapter 2 Installing on Linux

2. Run ./setup -file .operatorInput

2.5 Linux installation log files


The following files are created during an installation on Linux:
• setup.log
This is the installation log file. It is created in the directory where you run the
setup.
• systeminfo
A system information XML file is created in the systeminfo directory. OpenText
Customer Support may require this file when you log an incident.
• .setup_environment
This file shows the parameters entered during the installation. Exstream
applications read this file on startup. The file is located in the Exstream
installation directory.

16 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
Chapter 3
Installing on Windows

3.1 Installing Runtime (attended install)


The Runtime installer on Windows includes the components below. For detailed
information, see “Runtime components” on page 10. You can either run a typical
install, which installs all components on one computer, or you can run an advanced
install and select the components to install.

• Communications Server

Note: Communications Server requires third-party software. During the


installation, the installer does a prerequisite check and installs the missing
software automatically.
• Exstream Engine
• Web Applications
The Web application ARchive (WAR) files are installed in the directory below.
After the installation, you must deploy the WAR files to a supported Java
Application Server.
<Installation directory>\<Version>\Server\solutions\management\web

Prerequisites
• To install or remove software on Windows, you must have administrator rights.
• Before you install Communications Server, you must close all web browsers and
stop any Java Application Servers running on the computer.
• You must install Communications Server before you install Exstream Engine.
You must then install Exstream Engine on the same computer as
Communications Server.

Note: If you run a typical install, the components are automatically


installed in the correct order.

Related documentation
• For Exstream Engine specific prerequisites and post-installation steps, see
Installing the Production Environment in Installation and Upgrade Information in
Design and Production documentation.

To install Runtime on Windows

1. Double-click the ExstreamSetup.exe file.

OpenText Exstream – Installation Guide 17


CCM160400-IGD-EN-01
Chapter 3 Installing on Windows

2. Do one of the following, and then click Next:

• Click Typical Install.


• Click Advanced Install.
3. Follow the installer wizard, which guides you through the installation. For
installation options, see below.

Installation options
• Destination Folder – The installation folder for the Communications Server,
Exstream Engine, and Web Applications program files.
• Management Gateway - Location of base directory – This directory contains the
working directories for Exstream applications. When you deploy a
Communications Builder Project in Control Center, the Project is deployed to the
working directory.

3.2 Installing Design Tools (attended install)


The Design Tools installer includes the components below. For detailed information,
see “Design Tools components” on page 11. You can either run a typical install,
which installs all components on one computer, or you can run an advanced install
and select the components to install.
• Design Manager
• Communications Builder
• Control Center

Note: Communications Builder and Control Center require third-party


software. During the installation, the installer does a prerequisite check and
installs the missing software automatically.

Prerequisites
• To install or remove software on Windows, you must have administrator rights.
• Windows® Internet Explorer® must be installed on the computer where you
install Communications Builder.
• You must install Communications Builder before you install the Design Manager
component. You must then install Design Manager on the same computer as
Communications Builder.

Note: If you run a typical install, the components are automatically


installed in the correct order.

Related documentation
• The Design Manager component installs Design and Production design
environment on your computer. For Design and Production specific prerequisites

18 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
3.2. Installing Design Tools (attended install)

and post-installation steps, see Installing the Design Environment in Installation and
Upgrade Information in Design and Production documentation.

To install Design Tools on Windows

1. Double-click the ExstreamSetup.exe file.

2. Do one of the following, and then click Next:

• Click Typical Install.


• Click Advanced Install.

3. Follow the installer wizard, which guides you through the installation. For
installation options, see below.

Installation options
• Destination Folder – The installation folder for the Design Manager,
Communications Builder, and Control Center program files.

OpenText Exstream – Installation Guide 19


CCM160400-IGD-EN-01
Chapter 3 Installing on Windows

3.3 Installing Runtime and Design Tools (silent


install)
This section describes how to install the following components silently:
• Communications Server
• Web Applications
• Communications Builder
• Control Center
• Design and Production

Installation files
For silent installations on Windows, the installer directory includes both a setup.
exe and an MSI file for each component. The setup.exe file installs the
prerequisites automatically. If you want to run the silent installation on several
computers at the same time, you must use the MSI file and install the prerequisites
manually before you begin.

Installation parameters and logging options


When making a silent installation, you can use Msiexec command line options to
specify the installation and logging options. For more information about the Msiexec
options, see the documentation available on http://technet.microsoft.com (http://
technet.microsoft.com/en-us/library/aa991542.aspx)

Optional installation parameters


Optional installation parameters – All components
• INSTALLDIR
The installation directory for the component. The default directories are listed
below.
• Communications Server:
C:\Program Files\OpenText\Exstream\<Version>\Server
• Web Applications:
C:\Program Files\OpenText\Exstream\<Version>\Server\solutions
• Communications Builder and Control Center:
C:\Program Files\OpenText\Exstream\<Version>
• Design and Production:
C:\Program Files\OpenText\Exstream <Version>
• REBOOT

20 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
3.3. Installing Runtime and Design Tools (silent install)

Use ReallySuppress to prevent the computer from restarting after the


installation. If you do not use this parameter it defaults to whatever the installer
requires. For example, if the installer updates files that are locked the computer
will restart, otherwise the computer will not restart.

Optional installation parameters – Additional parameters for Communications


Server
• CAPPDIR
The management gateway base directory, which will contain the working
directories for Communications Server, service gateway, and task scheduler
applications. When you deploy a Communications Builder Project in Control
Center, the Project is deployed to the working directory.
• FILEPRIVATEKEY
The path for the certificate for the management gateway. The installer includes a
demonstration certificate demo.pfx, which is installed in the following directory:

<Installation directory>\global\security\keystore\private

3.3.1 Installing Communications Server silently


You install Communications Server silently by using either of the two files below,
which are located in the setup directory under \Software\Server
• OpenText Exstream Communications Server <Version>.msi
• setup.exe

Prerequisites and requirements


• Microsoft® Visual C++® 2013 Redistributable Package (64-bit)
• Microsoft Visual C++ 2017 Redistributable Package (64-bit)
• Microsoft .NET Framework 4.6.1 Extended
• Java Standard Edition Version 8 Update 144 (64-bit)
• Before you install Communications Server, you must close all web browsers and
stop any Java Application Servers running on the computer.

Installation parameters
• See “Installation parameters and logging options” on page 20.
• See “Optional installation parameters” on page 20.

Example 3-1: Installing Communications Server silently

This example installs Communications Server using the default options. The
installation may take several minutes. The log for the installation is found
under c:\<Version>\service_framework.log.

OpenText Exstream – Installation Guide 21


CCM160400-IGD-EN-01
Chapter 3 Installing on Windows

start "" /wait "setup.exe" /s /v" /qn /Liwrmo!vucape c:


\<Version>\service_framework.log"

3.3.2 Installing Web Applications silently


You install the web applications silently by using either of the two files below, which
are located in the setup directory under Software\Web

• OpenText Exstream Web <Version>.msi


• setup.exe

Installation parameters

• See “Installation parameters and logging options” on page 20.


• See “Optional installation parameters” on page 20.

Example 3-2: Installing the web applications silently using the MSI file

This example installs the web applications in the default installation


directory.

start "" /wait msiexec /package "OpenText Exstream Web


<Version>.msi" /qn /Liwrmovucape web.log REBOOT=ReallySuppress

3.3.3 Installing Communications Builder silently


You install Communications Builder silently by using either of the two files below,
which are located in the setup directory under Software\Builder

• OpenText Exstream Communications Builder <Version>.msi


• setup.exe

Prerequisites

• Microsoft Visual C++ 2013 Redistributable Package (64-bit)


• Microsoft Visual C++ 2017 Redistributable Package (64-bit)
• Microsoft .NET Framework 4.6.1 Extended

Installation parameters

• See “Installation parameters and logging options” on page 20.


• See “Optional installation parameters” on page 20.

22 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
3.3. Installing Runtime and Design Tools (silent install)

Example 3-3: Installing Communications Builder silently using the MSI


file

This example installs Communications Builder in the default installation


directory.

start "" /wait msiexec /package "OpenText Exstream Communications


Builder <Version>.msi" /qn /Liwrmovucape builder.log
REBOOT=ReallySuppress

3.3.4 Installing Control Center silently


You install Control Center silently by using either of the two files below, which are
located in the setup directory under Software\ControlCenter
• OpenText Exstream Control Center <Version>.msi
• setup.exe

Prerequisites
• Microsoft Visual C++ 2013 Redistributable Package (64-bit)
• Microsoft Visual C++ 2017 Redistributable Package (64-bit)
• Microsoft .NET Framework 4.6.1 Extended
• Java Standard Edition Version 8 Update 144 (64-bit)

Installation parameters
• See “Installation parameters and logging options” on page 20.
• See “Optional installation parameters” on page 20.

Example 3-4: Installing Control Center silently using the MSI file

This example installs Control Center in the default installation directory.

start "" /wait msiexec /package "OpenText Exstream Control Center


<Version>.msi" /qn /Liwrmovucape controlcenter.log
REBOOT=ReallySuppress

OpenText Exstream – Installation Guide 23


CCM160400-IGD-EN-01
Chapter 3 Installing on Windows

3.3.5 Installing Design and Production silently


You can install Design and Production silently by using either of the two files below,
which are located in the setup directory under Software\DesignManager
• OpenTextExstream_setup_x64_<Version>.exe
• setup.exe

Prerequisites
• 10GB free disk space (minimum 800MB) and 4GB RAM (minimum 2GB)
You must have enough disk space to handle all production files that you use in
design and test applications. The actual space required depends on the size of the
files that are used.
• Minimum screen resolution of 1366x768
A resolution of 1920x1080 works best with Design and Production add-ins.
• Microsoft Visual C++ 2017 Redistributable Package (64-bit)
• Microsoft .NET Framework 4.6.1 or later
• Java Runtime Environment (JRE) version 1.4.2 or later

Installation parameters

When you use the silent installation method to install the design environment for
Design and Production, you use Microsoft and InstallShield standard command line
switches to initiate the installation process. Additionally, Design and Production
includes optional command line switches that you can use to specify installation-
specific options. Use the /v command line switch to pass the command line switches
or arguments to the installer executable. If you use the silent installation method to
repair an existing installation of , you must use the REINSTALL and REINSTALLMODE
Microsoft command line switches and the appropriate arguments to define the
actions that the installer performs.
• INSTALL_TYPE
The INSTALL_TYPE command line switch is an optional switch that lets you
specify a value for the type of installation that you want to use. By default, if you
do not specify the INSTALL_TYPE command line switch, then the installer
replaces the current version of if one exists. You must specify one of the
following arguments for the switch:
• Use PRESERVE_VERSION to preserve your existing version of Design and
Production and install the newer version of Design and Production to a
separate installation directory.
• Use REPLACE_VERSION to replace your existing version of Design and
Production with the newer version.

For example:

24 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
3.3. Installing Runtime and Design Tools (silent install)

INSTALL_TYPE=PRESERVE_VERSION
• INSTALLDIR
The INSTALLDIR command line switch is an optional switch that lets you specify
the installation directory that you want to use. The value for this switch is the file
path of the directory. For example:
INSTALLDIR=\"C:\Exstream\"
By default, if you do not specify the INSTALLDIR command line switch, then the
installer uses the following installation folder:
C:\Program Files\OpenText\Exstream\Exstream <version>
• START_MENU
The START_MENU command line switch is an optional switch that lets you specify
the name of the Start Menu folder that you want to use. The value for this switch
is the name of the Start Menu folder. Start Menu folder names that contain spaces
must be enclosed in quotation marks. For example:
START_MENU=\"OpenText Exstream"
If the Start Menu folder name that you specify does not contain spaces, then you
do not have to enclose the folder name in quotation marks. For example:
START_MENU=AStartMenuFolder\OpenTextExstream\production\
By default, if you do not specify the START_MENU command line switch, then the
installer uses the following folder:
OpenText Exstream <version>

Related documentation

To learn more about working with command line switches, see the following
resources:
• Microsoft website for information about the REINSTALL and
REINSTALLMODE Microsoft command line switches and Microsoft standard
command line switches
• Flexera Software website for information about InstallShield standard command
line switches

Example 3-5: Installing Design and Production silently

The following table provides some examples of how you can use command
line switches to perform custom silent installations Design and Production.

OpenText Exstream – Installation Guide 25


CCM160400-IGD-EN-01
Chapter 3 Installing on Windows

Table 3-1: Custom silent installation examples

To Use these command line arguments


• Install the English language version OpenTextExstream_setup_x64_<ve
of Design and Production rsion>.exe /s /L1033 /v "/qn
• Write the installation log to a user- \" /l C:\install_log.txt
specified directory
• Install the English language version OpenTextExstream_setup_x64_<ve
of Design and Production rsion>.exe /L1033 /s /v "/qn
• Specify a Start Menu folder with a START_MENU=AStartMenuFolder\
folder name that does not contain OpenTextExstream<version>
spaces \production\ /l C:
\install_log.txt"
• Write the installation log to a user-
specified directory
• Install the English language version OpenTextExstream_setup_x64_<ve
of Design and Production rsion>.exe /s /L1033 /v "/qn
• Keep currently installed versions of INSTALL_TYPE=PRESERVE_VERSION
the software INSTALLDIR=\"C:\Program Files
\OpenText\Exstream
• Place a new version of the software in
\Exstream <version>\" /l C:
a user-specified directory
\install_log.txt"
• Write the installation log file to a
user-specified directory

26 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
Chapter 4
Removing components on Windows

This section describes how to remove the following components:

• Exstream Engine
• Web Applications
• Communications Server
• Design Manager
• Communications Builder

Note: Communications Builder Projects are not deleted when you remove
Communications Builder.
• Control Center

Prerequisites
• To install or remove software on Windows, you must have administrator rights.
• You must remove Exstream Engine before you remove Communications Server.
• You must remove Design Manager before you remove Communications Builder.
• Windows services for Communications Server, service gateway, and task
scheduler applications are not deleted when you remove Communications
Server. To remove the services, you can delete the corresponding applications in
Control Center before removing Control Center.

To remove Exstream Engine

• To remove Exstream Engine, you must manually delete the following folder:
<Installation directory>\Engine_<x_y_z>

To remove components using Windows Control Panel

1. From Windows Control Panel, open Programs and Features.

2. Right-click component to remove, and then select Uninstall.

3. Repeat for the other components.

Post requisites
• Repositories are not deleted when you remove the components. To delete the
repositories, you can use an external tool.

OpenText Exstream – Installation Guide 27


CCM160400-IGD-EN-01
Chapter 4 Removing components on Windows

• Deployed web applications are not deleted when you remove Web Applications.
To remove deployed web applications, you must delete the WAR files and the
exploded folders from the portal root.

28 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
Chapter 5

Steps after the installation

5.1 Post-installation steps


Before using an installed component, you have to do some configurations and
preparations.

Steps for Communications Server


After installing Communications Server, Communications Builder, and Control
Center, you must make the following preparations:

• Set up the environment for Communications Server. For example, set up OTDS
for the components, prepare the database, configure the management gateway
and create a multi-tenant repository, add a tenant and set up a tenant repository,
etc. For more information, see Part I “Getting started” in OpenText Exstream -
Communications Server Administration Guide (CCMSYS-AGD).
• Unlicensed Communications Server applications run in demo mode by default.
For information about how to license your Communications Server applications,
see Section 9 “Managing license files” in OpenText Exstream - Communications
Server Administration Guide (CCMSYS-AGD).
• If your installation includes Web Applications, you must prepare for running the
web applications. For example, deploy the web applications to the Java
Application Server (if this is not done from the installer). For more information,
see Part V “Administering web applications” in OpenText Exstream -
Communications Server Administration Guide (CCMSYS-AGD).

Steps for Design and Production


After installing Design Manager and Exstream Engine, you must make the following
preparations:

• Set up a design database. For more information see Installation and Upgrade
Information in Design and Production documentation.
• Configure the environment for Design and Production. For more information,
see System Administration in Design and Production documentation.

Steps for Empower


• For information about how to proceed after installing Empower Editor and
Empower Server, see Installing and Upgrading OpenText Exstream Empower Editor.

OpenText Exstream – Installation Guide 29


CCM160400-IGD-EN-01
Chapter 5 Steps after the installation

5.2 Upgrading to Exstream 16.4


• For information about upgrading from an earlier version of Design and
Production, see Installation and Upgrade Information in Design and Production
documentation.
• For information about upgrading Projects from StreamServe 5.6.2, OpenText
Communications Center Enterprise 16.0, or an earlier vesion of Exstream, see
OpenText Exstream - Upgrading Projects and Migration Reference Guide (CCM-DRG).

30 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
Chapter 6

Installing updates and applying hotfixes

The procedures for installing an update and upgrading the environment accordingly
depend on the components being installed.

• Communications Server
For Communications Server, you install an update using a separate Hotfix Setup.
The Setup replaces the files in the Exstream installation folder and in the
management gateway base directory. If the update includes any database
changes, you must manually apply the update to your Exstream repositories. If
the update includes changes to the web applications, you must replace the WAR
files on the Java application server.
For detailed information, see Part VII “Installing and applying hotfixes” in
OpenText Exstream - Communications Server Administration Guide (CCMSYS-AGD).
• Design and Production
For Design and Production, you install the update using the Runtime and Design
Tools installers. Depending on whether you want to replace the current versions
or install new versions, you can either run the installers or update the
environments from the \Software folders in the setup directories.
For detailed information about updating Design and Production and any
upgrade considerations for the current version, see Installation and Upgrade
Information in Design and Production documentation.
If you install a new version of Exstream Engine without running the Runtime
installer, you must manually register the new version to enable Communications
Server to invoke the engine. For more information, see “Registering an Exstream
Engine version” on page 31.

6.1 Registering an Exstream Engine version


If you install a new version of Exstream Engine outside of the Runtime installer, you
must manually register the new version to enable Communications Server to invoke
the engine. When registering the new version, the engine is added to a .exstream
file and is then available as an engine startup parameter in Control Center.

If you remove an already registered engine, you must open and update
the .exstream file accordingly.

In this section

• “Registering an Exstream Engine on Linux” on page 32


• “Registering an Exstream Engine on Windows” on page 32

OpenText Exstream – Installation Guide 31


CCM160400-IGD-EN-01
Chapter 6 Installing updates and applying hotfixes

Registering an Exstream Engine on Linux


On Linux, you download the ZIP file for the new Exstream Engine, and then you re-
run the Runtime installer to register the new version. When re-running the installer,
a start script for the new engine is also created.

To register an Exstream Engine on Linux

1. Download the ZIP file for the new Exstream Engine to the ExstreamEngine
folder. For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>/ExstreamEngine

2. Browse to the directory created when extracting the setup files. For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>

3. Enter ./setup

4. Read the End User License Agreement text, and then enter q to continue.

5. Accept by entering Yes.

6. Enter 2 to select the Advanced install.

7. Select the option to install Exstream Engine.

8. Follow the prompts to complete the installation.

9. Open the following directory and verify that the .exstream file is present and
updated:
<Root>/.installed_software/.applications/.exstream
Where <Root> is the path to the root directory in the Communications Server
Projects directory.

Registering an Exstream Engine on Windows


On Windows, you register a new Exstream Engine by running a command line
utility together with a batch file containing information about the new version.

To register an Exstream Engine on Windows

1. Prepare an installed_software_exstream.txt batch file. For syntax, see


below.

2. Open a command prompt and navigate to the following directory:


<Communications Server_Installation_Directory>\Server\bin
For example, C:\Program Files\OpenText\Exstream\<version>\Server\
bin

3. Run the following command to update the .exstream file based on your batch
file:

32 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01
6.1. Registering an Exstream Engine version

ss_storage -standalone -batch <Path_to_batchfile>


\installed_software_exstream.txt -log <Path_to_logfile>
\ss_storage.log

Note: The ss_storage.log file does not have to exist before you run the
command.
4. Open the ss_storage.log file and verify that the file ends with the following:
Executing batch succeeded

5. Open the following directory and verify that the .exstream file is present and
updated:
<MGW_root>\.installed_software\.applications\.exstream
For example, C:\ManagementGateway\<version>\root
\.installed_software\.applications\.exstream

Syntax of installed_software_exstream.txt

create:"<MGW_root>/.installed_software/.applications/.exstream":E
ngine_<Version>.<Build>:8
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:<Version>:1
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:<Exstream_Installation_directory>/
Engine_<x_y_z>/ProdEngine_dbcs.exe:2
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>: :3
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:STRSEE:4
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:Exstream Engine <Version>.<Build>:5
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:<Version>:6
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:<Version>:7
set:"<MGW_root>/.installed_software/.applications/.exstream":Engi
ne_<Version>.<Build>:MULTIPLE:8

Where:
• <MGW_root> is the path to the root directory in the management gateway
base directory.
For example, C:/ManagementGateway/<version>/root
• <Exstream_Installation_directory> is the production folder where you
have extracted the Exstream Engine files. For example, C::/Program Files/
OpenText/Exstream

Note: You must use double colons (::) in the path.

• Engine_<x_y_z> is the version number of the Exstream Engine. For example,


Engine_16_4_0

OpenText Exstream – Installation Guide 33


CCM160400-IGD-EN-01
Chapter 6 Installing updates and applying hotfixes

• <Version> is the version number for Design and Production. For example,
16.4.0
• <Build> is the build number for Design and Production. For example,
179327

Tip: You can find out the build number by opening Design Manager or
Designer and then clicking Help > About ...

34 OpenText Exstream – Installation Guide


CCM160400-IGD-EN-01

You might also like