Jump to: navigation, search

Solution Deployment

Solution Deployment enables you to fully deploy solution definitions and installation packages (IPs) to remote locations. This includes installation and configuration of all of the necessary applications and updates to existing multi-Tenant applications, where appropriate.

Genesys Deployment Agent (GDA) is required to deploy solution definitions and IPs.

  • Starting from Local Control Agent, GDA is no longer installed and supported as part of Management Framework and therefore all functionality using GDA (including the installation of IPs) is deprecated.
  • GDA does not support multiple concurrent deployments on the same host. Therefore, multiple users cannot deploy a solution by using GAX on the same host at the same time that GDA is deploying. This limitation has always existed for GDA.

A solution definition consists of none, one, or multiple IPs for Genesys components. For Hosted Provider Edition, the IPs to be deployed must be primarily related to Tenant objects, and should contain object definitions, access permissions, and role privileges.

A solution definition consists of an XML file that defines the steps to install, upgrade, or configure IPs and system configurations to successfully deploy a solution. For information about authoring solution definition files, see Authoring Solution Definitions.

Solution Deployment can make changes to Tenant objects in Configuration Server, perform installations of IPs, or execute external scripts, such as database scripts.

You can also define a list of trusted URLs, called whitelisted hosts, to and from which the IPs are sent and retrieved. Use the host_whitelist and host_whitelist_enabled options, as described in the security section.

For each deployed solution, from the Deployed Solutions window, you can export a file that contains the properties, summary, and actions for auditing purposes.

Not all browsers enable you to use filenames that are not US-ASCII compatible; therefore, Genesys recommends that you use only filenames that are US-ASCII compatible.

Defined Privileges

Roles and their privileges are imported into GAX during the upload of an installation package (IP). All privileges that are defined in the metadata of the IP are imported into the GAX database. Privileges are defined as task elements in the metadata XML of the IP.

Solution Definition File Version Tracking

During normal use, solution definition files (also called solution package definitions, or SPDs) are added, upgraded, revised, and removed. Solution Deployment supports versioning, auditing, and tracking of changes of SPDs from within the GAX interface. The tracking report can be exported to a CSV file for use outside of GAX.

Solution Deployment enables you to view and access past versions of SPDs. You can also add custom comments and notes to any version.

You can filter and sort the SPD history by one or more of the following criteria:

  • Solution—Group results by deployed solutions.
  • Tenant—Group results by Tenant and select a subset of a Tenant or Tenants by solution and version.
  • Date—Group results by date range.
  • Result—Group by successful and failed deployments.

You can generate reports for both individual solutions as well as for individual Tenants.

You can configure the reports by specific criteria, including the following parameters:

  • Solution Definition name
  • Solution Definition version
  • Tenant name
  • Profile
  • Date deployed
  • Deployed by (name of the individual who performed the deployment)
  • Result of deployment (Success, Fail, Unknown)
  • Latest (true or false)
  • Application name (IP Xref)

Protection Against External XML Entity Injection Protection

GAX includes XML validation to protect against external XML entity injection. This validation rejects any XML file that includes the external entity definition DOCTYPE.

External Script Support

Solution Deployment passes arguments to external scripts when executing them, and can receive back results from the execution of a script. For example, if you have a script to create a new virtual host by using the VMware API, you can specify a name or naming convention from within an SPD. You will then receive confirmation that the creation was successful and the name of the new host that was created.

This page was last edited on September 8, 2020, at 10:41.
Comments or questions about this documentation? Contact us for support!