Revision as of 14:44, March 12, 2015 by Djudge (talk | contribs) (→‎ScreenRecordingConfig)
Jump to: navigation, search

Screen Recording Client

Installing and Configuring the Screen Recording Client

Prerequisites

Before you can install and use the Screen Recording Client, you must have the following prerequisites:

  • Windows 7 64-bit
  • The Web Services URL
  • Access to Workspace Web Edition
  • Admin privileges to install the Screen Recording Client
  • The Screen Recording Client software
  • Agent login credentials

To install and configure the Screen Recording Client:

  1. On the Agent's desktop, install the Screen Recording Client using command line.
    The client is distributed using a setup.exe file. To run the setup, a user with administrative right is required. An administrator may choose to run the setup program using command line switches. The following is an example of the command line: 
    setup_<version>.exe /VERYSILENT  /SUPPRESSMSGBOXES /DIR="C:\Genesys\SRC" /NOCLOSEAPPLICATIONS

    This example shows that the command line starts a silent installation in the C:\Genesys\SRC directory, and will close any open applications using the files that are needed for the installation.

    Important
    To debug problems with the installation, you can add the /LOG="logfilename" command to the installation path. For example, setup_<version>.exe /VERYSILENT /SUPPRESSMSGBOXES /DIR="C:\Genesys\SRC" /NOCLOSEAPPLICATIONS /LOG="C:\src_setup.log".

    If the Agent is using Workspace Web Edition, the desktop requires a secure connection (the URL has https:// as the prefix) to Web Services. The Screen Recording Client is also required to support a secure connection with Workspace Web Edition, so it can accept credentials to Web Services.

    Optionally, you can add the /TASKS="HTTPS" parameter during installation to enable secure connection. The parameter will generate unique self-signed certificates and will configure the Screen Recording Client to use them. It will add the certificates to the Windows certificates store under "Trusted Root Certification Authorities". The following is an example of how to use the /TASKS="HTTPS" parameter: 

    setup_<version>.exe /VERYSILENT  /SUPPRESSMSGBOXES / DIR="C:\Genesys\SRC" /NOCLOSEAPPLICATIONS /TASKS="HTTPS"
    Important
    The default installation will NOT install the Screen Recording Client's self-signed PFX certificates to the root certificates store, nor will the Screen Recording Client use the certificates when setting up an HTTPS server for Workspace Web Edition. For more information, see Creating Self-Signed Certificates.

    Silent install using Answers File

    You can also use an answers file to run the setup. To create an answers file, start the setup with /SAVEINF=”answers_file”. All options set in the setup execution will be written to the file. To run the setup using a predefined answers file, use the /LOADINF=”answers_file” command line switch. The following is an example of an answers file: 

    [Setup]
Lang=english
Dir=C:\Program Files (x86)\Genesys SRC
Group=(Default)
NoIcons=0
Tasks=
  2. After running the setup, modify the <installdir>\config.json file, and include the following information: 
    [
  {
    "name": "server",
    "value": " <Web Services server>:<Web Services port>"
  },
  {
    "name": "certificate"
    "value": "true"
  }
]
    Important
    The certificate is an optional parameter in config.json file. It indicates how the screen recording client validates the server TLS certificate. If set to false (the default value), the screen recording client will not validate the certificate. If set to true, the client will validate the certificate using the Windows certificate store when the server is using a certificate from the public CA. If set to a file path (for example, C:\\Automation\\server.pem), the screen recording client will validate the certificate using a self-signed certificated when the server is using a private self-signed certificate.
    3. Tip
    See the Advanced Configuration Options section for descriptions of the options that you can add to the config.json file.
  3. Restart the Agent's computer.

Creating Self-Signed Certificates

If you did not use the /TASKS="HTTPS" parameter to install the Screen Recording Client, create self-signed certificates as follows:

  1. Open a command window as an Administrator.
  2. Navigate to the <install_dir>\Certificates\Self-Signed directory.
  3. Run the create_certificates.bat file. This creates a set of unique self-signed certificates.
  4. Run the install_certificates.bat file. This installs the new self-signed certificates to windows trusted certificates store.
Important
You can also execute these files at any time to create and/or install new self-signed certificates for the Screen Recording Client to use.


Installing Your Own Certificates

Alternatively, you can provided you own certificates without any configuration changes as follows:

  1. Provide a certificate for the IPv4 host, 127.0.0.1, in the <install_dir>\Certificates\server.pem file.
  2. Install the .pfx form of this certificate to the local certificates store as a "Trusted Root Certification Authority" file.
  3. Provide a certificate for the IPv6 host, [::1], in the <install_dir>\Certificates\serverIp6.pem file.
  4. Install the .pfx form of this certificate to the local certificates store as a "Trusted Root Certification Authority" file.
  5. The PEM certificate files should include both the private RSA key and the certificate itself and should have the following form: 
    ----BEGIN RSA PRIVATE KEY----
.
.
.
----END RSA PRIVATE KEY----
----BEGIN CERTIFICATE----
.
.
.
----END CERTIFICATE----
Important
If the .pem certificates are to be protected by a password, you must use genesysscreenrecording for that password.


Advanced Configuration Options

The following table describes the options that can be set in the config.json file on each Agent's desktop. Use the Your value column to track your option values.

Name Is this Option Mandatory? Description Default value Your value
server Y The server base url. The default port is 80; to use a different port, use the url:port format. This must be configured at installation. For example, https://<web services host>:80 Empty
authenticationCertificate N The relative or full path to the authentication server's PEM certificate. If a value is available, the authentication server uses it for the HTTPS connection to the agent's desktop.

Note: This parameter is not needed in the default Screen Recording Client installation. The Screen Recording Client uses the default self-signed certificate (%install_dir\Certificates\server.pem) automatically.

%install_dir\\Certificates\server.pem
authenticationCertificateIp6 N The relative or full path to the authentication server's PEM certificate for IPv6. If a value is available, the authentication server uses it for the HTTPS connection to the agent's desktop.

Notes:

  • This parameter is not needed in the default Screen Recording Client installation. The Screen Recording Client uses the default self-signed certificate (%install_dir\Certificates\server.pem) automatically.
  • Each host requires a unique certificate.
 %install_dir\\Certificates\serverIp6.pem
authenticationPort N The port used for internal communication with Web Services. If using HTTP, the port is 8080. If using HTTPS, the port is 443.
authenticationPortIp6 N The port used for internal communication with Web Services. If using HTTP, the port is 8080. If using HTTPS, the port is 443.
certificate N Indicates how the screen recording client validates the server TLS certificate. If set to false, the screen recording client will not validate the certificate. If set to true, the client will validate the certificate using the Windows certificate store when the server is using a certificate from the public CA. If set to a file path (for example, C:\\Automation\\server.pem), the screen recording client will validate the certificate using a self-signed certificated when the server is using a private self-signed certificate. false
certificatePassword N The password for the PEM certificate's private RSA key. Empty
certificatePasswordIp6 N The password for the IPv6 PEM certificate's private RSA key. Empty
credentialsTimeout N The timeout duration, in minutes, between the keep alive (GET/Ping) requests from the agent's desktop and the Screen Recording Client. When the timeout expires, the agent's credentials are deleted from the Screen Recording Client's cache. 35

Note: This value must be longer than the Web Services session timeout duration for the agent's desktop. By default the Web Services session timeout is 30 minutes, and the credentialsTimeout is 35 minutes. The latter must be increased if the Web Services session timeout is increased.

ip6 N Indicates whether to support IPv6 in addition to IPv4 for communication with Web Services. true
password N The HTTP authentication password. If provided, the value of the password is used until new authentication credentials are provided by the Agent desktop. Empty
statusTimeout N The timeout duration, in seconds, between the keep alive GET/Ping requests from the agent's desktop and the screen recording client. 60
userName N The HTTP authentication username. If provided, the value of the userName is used until new authentication credentials are provided by the Agent desktop. Empty
Comments or questions about this documentation? Contact us for support!