MyProduct. Version N.n

Transcription

1 I N S T A L L A T I O N G U I D E MyProduct Version N.n 8 April 2016

2 Copyright 2016 Axway All rights reserved. This documentation describes the following Axway software: Axway MyProduct N.n No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway. This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway does not warrant that this document is error free. Axway recognizes the rights of the holders of all trademarks used in its publications. The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site. Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.

3 Contents Preface 7 Who should read this guide 7 How to use this guide 7 [Install Guide - About this guide] 8 [Who should read this guide] 8 MyProduct documentation set 9 [Install Guide - Related docs] 9 Support services 10 Training services 10 Accessibility 11 Product accessibility 11 Keyboard shortcuts 11 Screen reader support 12 Documentation accessibility 12 Screen reader support 12 Support for high contrast and accessible use of colors 13 1 Introduction 14 About MyProduct 14 Installation outline 14 2 Quick start 15 Prerequisites 15 Software and license keys 15 Start installation 16 Prerequisites 16 Installation package contents 17 Start the Installer 18 Installation parameters 18 Verify the installation 22 Start and stop MyProduct 22 Log into the administrative or client interface 23 Check log files 25 3 Plan the deployment 26 Axway 5 Suite reference solutions and interoperation 26 Platforms 27 Client considerations 27 Axway MyProduct N.n Installation Guide 3

4 Flash Player 27 Cluster considerations 27 Planning process 28 Cluster architecture 28 Connection to other products 28 Default ports 29 Administration 30 MyProduct <parts> 32 4 Prerequisites 33 Hardware 33 Disk space and RAM requirements 34 Screen resolution 35 Java 35 All platforms 35 UNIX-based platforms 35 UNIX user for starting the products 36 Umask information 36 libstdc++.so information 36 Red Hat 6 platform 36 Mounting a shared disk 37 Global environment on a UNIX machine 37 Using a temporary directory 37 Windows platforms 37 Windows UAC 38 Windows firewall 38 Windows itanium installation 38 Windows Server Core 39 Using a temporary directory 39 Other platforms 39 Software and license keys 39 Check your authorization 40 Cluster installations 40 Certificates 40 5 Install 42 Installation modes 42 Start installation 43 Prerequisites 43 Installation package contents 43 Start the Installer 44 Installation parameters 44 Axway MyProduct N.n Installation Guide 4

5 6 Post-installation 49 Verify the installation 49 Start and stop MyProduct 49 Verify connections 50 Log into the administrative or client interface 50 Check log files 52 Initial configuration 52 Secure MyProduct 52 Change default passwords 52 Change default certificates 53 Set up services 53 Set up services on UNIX-based platforms 53 Set up Windows services 53 Set up the cluster manager 53 Next steps 54 7 Update MyProduct 55 Prerequisites 55 Installing updates in an interactive mode 55 Installing updates in a non-interactive mode 56 8 Configure an existing MyProduct installation 57 Windows installations 57 Services modification 57 Procedure 58 GUI mode 58 Console mode 58 9 Upgrade 59 Overview of upgrade procedure 59 Before upgrading 60 Upgrade sequence 60 Prerequisites 60 Software and license keys 60 Installer and Java upgrade 60 Upgrade Java 61 Upgrade Installer 64 Start upgrade Migration 66 Tools Uninstall 67 Prerequisites 67 Axway MyProduct N.n Installation Guide 5

6 Start uninstallation 67 Windows installations 67 Procedure 68 Remove updates 68 Remove updates in GUI mode 68 Remove updates in console mode Troubleshooting 70 Installation 70 Installer known issues 70 MyProduct 71 Upgrade 72 MyProduct 72 Post-installation 72 Appendix A: Worksheet 73 Example worksheet 73 Appendix B: Reference 77 Installer 77 About the Installer 77 Installer modes 77 Installer functions 77 Display command 79 Installed directories 79 Installer scripts 79 Cluster installations 82 Install first node in cluster 82 Install additional nodes in cluster 82 Cluster configurations 83 Silent mode installation 84 Using silent mode 84 Silent File concepts 86 Silent File Editor 88 Database-related silent file parameters 90 Axway MyProduct N.n Installation Guide 6

7 Preface This guide describes Axway MyProduct. It explains [...]. Who should read this guide [Describe the target audience. This is an example for an interop guide. Adapt the content for your doc.] This guide is intended for enterprise architects, other enterprise personnel, and Axway Professional Services personnel who are responsible for basic <product> to <product> configuration. Other technical or business users may find parts of this guide useful as well. [List any required qualifications, such as product expertise.] Familiarity with Axway 5 Suite products is recommended. How to use this guide [The following sentence is used in the Axway 5 Suite reference solution guides. Adapt it or delete as required.] The information in this guide is designed to be used in conjunction with, but does not replace, the product documentation. Before you begin [...], review this guide thoroughly. The following is a brief description of the contents of each chapter: [chapter name] Describes [...]. [chapter name] Describes [...]. [chapter name] Describes [...]. Glossary Contains a list of terms used in this guide and their definitions. [If you are updating an existing PDF doc: For a print output, you should add the following additional topics to the Preface section of your TOC:] MyProduct documentation set on page 9 Related documentation on page 1 Training services on page 10 Support services on page 10 Axway MyProduct N.n Installation Guide 7

8 Preface [Install Guide - About this guide] [This topic contains suggested content that you can use in the "About this guide/preface" topic in the Install Guide] Concept topic with an overview of installation using Axway Installer and installing MyProduct. This guide describes how to install MyProduct using the Axway Installer and how to upgrade MyProduct to the latest version. It also covers: Quick start installation Enables you to install quickly using standard settings. See Quick start on page 15. Preparing and planning your installation Describes what you should plan for deploying and configuring your system architecture, installing any prerequisite software, and configuring other components. Use the Example worksheet on page 73 while you plan. Installing Describes how to perform a complete install as well as apply a service pack using the Axway Installer. See Install on page 42. Post installation Provides instructions on how to check if the installation was successful and set up MyProduct before the administrator can log on to the product for initial configuration. See Postinstallation on page 49. Upgrade Involves a change in product version and the replacement of binary artifacts; may also require configuration change. More specifically, what are the results of the upgrade for your product. MyProduct upgrade information including how to upgrade the Axway Installer if need be. See Upgrade on page 59. Migration Involves a change in product versions, such as from 3.0 to 4.0. As part of this process, the existing configuration may need to be modified or updated to be compatible with the new version. For example, you may need to modify configuration files or the database schema. Because migration can be a complex process, organizations typically set up a migration project to study the new features and determine the impact on the existing configuration, and to plan for the changes across the various environments. See Migration on page 66. Uninstallation Describes how you can uninstall MyProduct using the Axway Installer. See Uninstall on page 67. Troubleshooting Describes the different types of troubleshooting errors you can encounter during installation, upgrade and post-installation. See Troubleshooting on page 70. [Who should read this guide] [This section contains suggested content that you can use in the "Who should read this guide" section in the Install Guide] This guide is intended for enterprise personnel involved in installing software and Axway Professional Services personnel. Familiarity with Axway 5 Suite products is recommended. Axway MyProduct N.n Installation Guide 8

9 Preface This guide presumes you have knowledge of: Your company s business processes and practices Your company s hardware, software, and IT policies The Internet, including use of a browser Others who may find parts of this guide useful include network or systems administrators and other technical or business users. MyProduct documentation set Go to Axway Sphere at to find all documentation for this product version. [Optionally list all the docs in your doc set. Remember that if you just point users to Sphere, for some products they might have to scroll through several pages of docs!] The MyProduct documentation set includes the following documents: Axway MyProduct Installation Guide Explains how to install MyProduct using the Axway Installer and how to upgrade MyProduct to the latest version. Axway MyProduct Administrator Guide Describes how to configure and start up MyProduct. Axway MyProduct Release Notes Provide up-to-date information related to new features included in this release and known limitations. [Any other docs] [...] [If your doc is portalized you can add a URL to your product home page. In this case you do not need to list the docs.] [Install Guide - Related docs] [Include at least these two docs in the Related documentation section of the Install Guide.] Axway 5 Suite Supported Platforms Lists the different operating systems, databases, browsers, and thick client platforms supported by each product in Axway 5 Suite. Axway 5 Suite Interoperability Matrix Provides product version and interoperability information for products used in an Axway 5 Suite reference solution. Axway MyProduct N.n Installation Guide 9

10 Preface [Include the Axway Database Administrator Guide if MyProduct requires a database.] Axway Database Administrator Guide Provides information on managing the Axway Database product. Support services The Axway Global Support team provides worldwide 24 x 7 support for customers with active support agreements. support@axway.com or visit Axway Sphere at Training services Axway offers training across the globe, including on-site instructor-led classes and self-paced online learning. For details, go to: Axway MyProduct N.n Installation Guide 10

11 Accessibility The h1 heading is <h1 class="nonumber"> Axway strives to create accessible products and documentation for users. The following describes the accessibility features of <MyProduct and its documentation><the documentation>. In the preceding sentence, choose the option applicable for your project. If the product is not accessible yet, then only mention the documentation and hide the "Product accessibility" section below. Product accessibility MyProduct has the following accessibility features: Keyboard shortcuts on page 11 Screen reader support on page 12 Keyboard shortcuts MyProduct has keyboard shortcuts for navigating the user interface and performing actions. Note To use shortcuts with JAWS, turn off the virtual PC cursor. For more information, see Screen reader support on page 12. The following table lists keyboard shortcuts you can use. [Category A] Indicate a category name. Example: Selection Category names depend on the product. For Axway products, it can be for example: Application, Go to, Selection, and so on. See Ivan Vladimirov s post on Jive ST - Web Access Plus Keyboard Navigation.docx. To do this [Action] Example: Activate item with focus [Action] [Action] Press [Keyboard shortcut] Enter [Keyboard shortcut] [Keyboard shortcut] Axway MyProduct N.n Installation Guide 11

12 Accessibility [Category B] To do this Press [Action] [Keyboard shortcut] [Action] [Keyboard shortcut] [Action] [Keyboard shortcut] Screen reader support MyProduct supports JAWS (Job Access With Speech), a computer screen reader program for Microsoft Windows that enables blind and visually impaired users to read the screen with a text-tospeech output or by a refreshable Braille display. However, you must configure your screen reader before using JAWS. You interact with JAWS using keyboard shortcuts. Typically, you press the JAWS key in combination with other keys. By default, the JAWS key is the Insert key. To use the arrow keys and keyboard shortcuts with MyProduct, turn off the virtual PC cursor by pressing the JAWS key+z. Documentation accessibility The product documentation provides the following accessibility features: Screen reader support on page 12 Support for high contrast and accessible use of colors on page 13 The "Keyboard-only navigation" section is hidden for now, because the ARIA changes have not been implemented yet. The first bullet point in the "Screen reader support" section below is hidden for the same reason. JAWS has not been tested yet. Screen reader support Alternative text is provided for images whenever necessary. If you have not completed this task, indicate that alt text is only available for some percentage of the graphics in the document. The PDF documents are tagged to provide a logical reading order. Axway MyProduct N.n Installation Guide 12

13 Accessibility Support for high contrast and accessible use of colors The documentation can be used in high-contrast mode. There is sufficient contrast between the text and the background color. The graphics have the right level of contrast and take into account the way color-blind people perceive colors. Condition this bullet point to NotPublish if the graphics are not aligned with the latest guidelines. Axway MyProduct N.n Installation Guide 13

14 Introduction 1 This guide explains how to perform a full installation of MyProduct using the Axway Installer and how to upgrade it to the latest version. About MyProduct Brief description about MyProduct. Installation outline Provide the installation outline one needs to perform in order to completely install MyProduct as well as starting it once installed. Axway MyProduct N.n Installation Guide 14

15 Quick start 2 Concept topic describing a "quick start" installation of MyProduct and when it is possible. A quick start installation is a simple, standard installation of MyProduct, for example, for a demonstration or proof of concept. In the interaction with Axway Installer, the users should accept the defaults in almost all cases. Consult the MyProduct PM or other resource. If there are no use cases for quick start or if those cases should not be covered in customer documentation, condition this file and the topic files in this chapters as NotPublish and remove them from the TOC. Prerequisites A reference topic that includes what the user must check or do before a "quick start" installation. If this topic is large, consider whether "quick start" is applicable to MyProduct. Refers the user to Worksheet on page 73 Software and license keys A reference topic that refers the user to the "Welcome" which includes the procedures "To download the software" and "To download keys." This topic is shared by Quick start on page 15 and Prerequisites on page 33, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. Axway 5 Suite products are delivered electronically from Sphere, the Axway support website. A welcome letter notifies you that your products are ready for download. In the case where the product is delivered on an appliance, you must wait for the physical delivery of the hardware. When you are ready, perform the following tasks: 1. Check your authorization. 2. Check the hardware and system requirements. 3. Download product. 4. Install products. Axway MyProduct N.n Installation Guide 15

16 2 Quick start Check your authorization Verify that you can access Sphere by going to and logging in. If you do not have an account, follow the instructions in your welcome letter. Log in to download or access: The product installation package Your product license key Product documentation Product updates, including patches and service packs Product announcements The case center, to open a new case or to track opened cases You can also access other resources, such as articles in the Knowledge Base, the Axway User Forum, and documentation for all Axway products. Cluster installations Does MyProduct support a full cluster installation? MyProduct supports a full cluster installation. Make sure that you get the license keys for all the nodes you want to install MyProduct on. Start installation A task topic that describes how to expand the installation package, extract the installation files, start the Installer in the correct mode, and, if applicable, follow the Worksheet on page 73. For installation on an Axway Appliance, include how to start the installation from the console menu. When this shared topic appears in the Quick start on page 15, it describes starting the Installer in standard mode. This topic is shared by Quick start on page 15 and Install on page 42, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. This guide does not document the Installer steps because the interaction is straightforward and the subtopics or sections of Worksheet on page 73 correspond to the Axway Installer screens for MyProduct. Prerequisites You have downloaded the installation package from Axway Sphere. The download instructions are in the welcome letter that Axway sent you in an message. You have uncompressed or unzipped the package. Axway MyProduct N.n Installation Guide 16

17 2 Quick start Installation package contents The installation package is a zip archive. Once you unzip it, it contains: List and describe the folders / files that your installation package contains. The Installer installation package contains the following contents depending on the platform: UNIX platforms Components Installer Java Tools EULA.html EULA.txt setup.sh Windows 32-bit Components Installer Java Tools EULA.html EULA.txt setup32.exe Windows 64-bit Components Installer Java Tools EULA.html EULA.txt setup64.exe Axway MyProduct N.n Installation Guide 17

18 2 Quick start Start the Installer Locate and run the setup file in the root folder of the installation package. GUI mode: UNIX/Linux: setup.sh Windows: setup32.exe or setup64.exe Console mode: UNIX/Linux: setup.sh -m console Windows: setup32.exe -m console or setup64.exe -m console setup32.exe is a 32-bit build executable and will run on a 64-bit platform provided that the compatibility layer has been installed. Installation parameters TP: I moved around the order of the screens. Make sure you have the latest. License agreement There are some differences for reviewing the end-user license agreement (EULA) in GUI and console modes. In GUI mode Read the EULA and click I agree if you accept its terms and conditions. This also lets you continue to the next page. You can also print the license agreement by clicking the print link. You must have a web browser installed for this otherwise the page will not open. Click Quit to stop the installation at any time. In console mode In console mode: A print link for the EULA is not available. If you want to read or print the EULA file, it is available in HTML or.txt format at the root folder of the installation package. Select the bit architecture This topic applies only if MyProduct supprts both 32- and 64-bit architectures, or if MyProduct is a suite of products. Check with your R&D team if this is the case and condition it as NotPublish if it is not applicable to you. Axway MyProduct N.n Installation Guide 18

19 2 Quick start If you install MyProduct on a 64-bit platform with a 32-bit compatibility layer installed, you need to specify the bit architecture you want your product to be installed with. Standard installation 32 bits 64 bits (by default) Advanced installation For each product in the list you need to choose between a 32-bit or 64-bit architecture. The default is 64 bits which you can change. For some products however, this may not be modifiable due to the Installer not being able to identify both options as possible. Installation type Select the expertise level: Standard: Selects Axway Database by default, if a database is required. Some parameters are not displayed during a standard installation as the Installer assumes default values for them. Advanced: Allows you to customize the installation environment. Select advanced if you want to install cluster architecture, change port numbers or customize database information. For a quick installation, select the Standard option. Installation architecture There are two types of installation architectures: single and cluster. You do not have the option to install cluster architecture unless you select advanced installation mode. Select the architecture type: Single: installs products on a single server (default) Cluster: recommended for failover and high availability, creates a shared directory common to all products If you select cluster architecture, an additional step displays. Specify if the installation is the First node in the cluster, or an Additional node in the cluster. Select the architecture type and click Next. Installation name On Windows an installation name is required. This is the logical name for the installation which also helps you identify where the product is located. For example: Axway MyProduct N.n Installation Guide 19

20 2 Quick start Start > Programs > Axway Software > Axway [TEST] > Product name. In this example, TEST is the installation name. The installation name also identifies the service name when you install a product as a Windows service. Installation directories Each Axway product is installed in its own installation folder. If you previously installed Axway products, do not install MyProduct in the same folder, except for Composer and the Enablers. Some products do not support being installed in a path containing white spaces (blanks). Check with your R&D team if this is the case for MyProduct, and if not, remove the line below. This product does not support installation in a path containing spaces. Install the product in an empty directory. If you install in a directory with files, the entire directory is deleted when you uninstall. Shared Directory In case you install in a cluster architecture, you need to specify both the: Installation directory location where the product binaries will be installed Shared directory location where the product configuration and data will be stored Select products This topic applies only if MyProduct is delivered along with Administration and Infrastructure, so condition it as NotPublish if it is not applicable to MyProduct. Select the products to install. To set the installation options for a product, click the arrow to the right of the product name and select the installation option from the drop-down list: Install Install the selected product Install all Install the selected product and all of its modules Not selected Does not install the selected product If your product requires a database and you want to use Axway Database, select Install using the arrow to the right of the Axway Database option. You must then set up Axway Database. Refer to the Axway Database Installation Guide on Sphere. Axway MyProduct N.n Installation Guide 20

21 2 Quick start Configure MyProduct A topic to describe the Advanced configuration options for MyProduct. It should at least contain a reference to the Worksheet here, Example worksheet on page 73 Ready to install After configuring your product, review the installation configuration and click Install to begin installing. When the progress bar displays Installation complete, the installation is finished and displays one of the following: The install action completed successfully The install action completed with errors The install action completed with warnings Installation summary For each product, review the installation summary. The Installer displays one of the following messages: For a successful installation: o o o Installation folder Installed modules Updates applied in chain with the installation For a failed installation: o o o Error while executing task: [task name] [reason] Installation aborted by the user (if this was the case) Log file location For a failed installation, check the Installer log file. Installation log file The installation log file is located at <install directory>\install.log for error messages. This file holds the information about all actions performed on the installation in time (installation, update, configure, uninstall) and are always appended to the file. For support purposes it is extremely important that you do not tamper with this file. If it becomes too big, you can split it and archive it. If you have to contact Axway for support, consider providing all archived logs to them. The format of the log message is: Axway MyProduct N.n Installation Guide 21

22 2 Quick start Date Date when message was logged Classifier Type of message (DEBUG, INFO, WARN, ERROR, FATAL) Message_body Description of error By default, Installer logs only the INFO, WARN, ERROR and FATAL messages. In case of issues you want to report to Axway Support, it is crucial that you provide the detailed log containing the DEBUG messages. To enable this type, launch the operation again with the -d option: setup.sh -d If you suspect the installation failed because of values you entered, check the file <install directory>\syninstall\install.properties. After the installation process is finished, go to Axway support website at for the latest service packs for your product. See the readme file for dependencies between service packs. Verify the installation A concept topic that introduces the following task subtopics by describing why it is important to verify the installation. This topic is shared by Quick start on page 15 and Post-installation on page 49, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. To verify your installation, follow these guidelines: Check the installation results o o o Summary screen shows the installation completed successfully. The installation log (<installation_root_folder>/install.log) does not contain error messages. Running the display script (<installation_root_folder>/display.bat or <installation_root_folder>/display.sh) shows the product in the list. Required tasks [Any tasks required before the administrator can log on to the product for initial configuration, such as manual edits to configuration files, starting the server.] Log on [How to log on to the server or a pointer to that topic in the administrator guide.] Start and stop MyProduct A task topic that might single-source content with the MyProduct Administrator Guide or other guide, either as a complete topic or using snippets. This topic is shared by Quick start on page 15 and Post-installation on page 49, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. Axway MyProduct N.n Installation Guide 22

23 2 Quick start In addition to describing how to start and stop MyProduct, include the information below only if MyProduct has a dependency on Administration or Axway Database. Start Administration 1. Go to <install_directory>/administration and run the command: start 2. Check that Tomcat is started. 3. To log on to the Administration UI, open a web browser and enter the URL in the format: http (s)://<tomcat hostname>/administrationui Then, to start the products, use the commands or the Administration UI. Creating product scripts A product script is only automatically generated if it is installed with Administration for the first time. Thereafter, if you install another product in the same installation directory, you will have to start Administration to create the corresponding product script. Start the Axway Database To start the Axway Database, run the command: Axway_Database start If you are using an external database, refer to the vendor documentation for start instructions. Log into the administrative or client interface A task topic that might single-source content with the MyProduct Administrator Guide or other guide, either as a complete topic or using snippets. This topic is shared by Quick start on page 15 and Post-installation on page 49, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. After installing Administration, you need to start it and connect to the user interface. Command line You can find the Administration directory in <install directory>/administration. To start the Administration using a command line, run: Windows: Administration.bat UNIX: Administration Use the following commands for starting and stopping the Administration: start stop Axway MyProduct N.n Installation Guide 23

24 2 Quick start Connecting to the Administration UI Open a web browser and enter the URL, (http(s)://<tomcat hostname>/administrationui). Use the default superuser admin/admin to log in. Start / Stop timeout A product timeout fails after 60 seconds by default. You can increase this start / stop parameter manually by modifying the dynamicconfiguration.cfg file located in Administration/etc/dynamicConfiguration.cfg. Autostart feature With the Autostart feature, when you start Administration the first time, Axway Database and Tomcat (or WebSphere) are configured to start automatically. Through the Administration user interface, you can configure whether products should start or stop automatically when you start or stop Administration. Axway Administration UI command lines Open a command line session and enter: platform status: Displays the status of each installed Agent or product platform version: Displays the version of each installed SP, patch or product platform start: Launch the platform start procedure platform stop: Launch the platform stop procedure localplatform status: Displays the status of products locally installed localplatform version: Displays the version of products locally installed Product command line To manage products, open a command line session and change to the Administration bin directory (<Axway installation directory>/administration/bin). You are able to view the list of products that started automatically. Run the script with no parameters to view the following default command options: start: start the product and wait for it to start stop: stop the product and wait for it to actually stop restart: restart the product status: get the product status (optionally view the running processes) version: print the product version and patches log: display the product logs Axway MyProduct N.n Installation Guide 24

25 2 Quick start Check log files A task topic that might single-source content with the MyProduct Administrator Guide or other guide, either as a complete topic or using snippets. This topic is shared by Quick start on page 15 and Post-installation on page 49, so do not condition it as NotPublish even if Quick start on page 15 is not applicable to MyProduct. Axway MyProduct N.n Installation Guide 25

26 Plan the deployment 3 A concept topic that describes deployment planning. This chapter includes both deployment planning and those installation prerequisites that result from deployment choices. As the IT manager plans the deployment, the manager enters information in the Worksheet on page 73. The IT manager enters the rest of the information required for this installation in the Worksheet on page 73 based on the contents of the Prerequisites chapter. Include only the configuration information that is required before MyProduct installation. Do not include post-installation configuration of the various deployment options. For example, if the integration between MyProduct and Sentinel is configured after MyProduct is installed, do not include that configuration here. The IT manager uses this chapter to understand this MyProduct installation in the context of an RI, a collection of interoperating products, or two or more MyProduct installations required for full MyProduct functionality or for a cluster. This chapter covers the "big picture," deployment, and the following chapter covers prerequisites for individual installations. That is, the organization is "big to small." This is not intended to be a complete deployment guide that discusses issues of deployment architecture or even the benefits of different deployment architectures. If MyProduct has a capacity planning guide, a deployment guide, or an implementation guide, review them and determine what information to include and what information to reference in this guide. Axway 5 Suite reference solutions and interoperation A reference topic that refers to any applicable Axway 5 Suite documents. For example, the Axway 5 Suite reference solution guides describe reference solution deployment and installation order. The Axway 5 Suite Interoperability Guide describes how to deploy and configure the various Axway 5 Suite services. This guide references that information. It does not include it. If the Axway 5 Suite Interoperability Guide is out-of-date for MyProduct, decide whether to refer to it or to any product documents that include interoperation information. If MyProduct is not referenced in any Axway 5 Suite documents, condition this file as NotPublish and remove it from the TOC. Note that Connection to other products on page 28 covers connection to other Axway or third-party products outside of Axway 5 Suite reference solutions. Axway MyProduct N.n Installation Guide 26

27 3 Plan the deployment Platforms A reference topic that includes a reference to Axway 5 Suite Supported Platforms. Example text: For more information on the exact platforms that Axway supports for MyProduct, refer to the Axway 5 Suite Supported Platforms document on Axway Sphere at If MyProduct requires documentation of support for specific virtualization platforms beyond the general statement in the "Virtualization support" topic in Axway 5 Suite Supported Platforms, this topic includes that documentation. Client considerations This reference topic describes requirements for systems that will run administrator and end-user clients of MyProduct. It appears in this planning chapter so that the IT manager can plan to make any updates to the client systems as part of preparations for the MyProduct installation. Include the following information: For a thin client, a reference to the "Supported Web Browsers" section of Axway 5 Suite Supported Platforms For a thick client, a reference to the "Supported Thick Client Platforms" section of Axway 5 Suite Supported Platforms If a thin client of MyProduct requires that Java is installed on the client system, the supported versions of Java If a thin client of MyProduct requires that the Flash player is installed on the client system, the supported versions of Flash Flash Player Adobe Flash Player needs to be installed locally. You do not have to install it on the server, just on the client machines. Axway products require Adobe Flash Player 10. Refer to the Adobe web site to download the player: Cluster considerations If MyProduct supports clustering, this reference topic describes the deployment architecture and lists all installation prerequisites and information, such as shared database and directories (folders), Axway MyProduct N.n Installation Guide 27

28 3 Plan the deployment and overview steps required including the order of installation. It includes the information to include in the Worksheet on page 73. It does not include detailed cluster configuration that is not required for installation of a single cluster node. A number of Axway products use common active/passive cluster configuration. The common content can support installation of those products. If MyProduct uses external cluster managers, describe how the cluster manager is used. Include cluster manager scripts or where to get them in the Administrator Guide and single-source or reference that information here. Scripts include start and stop. If MyProduct uses its own cluster technology and configuration, replace the common content. If MyProduct does not support clustering, condition this file as NotPublish and remove it from the TOC. A cluster is a group of computers linked together in a network that share disk resources in a highavailability environment. The machines in a cluster cooperate to provide a set of services or resources to clients. In a cluster configuration, if the platform supporting a set of applications fails, the functions of the applications are transferred to a backup platform. This backup (or standby) platform is ready to immediately provide support for the critical application processes normally assured by the principal platform. In most cluster solutions, when the original platform recovers from failure, it recovers application processes from the secondary system that has temporarily acted as the active system. Planning process If there is a specific planning process for the type of clustering MyProduct supports, describe it here. You can refer to the cluster installation checklist here. This is a generalized checklist, check with your R&D team before including it. Cluster architecture Describe your cluster architecture here. Connection to other products If MyProduct can or must connect with other Axway or third-party products (outside of Axway 5 Suite reference solutions), this topic describes the deployment architecture and lists all installation prerequisites and information, and steps required including the order of installation. Do not include detailed configuration information that is not required during installation. Axway MyProduct N.n Installation Guide 28

29 3 Plan the deployment Examples of other products are Axway Administration, Axway Database or other database, Axway Infrastructure, a web application server, Composer Broadcast Agents, Composer Enablers, Sentinel, Central Governance, and PassPort. Broadcast Agent and Enablers can be viewed as parts of Composer that are installed separately to provide connection to another product. They are included here instead of in MyProduct <parts> on page 32 because they are essential for connection. Consider creating subtopics for: Mandatory infrastructure, such as Axway Database, other database, shared folder, and the like Axway governance products Axway runtime products Other external products, such as LDAP, SVN, and the like Include such items as port numbers, database users and configuration, and other preparation. Create subtopics for each connected product. If MyProduct can use the Axway Database, refer the reader to the Axway Database Administrator Guide. This guide does not include Axway 5 Suite connectivity information. Axway 5 Suite reference solutions and interoperation on page 26 refers to Axway 5 Suite documents that cover connections in reference solutions. If the user configures the connections to the other products after installation so that there are no associated installation requirements and if the information required is covered in another guide, this topic references that information, but notes that the user might want to perform certain tasks that are required for connection, such as opening ports, during the preparation for MyProduct installation even though they are not required for installation. If MyProduct does not connect with other Axway or third-party products (outside Axway 5 Suite reference solutions), condition this file as NotPublish and remove it from the TOC. If MyProduct uses Administration and Axway Database, include this information with any other product dependencies you may have. MyProduct connects to the following products: Administration The administration console provides transversal administration features for a subset of Axway 5 Suite products. Axway Database Powered by MySQL, the Axway Database requires the expertise of a database administrator to manage backups, restore operations and monitor disk resources. Default ports Axway Database 3306 Connection port Axway MyProduct N.n Installation Guide 29

30 3 Plan the deployment Administration 8005 Command port to start, stop Tomcat 8080 HTTP port 8099 PassPort SSO port 8443 HTTPS port 8754 Administration port for internal communications between Agent and Manger Administration A reference topic that lists the Administration components that MyProduct requires and installs and describes any selections or actions required during installation that are listed on the Worksheet on page 73. For example, the IT manager might need to know that Infrastructure includes the Apache Tomcat servlet container and web server. If MyProduct does not require and install any infrastructure components or Administration, condition this file as NotPublish and remove it from the TOC. The administration console provides transversal administration features for a subset of Axway 5 Suite products. For an installation that includes Administration, the architecture comprises: Administration Manager Communicates with the Agent or Agents by dispatching orders to them received via the UI. It is installed once per infrastructure instance. The Manager also centralizes information from the Agents, which is important for infrastructure consistency. Administration Agent The Agent controls the behavior of two or more products installed in an infrastructure instance by starting or stopping them. Web application user interface (UI) An administrator controls the infrastructure using the commands in the UI. All the instances in an infrastructure can be managed from this single point of entry. It provides the following monitoring and administration features: Distributed monitoring At product, instance, and platform levels Command line standardization Homogenizes the command line for all products Axway MyProduct N.n Installation Guide 30

31 3 Plan the deployment Basic administration commands For the administering of products and platforms Autostart functioning Can be configured to start or stop products Adding of applications Enables you to add, manage, and configure your own applications Log access centralization Provides a unique access point for all useful product logs The user interface provides the following features: Basic administration commands, for example: o o o o o Start Stop Restart Status Force stop Specific administration commands for: o Axway Database For Manager access for each instance, you define the host name, port and password. The user interface consists of the following major sections. Overview The first screen that displays after you log in, it displays the status of all the instances running on each installation node. Components Displays product-level status on each installation node. Click on a node to view the products and sub-products tab, for example the Components tab displays the: Agents connected to the Manager (called "default" after installation) Component status (start, stop, log,...) and you can perform commands on them based on this status Configuration tab On the Configuration tab you can: Rename an installation Connect the Administration UI to another Manager Change the login and password of the superuser Axway MyProduct N.n Installation Guide 31

32 3 Plan the deployment MyProduct <parts> A reference topic that describes the deployment architecture and lists all installation prerequisites and information and overview steps including the order of installation required if MyProduct requires two or more independent installations for certain functionality. Do not include detailed configuration information that is not required during installation. Change the title of this section depending on the term used for the "parts" of MyProduct. Examples of multiple installations include a server installed in the peripheral network (DMZ) to provide security for the private network and proxy services and products and independentlyinstalled servers that enable file transfers between different platforms. If MyProduct does not require two or more independent installations for certain functionality, condition this file as NotPublish and remove it from the TOC. Axway MyProduct N.n Installation Guide 32

33 Prerequisites 4 This chapter describes everything that the user must check or do before a single installation. Prerequisites include requirements, such as required configuration changes and software, and preinstallation tasks. Consult the MyProduct PM or other resource and determine whether to list requirements in reference topics ("You must disable SELINUX." "You must install the compatibility packages.") or to provide task topics with the required procedures. This introduction topic references Worksheet on page 73 where all the information needed during the installation can be recorded. This chapter describes the system requirements for MyProduct. System requirements can change when Axway releases service packs and patches for a product version. Therefore, also refer to the Axway 5 Suite Supported Platforms document on Axway Sphere at The document lists the supported operating systems, databases, web servers, and browsers. You must include your product's information as it relates to supported databases, operating systems, web application servers, and browsers information here. You must also provide additional information for your product, such as disk space, RAM requirements, or any other product-specific requirements. The following are the system requirements:??the following types of information belong in the system requirements section. Include the topics that apply to your product. Supported operating systems and versions. This also can include virtualization platforms. Supported databases types and versions. Hardware requirements, including RAM and disk space. Supported network storage (for example, NAS or SAN) and supported file systems. Reference that describes the license keys required to perform the product installation Supported browsers for the product Screen resolution for the product Flash Player for the product Any other requirements (consult with your development team). Hardware A reference topic that lists the minimum and recommended real or virtual processor, memory, and disk space. Includes hardware needed for Axway Installer, Axway Database, and other infrastructure, as needed. If MyProduct is supported on Axway Appliances, list the supported models. Can include a reference to the MyProduct Capacity Planning Guide. Axway MyProduct N.n Installation Guide 33

34 4 Prerequisites Includes required screen resolution for the Axway Installer GUI mode. Disk space and RAM requirements?? Add the space needed by the Installer to the space required by your product. (In some cases the product space requirement number may already have accounted for the Installer's needs.) Harvest the Axway Database and Administration data as needed for your product. If your product requires Administration, you can roll the disk space into your product's requirement. Axway Database Minimum RAM for Axway Database depends on the configuration selected at installation. 32-bit There are three possible configuration sizes: Small < 512 MB Medium = 1 GB Large = 2 GB 64-bit There are four possible configuration sizes: Small < 512 MB Medium = 1 GB Large = 2 GB Huge = 3 GB Administration 50 megabytes minimum disk space 50 megabytes minimum RAM Infrastructure 250 megabytes minimum disk space Axway MyProduct N.n Installation Guide 34

35 4 Prerequisites Installer 250 megabytes minimum disk space in temporary folder No RAM requirement JRE Depending on the platform, the necessary disk space varies between 250 megabytes and 600 megabytes. Screen resolution When the Installer is run in GUI mode, a resolution of at least 800 x 600 is required. If this is the same or less than the minimum for your product, use your product's minimum as the standard and don't bother mentioning the Installer's needs. Java A reference topic that documents whether Java must be installed or uninstalled, whether JAVA_ HOME must be set, and the version of Java that is installed. If a web client of MyProduct requires that Java is installed on the client system, include the supported Java versions. Axway provides the correct JRE which is installed during the product installation in the directory, <installation_root_directory>/java/<platform name> All platforms A topic that includes information about required users, passwords, system configuration, and software that applies to all supported platforms. If applicable, the introduction directs the user to the following topics for specific platforms. UNIX-based platforms A topic that includes information about required users, permissions, passwords, kernel and system configuration, libraries, X Windows System for GUI mode installations, and other software. Also includes directories required during installation (to be entered in the installation worksheet). If MyProduct has prerequisites that apply only to specific UNIX-based platforms, add a sub-topic for each platform with those requirements. Include installation on an Axway Appliance, if applicable. Axway MyProduct N.n Installation Guide 35