Release Number |
---|
8.5.1xx.xx |
8.5.010.xx |
8.5.000.xx |
This deployment procedure applies to the releases of Pulse listed in the Release table, above. Click the link in the Release table for the version you are deploying to jump to a description of how to deploy Pulse using the package you received from Genesys. Most releases use the same standard deployment procedure.
If your release requires a specialized procedure, the link in the Release table takes you to a header specifying the version number and date of the release.
To deploy this package, do the following:
To deploy this installation package within a new environment, follow the instructions in the Pulse 8.5.1 Deployment Guide.
To install the 8.5.1 release of Pulse over the prior 8.5.x or 8.1.4 release, use this Deployment Procedure and refer to the Pulse 8.5.1 Deployment Guide as needed.
Notes:
Review all steps before performing any of them.
Plan a time when you can complete the installation in one continuous session.
This procedure is valid only for Genesys Administrator Extension (GAX) and Pulse installed with jetty.
Rollback to a previous release causes Pulse to lose all widgets previously created by users, because all widgets are automatically converted to release 8.5 during migration.
After migration from Pulse 8.1.4 to 8.5.1, all widgets from the Custom dashboard are placed into a tab named Custom
. To see the Default dashboard you must create a new dashboard and select the Reset to Default Dashboard
from the menu.
If you have widgets for CampaignGroups
created in Pulse 8.1.4, Pulse 8.5.1 displays the message No Objects. Please check widget configuration
. To make these widgets work, edit them to reselect required objects.
The KPI Widget may change the Headline
object as the result of migration from 8.1.4 to 8.5.1. If this is the case, edit the affected widget by setting up the appropriate Headline
object.
After migration from Pulse 8.5.000 to Pulse 8.5.1, historical data collected during the previous day is lost, which prevents Pulse from loading the line charts until new data is available. After Collector starts, Pulse can display historical data after the first new snapshot is created. This impacts line charts.
Installation Steps
Upgrade GAX. See the GAX upgrade procedure.
Note: The GAX upgrade procedure contains options that you must use to enable Pulse migration:
Retain the existing GAX Application
object for use with Pulse 8.5.
Do not retain Pulse files from a previous version.
Remove Pulse files (pulse.jar, pulse-proto.jar, protobuf-java-2.5.0.jar
) from <GAX installation folder>/plug-ins
directory.
If the previous release of Pulse was 8.1.400.xx,
then you must change options of Data Access Point object used to connect to Pulse database.
In the DAP options, change value of role options in the [GAX]
section from
ezpulse
to pulse
.
Start GAX.
In GAX, upload the Pulse Installation Package and Template:
Navigate to Administration > Installation Packages and click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Installation Package, which contains the ip_description.xml
file as well as setup.exe
on the root level.
For Upload an XML template, select the XML Template file Pulse.xml
from the Templates Installation Package directory.
For Upload an APD template, select the APD Template file Pulse.apd
from the Templates Installation Package directory.
Click Finish.
Deploy the Pulse Installation Package and Template:
Click the Pulse Installation Package to open the Properties tab.
Important: The Pulse Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
Enter details in the required fields and finish the installation.
Important: The IPCommon InstallPath should be an empty folder for the Pulse installation (for example C:\genesys\GCTI\Pulse8.5.1
).
For a High Availability (HA) deployment repeat steps 1 through 6, and 8 for a second GAX. In step 8, you must select a second GAX server.
Migration from Pulse 8.1.4 only:
Optionally, update options inside the pulse_statistics.cfg
file from the scripts folder to a particular social media that is configured in eServices solution (for example, facebook, twitter, facebooksession, facebookprivatemessage).
See eServices documentation for more details.
Import the pulse_statistics.cfg
file from the scripts folder to the Stat Server Application Options to create new stattypes
within both the primary and backup Stat Server Application
objects.
Note: In the first step of this file import uncheck Override.
Important: To calculate the % Ready Time in the Queue KPIs template, set the queue-use-pseudo-actions option in the [statserver]
section of Stat Server Application
object to false.
After the pulse_statistics.cfg
file is imported, restart the Stat Server application.
(Optional) To prevent Pulse from updating the Genesys-provided templates to release 8.5 when Pulse starts,
create the new option install_templates
with its value set to false
in the [pulse]
section of the GAX Application
object.
If you also want the ability to remove any template using Pulse,
create the option editable_templates
with its value set to true
.
See the Configuration Options in the Pulse Deployment Guide for details.
Back up the Pulse Collector configuration options to a file:
In GAX, navigate to Configuration > Environment > Applications.
Select the Pulse Collector Application
object.
Open the Application Options tab.
Click More.
Choose Export to save the file.
In GAX, upload the Pulse Collector Installation Package and Template:
In GAX, navigate to Administration > Installation Packages and Click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Collector Installation Package (for example, \PulseCol\version\linux\b1\ip
, which has the Installation Package description file).
For Upload an XML template, select the XML Template file (Collector.xml
from the Templates Installation Package directory).
For Upload an APD template, select the APD Template file (Collector.apd
from Templates Installation Package directory).
Click Finish.
Deploy the Pulse Collector Installation Package and Template:
Click the Pulse Collector Installation Package to open the Properties tab.
Important: The Pulse Collector Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
After the host selection, enter the Pulse Collector application name from the previous release as the application name and finish the installation.
Important: The InstallPath should point to an empty folder.
Update the Pulse Collector Application
options:
In GAX navigate to Configuration > Environment > Application Templates.
Select the new Pulse Collector Application Template.
Open the Application Options tab.
Click More.
Select Export to save the file with the Pulse Collector Template options.
Navigate to Configuration > Environment > Applications.
Open the Properties of the Pulse Collector Application
object.
Open the Application Options tab.
Click More.
Select Import and select the file you saved with the Pulse Collector Template options.
Check Override.
Apply the changes.
If required, update the new options according to recommendations in the Pulse Deployment Guide. Also, you can use the backup file of the Pulse Collector configuration options as a guide of what to change.
Stop GAX.
In the Pulse installation folder, open the scripts folder to select the upgrade script for your RDBMS.
Execute the upgrade SQL script on your Pulse DB schema.
From the Pulse installation folder, within the dbtool folder, create the configuration file dbtool.cfg using the sample provided:
db.type=<dbtype> db.url=<url for connection to db> db.user=<database username> db.password=<database password> config_server.host=<configuration server host> config_server.port=<configuration server port> config_server.username=<username to connect to configuration server> config_server.password=<password to connect to configuration server>
From the command line, run: dbtool -m
Start GAX.
Start Pulse Collector.
You have successfully completed your deployment of Pulse.
To deploy this package, do the following:
To deploy this installation package within a new environment, follow the instructions in the Pulse 8.5.010 Deployment Guide.
To install the 8.5.010.xx release of Pulse over the prior 8.5.x or 8.1.4 release, use this Deployment Procedure and refer to the Pulse 8.5.010 Deployment Guide as needed.
Notes:
Review all steps before performing any of them.
Plan a time when you can complete the installation in one continuous session.
This procedure is valid only for Genesys Administrator Extension (GAX) and Pulse installed with jetty.
Rollback to a previous release causes Pulse to lose all widgets previously created by users, because all widgets are automatically converted to release 8.5 during migration.
After migration from Pulse 8.1.4 to 8.5.010, all widgets from the Custom dashboard are placed into a tab named Custom
. To see the Default dashboard you must create a new dashboard and select the Reset to Default Dashboard
from the menu.
If you have widgets for CampaignGroups
created in Pulse 8.1.4, Pulse 8.5.010 displays the message No Objects. Please check widget configuration
. To make these widgets work, edit them to reselect required objects.
The KPI Widget may change the Headline
object as the result of migration from 8.1.4 to 8.5.010. If this is the case, edit the affected widget by setting up the appropriate Headline
object.
After migration from Pulse 8.5.000 to Pulse 8.5.010, historical data collected during the previous day is lost, which prevents Pulse from loading the line charts until new data is available. After Collector starts, Pulse can display historical data after the first new snapshot is created. This impacts line charts.
Installation Steps
Upgrade GAX. See the GAX upgrade procedure.
Note: The GAX upgrade procedure contains options that you must use to enable Pulse migration:
Retain the existing GAX Application
object for use with Pulse 8.5.
Do not retain Pulse files from a previous version.
Remove Pulse files (pulse.jar, pulse-proto.jar, protobuf-java-2.5.0.jar
) from
directory.
If the previous release of Pulse was 8.1.400.xx, then you must change options of Data Access Point object used to connect to Pulse database. In the DAP options, change value of role options in the [GAX]
section from ezpulse
to pulse
.
Start GAX.
In GAX, upload the Pulse Installation Package and Template:
Navigate to Administration > Installation Packages and click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Installation Package, which contains the ip_description.xml
file as well as setup.exe
on the root level.
For Upload an XML template, select the XML Template file Pulse.xml
from the Templates Installation Package directory.
For Upload an APD template, select the APD Template file Pulse.apd
from the Templates Installation Package directory.
Click Finish.
Deploy the Pulse Installation Package and Template:
Click the Pulse Installation Package to open the Properties tab.
Important: The Pulse Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
Enter details in the required fields and finish the installation.
Important: The IPCommon InstallPath should be an empty folder for the Pulse installation (for example C:\genesys\GCTI\Pulse8.5.010
).
For a High Availability (HA) deployment repeat steps 1 through 6, and 8 for a second GAX. In step 8, you must select a second GAX server.
Migration from Pulse 8.1.4 only:
Optionally, update options inside the pulse_statistics.cfg
file from the scripts folder to a particular social media that is configured in eServices solution (for example, facebook, twitter, facebooksession, facebookprivatemessage).
See eServices documentation for more details.
Import the pulse_statistics.cfg
file from the scripts folder to the Stat Server Application Options to create new stattypes
within both the primary and backup Stat Server Application
objects.
Note: In the first step of this file import uncheck Override.
Important: To calculate the % Ready Time in the Queue KPIs template, set the queue-use-pseudo-actions option in the [statserver]
section of Stat Server Application
object to false.
After the pulse_statistics.cfg
file is imported, restart the Stat Server application.
(Optional) To prevent Pulse from updating the Genesys-provided templates to release 8.5 when Pulse starts,
create the new option install_templates
with its value set to false
in the [pulse]
section of the GAX Application
object.
If you also want the ability to remove any template using Pulse,
create the option editable_templates
with its value set to true
.
See the Configuration Options in the Pulse Deployment Guide for details.
Back up the Pulse Collector configuration options to a file:
In GAX, navigate to Configuration > Environment > Applications.
Select the Pulse Collector Application
object.
Open the Application Options tab.
Click More.
Choose Export to save the file.
In GAX, upload the Pulse Collector Installation Package and Template:
In GAX, navigate to Administration > Installation Packages and Click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Collector Installation Package (for example, \PulseCol\version\linux\b1\ip
, which has the Installation Package description file).
For Upload an XML template, select the XML Template file (Collector.xml
from the Templates Installation Package directory).
For Upload an APD template, select the APD Template file (Collector.apd
from Templates Installation Package directory).
Click Finish.
Deploy the Pulse Collector Installation Package and Template:
Click the Pulse Collector Installation Package to open the Properties tab.
Important: The Pulse Collector Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
After the host selection, enter the Pulse Collector application name from the previous release as the application name and finish the installation.
Important: The InstallPath should point to an empty folder.
Update the Pulse Collector Application
options:
In GAX navigate to Configuration > Environment > Application Templates.
Select the new Pulse Collector Application Template.
Open the Application Options tab.
Click More.
Select Export to save the file with the Pulse Collector Template options.
Navigate to Configuration > Environment > Applications.
Open the Properties of the Pulse Collector Application
object.
Open the Application Options tab.
Click More.
Select Import and select the file you saved with the Pulse Collector Template options.
Check Override.
Apply the changes.
If required, update the new options according to recommendations in the Pulse Deployment Guide. Also, you can use the backup file of the Pulse Collector configuration options as a guide of what to change.
Stop GAX.
In the Pulse installation folder, open the scripts folder to select the upgrade script for your RDBMS.
Execute the upgrade SQL script on your Pulse DB schema.
From the Pulse installation folder, within the dbtool folder, create the configuration file dbtool.cfg using the sample provided:
db.type=<dbtype> db.url=<url for connection to db> db.user=<database username> db.password=<database password> config_server.host=<configuration server host> config_server.port=<configuration server port> config_server.username=<username to connect to configuration server> config_server.password=<password to connect to configuration server>
From the command line, run: dbtool -m
Start GAX.
Start Pulse Collector.
You have successfully completed your deployment of Pulse.
To deploy this package, do the following:
To deploy this installation package within a new environment, follow the instructions in the Pulse 8.5 Deployment Guide.
To install the 8.5.000.xx release of Pulse over the prior 8.1.4 release, use this Deployment Procedure and refer the Pulse 8.5 Deployment Guide as needed.
Notes:
Review all steps before performing any of them.
Plan a time when you can complete the installation in one continuous session.
This procedure is valid only for Genesys Administrator Extension (GAX) and Pulse release 8.1.4 installed with jetty.
Rollback to release 8.1.4 causes Pulse to lose all widgets previously created by users, because all widgets are automatically converted to release 8.5 during migration.
After migration from Pulse 8.1.4 to 8.5, all widgets from the Custom dashboard are placed into a tab named Custom
. To see the Default dashboard you must create a new dashboard and select the Reset to Default Dashboard
from the menu.
If you have widgets for CampaignGroups
created in Pulse 8.1.4, Pulse 8.5 displays the message No Objects. Please check widget configuration
. To make these widgets work, edit them to reselect required objects.
No SQL scripts must be executed to upgrade the database schema as Pulse 8.1.4 and Pulse 8.5 have the same database schema.
The KPI Widget may change the Headline
object as the result of migration from 8.1.401.xx to 8.5.000.14. If this is the case, edit the affected widget by setting up the appropriate Headline
object.
Installation Steps
Upgrade GAX from release 8.1.4 to 8.5. See the GAX upgrade procedure.
Note: The GAX upgrade procedure contains options that you must use to enable Pulse migration:
Retain the existing GAX Application
object for use with Pulse 8.5.
Do not retain Pulse 8.1.4 files.
If the previous release of Pulse was 8.1.400.xx, then you must change options of Data Access Point object used to connect to Pulse database. In the DAP options, change value of role options in the [GAX]
section from ezpulse
to pulse
.
Start GAX.
In GAX, upload the Pulse Installation Package and Template:
Navigate to Administration > Installation Packages and click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Installation Package (for example, \Pulse\version\linux\b1\ip
, which has the Installation Package description file).
For Upload an XML template, select the XML Template file (for example, Pulse.xml
from the Templates Installation Package directory).
For Upload an APD template, select the APD Template file (for example, Pulse.apd
from the Templates Installation Package directory).
Click Finish.
Deploy the Pulse Installation Package and Template:
Click the Pulse Installation Package to open the Properties tab.
Important: The Pulse Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
Enter details the required fields and finish the installation.
Important: The IPCommon InstallPath should be an empty folder for the Pulse installation (for example C:\genesys\GCTI\Pulse8.5.010
).
For a High Availability (HA) deployment repeat steps 1, 2, 3, and 6 for second GAX.
Update options inside pulse_statistics.cfg
file from the scripts folder to a particular social media that is configured in eServices solution (for example, facebook, twitter, facebooksession, facebookprivatemessage).
See eServices documentation for more details.
Import the pulse_statistics.cfg
file to the Stat Server Application Options to create new stattypes
within both the primary and backup Stat Server Application
objects.
Note: In the first step of this file import uncheck Override.
Important: To calculate the % Ready Time in the Queue KPIs template, set the queue-use-pseudo-actions option in the [statserver]
section of Stat Server Application
object to false.
After the pulse_statistics.cfg
file is imported, restart the Stat Server application.
(Optional) To prevent Pulse from updating the Genesys-provided templates to release 8.5 when Pulse starts,
create the new option install_templates
with its value set to false
in the [pulse]
section of the GAX Application
object.
If you also want the ability to remove any template using Pulse,
create the option editable_templates
with its value set to true
..
See Configuration Options in the Pulse Deployment Guide for details.
Stop Pulse Collector 8.1.4.
Uninstall Pulse Collector 8.1.4.
Back up the Pulse Collector 8.1.4 configuration options to a file:
In GAX, navigate to Configuration > Environment > Applications.
Select the Pulse Collector 8.1.4 Application
object.
Open the Application Options tab.
Click More.
Choose Export to save the file.
In GAX, upload the Pulse Collector Installation Package and Template:
In GAX, navigate to Administration > Installation Packages and Click the plus sign.
Select Installation Package Upload (template uploaded separately) and click Next.
For Upload a Package, select the zipped file that contains the Pulse Collector Installation Package (for example, \PulseCol\version\linux\b1\ip
, which has the Installation Package description file).
For Upload an XML template, select the XML Template file (Collector.xml
from the Templates Installation Package directory).
For Upload an APD template, select the APD Template file (Collector.apd
from Templates Installation Package directory).
Click Finish.
Deploy the Pulse Collector Installation Package and Template:
Click the Pulse Collector Installation Package to open the Properties tab.
Important: The Pulse Collector Installation Package status should be complete.
Click the related icon and choose Install to open the IP Deployment Wizard.
After the host selection, enter the Pulse Collector application name from the previous release as the application name and finish the installation.
Important: The InstallPath should point to an empty folder.
Update the Pulse Collector Application
options:
In GAX navigate to Configuration > Environment > Application Templates.
Select the new Pulse Collector 8.5 Application Template.
Open the Application Options tab.
Click More.
Select Export to save the file with the Pulse Collector 8.5 Template options.
Navigate to Configuration > Environment > Applications.
Open the Properties of the Pulse Collector Application
object.
Open the Application Options tab.
Click More.
Select Import and select the file you saved with the Pulse Collector 8.5.010 Template options.
Check Override.
Apply the changes.
If required, update the new options according to recommendations in the Pulse 8.5 Deployment Guide. Also, you can use the backup file of the previous Pulse Collector configuration options as a guide of what to change.
Start Pulse Collector 8.5.
Restart GAX.
You have successfully completed your deployment of Pulse.
Additional information on Genesys Telecommunications Laboratories, Inc. is available on our Customer Care website. The following documentation also contains information about this software. Please consult the Pulse 8.5 Deployment Guide available on the Pulse landing page first.
Pulse 8.5 Deployment Guide introduces Pulse and describes the interrelationships with other Genesys components; describes how to configure and install Pulse; and explains how to start and stop Pulse.
Pulse 8.5 User's Guide contains instructions for using the GAX interface to generate reports.
Genesys Administrator Extension 8.5 Deployment Guide helps you deploy Genesys Administrator Extension.
The Framework 8.5 Combined Log Events Help contains a section which describes the log messages that Pulse and its procedures generate.
If you encounter any issues with the deployment of this package, please contact Genesys Customer Care.