OpenText™ StreamServe 5.6.2 Installation Guide Rev D OpenText™ StreamServe 5.6.2 Installation Guide Rev D 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 © 2017 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. 3 Contents Introduction ..................................................................................................................5 StreamServe components ........................................................................................... 7 Components for StreamServer applications ....................................................................... 8 Components for StreamStudio web applications.............................................................. 10 StreamServe design and administration tools .................................................................. 12 Before the installation................................................................................................ 13 Hardware planning............................................................................................................ 14 Database requirements for StreamServe repositories...................................................... 16 Database configuration for Microsoft SQL Server.................................................... 16 Database configuration for Oracle Database ........................................................... 17 Managing license files ...................................................................................................... 18 Typical installation steps........................................................................................... 19 Installing on a computer used for development and testing ............................................. 20 Required steps ......................................................................................................... 20 StreamStudio steps.................................................................................................. 21 Steps after the installation........................................................................................ 21 Installing in a production environment .............................................................................. 23 Installation steps ...................................................................................................... 24 After the installation.................................................................................................. 25 Example - A typical StreamServe installation ................................................................... 29 Installing Framework and StreamServer on Windows ........................................... 35 Using the Setup wizard to install Framework and StreamServer ..................................... 36 Installing Control Center ........................................................................................... 37 Installing Design Center ............................................................................................ 39 Installing StreamStudio on Windows ....................................................................... 41 Using the Setup wizard to install StreamStudio................................................................ 43 Deploying the web applications ........................................................................................ 44 Installing Database Administration Tool.................................................................. 45 Installing Windows components silently ................................................................. 47 Installing Framework and StreamServer silently .............................................................. 48 Installation options for Framework and StreamServer ............................................. 48 Examples – Installing Framework and StreamServer silently .................................. 50 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 4 Installing Control Center silently ....................................................................................... 51 Installing Design Center silently........................................................................................ 52 Installing StreamStudio silently......................................................................................... 53 Installing Framework and StreamServer on UNIX................................................... 55 Extracting the StreamServe setup files............................................................................. 56 Running the script to install Framework and StreamServer ............................................. 57 Installing StreamStudio on UNIX .............................................................................. 59 Running the setup script to install StreamStudio .............................................................. 60 Deploying the web applications ........................................................................................ 61 Installing OpenDS ...................................................................................................... 63 Installing StreamServe Port Monitor and Print Processor .................................... 65 Installing Print Processor and Port Monitor ...................................................................... 66 Creating a printer for Port Monitor .................................................................................... 67 StreamServer applications and AS/400 environments ..................................................... 70 Removing StreamServe Windows components...................................................... 71 Running parallel StreamServe versions .................................................................. 73 Installing StreamServe 5.6.2 in parallel with previous versions........................................ 74 Installing and applying StreamServe hotfixes......................................................... 75 About StreamServe hotfixes ............................................................................................. 76 Installing a StreamServe hotfix ......................................................................................... 77 Keeping customizations ........................................................................................... 77 Preparing an encrypted environment ....................................................................... 77 Installing a StreamServe hotfix on Windows............................................................ 78 Installing a StreamServe hotfix on UNIX.................................................................. 78 Applying the hotfix to StreamServe repositories............................................................... 79 Applying the hotfix in Control Center........................................................................ 79 Listing schema versions and applied database hotfixes .................................. 80 Applying the hotfix to a repository in Control Center ........................................ 80 Applying the hotfix without Control Center ............................................................... 81 Applying the hotfix to a repository without Control Center................................ 82 Applying the hotfix manually (DBAT not available) .................................................. 84 Applying a hotfix to a repository manually ........................................................ 85 Applying the hotfix to StreamServe web applications....................................................... 86 Files and folders....................................................................................................... 87 Keeping customized files ......................................................................................... 89 Redeploying web applications in Control Center ..................................................... 89 Appendix A - Preserved files on Windows........................................................................ 91 Preserved files in the base directory ........................................................................ 91 Preserved files in the installation directory............................................................... 91 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 5 Introduction This guide describes how to install OpenText StreamServe software. It includes the following information: • Components of StreamServe software. • Steps that are required before you begin a StreamServe installation. • Steps to install StreamServe on a computer that is used for testing and development purposes, and steps to install StreamServe in a production environment. • How to install StreamServe components in a Windows® environment. • How to install StreamServe components in a UNIX environment. • How to remove StreamServe components in a Windows environment. • How to install a StreamServe hotfix. Related documents The following documents are available on OpenText Knowledge Center: • OpenText StreamServe Supported Platforms and Software Reference Guide • OpenText StreamServe Hardware Guidelines for StreamServer applications Reference Guide • OpenText StreamServe <Database Vendor> Database Guidelines • OpenText StreamServe Upgrading Instructions OpenText™ StreamServe 5.6.2 Installation Guide Rev D 6 Installing StreamServe software OpenText™ StreamServe 5.6.2 Installation Guide Rev D 7 StreamServe components This section describes the main components you need to run StreamServe software. In this section • Components for StreamServer applications on page 8 • Components for StreamStudio web applications on page 10 • StreamServe design and administration tools on page 12 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 8 Components for StreamServer applications StreamServe components Components for StreamServer applications A StreamServe installation that is used to run OpenText StreamServe StreamServer applications includes the following main parts: • StreamServer • Framework and management gateway • StreamServe Enterprise Repository • Application domain • Runtime repository This section gives a brief overview of what each component is used for and how you install or configure the component. For more detailed descriptions of these components, see Components to run StreamServer applications in the Control Center documentation. Figure 1 Components for running StreamServer applications StreamServer This includes the software to run StreamServer applications. StreamServer can be installed and run on Windows or UNIX using the Framework and StreamServer Setup. Framework and management gateway The Framework includes a management gateway and the underlying software to run StreamServe applications, such as, service gateways, Archiver applications, and task scheduler applications. The management gateway performs the following activities: • Manages and monitors the StreamServe applications on the computer • Connects the computer to a StreamServe Enterprise Repository • Handles the communication between Control Center and the StreamServe applications The management gateway Windows services are called: • StreamServe Management Gateway <version> • StreamServe Management Nanny <version> On Windows, the management gateway services use the local administrator account. These services require local administrator access to create and remove other Windows services. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Components for StreamServer applications StreamServe components The management gateway UNIX processes are called: • ManagementGateway • ManagementNanny The framework and management gateway are part of the Framework and StreamServer Setup. To manage the StreamServe applications on a computer, each user needs a login to the management gateway. A Management Gateway Administrator with the user name Administrator is included with the Framework and StreamServer Setup, this user is assigned the administrator role. For information about setting up management gateway users, see Managing users in the Control Center documentation. StreamServe Enterprise Repository This database is used for deployment information, such as: • StreamServe applications at one company or organization • Application domains at the company or organization • Computers used to run these applications • Master document types used by the company or organization In distributed environments, you should have one central enterprise repository at your company or organization. After the installation, you use Control Center to create the enterprise repository or the Command Line Utilities to generate the scripts to create the repository. The default name for enterprise repository is StrsSER. Application domain Depending on what you want to achieve in terms of document storage and access, you organize StreamServe applications in application domains. All applications in one application domain share the same repositories, connection profiles, document types, and channels for reprocess and preview. You configure application domains using Control Center or the Command Line Utilities. Runtime repository This database is used to store job and document data for the StreamServe applications in one application domain. After the installation, you use either Control Center or the Command Line Utilities to generate the scripts for the runtime repository. The default name for the runtime repository is StrsData. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 9 10 Components for StreamStudio web applications StreamServe components Components for StreamStudio web applications In addition to the StreamServer components, you use the following components to run OpenText StreamStudio web applications: • StreamStudio web portal • Service gateway • Collector archive (optional) • Web content repository (optional) • User directories This section gives a brief overview of what each component is used for and how you install or configure the component. For more detailed descriptions of these components, see Components to run StreamStudio web applications in the Control Center documentation. Figure 2 StreamStudio components StreamStudio This is the web portal containing the StreamStudio web applications. The StreamStudio web portal can be installed and run on Windows or UNIX using the StreamStudio Setup. To run StreamStudio you need a Java application server, for example Apache Tomcat. See the Supported platforms and software documentation for a list of the supported Java application servers. Service gateway This is a web service gateway that connects the StreamStudio web applications to the runtime repository and user directories. The service gateway is installed with Framework and StreamServer on both Windows and UNIX. The service gateway Windows service is called StreamServe Service Gateway. The service gateway UNIX process is called ServiceGateway. User directories The user directories contain the user profiles for the StreamStudio web applications. The user directories can be connected to an existing directory server that supports the LDAP protocol. See the Supported platforms and software documentation, for a list of the supported user directories. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Components for StreamStudio web applications StreamServe components You configure the connections to the user directories using Control Center or the Command Line Utilities. Collector archive This database stores output documents and related metadata used for the StreamStudio Collector web application. The default name for the Collector archive is StrsCollector. You use Control Center or the Command Line Utilities to generate the scripts used to create the Collector archive. Web content repository This database stores Composition Center resources and roles during the document design phase. The default name for the web content repository is StrsWeb. You use Control Center or the Command Line Utilities to create the web content repository. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 11 12 StreamServe design and administration tools StreamServe components StreamServe design and administration tools The following main tools are used to design StreamServe Projects and administer StreamServe applications. OpenText StreamServe Design Center System integrators and StreamServe developers use Design Center to build StreamServe Projects. Design Center is available on various editions of Windows. You can deploy Projects built in Design Center to StreamServer applications both Windows and UNIX hosts. You use the Design Center Setup to install Design Center. You can install Design Center on a computer that runs other StreamServe components, such as Framework and StreamServer. You can also install Design Center on a computer that does not run any other StreamServe components. OpenText StreamServe Control Center System administrators use Control Center to deploy, run, and administer StreamServer applications and other types of StreamServe applications. Control Center is available on various editions of Windows. You can use Control Center to run and administer StreamServe applications on both Windows and UNIX hosts. You use the Control Center Setup to install Control Center. You can install Control Center on a computer that runs other StreamServe components, such as Framework and StreamServer. You can also install Control Center on a computer that does not run any other StreamServe components. After the installation, you must connect Control Center to a management gateway on a computer where you have installed Framework and StreamServer. OpenText StreamServe Database Administration Tool By using this tool, database administrators can administer enterprise repositories, runtime repositories, and web content repositories that run on Microsoft® SQL Server® or Oracle® Database. Database Administration Tool is available for various editions of Windows. You use the Database Administration Tool Setup to install it. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 13 Before the installation The following steps are required before you begin a StreamServe installation: • Determine the hardware that is required for your StreamServe solution. • Ensure that you have the required software for each StreamServe component you want to install. • Ensure that you have access to a database installation configured for use with StreamServe components. In this section • Hardware planning on page 14 • Database requirements for StreamServe repositories on page 16 • Managing license files on page 18 Related topics Before you begin, you should read the following: • StreamServe components on page 7 – This describes the main components of StreamServe software. • Typical installation steps on page 19 – This describes steps that you can use to install StreamServe components. Securing StreamServe installations To comply with your company’s security policy you may need to secure your StreamServe installations. For more information about securing a StreamServe installation, see Security User Guide available on OpenText Knowledge Center. Supported software and platforms For the official list of supported software and platforms, see Supported platforms and software documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 14 Hardware planning Before the installation Hardware planning You can install all StreamServe components on the same computer. You can also use different computers for the following components: • Control Center • Design Center • Framework and StreamServer • StreamStudio • StreamServe repositories The number of computers used to implement your StreamServe solution depends on the individual requirements at your company, such as, company infrastructure, organizational structure, operational practices, etc. You should also consider the complexity of the StreamServe solution and type of applications you will run when planning the hardware. Hardware guidelines StreamServe Hardware Guidelines documentation, which is available on OpenText Knowledge Center, contains information about the factors you should consider when planning a StreamServe installation. It also contains hardware recommendations for development, testing, and production environments. Example - Hardware used to run different StreamServe components This example shows a StreamServe installation that uses three computers to run different components of the StreamServe software. For information about the third-party software required on each of these computers, see Database requirements for StreamServe repositories on page 16. Figure 3 StreamServe installation using three computers OpenText™ StreamServe 5.6.2 Installation Guide Rev D Hardware planning Before the installation Computer 1 This computer is used to develop StreamServe Projects and administer StreamServe applications. Control Center and Design Center run on this computer. Computer 2 This computer runs StreamServer applications and the StreamStudio web applications. Computer 3 This computer is a dedicated database server. It is used for the StreamServe Enterprise Repository and the runtime repository. Installation steps for this scenario For information about the steps to install and configure the StreamServe software in this example, see Example - A typical StreamServe installation on page 29. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 15 16 Database requirements for StreamServe repositories Before the installation Database requirements for StreamServe repositories A database installation is required for the StreamServe repositories. For a list of supported database vendors and versions, see Databases in the Supported platforms and software documentation. All the StreamServe repositories must use the same database vendor. For example, if the enterprise repository runs on Oracle, the runtime repository, the Collector archive, and the web content repository must also run on Oracle. Before creating the StreamServe repositories, you must configure the database installation for use with StreamServe components. This section describes the minimum database requirements that must be fulfilled in a development or testing environment. Database Guidelines For detailed information about how to installing, maintaining, and backing up StreamServe repositories, see: • OpenText StreamServe Microsoft SQL Server Database Guidelines • OpenText StreamServe Oracle Database Database Guidelines The guidelines are available at OpenText Knowledge Center. In this section • Database configuration for Microsoft SQL Server on page 16 • Database configuration for Oracle Database on page 17 • Managing license files on page 18 Database configuration for Microsoft SQL Server This section describes the minimum database requirements that must be fulfilled before creating StreamServe repositories in a testing environment. For detailed information, see OpenText StreamServe Microsoft SQL Server Database Guidelines, available at OpenText Knowledge Center. Database configuration • Enable TCP/IP. • Specify Mixed Mode authentication. • For all IP addresses, specify the static TCP port number that you use to access the database. Note: Do not specify any dynamic TCP ports. • Select a proper collation. SQL Server Browser service for named instances If you use a named instance of SQL Server, the SQL Server Browser service must be started before you create the StreamServe repositories. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Database requirements for StreamServe repositories Before the installation Database configuration for Oracle Database This section describes the minimum database requirements that must be fulfilled before creating StreamServe repositories in a testing environment. For detailed information, see OpenText StreamServe Oracle Database Database Guidelines, available at OpenText Knowledge Center. Database configuration • Specify the following database server parameter: Parameter Value db_block_size Must be at least 8192. Note: If the database server has more than 4 GB memory, you can raise this value to 16384. • Create a UTF database with: – Character set AL32UTF8. – National character set AL16UTF16. • Make all tablespaces locally managed. • Where applicable, make tablespaces automatic segment space managed (SEGMENT SPACE MANAGEMENT AUTO, which is default on Oracle 11g). • For Oracle 12c, create a service name in tnsnames.ora for every PDB (pluggable database) you want use for a StreamServe repository. Increasing Unicode support • If the database character set uses a multi-byte character encoding scheme and the default Unicode support is not enough, you can increase the Unicode support by specifying the following database server parameter: Parameter Value nls_length_ semantics char Note: The char value requires more space in the database than the default byte value. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 17 18 Managing license files Before the installation Managing license files Unlicensed StreamServer applications run in demo mode by default. In demo mode, texts in the output are randomly removed and replaced by the text string Demo. To license StreamServer applications, you must get a license file and connect the license file to the StreamServer applications. See Managing license files in the Control Center documentation for information about how to manage license files. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 19 Typical installation steps The installation steps for StreamServe software differ depending on whether you are installing all components on one computer, or whether you are installing the components on several computers. You also use different steps to install in a development and test environment compared to a production environment. In this section • Installing on a computer used for development and testing on page 20 – Describes the steps to install all StreamServe components on a computer used for development and testing. • Installing in a production environment on page 23 – Describes the steps to install StreamServe components in a production environment. • Example - A typical StreamServe installation on page 29. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 20 Installing on a computer used for development and testing Typical installation steps Installing on a computer used for development and testing This section describes the main steps to install StreamServe components on a computer used to develop StreamServe Projects, and run StreamServe applications for development and testing purposes. In this scenario, you install and configure the following StreamServe components: • Framework and StreamServer • Management gateway • Control Center • Design Center • Application domain • StreamServe Enterprise Repository • Runtime repository • Service gateway You create the repositories in a local database. For example, Microsoft SQL Server Express. You can also install the StreamStudio components and OpenDS on the same computer. Steps to install on a computer used for development and testing • Required steps on page 20 • StreamStudio steps on page 21 • Steps after the installation on page 21 Required steps This section describes the steps to prepare for the installation and to install the following components on the computer: • Framework and StreamServer • Design Center Step 1 – Download the Setup You can download the OpenText StreamServe Setup from the StreamServe Product area on OpenText Knowledge Center: • https://knowledge.opentext.com Step 2 – Preparations Before you begin, you must: • Confirm you have the software and hardware that is required for each StreamServe Component you want to install. See Support platforms and software documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing on a computer used for development and testing Typical installation steps • Install any third-party software that is required. For example, SQL Server Express, Apache Tomcat, etc. • Prepare the database server that you will use to host the StreamServe repositories. See Database requirements for StreamServe repositories on page 16. Step3 – Install Framework and StreamServer Install the Framework and StreamServer using the Setup wizard. See Installing Framework and StreamServer on Windows on page 35. Step 4 – Install Control Center Install Control Center using the Setup wizard. See Installing Control Center on page 37. Step 5 – Install Design Center Install Design Center using the Setup wizard. See Installing Design Center on page 39. StreamStudio steps This section describes the steps to install StreamStudio and OpenDS on the computer. Step 1 – Install StreamStudio Install StreamStudio using the Setup wizard. See Installing StreamStudio on Windows on page 41. Optional – Install OpenDS To test or demonstrate StreamStudio, you can install the OpenDS directory server with a set of StreamServe demonstration users. See Installing OpenDS on page 63. Steps after the installation This section describes the steps that are required after the installation to get started in Control Center, create the enterprise repository, and run StreamServer applications. It also describes the steps that are required to run StreamStudio web applications. Step 1 – Get started in Control Center 1 Open Control Center and enter a new password for the Management Gateway Administrator (user name Administrator). See Opening Control Center and changing the password for the Management Gateway Administrator in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 21 22 Installing on a computer used for development and testing Typical installation steps 2 In Control Center, specify the connection settings for the enterprise repository. See Configuring the connection settings for StreamServe Enterprise Repository in the Control Center documentation. 3 In Control Center, rename the site. See Renaming a site in the Control Center documentation. Step 2 – Create the StreamServe Enterprise Repository In Control Center, create the enterprise repository. See Creating StreamServe Enterprise Repository in the Control Center documentation. Step 3 – Prepare to run StreamServer applications 1 In Control Center, configure an application domain. See Creating an application domain in the Control Center documentation. 2 In Control Center, create the runtime repository. See Creating a runtime repository in the Control Center documentation. Step 4 – Prepare to run StreamStudio applications 1 Configure the application domain for StreamStudio. See Preparing the application domain for web applications in the Control Center documentation. 2 If required, create the repositories needed for the StreamStudio web applications you will run. • For Collector, you need a Collector archive. See StreamStudio Collector configurations in the Control Center documentation. • For Composition Center, you need the web content repository. See StreamStudio Composition Center configurations in the Control Center documentation. 3 Add the service gateway application(s) for StreamStudio. See Adding a service gateway in the Control Center documentation. 4 Deploy the StreamStudio web portal to the Java application server. See Deploying a web application in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing in a production environment Typical installation steps Installing in a production environment This section describes the main steps to install StreamServe components in a production environment. For descriptions of these components, see StreamServe components on page 7. Using a central enterprise repository When you run StreamServe software in a production environment, you create one central StreamServe Enterprise Repository. You then connect Framework and StreamServer, and Control Center to the central enterprise repository. For performance and scalability reasons, you may want to install and run Framework and StreamServer on more than one computer. In this scenario, you must connect all the installations to the central enterprise repository. If you want use Control Center to deploy the StreamStudio web application files, you must install Framework and StreamServer on the same computer as StreamStudio and then connect the computer to the central enterprise repository. Steps In a production environment, the order of the installation steps can differ to those described in this section depending on the specific requirements of your StreamServe solution, the StreamServe components you will run, and the hardware used. When making a typical installation in a production environment, you usually start by installing Framework and StreamServer on the computers you want to use to run StreamServer applications. You then install Control Center on the computer that you will use to administer your environment. If required, you then install StreamStudio. After the installation, you open Control Center, connect to the management gateway on a computer with a Framework and StreamServer installation, and create the central enterprise repository. If you have installed Framework and StreamServer on several computers, you must connect all the computers to the central enterprise repository. Finally, you can make the preparations to run StreamServer applications and, if required, StreamStudio applications. Installation – steps • Step 1 – Download the Setup on page 20 • Step 2 – Preparations on page 20 • Step 3 – Install Framework and StreamServer on page 24 • Step 4 – Install Control Center on page 24 • Step 5 – Install StreamStudio (optional) on page 24 • Step 6 – Install Design Center on page 25 After the installation – steps • Step 1 – Get started in Control Center on page 25 • Step 2 – Create the StreamServe Enterprise Repository on page 26 • Step 3 – Connect all computers to the central enterprise repository on page 26 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 23 24 Installing in a production environment Typical installation steps • Step 4 – Prepare to run StreamServer applications on page 27 • Step 5 – Prepare to run StreamStudio applications (optional) on page 27 Installation steps Step 1 – Download the Setup You can download the OpenText StreamServe Setup from the StreamServe Product area on OpenText Knowledge Center: • https://knowledge.opentext.com Step 2 – Preparations Before you begin, you must: • Confirm you have the software and hardware that is required for each StreamServe component you want to install. See Supported platforms and software documentation. • Install any third-party software that is required, for example Apache Tomcat. • Obtain user names and passwords to any third-party systems that are required, for example, to the database server, Java application server, and directory server. Or, contact the administrators who are responsible for these systems to arrange access. • Prepare the database server(s) that you will use to host the StreamServe repositories. See Database requirements for StreamServe repositories on page 16. Step 3 – Install Framework and StreamServer To install Framework and StreamServer, see: • Installing Framework and StreamServer on Windows on page 35 • See Installing Framework and StreamServer on UNIX on page 55 Step 4 – Install Control Center • Installing Control Center on page 37. Step 5 – Install StreamStudio (optional) To use Control Center to deploy the StreamStudio web application files to the Java application server, you must install Framework and StreamServer on the same computer as StreamStudio, and then connect the computer to the central enterprise repository. You can then use Control Center on any computer connected to the same enterprise repository to deploy and administer these applications. To install StreamStudio, see: • Installing StreamStudio on Windows on page 41 • Installing StreamStudio on UNIX on page 59 OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing in a production environment Typical installation steps Step 6 – Install Design Center If you want to run Design Center on a computer with other StreamServe components, you must configure the other components on the computer to use the central enterprise repository. You can also install Design Center on a computer without any other StreamServe components. Installing Design Center on a separate computer See Installing Design Center on page 39. Installing Design Center on a computer with other StreamServe components 1 Install Framework and StreamServer. See Installing Framework and StreamServer on Windows on page 35. 2 Install Control Center. See Installing Control Center on page 37. 3 Install the other StreamServe components as required, for example, Framework and StreamServer. 4 Install Design Center. See Installing Design Center on page 39. 5 After you create the central enterprise repository, open Control Center and connect to the enterprise repository. See Step 1 – Get started in Control Center in Control Center documentation. After the installation Step 1 – Get started in Control Center These steps describe how you use Control Center to change the password for the Management Gateway Administrator and configure connection settings to the enterprise repository. Getting started using the Command Line Utilities You can also perform these steps using the Command Line Utilities. For more information, see Command Line Utilities documentation, available on OpenText Knowledge Center. To get started in Control Center 1 Open Control Center and enter a new password for the Management Gateway Administrator (user name Administrator). See Opening Control Center and changing the password for the Management Gateway Administrator in the Control Center documentation. 2 In Control Center, specify the connection settings for the enterprise repository. See Configuring the connection settings for StreamServe Enterprise Repository in the Control Center documentation. 3 In Control Center, rename the site. See Renaming a site in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 25 26 Installing in a production environment Typical installation steps Step 2 – Create the StreamServe Enterprise Repository These steps describe how to use Control Center to create the enterprise repository. Creating the enterprise repository manually If the company security policy prevents Control Center from connecting to the database or if you want to have full traceability of the repository creation, you can create the enterprise repository manually. See Creating an enterprise repository manually in the Control Center documentation. Using the Command Line Utilities to generate the enterprise repository scripts You can use the Command Line Utilities to generate the scripts for the enterprise repository. For more information, see Command Line Utilities documentation available on OpenText Knowledge Center. To use Control Center to create the enterprise repository In Control Center, create the enterprise repository. See Creating an enterprise repository from Control Center in the Control Center documentation. Step 3 – Connect all computers to the central enterprise repository If you install Framework and StreamServer on more than one computer, you must connect the management gateway on each computer to the central enterprise repository. If you do not run Control Center on the computer, you can do this by manually copying the enterpriserepository.xml file from the management gateway on the computer that you used to create the enterprise repository to the management gateway on the subsequent computers. If you run Control Center on the computer, you enter the settings for the central enterprise repository in the Enterprise Repository Configuration dialog box. To copy the enterpriserepository.xml file 1 On the computer with the management gateway that you used to create the enterprise repository, navigate to the following directory: <Management gateway base directory>\<version>\root\securityprofiles where <Management gateway base directory> is the base directory specified during the Framework and StreamServer installation. The default location on Windows is C:\ManagementGateway 2 Copy the enterpriserepository.xml file from this directory. 3 On the computer that you want to connect to the enterprise repository, do the following: a Navigate to the directory <Management gateway base directory> \<version>\root\securityprofiles a Paste the entepriserepository.xml into this directory. b Restart the StreamServe Management Gateway and StreamServe Management Nanny services. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing in a production environment Typical installation steps Step 4 – Prepare to run StreamServer applications These steps describe how to make the preparations to run StreamServer applications. Using the Command Line Utilities to prepare to run StreamServer applications For information about using the Command Line Utilities to make these preparations, see Command Line Utilities documentation available from OpenText Knowledge Center. To prepare to run StreamServer applications 1 In Control Center, configure an application domain. See Creating an application domain in the Control Center documentation. 2 In Control Center, generate the scripts for the runtime repository. See Generating database scripts from Control Center in the Control Center documentation. 3 Update the scripts to fit your company requirements for the database. For example, configure the filegroups, size, file growth parameters, etc. 4 Run the scripts in the database server to create the runtime repository. See the following sections in the Control Center documentation: • Executing database scripts (Microsoft SQL Server) • Executing database scripts (Oracle Database) • Adding a StreamServer application Step 5 – Prepare to run StreamStudio applications (optional) These steps describe how to use Control Center to make the preparations to run StreamStudio applications. Using the Command Line Utilities to prepare to run StreamStudio applications For information about using the Command Line Utilities to make these preparations, see Command Line Utilities documentation available from OpenText Knowledge Center. To prepare to run StreamStudio web applications 1 Configure the application domain for StreamStudio web applications. See Preparing the application domain for web applications in the Control Center documentation. 2 If required, create the repositories needed for the StreamStudio web applications you will run. 3 • For Collector, you need a Collector archive. See StreamStudio Collector configurations in the Control Center documentation. • For Composition Center, you need a web content repository. See StreamStudio Composition Center configurations in the Control Center documentation. Add the service gateway application(s) for StreamStudio. See Adding a service gateway in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 27 28 Installing in a production environment Typical installation steps 4 Deploy the StreamStudio web application to the Java application server. See Deploying a web application in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Example - A typical StreamServe installation Typical installation steps Example - A typical StreamServe installation In this example, Company ABC Ltd is planning a StreamServe installation that will use three computers to host different StreamServe components. Figure 4 Installing StreamServe components on three computers Computer_1 This computer will be used to develop StreamServe Projects and administer StreamServe applications. The following StreamServe components will be installed on this computer: • Control Center • Design Center Computer_2 This computer will run StreamServer applications and the StreamStudio web applications. Apache Tomcat is already installed on this computer. The following StreamServe components will be installed on this computer: • Framework and StreamServer • StreamStudio Computer_3 Microsoft SQL Server is running on this computer. The StreamServe Enterprise Repository and runtime repository will be created on this computer. Steps These instructions describe how to install the StreamServe components on each of the computers and how to create the enterprise repository. Before StreamServer or StreamStudio applications can be run, further configurations are required. These are described in Control Center documentation. Steps • Prepare for the StreamServe installation on page 30 • Install StreamServe components on computer_2 on page 30 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 29 30 Example - A typical StreamServe installation Typical installation steps • Install Control Center and Design Center on computer_1 on page 31 • Open Control Center and create enterprise repository on page 32 • Further preparations required on page 33 Prepare for the StreamServe installation To prepare to install the StreamServe software: • Confirm the software and hardware that is required for each StreamServe component that will be installed on each computer. See Database requirements for StreamServe repositories on page 16. • Obtain the user name and password that are required to access SQL Server. See Access details for SQL Server on computer_3 on page 30. • Configure Microsoft SQL Server for use with StreamServe components. See Configure SQL Server for use with StreamServe components on page 30. Access details for SQL Server on computer_3 Parameter Value Hostname\instance name computer_3 SA user name sa SA password Kanelbulle15 Configure SQL Server for use with StreamServe components 1 Open SQL Server Configuration Manager and configure the database according to the following: • Enable TCP/IP • Specify Mixed Mode authentication • Specify a static TCP port number for accessing the database from all IP Note: Do not specify any dynamic TCP ports. • Select a proper collation. Install StreamServe components on computer_2 The following steps are required to install StreamServe components on computer_2: • Install Framework and StreamServer on page 30 • Install StreamStudio on page 31 Install Framework and StreamServer 1 From the installation CD, double-click the mssetup.exe file. The OpenText StreamServe Setup opens. 2 Click Framework and StreamServer. 3 A page opens with a list of the required third-party software, click Install. The Setup installs the third-party software, which takes several minutes. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Example - A typical StreamServe installation Typical installation steps 4 A message displays prompting you to reboot your computer. Click OK, Finish, and reboot the computer. 5 Reopen the Setup, click Framework and StreamServer, and on the Welcome page click Next. 6 On the Installation information page, click Next. 7 On the Framework and StreamServer - Destination Folder page, click Next to install the files in the default folder. 8 On the Management Gateway - Location of base directory page, click Next, to use the default location for the working directory for StreamServe Projects. 9 On the Ready to Install page, review the installation settings, and click Install. The Setup installs the software, which takes several minutes. 10 On the Completed page, click Finish. The next step is to install StreamStudio on computer_2. Install StreamStudio 1 From the OpenText StreamServe Setup, click StreamStudio. 2 On the Welcome page, click Next. 3 On the License Agreement page, click Yes. 4 On the Ready to Install page, review the installation settings, and click Install. The Setup installs the software, which takes several minutes. 5 On the Completed page, click Finish. 6 Click Exit to close the OpenText StreamServe Setup. The next step is to install Control Center and Design Center on computer_1. Install Control Center and Design Center on computer_1 The following steps are required to install the StreamServe components on computer_1: • Install Control Center on page 31 • Install Design Center on page 32 Install Control Center 1 From the installation CD, double-click the mssetup.exe file. The OpenText StreamServe Setup opens. 2 Click Control Center. A page opens, which lists the third-party software Control Center requires. 3 Click Install to install the software 4 Click Yes to install Java Standard Edition Version. After the Setup has installed the third-party software, reboot the computer. 5 Open OpenText StreamServe Setup again and click Control Center. 6 On the Welcome page, click Next. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 31 32 Example - A typical StreamServe installation Typical installation steps 7 On the Control Center - Destination page, click Next to accept the default installation path. 8 On the Ready to Install page, click Install. The Setup installs the software, which takes several minutes. 9 On the Completed page, click Finish. Design Center can now be installed on computer_1. Install Design Center 1 From the OpenText StreamServe Setup, click Design Center. 2 On the Welcome page, click Next. 3 On the License Agreement page, click Yes. 4 Click Next to accept the default location for the Design Center installation files. 5 On the Update log page, click Install. The Setup installs the software, which takes several minutes. 6 On the Completed page, click Finish. 7 Click Exit to close the OpenText StreamServe Setup. Control Center can now be used to configure the central enterprise repository. Open Control Center and create enterprise repository You use Control Center installation on computer_1 to configure the connection settings for the enterprise repository and create the database for enterprise repository. To do this you need to connect to the management gateway on computer_2. The following steps are required: • Open Control Center and connect to the management gateway on computer_2 on page 32 • Create the enterprise repository on page 33 Open Control Center and connect to the management gateway on computer_2 1 Click Start > All Programs > OpenText StreamServe <version> > Control > Control Center. 2 Right-click the Root node and click New Site. 3 In the New site dialog box, enter the following settings • Site name – ABC_Production • Host name – computer_2 4 Click OK to continue. 5 In the Change Password dialog box, enter strs_password and strs_password, and click OK. 6 In the Enterprise Repository Configuration dialog box, enter the following settings and click OK. • Database vendor – SQL Server • Host name – computer_3 OpenText™ StreamServe 5.6.2 Installation Guide Rev D Example - A typical StreamServe installation Typical installation steps • Port – 1433 • Database name – StrsSER • User name – StrsSERAccess • Password – StrsSER456 The next step is to create the database for the enterprise repository on computer_3. Create the enterprise repository 1 Right-click the ABC_Production site and click Create Database... 2 In the Connect dialog box, enter the login details for the Management Gateway Administrator (Administrator and strs_password), and click OK. 3 In Create Database dialog box, select Create now and click Start. 4 In the Connect dialog box, enter the following login details for the database administrator and click OK: • User name – sa • Password – Kanelbulle15 A database called StrsSER is created in Microsoft SQL Server on computer_3. 5 Review the Result log and click Close to close the Create Database dialog. Further preparations required Before you can run StreamServer or StreamStudio applications you must make further preparations. These preparations are described in the Control Center documentation. Related topics For information about: • The preparations required to run StreamServer applications, see StreamServer configurations in the Control Center documentation. • The preparations required to run StreamStudio applications, see StreamServe web application configurations in the Control Center documentation. • The preparations required to run Collector, see StreamStudio Collector configurations in the Control Center documentation. • The preparations required to run Composition Center, see StreamStudio Composition Center configurations in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 33 34 Example - A typical StreamServe installation Typical installation steps OpenText™ StreamServe 5.6.2 Installation Guide Rev D 35 Installing Framework and StreamServer on Windows The Framework and StreamServer Setup installs the following StreamServe components: • Software used to run StreamServer applications. • Framework, which includes a management gateway and the underlying software to run other types of StreamServe applications, such as service gateways, Archiver applications, and Task Scheduler applications. Supported platforms and software For information about these, see the following sections in the Supported platforms and software documentation: • Platforms for Framework and StreamServer, and StreamServe web applications • Hardware providers and CPUs • Java Runtime Environments 64-bit Windows The Framework and StreamServer Setup requires a 64-bit version of Windows®. Stop the Java application servers and close your web browsers Before you install Framework and StreamServer, you must close all web browsers and stop and any Java application servers that are running on the computer. Third-party software Framework and StreamServer requires third-party software, such as Microsoft Visual C++ Redistributable Package and Microsoft .NET Framework. During the Framework and StreamServer installation, the Setup does a prerequisite check and lists the required software that is missing on your computer. If any software is missing, you can install it from the Setup. You have the option to install Java Standard Edition during the Setup. If you choose not to install this, you must have another supported version of the Java Runtime Environment on your computer. For information about the supported versions, see Java Runtime Environments in Supported platforms and software documentation. Prerequisites To install or remove StreamServe software in a Windows environment, you must have administrator rights. Java environment for StreamServer applications StreamServer applications use the environment variable $STRS_JAVA_HOME to point out the Java Runtime Environment that is used to run Java components. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 36 Using the Setup wizard to install Framework and StreamServer Installing Framework and StreamServer on Windows Using the Setup wizard to install Framework and StreamServer Installation options During the Framework and StreamServer installation, you specify the following options: Option Description Java Standard Edition Runtime Environment You can select whether to install this with Framework and StreamServer. If you select No, another version of the Java Runtime Environment must be installed on the computer. If you select Yes, the Java Standard Edition Runtime Environment is installed even if you have an another version installed. Framework and StreamServer Destination folder The folder for the framework and StreamServer program files. Management Gateway - Location of base directory This directory contains the working directories for StreamServe applications. When you deploy a Project in Control Center, the Project is deployed to the working directory. To install Framework and StreamServer 1 If autostart is enabled on your computer, the Setup opens automatically. Otherwise, double-click the mssetup.exe file to open the Setup. 2 Click Framework and StreamServer. 3 A page opens, which lists the required third-party software, click Install to install this software. Note: If the Setup installs Microsoft .NET Framework 4, you must restart the computer and then open the Setup again. 4 Follow the Setup wizard, which guides you through the installation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 37 Installing Control Center This section includes information about how to install Control Center. Third-party software included During the Control Center installation, the Setup does a prerequisite check and lists the required software that is missing from your computer. If any software is missing, you can install it from the Setup. You have the option to install Java Standard Edition during the Setup. This is required if you want to use Control Center to create the StreamServe repositories. Prerequisites To install or remove a Control Center installation on Windows, you must have administrator rights. Supported Windows versions For information about the supported versions of Windows, see Platforms for Design Center, Control Center, and administration tools in Supported platforms and software documentation. Using the Setup wizard to install Control Center 1 If autostart is enabled on your computer, the Setup opens automatically. Otherwise, double-click the mssetup.exe file to open the Setup. 2 Click Control Center. 3 Follow the Setup wizard, which guides you through the installation. Opening Control Center after the installation Click Start > All Programs > OpenText > OpenText StreamServe <version> > Control > Control Center. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 38 Installing Control Center OpenText™ StreamServe 5.6.2 Installation Guide Rev D 39 Installing Design Center The Design Center Setup installs the following StreamServe desktop tools: • Design Center • StoryTeller • UTF Edit • Overlay Editor • Device Tool • Windows Driver Tool Third-party software included Design Center requires third-party software, such as Microsoft .Net Framework Full. During the Design Center installation, the Setup does a prerequisite check and lists the required software that is missing from your computer. If any software is missing, you can install it from the Setup. Prerequisites • To install or remove Design Center on Windows, you must have administrator rights. • Internet Explorer® must be installed on the computer. For information about the supported versions, see Web browsers in Supported platforms and software documentation. • For information about the supported versions of Windows, see Platforms for Design Center, Control Center, and administration tools in Supported platforms and software documentation. Using the Setup wizard to install Design Center 1 If autostart is enabled on your computer, the Setup opens automatically. Otherwise, double-click the mssetup.exe file to open the Setup. 2 Click Design Center. 3 Follow the Setup wizard, which guides you through the installation. Accessing the StreamServe tools after the installation After the installation, the StreamServe tools are available through either: • Start > All Programs > OpenText > OpenText StreamServe <version> > Design • Start > All Programs > OpenText > OpenText StreamServe <version> > Utilities OpenText™ StreamServe 5.6.2 Installation Guide Rev D 40 Installing Design Center OpenText™ StreamServe 5.6.2 Installation Guide Rev D 41 Installing StreamStudio on Windows The StreamStudio Setup copies the files for the following web applications to the computer: • StreamStudio web applications • SSSP application • Document Broker Query Tool (DBQ Tool) • Ad Hoc Correspondence and Correspondence Reviewer Third-party software included The following software is installed with the StreamStudio Setup: • DataDirect JDBC driver (for Oracle) • JTDS driver (for SQL Server) Prerequisites • The following software is required on the computer where you will run StreamStudio: – – Java application server A Java Runtime Environment. You can download the JRE from http://www.java.com Note: If you use SAP NetWeaver Java application server, you do not need a separate JRE installation. • To install or remove StreamServe software in a Windows environment, you must have administrator rights. • To use Control Center to deploy and administer the web applications, you must install Framework and StreamServer on the same computer as you install StreamStudio, and then connect the computer to the central enterprise repository. Deploying the applications to a Java application server After the installation, you must deploy the web application to a Java application server, for example Apache Tomcat. For more information, see After the installation on page 43. Supported platforms and software For information about the supported software and platforms, see the following sections in the Supported platforms and software documentation: • Platforms for Framework and StreamServer, and StreamServe web applications • Hardware providers and CPUs • Java application servers for StreamServe web applications • Java Runtime Environments OpenText™ StreamServe 5.6.2 Installation Guide Rev D 42 Installing StreamStudio on Windows Directory server for testing and development For testing and Project development purposes, you can use OpenDS as a directory server for storing StreamStudio users. See Installing OpenDS in StreamServe Installation documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Using the Setup wizard to install StreamStudio Installing StreamStudio on Windows Using the Setup wizard to install StreamStudio 1 If autostart is enabled on your computer, the Setup opens automatically. Otherwise, double-click the mssetup.exe file to open the Setup. 2 Click StreamStudio. 3 Follow the Setup wizard, which guides you through the installation. After the installation After running the StreamStudio Setup, you must deploy the web applications to the Java application server, see Deploying the web applications on page 44. For information about the preparations required to run the web applications, see the following documentation: • All web applications – For information about the configurations required to run all web applications, see StreamServe web application configurations in the Control Center documentation. • StreamStudio applications – For information about the preparations required to run these applications, see StreamStudio installations in StreamStudio Administrators Guide. • DBQ Tool – For information about making the preparations to run this tool, see Getting started with DBQ Tool in Document Broker Plus documentation. • Ad Hoc Correspondence and Correspondence Reviewer – For information about these applications, see Deploying the applications in Ad Hoc Correspondence and Correspondence Reviewer Administrator’s documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 43 44 Deploying the web applications Installing StreamStudio on Windows Deploying the web applications Deploying web application files from Control Center in an open environment If you have installed Framework and StreamServer on the same computer as StreamStudio, you can use Control Center to deploy StreamStudio to the Java application server. For more information, see Control Center documentation. Deploying the web application files to an isolated environment A common production scenario is that StreamStudio is installed on a computer without other StreamServe components. In this scenario, you can still configure the StreamStudio environment in Control Center. Then you can manually copy the StreamStudio files to the computer where the Java application server is installed. For more information, see Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 45 Installing Database Administration Tool This section includes information about how to install Database Administration Tool. Third-party software included Database Administration Tool requires Java Standard Edition. If this is not already installed on your computer, you can install it during the Setup. Prerequisites To install or remove StreamServe software in a Windows environment, you must have administrator rights. Supported Windows versions For information about the supported versions of Windows, see Platforms for Design Center, Control Center, and administration tools in Supported platforms and software documentation. Using the Setup wizard to install Database Administration Tool 1 If autostart is enabled on your computer, the Setup opens automatically. Otherwise, double-click the mssetup.exe file to open the Setup. 2 Click Database Administration Tool. 3 Follow the Setup wizard, which guides you through the installation. Opening Database Administration Tool after the installation Click Start > All Programs > OpenText > OpenText StreamServe <version> > Utilities > Database Administration Tool. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 46 Installing Database Administration Tool OpenText™ StreamServe 5.6.2 Installation Guide Rev D 47 Installing Windows components silently In this section • Installing Framework and StreamServer silently on page 48 • Installing Control Center silently on page 51 • Installing Design Center silently on page 52 • Installing StreamStudio silently on page 53 Logging and installation options When you install StreamServe components silently, 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 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 48 Installing Framework and StreamServer silently Installing Windows components silently Installing Framework and StreamServer silently You can run the silent install using either the setup.exe or MSI file. We recommend you use the setup.exe file because it 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. The setup files are found in the folder: \Software\Platform64 – OpenText StreamServe Framework and StreamServer <version> – setup.exe Stop the Java application servers and close your web browsers Before you install Framework and StreamServer, you must close all web browsers and stop and any Java application servers that are running on the computer. Prerequisites • Microsoft Visual C++ 2013 Redistributable Package (64-bit) • Microsoft .NET Framework 4 Extended • A supported version of Java Standard Edition Installation options for Framework and StreamServer The Framework and StreamServer silent installation has several optional parameters, which you can use to change the installation directory, change the location of the management gateway base directory, to enter the settings to connect to an existing enterprise repository, or to enter settings for a new enterprise repository. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing Framework and StreamServer silently Installing Windows components silently Optional parameters Parameter Description INSTALLDIR The installation directory for Framework and StreamServer. The default is C:\Program Files\OpenText \StreamServe DATABASESELECTION The database vendor for the StreamServe Enterprise Repository. Use oracle or sqlserver. The default is sqlserver. TERRITORY_HOST_NA The IP address or host name of the database server. Use ME one of <host_name> or localhost. The default is localhost. IS_SQLSERVER_PORT The port used for communication with the database server. The default port for Oracle Database is 1521. The default port for Microsoft SQL Server is 1433. TERRITORY_NAME The name of your enterprise repository database. The default is StrsSER. TERRITORY_USER_NA The dat ME abase administration user that the management gateway uses to connect to the enterprise repository. The user is automatically created when the enterprise repository is created. The default user name is StrsSERAccess. TERRITORY_PASSWOR The password to access the enterprise repository. The D default is Changeoninstall768. IS_ORACLE_SERVICE Only applicable if DATABASESELECTION = Oracle. _NAME The Oracle SID for the database. MGW_USER_NAME The management gateway user name. The default is Administrator. MGW_PASSWORD The password for the management gateway user. The default is strs. CAPPDIR The management gateway base directory, which will contain the working directories for StreamServe applications. When you deploy a Project in Control Center, the Project is deployed to the working directory. FILEPRIVATEKEY The path for the certificate for the management gateway. The Setup includes a demonstration certificate demo.pfx, which is installed in the following directory: <Framework and StreamServer installation directory>\Platform\Core\<version>\bin \security\keystore\private OpenText™ StreamServe 5.6.2 Installation Guide Rev D 49 50 Installing Framework and StreamServer silently Installing Windows components silently Parameter Description SERVICEGATEWAY The installation folder for the service gateway. The default path is: <Framework and StreamServe installation directory>\Applications\Service Gateway Examples – Installing Framework and StreamServer silently For descriptions of the parameters used in these examples, see Installation options for Framework and StreamServer on page 48. Example 1 Installing Framework and StreamServer silently This example installs the Framework and StreamServer using the default options. The log for the installation is found under c:\<version>\service_framework.log. The installation may take several minutes. start "" /wait "setup.exe" /s /v" /qn /Liwrmo!vucape c:\<version>\service_framework.log" Example 2 Installing Framework and StreamServer silently using extended options This example installs the Framework and StreamServer and enters the connections settings for the enterprise repository, the management gateway administrator user and the management gateway base directory. start "" /wait msiexec /package "OpenText StreamServe Framework and StreamServer <version>.msi" /qb /Liwrmovucape service_framework.log DATABASESELECTION="oracle" TERRITORY_HOST_NAME="linux28" IS_SQLSERVER_PORT="1521" TERRITORY_NAME="STRSSER" TERRITORY_USER_NAME="STRSSER_SSTERRITORYTEST" TERRITORY_PASSWORD="Changeoninstall999" IS_ORACLE_SERVICE_NAME="LINUX28" MGW_PASSWORD="strs" MGW_PASSWORD_MASKED="strs" MGW_USER_NAME="Administrator" MGW_PORT="28200" CAPPDIR="C:\ManagementGateway\" OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing Control Center silently Installing Windows components silently Installing Control Center silently You can install Control Center silently using either of the two files below, which are located in the Setup directory under Software\ControlCenter • OpenText StreamServe Control Center <version> • setup.exe We recommend you use the setup.exe file because it 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 before you begin. Prerequisites • Microsoft Visual C++ 2013 Redistributable Package (64-bit) • Microsoft .NET Framework 4 Extended • Java Standard Edition Version 7 Update 21 (64-bit) Optional parameters Parameter Description INSTALLDIR The installation directory for Control Center. The default is C:\Program Files\OpenText\StreamServe REBOOT Example 3 Use ReallySuppress to prevent the computer from restarting after the installation. If you do not use this parameter it defaults to whatever the Setup requires. For example, if the Setup updates files that are locked the computer will restart, otherwise the computer will not restart. Installing Control Center silently using the MSI file This example installs Control Center in the default installation directory. start "" /wait msiexec /package "OpenText StreamServe Control Center <version>.msi" /qb /Liwrmovucape controlcenter.log REBOOT=ReallySuppress OpenText™ StreamServe 5.6.2 Installation Guide Rev D 51 52 Installing Design Center silently Installing Windows components silently Installing Design Center silently You can install Design Center silently by using either of the two files below, which are located in the Setup directory under: Software\Tools • OpenText StreamServe Design Center 5.6.2.msi • setup.exe Prerequisites 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 before you begin. • Microsoft Visual C++ 2013 Redistributable Package (64-bit) • Microsoft .NET Framework 4 Extended Optional parameters Parameter Description INSTALLDIR The installation directory for Design Center. The default is C:\Program Files\OpenText\StreamServe REBOOT Example 4 Use ReallySuppress to prevent the computer from restarting after the installation. If you do not use this parameter it defaults to whatever the Setup requires. For example, if the Setup updates files that are locked the computer will restart, otherwise the computer will not restart. Installing Design Center silently using the MSI file This example installs Design Center in the default installation directory. start "" /wait msiexec /package "OpenText StreamServe Design Center <version>.msi" /qn /Liwrmovucape designcenter.log REBOOT=ReallySuppress OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing StreamStudio silently Installing Windows components silently Installing StreamStudio silently You can install StreamStudio silently by using either of the two files below, which are located in the Setup directory under: Software\StreamStudio • OpenText StreamServe StreamStudio 5.6.2.msi • setup.exe Optional parameters Parameter Description INSTALLDIR The installation directory for StreamStudio. The default is C:\Program Files\OpenText\StreamServe REBOOT Example 5 Use ReallySuppress to prevent the computer from restarting after the installation. If you do not use this parameter it defaults to whatever the Setup requires. For example, if the Setup updates files that are locked the computer will restart, otherwise the computer will not restart. Installing StreamStudio silently using the MSI file This example installs StreamStudio in the default installation directory. start "" /wait msiexec /package "OpenText StreamServe StreamStudio <version>.msi" /qn /Liwrmovucape streamstudio.log REBOOT=ReallySuppress OpenText™ StreamServe 5.6.2 Installation Guide Rev D 53 54 Installing StreamStudio silently Installing Windows components silently OpenText™ StreamServe 5.6.2 Installation Guide Rev D 55 Installing Framework and StreamServer on UNIX The following parts are included in the Framework and StreamServer Setup: • Software used to run StreamServer applications • Framework, which includes a management gateway and the underlying software to run other types of StreamServe applications, such as service gateways, Archiver applications, and Task Scheduler applications. Steps to install Framework and StreamServer on UNIX To install Framework and StreamServer on UNIX, you must: 1 Extract the StreamServe setup files. See Extracting the StreamServe setup files on page 56. 2 Run the StreamServe setup script. See Running the script to install Framework and StreamServer on page 57. After the installation – Managing and administering applications After you have installed Framework and StreamServer, you can manage and administer applications on the computer using either Control Center or the Command Line Utilities. For more information, see the following documentation: • Control Center documentation • Command Line Utilities documentation OpenText™ StreamServe 5.6.2 Installation Guide Rev D 56 Extracting the StreamServe setup files Installing Framework and StreamServer on UNIX Extracting the StreamServe setup files The StreamServe setup files are archived in a gzipped file which you can download from Knowledge Center: • streamserve-<releasenumber><buildnumber>-<platform>.tar.gz To extract the setup files 1 Create a folder to extract the StreamServe files to. For example /opt/ streamserve 2 Copy the gzipped file for the appropriate UNIX platform to the new directory. 3 From the StreamServe directory, extract the gzipped file using the following command: gunzip < <StreamServe_Installation_File> | tar xf - For example: gunzip < streamserve-<releasenumber>.GA.999-sparc-sunsolaris2.10-release.tar.gz | tar xf - The files are extracted to a new folder in the StreamServe directory called streamserve-<release_and_build_nr>. For example: /opt/streamserve/streamserve-<releasenumber>.GA.999 OpenText™ StreamServe 5.6.2 Installation Guide Rev D Running the script to install Framework and StreamServer Installing Framework and StreamServer on UNIX Running the script to install Framework and StreamServer You can run the StreamServe setup script without root privileges. After the script is run, a file is created with the values you entered during the setup. You can use this file to run the setup again using the same values. After the script is run, the ManagementGateway and ManagementNanny processes are started. For information about the structure of the StreamServe directory, see the README file in the folder created when extracting the setup file. Framework and StreamServer Setup options When you run the StreamServer and Framework setup, you must specify the following options: • Location for StreamServer Projects – This directory is used for the working directories for StreamServe applications. When you deploy a Project in Control Center or using the Command Line Utilities, the Project is deployed to the working directory. • Management gateway port – The port used by the management gateway for communication. • Java Environment – JAVA_HOME – The path to the Java Runtime Environment or Java Development Kit. After you enter the path, the Setup validates the path and the Java version. For the supported versions, see Java Runtime Environments in Supported Platforms and Software documentation. Running the Framework and StreamServe setup script manually 1 Browse to the folder created when extracting the setup file, for example: /opt/streamserve/streamserve-<releasenumber>.GA.999 2 Enter ./setup 3 Enter 1 to select Framework and StreamServer. An End User License Agreement text is displayed. 4 After reading the text, enter q to continue. 5 Accept by entering Yes. 6 Follow the prompts to complete the installation. For information on the parameters, see Framework and StreamServer Setup options above. To access the help during the installation Enter ? to display the help text for an option. Running the setup script using a file (silent install) When you run the setup a file called .operatorInput is created. 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 file, for example: OpenText™ StreamServe 5.6.2 Installation Guide Rev D 57 58 Running the script to install Framework and StreamServer Installing Framework and StreamServer on UNIX /opt/streamserve/streamserve-<releasenumber>.GA.999 2 Run ./setup -file .operatorInput Installation log An installation log file called setup.log is created in the directory where you run the setup. Files created during the installation systeminfo A system information XML file is created in the systeminfo folder. OpenText support may require this file when you log an incident. .setup_environment This file is created during the setup and displays the parameters entered during the setup. StreamServe applications read this file on startup. This file is located in the StreamServe installation directory and is called .setup_environment OpenText™ StreamServe 5.6.2 Installation Guide Rev D 59 Installing StreamStudio on UNIX The following main parts are included in the StreamStudio Setup: • StreamStudio web applications • Document Broker Query Tool • Ad Hoc and Correspondence Reviewer applications • SSSP application The StreamStudio setup also includes the following third-party software: • DataDirect JDBC driver (for Oracle Database, Microsoft SQL Server, and IBM DB2) • JTDS driver (for Mircosoft SQL Server) Prerequisites • A Java Runtime Environment must be installed on the computer where you install StreamStudio. For download and installation information, see http://java.sun.com • The StreamStudio applications must be deployed to a Java application server, for example Apache Tomcat. See http://tomcat.apache.org/ • To use Control Center to deploy the web applications, you must install Framework and StreamServer on the same computer as you install StreamStudio, and then connect the Framework and StreamServe to the central enterprise repository. Steps to install StreamStudio on UNIX To install StreamStudio on UNIX, you must: 1 Extract the StreamServe setup files. See Extracting the StreamServe setup files on page 56. Note: If you have already extracted the setup file on the same machine, you do not have to do this again. 2 Run the StreamServe setup script. See Running the setup script to install StreamStudio on page 60. 3 After the installation, you must deploy the web application files. See Deploying the web applications on page 61. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 60 Running the setup script to install StreamStudio Installing StreamStudio on UNIX Running the setup script to install StreamStudio You can run the script without root privileges. After the script is run, a file is created with the values you entered during the setup. You can use this file to run the setup again using the same values. After the script is run, the ManagementGateway and ManagementNanny processes are restarted. For information about the structure of the StreamServe directory, see the README file in the /Server directory. Running the StreamServe setup script manually 1 Browse to the folder created when extracting the setup file, for example: /opt/streamserve/streamserve-<releasenumber>.GA.999 2 Enter ./setup 3 Enter 2 to install StreamStudio. The setup copies the WAR files to the computer. 4 Enter q to close the setup. To access the help during the installation Enter ? to display help text for an option. Running the setup script using a file (silent install) When you run the setup a file called .operatorInput is created. You can use this file to run the setup again without being prompted to enter values. To run the setup script using a file 1 Browse to the folder created when extracting the setup file, for example: /opt/streamserve/streamserve-<releasenumber>.GA.999 2 Run ./setup -file .operatorInput Installation log An installation log file called setup.log is created in the directory where you run the setup. System information A system information XML file is created in the systeminfo folder. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Deploying the web applications Installing StreamStudio on UNIX Deploying the web applications You can deploy and administer the web application files using either Control Center or the Command Line Utilities. • See Control Center documentation • See Command Line Utilities documentation Deploying web application files from Control Center in an open environment If you have installed Framework and StreamServer on the same computer as StreamStudio, you can use Control Center to deploy StreamStudio to the Java application server. For more information, see Control Center documentation. Deploying the web application files to an isolated environment A common production scenario is that StreamStudio is installed on a computer without other StreamServe components. In this scenario, you can still configure the StreamStudio environment in Control Center. Then you can manually copy the StreamStudio files to the computer where the Java application server is installed. For more information, see Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 61 62 Deploying the web applications Installing StreamStudio on UNIX OpenText™ StreamServe 5.6.2 Installation Guide Rev D 63 Installing OpenDS You can install OpenDS and use a set of demo users to test or demonstrate StreamStudio. Note: We do not recommended using OpenDS in a production environment, if possible use Microsoft® Active Directory®. Prerequisites • For information about the prerequisites for OpenDS, see https://opends.java.net/ • If you want to load the demo users during the OpenDS setup, you must install one of the following components before you install OpenDS: – Framework and StreamServer – Control Center To load StreamServe demo users during the OpenDS setup Specify the following options during the setup: • Directory Base DN – specify dc=streamserve,dc=com which is the domain name the LDIF file is based on. • Directory Data – specify to import data from LDF file and browse to <StreamServe installation>\Platform\Core\<version>\etc\ strsdefaultusers.ldif • Optionally, select to run OpenDS as a Windows service. To install OpenDS Download and install OpenDS from https://opends.java.net/ To login to StreamStudio as a demo user If you have imported the strsdefaultusers.ldif file to your directory server, you can login with the following users: User name: strsAdmin Password: insecure User name: strsReader Password: insecure Note: Before you can log in to StreamStudio, you must make the preparations required to run the StreamStudio web applications and restart the Java application server. For more information, see StreamServe web application configurations in the Control Center documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 64 Installing OpenDS OpenText™ StreamServe 5.6.2 Installation Guide Rev D 65 Installing StreamServe Port Monitor and Print Processor This section describes: • How to install Print Processor and StreamServe Port Monitor • How to add a printer for Port Monitor • How to configure StreamServer applications for AS/400 environments Print Processor Print Processor converts documents from Windows applications into LXF (StreamServe Layout eXchange Format) files. You can then send these files to StreamServer applications via a StreamServe input connector. For more information, see StreamServe Print Processor in the Print Processor documentation. StreamServe Port Monitor Port Monitor responds to requests from the Windows spool system and writes data to files or sends data to an FTP server. Port Monitor ensures that all files delivered to the StreamServer application from the data source have unique file names. The file extension used is *.dsi. Port Monitor also functions as a logical printer in Windows environments. Using Port Monitor ensures that you can access StreamServe as a logical printer with an IP address and that the data source can direct its output to the IP address. This is the usual way of handling output, for example, from AS/400 systems to StreamServer applications. Configuring a StreamServer application for IBM AS/400 To use a StreamServer application to process output from an AS/400 environment, you must configure the AS/400 for the StreamServer application. For information, see StreamServer applications and AS/400 environments on page 70. In this section • Installing Print Processor and Port Monitor on page 66 • Creating a printer for Port Monitor on page 67 • StreamServer applications and AS/400 environments on page 70 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 66 Installing Print Processor and Port Monitor Installing StreamServe Port Monitor and Print Processor Installing Print Processor and Port Monitor The Port Monitor and Print Processor Setup is available on OpenText Knowledge Center. It includes two separate components. During the installation, you select which of the components you want to install: Component Description Port Monitor Installs Port Monitor, which enables you to use the Microsoft Windows spool system to send data in RAW format to a StreamServer application. Print Processor Installs Print Processor, which includes a printer called LXF Writer with a print processor called StrsPrint. The Print Processor only runs on Windows. User requirements You must have administrator rights to install Port Monitor and Print Processor. Third-party software included If not already installed, Microsoft Visual C++ Redistributable is installed with the Setup. To install Print Processor and Port Monitor 1 Double-click the setup.exe file to open the OpenText StreamServe Port Monitor and Print Processor Setup. 2 Follow the Setup wizard, which guides you through the installation. Configuring the Print Processor after the installation You configure the options for the Print Processor using the StreamServe Print Processor configuration utility. See Configuring the Print Processor in the Print Processor documentation. Creating a printer for Port Monitor After the installation, you must create a printer for Port Monitor, see Creating a printer for Port Monitor on page 67. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Creating a printer for Port Monitor Installing StreamServe Port Monitor and Print Processor Creating a printer for Port Monitor You use the Windows Add Printer Wizard to create a local printer with a port of StreamServe type. You do not have to set this printer as the default printer. Note: The steps required to set up a printer differ slightly in each version of Windows. To create a printer and printer queue for Port Monitor 1 Start the Add Printer Wizard. 2 Click Add a local printer. Note: On some versions of Windows, you must deselect Automatically detect and install my Plug and Play printer. 3 Click Create a new port, on the Type of port list, click StreamServe, and then click Next. Note: The StreamServe port type is only available when you have installed Port Monitor. 4 Enter the port definition settings and click OK. Port Definition settings Port name A unique name for the port. Output type File – Sends output to a file. Named pipe – Sends output via a named pipe. FTP – Sends output via FTP. Destination: path/ named pipe/address The destination path, pipe or address where the output is created. If Output Type is File, this is the directory from which the StreamServe input connector retrieves data. The path must be an absolute path and the directory must already exist. File example: C:\Program Files\StreamServe\Applications\StreamServer\<v ersion>\spool Named pipe destination syntax: \\.\pipe\<pipe_name> FTP destination syntax: <IP_address>\<FTP_directory> <Host_name>\<FTP_directory> String to send at start Adds a string to the start of the file. String to send at end Adds a string to the end of the file. Add owner to filename created Adds the owner name to the filename. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 67 68 Creating a printer for Port Monitor Installing StreamServe Port Monitor and Print Processor Port Definition settings Add document name to the filename created Adds the document name to the filename. Add printer to filename created Adds the printer name to the filename. Replacement for non valid characters in filename Removes invalid characters from the file names, or substitutes the invalid characters with another character. Note: You cannot add the document name to send output via FTP. To remove invalid characters from the file names, leave this empty or enter 0. To substitute invalid characters with another character, enter the hex value of the character you want to use in place of the invalid characters. FTP FTPS (FTP over SSL) – Select to send the file using FTPS implicit protocol. Verify host – Select to validate the server certificate on the FTP server. User name – User name to log on to the destination FTP server. Password – Password to log on to the destination FTP server. Final destination directory – The directory where the file is moved to (i.e. the StreamServe scanning directory). This directory must already exist. This parameter is optional, it only needs to be specified if the destination is different to what is specified using the parameter Destination: path/named pipe/address. 5 Select the Manufacturer and Printer, and click Next. Install Print Software settings 6 Manufacturer Select Generic. Printers Select Generic/Text only. Enter a name for the printer and click Next. Name Your Printer settings Printer name Enter a name for the printer. The printer is installed. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Creating a printer for Port Monitor Installing StreamServe Port Monitor and Print Processor 7 Enter the sharing settings and click Next. Share printer settings Shared as Enter a share name for the printer. For output from AS/400, the name of the shared resource must correspond to the name of the AS/400 remote output queue. For AS/400, uppercase letters should be used for the name. Location and Comment 8 These parameters are optional. Click Next and Finish to finish creating the printer port. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 69 70 StreamServer applications and AS/400 environments Installing StreamServe Port Monitor and Print Processor StreamServer applications and AS/400 environments The OS/400 operating system you are using to run StreamServer applications must have a level that supports TCP/IP. The minimum level is 3.2. To configure the StreamServer application for an AS/400 environment you must: • Create a text driver for the AS/400 output queue. Output sent to the StreamServer application must not contain control codes from HP printer driver source code. These codes might affect the operation of the StreamServer application. To avoid problems caused by control characters in the data stream, you must remove all control codes from the HP printer driver source code that might affect the operation of the StreamServer application. You do this by creating a text driver for use with the AS/400 output queue to the StreamServer application. • Create a remote output queue to the StreamServer application. On the AS/400 platform, you must create a remote output queue to the StreamServer application. This output queue uses the text driver to create pure text files. When you print to this output queue from your AS/400 application, the spool file is sent via TCP/IP to the computer where you have installed Port Monitor. • Configure Port Monitor on the Windows system. On the computer where you installed Port Monitor, you must configure the Port Monitor to have the same name as the AS/400 output queue to the StreamServer application. Port Monitor receives the spool file and saves it in a directory on the computer. To enable output to Port Monitor, you must define Port Monitor as a local printer and as a shared resource. The name of the shared resource must correspond to the name of the remote print queue in AS/400. You must use UPPERCASE letters for the printer name. See Creating a printer for Port Monitor on page 67. On the Windows computer, you must ensure the TCP/IP print server service is running. The default port for LPR is 515. For details on how to configure the AS/400 environment, see the AS/400 documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 71 Removing StreamServe Windows components You can remove the following components from Windows Control Panel: • Framework and StreamServer • Control Center • Design Center • StreamStudio web applications • Database Administration Tool Upgrading For information about upgrading from previous versions of StreamServe, see StreamServe Upgrading Instructions documentation. About removing StreamServe components Windows services Windows services for StreamServe applications are removed when you remove Framework and StreamServer. Design Center Projects Design Center Projects are not deleted when you remove Design Center. StreamServe repositories The StreamServe repositories are not deleted when you remove StreamServe software. You must use an external tool if you want to delete the StreamServe repositories. Removing StreamServe components from Windows Control Panel 1 From Windows Control Panel, open Programs and Features. 2 Select the program to remove and then click Uninstall. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 72 Removing StreamServe Windows components OpenText™ StreamServe 5.6.2 Installation Guide Rev D 73 Running parallel StreamServe versions You can run StreamServe 5.6.2 core components in parallel with the following StreamServe versions on both UNIX and Windows: • OpenText StreamServe 5.6.1 • OpenText StreamServe 5.6 • StreamServe Persuasion SP5 Hotfix 1684 (or later) It is possible to run all four versions in parallel – StreamServe 5.6.2, StreamServe 5.6.1, StreamServe 5.6, and Persuasion SP5 Hotfix 1684 (or later). The StreamServe core components include the following: • Applications based on the StreamServe framework (StreamServer, Archiver, Task Scheduler, and service gateway) • Management gateway • Design and administration tools, such as Design Center and Control Center You cannot run several versions of the StreamServe web applications in parallel. Database server supported for all versions You must ensure that the database server is supported for all the StreamServe versions you want to run. For information about the supported databases, see the Supported Platforms and Software documentation for each version. StreamServe SP5 and prior versions To run StreamServe 5.6.2 in parallel with releases previous to Persuasion SP5, you must first upgrade the installations to SP5 and apply Hotfix 1684. Separate versions of Control Center and the management gateway When you run 5.6.2 and previous versions in parallel, the environments are managed separately: • The 5.6.2 StreamServe applications are managed by the 5.6.2 versions of Control Center and the management gateway. • The 5.6.1 StreamServe applications are managed by the 5.6.1 versions of Control Center and the management gateway. • The 5.6 StreamServe applications are managed by the 5.6 versions of Control Center and the management gateway. • The SP5 StreamServe applications are managed by the SP5 versions of Control Center and the management gateway. Separate management gateway ports and directories are automatically used for each version. Shared or separate enterprise repositories Both the 5.6.2 environment and the environment for the previous version(s) can share the same 5.6.2 StreamServe Enterprise Repository. You can also set up separate enterprise repositories for each version. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 74 Installing StreamServe 5.6.2 in parallel with previous versions Running parallel StreamServe versions Installing StreamServe 5.6.2 in parallel with previous versions This section describes how to install and start running StreamServe 5.6.2 in parallel with a previous StreamServe version. Running in parallel with SP5 If you run SP5, the steps in this section assume you have installed hotfix 1684 and applied the hotfix to the enterprise repository (via Apply hotfix in Control Center). To install StreamServe 5.6.2 in parallel with a previous version 1 Close all StreamServe software and stop all StreamServe applications. 2 Install the StreamServe 5.6.2 components on the computer. 3 Open the 5.6.2 version of Control Center. 4 In the Welcome to Control Center dialog box, review the information, and click OK. 5 In the Change Password dialog box, change the password for the Management Gateway Administrator, and click OK. 6 In the Enterprise Repository Configuration dialog box, verify that the settings are correct to connect to the existing 5.6.1, 5.6 or SP5 enterprise repository. The management gateway for 5.6.2 connects to the existing enterprise repository. You can see the application domains from the previous StreamServe versions, but cannot manage them. To run StreamServe 5.6.2 and the previous versions You can now set up your application domains and applications for 5.6.2, and start running your StreamServe 5.6.2 environment. To manage the StreamServe applications from previous versions, you must use a Control Center installation of the same version. Related topics For information about migrating the SP5, 5.6, and 5.6.1 environments to 5.6.2, see the Transport and migration documentation. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 75 Installing and applying StreamServe hotfixes This document describes how to install and apply hotfixes on OpenText StreamServe. Installing a hotfix means that files in the OpenText StreamServe installation folder and the Management Gateway base directory are replaced. If the hotfix includes database changes, you must also apply the hotfix to the StreamServe repositories. If the hotfix includes changes to the web application archive (WAR) files, you must redeploy the WAR files to the Java application server. Hotfix documentation For information about the bug fixes related to a hotfix, see the hotfix documentation. In this section • About StreamServe hotfixes on page 76 • Installing a StreamServe hotfix on page 77 • Applying the hotfix to StreamServe repositories on page 79 • Applying the hotfix to StreamServe web applications on page 86 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 76 About StreamServe hotfixes Installing and applying StreamServe hotfixes About StreamServe hotfixes Each hotfix incorporates all previously released bug fixes for a specific OpenText StreamServe release. You must install all hotfixes included in the hotfix package, that is you cannot install specific fixes only. All hotfixes for a specific release will be included in the next service pack for this release. Each hotfix is made available for all applicable platforms. Hotfixes are distributed by OpenText Customer Support. The Customer Support team keeps track of all hotfixes distributed, and will provide any additional information you may need to apply the hotfix. Hotfix build number Each hotfix is identified by the release to which it is applicable and a build number, for example 5.6.2 Hotfix Build nnn. The build number is a unique number used internally by OpenText to identify specific hotfixes and releases. Any time you refer to a specific hotfix, you should use the release name and the build number to avoid any misunderstandings. The latest hotfix for a specific release is always the one with the highest build number. Build numbers are neither related to the number of hotfixes built, nor to the hotfix contents. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Installing a StreamServe hotfix Installing and applying StreamServe hotfixes Installing a StreamServe hotfix In this section • Keeping customizations on page 77 • Preparing an encrypted environment on page 77 • Installing a StreamServe hotfix on Windows on page 78 • Installing a StreamServe hotfix on UNIX on page 78 Keeping customizations If you have done customizations directly in any StreamServe configuration files, these files might be overwritten when the hotfix is installed. Windows To keep your customizations, you must make backups of the files and store them in a place where they cannot be overwritten. When you have installed the hotfix, you can compare the old files with the new files and manually restore your customizations to the new files. For a complete list of the files that are not overwritten when applying a hotfix, see Appendix A - Preserved files on Windows on page 91. UNIX If you use the same Management Gateway root when you apply the hotfix, any customizations made to the configuration files are automatically identified. For each identified customization, a comment is issued and a copy of the old file is stored. You can then compare the old file with the new file and manually restore your customizations to the new file. Related topics • For information about how to keep any customizations made to deployed and unpacked WAR files, see Keeping customized files on page 89. Preparing an encrypted environment An encrypted system environment must be decrypted before the hotfix installation. After the hotfix installation, the StreamServe installation can be reencrypted again. For information about decrypting and encrypting StreamServe installations, see OpenText StreamServe Security User Guide. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 77 78 Installing a StreamServe hotfix Installing and applying StreamServe hotfixes Installing a StreamServe hotfix on Windows 1 Close all StreamServe programs. 2 Open the Hotfix Setup wizard by double-clicking the EXE file. For example, 5.6.2_Hotfix_YYYY-MM-DD_Build_nnn.exe Where nnn is the hotfix build number. 3 Follow the instructions in the wizard. Installing a StreamServe hotfix on UNIX Prerequisites • The hotfix files must be unpacked before the installation. For more information, see the Extracting the StreamServe setup files on page 56. To install a StreamServe hotfix on UNIX 1 Stop all StreamServe services: cd streamserve-5.6.2.GA.xxx ./shutdown all Where xxx is the build number of the previous installation. 2 Copy the.operatorInput file from the previous installation. This file contains values, specified in the OpenText StreamServe Setup, that are preselected when the hotfix is installed. cd streamserve-5.6.2.GA.nnn cp ../streamserve-5.6.2.GA.xxx/.operatorInput ./ Where: 3 • nnn is the hotfix build number. • xxx is the build number of the previous installation. Install the hotfix: ./setup_upgrade If you use the same Management Gateway root, the setup automatically copies the file http_listener.access from the previous installation. Related topics • For information about how to install SAP Connectivity Pack components on UNIX, see OpenText StreamServe Connect for SAP Installation Guide. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Applying the hotfix to StreamServe repositories In this section • Applying the hotfix in Control Center on page 79 • Applying the hotfix without Control Center on page 81 • Applying the hotfix manually (DBAT not available) on page 84 Applying the hotfix in Control Center In Control Center, you can list all repositories belonging to a site, together with their current schema versions and the latest available hotfixes. This gives you an overview of the current statuses and helps you decide whether the repositories need to be upgraded. If an upgrade is needed, you can apply the latest available database hotfixes to the repositories directly in Control Center. Prerequisites • The login details for the database administration user that you originally used to create the repository must be available. • The Hotfix Setup has been run and the database hotfixes are installed in the Management Gateway base directory: <Base directory>\<Version>\root\config\database\ Where <Base directory> is the path specified for StreamServe Projects during the Framework and StreamServer installation. For example: C:\ManagementGateway Preparations and recommendations Before applying the hotfix to a repository, we recommend the following: • Make sure that no other users are connected to the repository. If possible, set the repository to single user mode. • Stop all applications accessing the repository. • For the runtime repository: Make sure that all jobs running against the repository are completed. • Perform a backup of the repository. Always read the hotfix documentation for additional preparations for a specific hotfix. In this section • Listing schema versions and applied database hotfixes on page 80 • Applying the hotfix to a repository in Control Center on page 80 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 79 80 Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Listing schema versions and applied database hotfixes 1 Open Control Center and connect to the site. 2 Right-click the site node and select Available Database Hotfixes. 3 In the Available Database Hotfixes dialog box: • Click Get List (if the dialog box is opened for the first time). • Click Update List (if the dialog box was previously opened). 4 In the Connect dialog box, enter the user name and password for the database administration user and click OK. 5 In the Available hotfixes area, review the information about the repositories, current schema versions, and the latest available database hotfixes. See also the log displayed in the Result log area. 6 Click Close to close the dialog box. Applying the hotfix to a repository in Control Center 1 In Control Center, right-click the node for the repository and select Create Database. The following nodes are available: • StreamServe Enterprise Repository – The <Site> node. • Runtime repository – The <Application domain> node. • Web content repository – The <Application domain> node. • Document Broker Plus repository – The <Document Broker repository> folder in the Repositories node. • Collector archive – The <Collector archive> folder in the Repositories node. • Statistics repository – The <Statistics repository> folder in the Repositories node. 2 In the Create Database dialog box, in the Operation area, select Apply hotfix. 3 Select the repository from the drop-down list. 4 Click Start to apply the latest available database hotfix in the base directory. 5 In the Connect dialog box, enter the user name and password for the database administration user and click OK. The database hotfix is applied to the repository. A short version of the log is displayed in the Result log area. Note: To view the full log in the default text editor, click Open Log File. 6 Click Close to close the dialog box. 7 Repeat for any other repositories that need to be upgraded. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Applying the hotfix without Control Center If Control Center is not available, you use StreamServe Database Administration Tool (DBAT) to apply hotfixes to the StreamServe repositories. You start DBAT from a command line by running a hotfix-repo script file. Prerequisites • The login details for the database administration user that you originally used to create the repository must be available. • The Hotfix Setup has been run and the database hotfixes are installed in: – Windows – <Base directory>\<Version>\root\config\database\ Where <Base directory> is the path specified for Design Center Projects during the Framework and StreamServer installation. For example: C:\ManagementGateway – UNIX – <Project location>/config/database/ Where <Project location> is the Project location specified during the Framework and StreamServer installation. For example: /opt/streamserve/root Preparations and recommendations Before applying the hotfix to a repository, we recommend the following: • Make sure that no other users are connected to the repository. If possible, set the repository to single user mode. • Stop all applications accessing the repository. • For the runtime repository: Make sure that all jobs running against the repository are completed. • Perform a backup of the repository. • For UNIX, you must manually set STRS_JAVA_HOME to a suitable JRE (only if the OpenText StreamServe Setup has not been run previously). Always read the hotfix documentation for additional preparations for a specific hotfix. In this section • Applying the hotfix to a repository without Control Center on page 82 OpenText™ StreamServe 5.6.2 Installation Guide Rev D 81 82 Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Applying the hotfix to a repository without Control Center To apply a hotfix, you run the hotfix-repo script file using the following syntax: hotfix-repo.<Extension> -s <Script root> -r <Repository name> -t <Path to connection file> -u <User name> -p <Password> See Example 6 on page 83 and Example 7 on page 83. Location of the hotfix-repo script file • Windows: <StreamServe_install>\Applications\Management\<Version>\bin\ hotfix-repo.bat • UNIX: .../streamserve-<Version>.GA.<build>/applications/ managementgateway/bin/hotfix-repo.sh Parameters -s <arg> Path to the directory with the scripts: Windows – <Base directory>\<Version>\root\config\database UNIX – <Project location>/config/database -r <arg> The type of the repository, this must be one of: • StrsSERModel – Enterprise repository • StrsDataModel – Runtime repository • StrsDocBrokerPlusModel – Document Broker Plus repository • StrsArchive – Collector repository • StrsDesign – Web content repository • StrsStatisticsModel – Statistics repository -t <arg> Runtime repository and web content repository Path to the territory.xml file. This can be the territory.xml file for any StreamServe application in same the application domain as the repository. You can create the territory.xml file in Control Center by extracting the settings for the application domain that you want to apply the hotfix to. To do this, right-click the application domain and select Extract Domain Settings. Document Broker Plus repository and statistics repository Path to the connection file: <Base directory>\<Version>\root\applications\<Service Gateway>\wd\securityprofiles\<Repository>-<GUID>securityprofile.xml Collector archive Path to the connection file: <Base directory>\<Version>\root\applications\<Archiver>\ wd\securityprofiles\<Archive>-<GUID>-securityprofile.xml OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes -u <arg> User name to access the repository. -p <arg> Password for the user. Example 6 Windows – Applying a database hotfix to the runtime repository hotfix-repo.bat -s "<Base directory>\<Version>\root\config\ database" -r StrsDataModel -t territory.xml -u sa -p password Example 7 UNIX – Applying a database hotfix to the runtime repository hotfix-repo.sh -s "<Project location>/config/database" -r StrsDataModel -t territory.xml -u sa -p password OpenText™ StreamServe 5.6.2 Installation Guide Rev D 83 84 Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Applying the hotfix manually (DBAT not available) We recommend that you apply a hotfix to the StreamServe repositories using Control Center or by running the hotfix_repo script in DBAT as described in: • Applying the hotfix in Control Center on page 79 • Applying the hotfix without Control Center on page 81 If neither Control Center, nor DBAT are available, you can apply the hotfix to the repositories manually. Prerequisites • The login details for the database administration user that you originally used to create the repository must be available. • The Hotfix Setup has been run and the database hotfixes are installed in: – Windows – <Base directory>\<Version>\root\config\database\ Where <Base directory> is the path specified for Design Center Projects during the Framework and StreamServer installation. For example: C:\ManagementGateway – UNIX – <Project location>/config/database/ Where <Project location> is the Project location specified during the Framework and StreamServer installation. For example: /opt/streamserve/root Preparations and recommendations Before applying the hotfix to a repository, we recommend the following: • Make sure that no other users are connected to the repository. If possible, set the repository to single user mode. • Stop all applications accessing the repository. • For the runtime repository: Make sure that all jobs running against the repository are completed. • Perform a backup of the repository. • For UNIX, you must manually set STRS_JAVA_HOME to a suitable JRE (only if the OpenText StreamServe Setup has not been run previously). Always read the hotfix documentation for additional preparations for a specific hotfix. In this section • Applying a hotfix to a repository manually on page 85 OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe repositories Installing and applying StreamServe hotfixes Applying a hotfix to a repository manually To apply a hotfix manually 1 Find the DBAT model file with the next revision corresponding to your present database schema version in the following directory: – Windows – <Base directory>\<Version>\root\config\database\ – UNIX – <Project location>/config/database/ 2 Open the DBAT model file and run all the scripts that are referenced inside. 3 Repeat steps 1 to 2 for the next DBAT model file, and continue until there is no more model files for your database version. Post requisites You must now deploy the updated routines to all <File name>.sql files. For Microsoft SQL Server and Oracle Database, you use standard procedures. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 85 86 Applying the hotfix to StreamServe web applications Installing and applying StreamServe hotfixes Applying the hotfix to StreamServe web applications When you install a hotfix, the web application archive (WAR) files in the StreamServe installation directory are updated. To apply the hotfix to the web applications, you must redeploy the WAR files to the Java application server. This section describes how to redeploy WAR files in Control Center. As an alternative to Control Center, you can manually replace the updated template WAR files in the portal root on the Java application server. You must then make sure the files with connection information (added by the management gateway at Control Center redeployment) are available in the unpacked application folders. For example, by manually copying the files from backups of the application folders for the previous installation. For information about template WAR files and files with connection information, see Files and folders on page 87. Prerequisites • The Hotfix Setup has been run, resulting in updated template WAR files installed in the StreamServe installation directory. • Backups of the unpacked application folders (including all sub-folders) in the portal root are taken. The backups are stored in a place where they cannot be overwritten (that is, not in the portal root). • Preparations to preserve any customized configuration files have been performed. See Keeping customized files on page 89. Post requisites • If required, restore customized configuration files from the backups. • If you use shortcuts to access the web applications and change the web application names, you must update the URLs in the shortcuts. In this section • Files and folders on page 87 • Keeping customized files on page 89 • Redeploying web applications in Control Center on page 89 Related topics • For general information about deploying StreamServe web applications, see OpenText StreamServe Control Center User Guide. • For information about deploying the software component packages (*.SCA) for StreamServe web applications on SAP NetWeaver, see OpenText StreamServe Web applications on SAP NetWeaver Application Server Installation Instructions. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe web applications Installing and applying StreamServe hotfixes Files and folders Template WAR files When you run a Hotfix Setup, the template WAR files below are automatically updated in the StreamServe installation directory. Windows: Web application Template WAR files updated by the Hotfix Setup StreamStudio <StreamServe Inst>\Applications\Management\ <Version>\etc\Portals\<Version>\ applications-5.6.2.GA.nnn.war Where nnn is the hotfix build number. SSSP <StreamServe Inst>\Applications\Management\ <Version>\etc\Web\<Version>\sssp.war Ad Hoc <StreamServe Inst>\Applications\Management\ <Version>\etc\Web\<Version>\adhoc.war Reviewer <StreamServe Inst>\Applications\Management\ <Version>\etc\Web\<Version>\reviewer.war DBQ Tool <StreamServe Inst>\Applications\Management\ <Version>\etc\Web\<Version>\dbq.war UNIX: Web application Template WAR files updated by the Hotfix Setup StreamStudio <StreamServe Inst>/applications/ managementgateway/etc/portals/<Version>/ applications-5.6.2.GA.nnn.war Where nnn is the hotfix build number. SSSP <StreamServe Inst>/applications/ managementgateway/etc/web/<Version>/sssp.war Ad Hoc <StreamServe Inst>/applications/ managementgateway/etc/web/<Version>/adhoc.war Reviewer <StreamServe Inst>/applications/ managementgateway/etc/web/<Version>/reviewer.war DBQ Tool <StreamServe Inst>/applications/ managementgateway/etc/web/<Version>/dbq.war Related topics For information about the dependencies between the WAR files, see: • OpenText StreamServe StreamStudio Administrator’s Guide • OpenText StreamServe Ad Hoc Correspondence and Correspondence Reviewer Administrator’s Guide • OpenText StreamServe Document Broker Plus User Guide OpenText™ StreamServe 5.6.2 Installation Guide Rev D 87 88 Applying the hotfix to StreamServe web applications Installing and applying StreamServe hotfixes Files with connection information When you deploy WAR files in Control Center, the management gateway adds the files with connection information below to the unpacked application folders. If you redeploy the WAR files manually, without using Control Center, you must make sure the files below are available in the unpacked application folders. For example, by manually copying the files from backups of the application folders for the previous installation. In the path examples below, Windows syntax is used. Corresponding paths are used on UNIX. <Name> is the web application name assigned in Control Center. Web application StreamStudio Files with connection information <Portal root>\<Name>\domains\<AppDomain>.xml <Name>\security profiles\<AppDomain>\ (if there are any files in this directory) SSSP <Portal root>\sssp\domains\<AppDomain>.xml sssp\security profiles\<AppDomain>\ (if there are any files in this directory) Ad Hoc <Portal root>\<Name>_adhoc\WEB-INF\spring\ properties\webportal.properties Reviewer <Portal root>\<Name>_reviewer\WEB-INF\spring\ properties\webportal.properties DBQ Tool <Portal root>\<Name>_dbq\WEB-INF\spring\ properties\webportal.properties OpenText™ StreamServe 5.6.2 Installation Guide Rev D Applying the hotfix to StreamServe web applications Installing and applying StreamServe hotfixes Keeping customized files When you redeploy WAR files to a Java application server, any customizations made to the current configuration files in the unpacked folders are lost. To keep customizations at redeployment, you can do one of the following: • Use the backups of the application folders related to the web applications (see Prerequisites on page 86) – after redeploying the WAR files, you can restore some of the files from the backups. • Use an external directory outside the portal root for the configuration files. See OpenText StreamServe Control Center User Guide > StreamServe web application configurations > Keeping customized configuration files. Note: Not all configuration files are stored in the external directory. See the referenced documentation above for a list of concerned files. When you use an external directory, the configuration files in this directory are preserved when you redeploy a web application. This means that if the configuration files are updated in the hotfix, and you want these updates to be available to the web application, you must manually delete the files in the external directory before the application is started. For example, if you rename the Ad Hoc application, you must delete the webportal.properties files for the Reviewer application before the Reviewer application is re-opened in the web browser. Redeploying web applications in Control Center Redeploying a web application to an open environment (managed deploy) 1 Stop the Java application server. 2 Delete the WAR file(s) and the corresponding application folder(s) from the portal root on the Java application server. 3 Restart the Java application server. 4 In Control Center, expand the Web Applications node. 5 Right-click the <Web application> and select Update Domain Information to deploy the WAR file(s). 6 If a Control Center message about the paths to the <Portal root>\<Name>\WEB-INF\spring folder(s) not being accessible, click OK. 7 Wait until the folder(s) are properly unpacked by the Java application server, resulting in an application folder for each web application. Note: Unpacking WAR files is time consuming. 8 Right-click the <Web application> and select Update Domain Information again to update the connection information. 9 Verify that the files with connection information are available in the application folder(s). See Files with connection information on page 88. OpenText™ StreamServe 5.6.2 Installation Guide Rev D 89 90 Applying the hotfix to StreamServe web applications Installing and applying StreamServe hotfixes Redeploying a web application to an isolated environment (unmanaged deploy) To redeploy a web application to an isolated environment 1 In Control Center, expand the Web Applications node. 2 Right-click the <Web application> and select Update Domain Information. 3 In the Control Center message, click Yes to redeploy the WAR file(s). The WAR file(s) and the corresponding application folder(s) are replaced in the manual deploy path: <Base Directory>\<Version>\root\etc\unmanagedportals You must now replace the existing WAR file(s) and application folder(s) on the Java application server with the ones from the manual deploy path. To replace WAR files and folders on Apache Tomcat The procedure below applies for Apache Tomcat. 1 Stop the Java application server. 2 Delete the WAR file(s) and the corresponding application folder(s) from the portal root on the Java application server. 3 Restart the Java application server. 4 Copy the WAR file(s) from the manual deploy path and paste the file(s) into the portal root on the Java application server. 5 Make sure that the WAR file(s) from the hotfix are unpacked by the Java application server, resulting in an unpacked application folder for each web application. 6 Copy the application folder(s) from the manual deploy path and paste (merge) the folder(s) into the portal root on the Java application server. 7 Verify that the files with connection information are available in the application folder(s). See Files with connection information on page 88. OpenText™ StreamServe 5.6.2 Installation Guide Rev D Appendix A - Preserved files on Windows Installing and applying StreamServe hotfixes Appendix A - Preserved files on Windows This chapter lists the files that are preserved (that is, that are not overwritten) when installing and applying hotfixes on OpenText StreamServe. Customizations made in any configuration files not mentioned in this section will be overwritten when a hotfix is installed. In this section • Preserved files in the base directory on page 91 • Preserved files in the installation directory on page 91 Related topics For general information about editing configuration files, see OpenText StreamServe Performance Guidelines, available on OpenText Knowledge Center. Preserved files in the base directory The paths below are specified relative to <Base directory>, which is the path specified for StreamServe Projects during the Framework and Control Center installation. For example: C:\ManagementGateway\ • <Base directory>\<Version>\root\iomanager.xml • <Base directory>\<Version>\root\logmanager.xml • <Base directory>\<Version>\root\parameters.xml • <Base directory>\<Version>\root\securityprofiles\ defaulttrustedcertificateauthorityprofiles.xml • <Base directory>\<Version>\root\securityprofiles\ enterpriserepository.xml Preserved files in the installation directory The paths below are specified relative to <StreamServe installation>, which is the path for the StreamServe installation. For example, C:\Program Files\OpenText\StreamServe • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSTS\iomanager.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSCI\iomanager.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSCS\iomanager.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSSG\iomanager.xml • <StreamServe installation>\Applications\StreamServer\ <Version>\Common\bin\iomanager.xml • <StreamServe installation>\Applications\StreamServer\ <Version>\Common\bin\logmanager.xml OpenText™ StreamServe 5.6.2 Installation Guide Rev D 91 92 Appendix A - Preserved files on Windows Installing and applying StreamServe hotfixes • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSSG\threadmanager.xml • <StreamServe installation>\Platform\Core\<Version> \bin\mgw-threadmanager.xml • <StreamServe installation>\Applications\Service Gateway\ <Version>\bin\semper.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\common\logmanager.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSSG\logmanager.xml • <StreamServe installation>\Platform\Core\<Version>\bin\ socketprotocoldriver.1.0.xml • <StreamServe installation>\Platform\Core\<Version>\bin\ socketprotocoldrivermovex.1.0.xml • <StreamServe installation>\Applications\Management\<Version> \etc\config\<Version>\STRSTS\securityprofiles\maintenance.xml • <StreamServe installation>\Applications\StreamServer\ <Version>\Common\OnlineHelp\*.xml (recursive) OpenText™ StreamServe 5.6.2 Installation Guide Rev D