Jump to: navigation, search

Deployment of Workbench Agent for LFMT 8.5.1

Tip
Before working with Workbench Agent, please refer to the Software Requirements section.
Important
Workbench Agent must be installed on all the hosts running Genesys Platform applications from which you want to collect log files. When a new agent is deployed to the environment, or when any configuration changes are made to an agent, the LFMT Collector must be restarted for the changes to be accepted by the LFMT..

The following directories in the Workbench installation package contain the Workbench Agent templates:

  • For Linux: /templates
  • For Windows: \templates
Important
The Workbench Agent can be deployed manually or by using the Agent Mass Deployer. The Mass Deployer is included within the utilities directory found inside the LFMT Collector working directory. If you use the Mass Deployer, you do not need to provision the Workbench Agent application in GAX, as this will be done automatically during the deployment process. Please see the “Deployment of Workbench Agent for LFMT 8.5.1” section for further details..

Provisioning the Workbench Agent

  1. Log into GAX, and navigate to Configuration Manager.
  2. In the Environment section, select Application Templates.
  3. In the Application Templates section, select New.
  4. In the New Properties pane, select Import Application Template.
  5. In the Import Application Template dialog, click the Choose File button and navigate to the CC_Agent.apd template. Select the template and keep the template name as “CC_Agent”. This is important for the Collector to identify the agents within the environment. Click the OK button to confirm the template import
  6. In the New Properties pane, click Save to save the new application template.
  7. Once the application template has been imported, navigate to Configuration Manager.
  8. In the Environment section, select Applications.
  9. In the Applications section, select New.
  10. In the New Properties pane, complete the following (some of these are temporary values and will be updated once the actual Workbench Agent software has been installed on the desired host)::
    1. In the General tab, enter a name for the Workbench Agent application in the Name field.
    2. Click on the Template field and navigate to the application template created above.
    3. In the Working Directory field, enter "."
    4. In the Command Line field, enter "." .
    5. Click on the Host field and navigate to the host where Workbench Agent will be installed.
    6. In the Application Options tab, review and configure the Workbench Agent options.
    7. Tip
      For more information on the Workbench Agent configuration options, please refer to the Workbench

      Agent Configuration Options section

    8. In the Ports tab, add the following listening ports: default = <an open port on the Workbench Agent host> (select whether this should be a Secured port or an Unsecured port)
    9. In the Permissions tab, grant the SYSYEM account (or the defined “Login As” account) full control
    10. Select the Save button to save the new application
Important
If the “default” port identified above is selected to be Secured, the LFMT Collector(s) will communicate with this Agent using TLS, otherwise, the communication will be Non-TLS.

Installing the Workbench Agent

The following directories in the Workbench Agent component contain the installation packages:

  • For Linux, /linux/bX/ip
  • For Windows, \windows\bX\ip

Installing the Workbench Agent on Linux

  1. In the directory to which the LFMT Agent installation package was copied, execute the install.sh script.
  2. On the Welcome screen, press Enter to continue.
  3. Read the Genesys Terms and Conditions, and enter Y to accept.
  4. Enter the Workbench Server application name defined in GAX (Configuration Server) and click Next.
  5. Enter the Host name and Port of the Primary Configuration Server.
  6. Enter the destination folder where the Workbench Agent application will be installed, and click Next.
  7. After the installation completes, go to the Workbench Agent installation directory and start the Workbench Agent by running the command wbagent_startup.sh -host <cfghost> -port <cfgport> -app <wbAgentapp> where:
    1. <cfghost> is the IP address of the Configuration Server
    2. <cfgport> is the port used to connect to the Configuration Server
    3. <wbAgentapp> is the name of the Workbench Agent application you created

Installing the Workbench Agent on Windows

  1. In the directory to which the Workbench Agent installation package was copied, double-click setup.exe to start the installation.
  2. On the Welcome screen, press Enter to continue.
  3. Read the Genesys Terms and Conditions, and enter Y to accept.
  4. Enter the Workbench Server application name defined in GAX (Configuration Server) and click Next.
  5. Enter the Host name and Port of the Primary Configuration Server.
  6. Enter the destination folder where the Workbench Agent application will be installed, and click Next.
  7. After the installation completes, go to the Workbench Agent installation directory and start the Workbench Agent by running the command startServer.bat
Important
You can also use GAX to start and stop the Workbench Agent.

Configuring LFMT Collector for use with the Workbench Agent

  1. LFMT Collectors automatically identify any agents configured in your environment, but port information requires to be updated based on the type of communication between the LFMT Collector and the associated Workbench Agent
  2. Log into GAX, and navigate to Configuration Manager
  3. From the Environment section, select Applications
  4. In the Applications section, select the LFMT Collector application
  5. In the Ports tab, add if not already present
  6.  *ftmessaging = <an open port on the LFMT Collector host> (this port will be used by agents that will transfer the file in plain text)
     *sftmessaging = <an open port on the LFMT Collector host> (this port will be used by agents that will encrypt the file before transfer)
    
  7. Select the Save button to save changes to the application
  8. Important
    • Ensure that the ftmessaging port is identified as an “Unsecured” port in its properties
    • Ensure that the sftmessaging port is identified as a “Secured” port in its properties
  9. Repeat the above steps for all LFMT Collector applications in your environment.
  10. Verifying the Workbench Agent installation

    After completing the installation of the Workbench Agent, its configuration should be verified through the GAX interface.

    1. Log into GAX, and navigate to Configuration Manager
    2. From the Environment section, select Applications
    3. In the Applications section, locate and open the Workbench Agent application
    4. In the General tab, verify that the following parameters have been updated by the installation process.
    5. *Working Directory: The Workbench Agent installation path
      *Command Line: agent_startup.bat or ./agent_startup.sh 
      *Command Line Arguments: -app <Workbench Agent Application Name> -host <Configuration Server Host> -port <Configuration Server Port> -backuphost <Backup Configuration Server Host> - backupport <Backup Configuration Server Port>
      
      Important

      The backuphost and backupport options are optional. These options are read from the Command Line Arguments field of the Workbench Agent object only.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on June 12, 2018, at 08:14.