OpenText Exstream 16.4 - Installation Guide English (CCM160400-IGD-EN-01)
OpenText Exstream 16.4 - Installation Guide English (CCM160400-IGD-EN-01)
OpenText Exstream 16.4 - Installation Guide English (CCM160400-IGD-EN-01)
Installation Guide
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.
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
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Getting started ........................................................................... 5
1.1 Exstream overview ............................................................................ 6
1.2 Installation components ................................................................... 10
1.3 Typical installation steps .................................................................. 11
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.
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
Note that not all Exstream components can be installed with the bootstrap.
This section provides a high-level overview of the Exstream components. The way
your company installs and implements Exstream depends on your business needs.
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.
• 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.
• 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.
External applications
The following external software applications are used for user management and
analytics functions and are installed separately from 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.
• 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
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
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.
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.
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.
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
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.
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.
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>
To download files
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.
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.
6. Follow the prompts to complete the installation. For parameters, see below.
Installation parameters
1. Browse to the folder created when extracting the setup files. For example:
/opt/Exstream/Exstream-<Version>.GA.<Build>
• Communications Server
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.
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.
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.
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.
Related documentation
• The Design Manager component installs Design and Production design
environment on your computer. For Design and Production specific prerequisites
and post-installation steps, see Installing the Design Environment in Installation and
Upgrade Information in Design and Production documentation.
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.
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 directory>\global\security\keystore\private
Installation parameters
• See “Installation parameters and logging options” on page 20.
• See “Optional installation parameters” on page 20.
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.
Installation parameters
Example 3-2: Installing the web applications silently using the MSI file
Prerequisites
Installation parameters
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
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:
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
The following table provides some examples of how you can use command
line switches to perform custom silent installations Design and Production.
• 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, you must manually delete the following folder:
<Installation directory>\Engine_<x_y_z>
Post requisites
• Repositories are not deleted when you remove the components. To delete the
repositories, you can use an external tool.
• 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.
• 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).
• 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.
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.
If you remove an already registered engine, you must open and update
the .exstream file accordingly.
In this section
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.
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.
3. Run the following command to update the .exstream file based on your batch
file:
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
• <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 ...