Jump to: navigation, search

Installing IWD Manager

Prerequisites

  • The environment meets the requirements that are described in Installation Prerequisites
  • The computer on which the iWD Manager is going to be installed has network access to the computer that is hosting Genesys Configuration Server. Users of iWD Manager will be authenticated through Genesys Configuration Server.
  • You have access rights to execute install.sh or setup.exe, depending on the operating system.
  • For upgrades from 8.5.1 to 9.0.x:
    • The previous version of iWD Manager is uninstalled—the iwd_manager directory from the web server is removed.

On Windows

Prerequisites

  • Installation Packages have been installed.

Purpose

To install the iWD Manager application on the Windows platform.

Summary

Installation of iWD Manager saves the required database scripts in the working directory. These scripts must be run against the Interaction Server database.

Important
For Interaction Server synchronization, from release 9.0 of iWD, the functionality previously in the Configure Ixn Custom Properties in iWD Manager is relocated to the Migration tab in the Solution definition in iWD GAX Plugin (new document).

The current procedure assumes that the application already exists in Configuration Server—the required steps are described in iWD Manager Application Definition.

Important
If you are upgrading, ensure that you have uninstalled the previous version and proceed with the current installation procedure. Also make sure not to skip the Application Definition step, because new versions might deliver new options.

Procedure

  1. Locate and double-click setup.exe in the iWD Manager directory of, for example, the iWD DVD.
  2. The iWD Manager Installation Wizard opens. Click Next in the Welcome screen.
  3. In the Connection Parameters to the Configuration Server screen, enter the login details to connect to Genesys Configuration Server and then click Next:
    • Host name—The host of Genesys Configuration Server
    • Port—The port that is used by Genesys Configuration Server
    • User name—The user name of the Person (or User) as defined in Genesys Configuration Manager or Genesys Administrator.
    • Password—The password that is associated with the Person (or User).
  4. From the list of available choices, choose the iWD Manager Server application that you want to install and click Next.
  5. Choose the destination location for iWD Manager.
  6. Click Next.
  7. Specify the address of the network interface where iWD Manager listens to connections, and the iWD Manager application name. Click Next.
  8. In the Ready to Install screen, click Install to begin the installation of iWD Manager.
  9. When installation has been completed, click Finish.
  10. Perform any optional steps or install localization if needed.

End of procedure

Using GAX

Purpose

To install the iWD Manager application on either Windows or Linux platform by using the simplified GAX method. Genesys strongly recommends that you install using the GAX/GAX Plug-in process.

Summary

GAX allows you to upload Installation Packages (IPs) and then use them to initiate the installation process. The procedure supports both a fresh install or an upgrade. The upgrade option is only available when you have installed the previous version of the application by using GAX. The upgrade procedure is basically the same as installation except that you are not forced to create a new application but are given the option either to use the old one or to merge them. So the upgrade does not remove the previous version of the application before the new installation.

IP Upload Procedure

Click here (new document) for the GAX IP Upload Procedure.

Installation Procedure

  1. Navigate to GAX > Administration > Installation Packages.
  2. Chose the appropriate IP from the list. To install it, click it. Its details appear in a new panel.
  3. Verify the details of the IP, then click the Iwd install1.png menu button and select Install. The installation wizard then takes you through the following steps.
  4. On the Welcome page, click Next.
  5. On the Host selection page, select the host to deploy to and click Next.
  6. Complete the application parameters:
    • Application Name—If you provide the existing application here, it won't be updated in any way.
    • Tenant—Not applicable for iWD Manager.
    • Application Port—Not applicable for iWD Manager.
    • Primary Configuration Server
    • Backup Configuration Server
  7. Click Next.
  8. Complete the Installation Parameters. For assistance look at the tooltips or see below:
    • IPCommon: JavaPath—Fully qualified absolute path to the JRE folder on the target computer.
    • IPCommon: JavaVersion—JRE supported version, for example: 1.3.0.
    • IPCommon: JavaPatchNumber—JRE supported service pack, for example: 1.
    • IPCommon: TomcatAddress—Address of the network interface where iWD Manager listens for connections.
    • IPCommon: iWDAppName—The iWD Manager Application Name
  9. Click Next.
    Important
    For Tomcat, before you click Finish, confirm that the server is not running
  10. On the Deployment tab, check all the parameters you have provided. Click Finish.
  11. The procedure then executes automatically, showing the progress bar. Its status (and other details) you can find on the GAX > Administration > Deployed IPs page. If the installation fails, re-initiate the process using the parameters that you already provided and/or make any necessary changes.

Upgrade Procedure

  1. Navigate to GAX > Administration > Deployed IPs.
  2. There is list of all installation attempts initiated via GAX. Choose one that was used previously and finished successfully. Its details appear in a new panel.
  3. Verify the details of the IP, then click the Iwd install1.png menu button and select Upgrade.
  4. You should get Profile Selection tab. If you successfully uploaded the latest version of the chosen IP then you should have that version available. Choose it and click Next.
  5. The installation wizard then takes you through the following steps. The difference to the installation procedure is that most of options are pre-selected or pre-populated here.
  6. One decision arises in the Application Parameters tab, which will show you the new proposed application name and the existing one. If you decide to use the new name, remember that you can change the name to old one and choose the No Merging option. In this case, the recommended option is Merge with Precedence to the New Template, because the new template might provide some new default settings.
  7. The rest of the steps are the same as for installation, unless you have a reason to change any of them. When you are done, click Finish.
Important
The Uninstall procedure (see Prerequisites) removes all localization and other installation customization like port definition and password encryption. If you need these then you must re-apply them. The Upgrade procedure, depending on your choices, could create a new application for iWD Manager in Configuration Server. When you compare the application settings of the old and new applications, there should be no difference except version, so you can just delete the old one.

On UNIX

Prerequisites

  • Installation Packages have been installed.

Purpose

To install the iWD Manager application on the UNIX platform.

Summary

Installation of iWD Manager saves the required database scripts in the working directory. These scripts must be run against the Interaction Server database.

Important
For Interaction Server synchronization, from release 9.0 of iWD, the functionality previously in the Configure Ixn Custom Properties in iWD Manager is relocated to the Migration tab in the Solution definition in iWD GAX Plugin (new document).

The current procedure assumes that the application already exists in Configuration Server—the required steps are described in iWD Manager Application Definition.


Important
If you are upgrading, ensure that you have uninstalled the previous version and proceed with the current installation procedure. Also make sure not to skip the Application Definition step, because new versions might deliver new options.

Procedure

  1. Locate the install directory and enter ./install.sh.
  2. When the following output is displayed, enter the required information, as indicated at each prompt.
  3. **************************************************
    * Welcome to the Genesys 9.0 Installation Script *
    **************************************************
    
    Installing iWD Manager, version 9.X.XXX.XX
    
    
    Please enter the hostname or press enter for "<hostname>" =>
    
    Please enter the following information about your Configuration Server:
    
    Configuration Server Hostname =>X.X.X.X
    Network port =>2020
    User name =><username>
    Password =><password>
    
    Please choose which application to install:
    1 : iWD_Manager_Server
     =>1
    
    Press ENTER to confirm "0.0.0.0" as
    the Tomcat network interface or enter a new one =>X.X.X.X
    
    Please enter the iWD Manager Application Name =>iWD_Manager
    
    Press ENTER to confirm /home/genesys/GCTI/iWDManager as
    the destination directory or enter a new one =>/home/genesys/GCTI/iWDManager
    
    Extracting tarfile: data.tar.gz to directory: /home/genesys/GCTI/iWDManager
    ...
    webapp/
    ...
    webapp/WEB-INF/
    webapp/WEB-INF/application.properties
    webapp/WEB-INF/web.xml
    webapp/WEB-INF/faces-config.xml
    webapp/WEB-INF/lib/
    webapp/WEB-INF/lib/hibernate.jar
    webapp/WEB-INF/lib/packagedstatisticsdeprecated.jar
    webapp/WEB-INF/lib/commons-lang.jar
    webapp/WEB-INF/lib/commons-logging.jar
    ...
    webapp/META-INF/MANIFEST.MF
    
    Installation of iWD Manager, version 9.X.XXX.XX has completed successfully.
    
    
  4. Perform any optional steps or install localization if needed.

iWD Manager Application Definition

  1. Log into Genesys Administrator or GAX and import the iWD Manager Server and iWD Manager Application templates from the iWD DVD. Double-check to see whether metadata were correctly imported.
  2. Import the iWD Manager IP into GAX to import privileges. This is important for the definition of roles in Genesys Administrator.
  3. Create a new Application object based on the iWD Manager Application template.
    Important
    The must be only one iWD Manager application on the Configuration Server. Additional ones will be ignored.
    1. To begin create procedure navigate to Configuration > Environment > Applications and click New.
    2. On the General tab:
      1. Enter a name for the iWD Manager.
      2. Select the application Template—This must of type iWD Manager.
      3. Version, Tenant and Is Application Server boxes are pre-selected according to the template type.
      4. State Enabled—If selected, indicates that the object is in regular operating condition and can be used without any restrictions.
    3. On the Connections tab, add the connections to the Configuration Server. If you need to:
      1. Add the Port ID on the Configuration Server that iWD Manager will connect to.
      2. Specify the Connection Protocol: simple or addp.
      3. Specify the Local Timeout and the Remote Timeout—These values are required only if you specified addp in Connection Protocol. This value specifies the heartbeat polling interval, measured in seconds, on a client side. This indicates how often the client application sends polling signals to the server application. To enable this functionality, specify any integer as the value.
      4. Specify a Trace Mode—The connection trace mode used between a server and its client.
        • Trace Is Turned Off—Select if you do not want either the client or the server application to print ADDP-related messages in its log.
        • Trace On Client Side—Select if you want the client application to print ADDP-related messages in its log.
        • Trace On Server Side—Select if you want the server application to print ADDP-related messages in its log.
        • Trace On Both Sides—Select if you want both the client and server applications to print ADDP-related messages in their log.
      5. Specify Transport Protocol Parameters—Any text, usually key/value pairs, separated by a semicolon (;). This property is application-specific.
      6. Specify Application Parameters—Any text, usually key=value pairs, separated by a semicolon (;). This property is application-specific.
    4. Ignore the Application Options tab.
    5. Click Save to save the Application object.
  4. Create a new Application object based on the iWD Manager Server template.
    1. To begin the create procedure navigate to Configuration > Environment > Applications and click New.
    2. On the General tab:
      1. Enter a name for the iWD Manager Server.
      2. Select the application Template—This must be of type:
        • Third Party Server for releases prior to 9.0.005.
        • Genesys Generic Server for release 9.0.005+.
      3. Version, Tenant and Is Application Server boxes are pre-selected according to the template type.
      4. State Enabled—If selected, indicates that the object is in regular operating condition and can be used without any restrictions.
    3. On the Connections tab:
      1. Add the connection to the Configuration Server. If you have both primary and backup Configuration Servers, add a connection only to the primary.
      2. Add the connection to the UCS.
      3. (Optional) Add the connection to the Message Server if you plan to use the Centralized Logging feature.
    4. On the Ports tab add the port where iWD Manager REST server will listen for connections. The Ports tab lists communication ports used by the clients of an application to connect to a server. To support specific high-availability configurations, more than one server can be registered on the same port within the same host. Otherwise, do not assign the port number to any other server on the same host.
    5. On the Application Options tab set [clientApplication] \ name to the name of iWD Manager application created in the previous step.
    6. On the Application Options tab configure any additional options if needed. A detailed description of these options can be found here.
    7. Click Save to save the Application object.

Implementing Single Sign-On and Single Log-Out

To configure single sign-on (SSO), the following additional configuration is required:

  1. Edit the [sso.properties] section and set the following properties:
    • iwd.saml.enabled—Set to true.
    • iwd.saml_entityid—Set to a value that is unique within the SSO circle (the full URL path, for example).
    • iwd.saml_idp_metadata—The URL from which to obtain the IDP's metadata file (a locally stored metadata file could be used as an alternative).
    • iwd.saml_sp_metadata—The path to the locally stored metadata file for the current SP (iWD Manager). The default value is metadata/iwdmanager_sp.xml .
    • iwd.saml.iwd_url—Set to the full URL of the local SP.
  2. In order to configure Single Log-Out set following attributes in the [sso.properties] section:
    • iwd.saml.sloEnabled—Set to true.
    • iwd.saml.sloAppName—Set to application name.
    • iwd.saml.sloRegEndpoint—Set to <activity-monitor-url>/v01/slo/registration/sp.
    • iwd.saml.sloUnregEndpoint—Set to <activity-monitor-url>/v01/slo/unregistration/sp.
    • iwd.saml.spSloEndpoint—Set to <iwd-manager-url>/saml/logout.
    • iwd.saml.spHeartbeatHandlerEndpoint—Set to <activity-monitor-url>/v01/server/activities.
    • iwd.saml.sloLogoutUrl—Set to /saml/logout.
    • iwd.saml.postLogoutUrl—Set to <hub-landing-page-url> or /ui/blank.jsf.
  3. Obtain encryption keys and store them in the local keystore file. The Java keystore is managed using the JDK keytool command. iWD needs to know the location of the keystore file, key name and passwords which are provided using the following properties:
    • iwd.saml.keystore/security/samlKeystore.jks
    • iwd.saml.keynameiwdmanager
    • iwd.saml.keypassChangeIt
    • iwd.saml.keystorepassChangeIt
  4. To encrypt password fields, use the passwordEncoder tool and set iwd.saml.keystorePasswordsEncoded as follows:
    • iwd.saml.keypass********
    • iwd.saml.keystorepass********
    • iwd.saml.keystorePasswordsEncodedtrue
  5. Generate the metadata file if it is not present:
    1. Go to the <iwd-manager-url>/saml/metadata URL, no additional configuration modification is required.
    2. Save the downloaded metadata file.
  6. Provide the SP's metadata file to your IDP.
  7. Enable concurrent former logging to iWD Manager in the HUB environment by setting the iwd.saml.formLoginEnabled property to true in the sso.property file.

Configuring TLS

Important
To configure TLS, please refer to the Configuring TLS for iWD guide.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 16 August 2018, at 09:15.