Jump to: navigation, search

General Elements

The following general elements define high-level attributes about the solution:

Multiple <profile> elements can be defined.

Within each <profile> there is a <dialog> section that defines input values to be gathered from the user during the execution of the wizard, and an <execution> section that performs tasks to deploy and configure the system, based on the user input that is gathered by the <dialog> section.

<solutionDefinition>

The <solutionDefinition> element must specify the version attribute. For GAX version 8.1.2 and higher, the version must be 2.0.0.

Relevant namespaces must be specified. The following is an example:

<?xml version="1.0" encoding="utf-8"?>
<solutionDefinition version="2.0.0" xmlns="http://genesys.com/gax/asd"
    xmlns:os="http://genesys.com/gax/asd/os" xmlns:cfg="http://genesys.com/gax/asd/cfg"
    xmlns:fileio="http://genesys.com/gax/asd/fileio" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://genesys.com/gax/asd asd.xsd http://genesys.com/gax/asd/os os.xsd
    http://genesys.com/gax/asd/cfg cfg.xsd http://genesys.com/gax/asd/fileio fileio.xsd"
>
</solutionDefinition>

The child elements <name>, <description>, <version>, and <deploymentkey> define the high-level items for this SPD, while the <profile> element defines one or more profiles within this solution definition that can be executed.

Child Elements

Attributes

Name

Type

version

string (required)

<deploymentkey>

This element contains a key that defines a unique instance of a deployment. Each deployment might have different attributes that determine uniqueness; the author of the SPD must define a unique deployment. For example, for the Hosted case, the tenant is a good choice for a deployment key (for example: <deploymentkey>${TENANT}</deploymentkey>) because deployments are carried out per-tenant. The <deploymentkey> element must occur only once in the SPD, and must be displayed in the Deployed Solutions view to successfully deploy the solution.

This element has no attributes or child elements.

<description>

Contains the description of the solution. For <solutionDefinition>, it must define what the SPD does. For example:

<description>This is the solution file to deploy a GVP solution</description>

For <input>, it must provide descriptive information to help the user determine what to enter for the input value.

This element has no attributes or child elements.

<name>

Contains the name of the Solution Definition that is displayed in the user interface. This element has no attributes or child elements.

<profile>

Multiple <profile> elements can be included in an SPD file. Each <profile> must have a unique name. Profiles can be of type incremental (incremental="true") or not incremental (incremental="false"). Further details about incremental profiles are in the Attributes table.

Each profile must have at least one <dialog> section, and at least one <execution> section. The <dialog> section defines the input values to be gathered from the user in the user interface. The <execution> section defines the steps to execute and deploy this particular profile.
Upgrade profile

To enable upgrades of existing deployments, the user interface uses a profile with name="upgrade".

The following scenario provides an example of a profile with name="upgrade":

  • Version 8.1.200.01 of an SPD is already installed,
  • A new SPD is installed with the profile name name="upgrade" and with the from attribute set to from=8.1.200.01.

The user interface enables upgrades for all SPD deployments that are version 8.1.200.01.

When the user clicks on the Upgrade link in the user interface, the wizard starts the update profile, and all the user-input values from the previously deployed version are pre-populated in the wizard.

Information.png Note: The <deploymentKey> value for the old and new SPD must be the same.
Examples

The following are two examples of SPDs. The first SPD uses the profiles name="install", name="modify", and name="delete". The second SPD uses the profile name="upgrade".


Child Elements


Attributes

Name

Type

Description

Default

Value

from

string

This must be defined for profiles with name="upgrade". This attribute specifies the version from which you can upgrade for this upgrade profile:

  • 8: Means that any 8.x.xxx.xx can use this version to upgrade
  • 8.1: Means that any 8.1.xxx.xx can use this version to upgrade
  • 8.1.3: Means that any 8.1.3xx.xx can use this version to upgrade

Information.png Note: The version must always be lower than the version that is specified in the <version> element. Also, upgrade profiles must always be incremental.

incremental

Boolean

These attributes define if this profile is incremental or not. An incremental profile can only be executed on top of a non-incremental profile within the same SPD file, unless it is an upgrade profile, in which case the incremental profile is executed on top of a profile from a previous version of the SPD file.

false

name

string (required)

A unique name for this profile. It is user-defined. Examples of standard profiles include: install, uninstall, upgrade, enable, and disable.

<dialog>

Defines an input dialog, where input from the user is collected.

Child Elements

Attributes

Name

Type

Description

Default

Values

cond

string

This attribute is a JavaScript expression that determines if this step is to be shown or skipped in the user interface. Note: By default, only attributes that are named "cond" or "expr" are JavaScript expressions. Using JavaScript (expressions or variables) in any other context requires the use of ${} around the JavaScript expression or variable. If the value evaluates to a "falsy" condition (for example: 0, "", false, undefined, null, NaN) then do not execute this step. Otherwise, execute this step.

step

string (required)

This attribute is used as the title of a step within the wizard. Each dialog is displayed as a different step within the wizard. This attribute defines the title to be used for this particular step.

The value is user-defined. Correct form includes the following: Tenant Selection, Host Selection, Common Applications, Tenant Applications, Credentials, and Parameters.

<execution>

Defines the actions to be done after all of the user-input has been collected and submitted, as defined in the <dialog> section.

Child Elements

Attributes

Name

Type

Description

Default

Values

step

string

This attribute is currently not used.

<summary>

This element is deprecated. It must not be used.

<version>

Contains the version of the Solution, for example:

<version>8.1.200.01</version>

The format of the version must conform to the standard Genesys IP versioning scheme.

The version is important when defining incremental profiles, such as upgrades. Also, as changes are made to an SPD file, the version must be incremented so that a user is aware that a new version of the same SPD file has been created.

This element has no attributes or child elements.

This page was last modified on December 12, 2018, at 23:18.

Feedback

Comment on this article:

blog comments powered by Disqus