l If you are upgrading Journey Manager, see upgrade Journey Manager.
Next
Plan the Installation - 7 -
System Requirements | System Administrator |
This section discusses the Journey Manager system requirements.
Next
System Requirements - 8 -
Software Requirements | System Administrator |
Operating Systems
l CentOS Linux 7 on Intel x86-64 (recommended)
l CentOS Linux 6 on Intel x86-64 (supported)
l Oracle Linux 6 (Unbreakable Enterprise Kernel) on Intel x86-64
l Red Hat Enterprise Linux Server AP 7 on Intel x86-64
l Microsoft Windows Server 2016 on Intel x86-64
Databases
l AWS Aurora RDS (MySQL-Compatible Edition)
l Oracle Database 12c and 11g
l Microsoft SQL Server 2017, 2014 and 2012
l MySQL 5.7, 5.6 and 5.5 (InnoDB storage engine only)
Additional Components
l Apache Web Server 2.4 (recommended)
l Apache Web Server 2.2 (supported)
l SSL TLS server certificate to enable HTTPS in Journey Manager
l ClamAV for Linux
l Symantec Scan Engine 5.2 for Windows
Next
Software Requirements - 9 -
Hardware Requirements | System Administrator |
Journey Manager Application Servers
Journey Manager runs best on the Intel x86-64 Xeon CPU architectures with high CPU performance. For on premise
deployment, we recommend server virtualization, such as VMware or Microsoft Hyper-V, to enable better hardware util-
ization and improve operational support.
The recommended application server specification is:
l Intel Xeon Processors 8 Cores with 2.4 GHz or greater clock speed (4 Cores minimum).
l 16 GB of RAM (8 GB minimum).
l 50 GB of local disk storage.
l 1 TB of shared SAN or NAS storage for shared transaction data, such as PDF receipts and file attachments. Shared
SAN or NAS storage must be highly available.
l I/O subsystem should support 2000 IOPS or greater.
Minimum configurations are only suitable for non-production environments or lower environments not being used for per-
formance load testing.
Database Servers
The database is a critical component in our architecture and must provide high availability to the application server nodes.
The database server should support 2000 IOPS or greater.
The recommended database server specification is
l Intel Xeon Processors (8 Cores) with 2.4 GHz or greater clock speed.
l 16 GB of RAM.
l 500 GB of storage.
For non production databases, you can use a single database server, which supports multiple Manager databases and
schemas in UAT, Test, Dev.
Next
Hardware Requirements - 10 -
Installation Process | System Administrator |
This chapter describes how to install a new Journey Manager instance.
If you are upgrading a Manager instance, see upgrade Journey Manager.
Next
Installation Process - 11 -
Configure Database Server | System Administrator |
The first step in performing a Journey Manager installation is to create a database schema to store and manage the Jour-
ney Manager's configurations, transactions and various reporting data.
Next
Configure Database Server - 12 -
Configure MySQL Database | System Administrator |
Configure Binary Storage
To configure the MySQL server to store large binary files:
1. Stop the MySQL database.
2. Edit the MySQL configuration file: $MYSQL/my.cnf or $MYSQL\my.ini.
3. Enable the Max. packet size option and set the maximum packet size to 100 M to store large BLOB records.
4. Set the start up parameter: max_allowed_packet=100M
5. Add the InnoDB log file size start up parameter: innodb_log_file_size=1G. This is for MySQL v5.6 data-
bases only.
6. Restart the MySQL database to apply the changes.
Create Database
To create the MySQL database:
1. Log onto mysql as a root user:
mysql -u root -p
2. Create a txmanager user:
CREATE USER 'txmanager'@'localhost' IDENTIFIED BY 'your_password';
Use a hardened password and record it, as you will need it when running the Journey Manager installer.
3. Create a txmanager database:
CREATE SCHEMA `txmanager` DEFAULT CHARACTER SET utf8 COLLATE utf8_uni-code_ci;
4. Grant database privileges to the txmanager user:
GRANT ALL PRIVILEGES ON txmanager.* TO 'txmanager'@'localhost' IDENTIFIED BY 'your_password'; FLUSH PRIVILEGES;
Configure MySQL Database - 13 -
Create Tables
During the Journey Manager installation, you can select the option to automatically create the database tables. However, if
you want to create the database tables manually, you can execute the following scripts:
mysql -u txmanager -p password < [JM install folder]/sql/setup-db-mysql.sql mysql -u txmanager -p password < [JM install folder]/sql/setup-db-history-mysql.sql
Create Indexes
The following database indexes may be missing in Journey Manager prior to version 19.11, so you need to add them manu-
ally to enhance Journey Manager performance. |
To create new database indexes:
1. Log onto mysql as a root user.
2. Execute the following queries:
create unique index ui_job_reference_number on job (reference_number); create unique index ui_release_version_number on release_version (ver-sion_number); create unique index ui_submission_attribute on submission_attribute (sub-mission_oid, attribute_type); create unique index ui_submission_group on submission_group (submission_oid, group_oid); create unique index ui_submission_property_name on submission_property (submission_oid, property_name); create index ix_lib_res_hist_lib_res_oid on library_resource_history (lib-rary_resource_oid); create index ix_schema_extrt_map_client_oid on schema_extract_map (schema_oid); create index ix_sub_prop_sch_submission_oid ON submission_property_search(submission_oid);
Next
Configure MySQL Database - 14 -
Configure Oracle Database | System Administrator |
Create Database
To create the Oracle database:
1. Log onto SQL*Plus as a system user.
2. Create a txmanager user:
CREATE USER txmanager IDENTIFIED BY your_password;
Use a hardened password and record it, as you will need it when running the Journey Manager installer.
3. Grant connect and resource roles to the txmanager user:
grant connect, resource to txmanager;
Create Tables
During the Journey Manager installation, you can select the option to automatically create the database tables. However, if
you want to create the database tables manually, you can execute the following command after installing Journey Man-
The following database indexes may be missing in Journey Manager prior to version 19.11, so you need to add them manu-
ally to enhance Journey Manager performance. |
To create new database indexes:
Configure SQL Server - 21 -
1. Log onto the Microsoft SQL Server Management Studio as the txmanager user.
2. Execute the following queries:
create unique index ui_job_reference_number on job (reference_number); create unique index ui_release_version_number on release_version (ver-sion_number); create unique index ui_submission_attribute on submission_attribute (sub-mission_oid, attribute_type); create unique index ui_submission_group on submission_group (submission_oid, group_oid); create unique index ui_submission_property_name on submission_property (submission_oid, property_name); create index ix_lib_res_hist_lib_res_oid on library_resource_history (lib-rary_resource_oid); create index ix_schema_extrt_map_client_oid on schema_extract_map (schema_oid); create index ix_sub_prop_sch_submission_oid ON submission_property_search(submission_oid);
Next
Configure SQL Server - 22 -
Run the Installer | System Administrator |
Journey Manager is distributed via an installer, which you can run in 3 different modes:
l Interactive GUI Mode - it uses a Setup Wizard, which leads you through a series of questions and then performs the
installation.
l Interactive CLI Mode - it uses a Command Line Interface (CLI) interactive mode, which runs you through the same
questions via the command line interface.
l Scripted CLI Mode - it uses a configuration properties file to perform the installation automatically.
We recommend using the scripted CLI mode for non-development environments to minimize the number of human errors.
You can also automate the installation and upgrade processes, which follows the DevOps best practices.
Next
Run the Installer - 23 -
Create a Dedicated User - Linux | System Administrator |
For security reasons, Journey Manager and related services must be run by a dedicated user, which is not a root user, so
you must create a new tmuser user, If it doesn't exist.
Always run the installer as the tmuser user.
To create the tmuser user on Linux:
1. Log onto a Linux server as root.
2. Create a new tmuser user:
useradd tmuser passwd tmuser
3. Run visudo to grant the sudo access to tmuser.
4. Add the following line to the end of the configuration file using the vi syntax:
tmuser ALL=(ALL) ALL
5. Save the configuration and exit theeditor.
6. Log out as root.
7. Log in as tmuser.
8. Create Manager directories with the correct permissions for the new user:
sudo mkdir /data sudo chown -R tmuser /data
Use /data as the destination directory for the installer. You can use a different directory, but it must be
accessible to the tmuser user.
Next
Create a Dedicated User - Linux - 24 -
Scripted Installation Mode | System Administrator |
You can automate the Journey Manager installation, which is useful when you must install our software on several servers.
The Journey Manager installer comes with CLI, which allows you to specify a property file with the installation con-
figuration, using the -config command line parameter, as shown below:
An example tm-installer.properties file is provided below:
## Temenos Journey Manager setup task you want to perform # install | upgrade-server | init-database | custom-portal deployment.mode=install ## Temenos Journey Manager License Key system.license.key= ## Temenos Journey Manager deployment environment # aws | onprem deployment.env=onprem ## Enforce Organization data isolation # true | false enforce.data.isolation=true ## Data Retention Policy Mode # strict | relaxed data.retention.policy=strict ### Databse setup ## Database server type that will be used for Temenos Journey Manager # mysql | oracle | sqlserver database.product=mysql ## Server hosting the database # localhost | etc database.server=localhost ## Database port # 3306 | 1521 | 1433 | etc
Scripted Installation Mode - 25 -
database.port=3306 ## Database schema name that Journey Manager will be using. This database must already exist. # txmanager | etc database.schema=txmanager ## Database user that Journey Manager will be using. This user must already exist. # txmanager | etc database.user=txmanager ## Database user's password database.password=password ## Create the database tables automatically. ## The database/schema must already exist and the login must also have per-mission to login and create the tables. # true | false database.create=true #### Application server setup ## Directory where Journey Manager server is installed # /opt/avoka/transact/manager | C:/avoka/transact/manager | etc install.destination.dir=C:/avoka/transact/manager ## Directory where installer setup files will be created # /usr/avoka-tm-setup | C:/avoka-tm-setup | etc install.dir=C:/avoka-tm-setup ## Directory to backup the Journey Manager server to # /data/avoka-tm-backup | C:/avoka-tm-backup | etc backup.dir=C:/avoka-tm-backup ## Clean up server module JARs # true | false cleanup.modules=true ## Journey Manager Server Memory (Mb) # 8192 | 4096 | 2048 | 512 java.heap.size=8192 # Java GC Memory (MB) - set to half the value of java.heap.size java.xmn.size=4096 ## Use secure cookies (HTTPS) # true | false cookie.secure=true ## Use only the secure Journey Manager Fluent SDK # true | false groovy.secure.api=false ### Modules and Spaces
Scripted Installation Mode - 26 -
## Journey Manager # true | false deploy.manager=true ## Web Plugin # true | false deploy.web.plugin=true ## Work Space # true | false deploy.work.space=true ## Salesforce Space # true | false deploy.salesforce.space=false ## Server Monitoring Form # true | false deploy.monitoring.form=true ## Receipt Server # true | false deploy.receipt.server=true ## Maguire Org, Space, Forms and Services # true | false deploy.example.content=false ## PDF receipt generation services to be used with Temenos Journey Manager # none | 10.0.2 livecycle.version=none ## Logging date/time format log.date.format=%d{yyyy-MM-dd'T'HH:mm:ss.SSSz} %-5p [%c] (%t) %s%E%n
You must obtain your system license, which is the system.license.key value, from Temenos before per-
forming the installation. Each separate Manager environment, such as PROD, TEST, and DEV, needs its own
license key. Developers can also obtain a license key for local development usage.
Next
Scripted Installation Mode - 27 -
Installation Setup Wizard | System Administrator |
You must have JDK 1.7 or later installed on your server to be able to install Journey Manager.
To check which Java version is installed on the server, run the java -version command.
Windows
You need run to the installer with administrator privileges, namely Run as Administrator , so it can create the Journey
Manager Windows service.
Linux
You need to run the installer as the dedicated tmuser user.
Next
Installation Setup Wizard - 28 -
Interactive Installation GUI Mode | System Administrator |
To install Journey Manager using the interactive mode, run the following commands from the installation folder on your
operating system:
Windows
java -jar avoka-tm-setup-19.5.0-win-x64.jar
Linux
java -jar avoka-tm-setup-19.5.0-linux-x64.jar
Make sure a Linux tmuser user has read and write permissions on the installation folder, so the installer can run
successfully. For more information, see create a dedicated user.
After this command runs, you should see the Journey Manager welcome screen, so you can proceed with the installation..
Next
Interactive Installation GUI Mode - 29 -
Interactive Installation CLI Mode | System Administrator |
The Journey Manager installer normally interacts with a user via GUI, but you can also run it in text-only mode so it inter-
acts with a user via CLI. The installation steps are the same, but the choices are all presented on the console.
To install Journey Manager using the interactive CLI mode, run the following commands from the Journey Manager install-
ation folder:
Windows
java -jar avoka-tm-setup-19.5.0-win-x64.jar text
Linux
java -jar avoka-tm-setup-19.5.0-linux-x64.jar text
Next
Interactive Installation CLI Mode - 30 -
Installation Modes | System Administrator |
The Journey Manager installer allows you to specify your installation options on the Installation Mode Setup screen:
To choose the installation modes and deployment environments:
1. Select the setup task, which can be:
l Install a new Journey Manager server.
l Upgrade an existing Journey Manager server, which must be version 4.3 or higher.
l Configure a Journey Manager server to use a database.
l Build a custom user portal.
2. Select the environment where to install Journey Manager:
l AWS Cloud - if a server is hosted on the Amazon cloud.
l On Premise- if a server is hosted on client premises.
The deployment mode affects what screens are shown in the installer, so ensure you select the correct set-
ting to avoid any installation issues.
3. Click Next.
This documentation only describes how to install and upgrade Journey Manager.
Next
Installation Modes - 31 -
License Key | System Administrator |
The License Key screen allows you to enter the license key for your Journey Manager server. It is not permitted to install
or run a Journey Manager server without a valid license key, so you must request it from Temenos before the installation.
You will need to use the license key for each Manager installation and upgrade, including development and test envir-
onments.
To specify the license key:
1. Enter the license key in the Journey Manager Server License Key field.
Make a record of the license keys and keep it handy as you need them to install or upgrade a Journey Man-
ager server using the installer.
2. Click Next.
A Journey Manager instance maps to a Journey Manager database, such as Prod, UAT, Test, and Dev. Each Journey Man-
ager instances can comprise several server nodes. Typically, a production Journey Manager instance has at least 2 server
nodes to provide high availability, while a development Journey Manager instance has only 1 server node.
If Journey Manager servers are deployed on premise, the network firewall rules must be configured to allow Journey Man-
ager server nodes to upload license compliance reports to https://s3-us-west-2.amazonaws.com. License compliance
reports contain transaction licensing meta data that are automatically uploaded at the end of each day. If the license report-
ing can't be uploaded, errors are thrown and recorded in the error log.
The OS Version screen allows you to select your target Operation System version, so the Journey Manager installer uses
correct libraries.
To specify the target OS version:
1. Select one of the following:
l CentOS 7
l CentOS 6
2. Click Next.
Next
OS Version - Linux - 33 -
Database Server | System Administrator |
The Database Server screen allows you to select a database server that Journey Manager will use to store and manage
its data. The installer configures Journey Manager and relevant applications based on your selection. If you need to
change the database later, you can do it by re-installing Journey Manager again. However, the data won't be migrated to
the new database.
You can only see this screen if you've chosen the on premise installation. For the AWS cloud installation,
Amazon RDS Aurora is used.
To specify a database:
1. Select one of the following:
l MySQL 5.7, 5.6 and 5.5
l Oracle 12c and 11g
l SQL Server up to 2017 with unicode support
If you are upgrading an existing Journey Manager server, select the database currently configured for your
server.
2. Click Next.
Next
Database Server - 34 -
PDF Receipt Services | System Administrator |
The PDF Receipt Services screen allows you to specify services that Journey Manager will use to generate PDF
receipts. The installer configures Journey Manager's services based on your selection.
You can only see this screen if you've chosen the on premise installation.
To specify a receipt generator:
1. Select one of the following:
l Default Services
l Adobe LiveCycle ES4 or ES3. |
2. Click Next.
Next
PDF Receipt Services - 35 -
Server Memory | System Administrator |
The Journey Manager Server Memory screen allows you to configure how much memory will be available to your Jour-
ney Manager server.
To specify the correct memory settings:
1. Select the Java Max Memory, which is the amount of memory that will be available to the Journey Manager applic-
ation server:
l 12 GB RAM
l 8 GB RAM
l 4 GB RAM
l 1 GB RAM - development environments only
2. Select the Java GC Memory, which is the garbage collector memory that must be at least half of the Java Max
Memory value:
l 6 GB RAM
l 4 GB RAM
l 2 GB RAM
l 0.5 GB RAM - development environments only
3. Click Next.
Next
Server Memory - 36 -
Security Configuration | System Administrator |
The Security Configuration screen allows you to configure several important Journey Manager security settings.
To specify the security settings:
1. Select the Use secure cookies (HTTPS) checkbox to harden the Journey Manager security, so users can only log
onto the system over the secure HTTPS protocol. You must select this option for production and system testing
environments. For development or evaluation purposes, you don't need to select this option.
We strongly recommend you to use SSL with certificates issued by a valid CA on all servers, including non-pro-
duction servers.Don't use self-signed certificates, as they can cause many non-existent issues, which are hard to troubleshoot.
2. Select the Use only the Fluent API checkbox so services can use the Journey Manager's Fluent API only. If not
selected, developers can create dynamic Groovy services using legacy mode.
3. Select the Enforce Org. data isolation checkbox to limit Groovy services data access to the organization where
the services are running. This ensures Groovy services are not able to access user transaction data or application
configurations outside of their organization security context.
4. Click Next.
Next
Security Configuration - 37 -
Installation Directory | System Administrator |
The Installation Directory screen allows you to configure the directories where Journey Manager will be installed or
upgraded. These directories are slightly different, as described below.
To specify the server's installation directories:
1. Select a directory from the Journey Manager server field, where to install Journey Manager.
2. Select a directory from the Setup installation directory field, where the installer will store the deployment modules
and resources that are not deployed to Journey Manager, such as SQL table create scripts, LiveCycle archives and
so on.
3. Click Next.
To specify the server's upgrade directories:
1. Ensure the Journey Manager service is stopped.
2. Select a directory from the Journey Manager server field, where to upgrade Journey Manager.
3. Select a backup directory from the Backup directory field, where the installer will create a backup of the current
Journey Manager server's directory before the upgrade.
4. Select a directory from the Setup installation directory field, where the installer will store the deployment modules
and resources that are not deployed to Journey Manager, such as SQL table create scripts, LiveCycle archives.
Installation Directory - 38 -
If the Setup installation and the Backup directory folders exist, make sure they are empty.
5. Check the target database version. is correct for the Journey Manager version to be upgraded.
6. Click Next.
Next
Installation Directory - 39 -
Modules and Form Spaces | System Administrator |
The Modules and Spaces screen allows you to choose modules and form spaces to be deployed on the Journey Man-
ager server. Depending on your solution design, you may want to have separate servers for hosting public facing and man-
agement modules.
To specify the modules and form spaces:
1. Select the Core Modules that can be:
l Journey Manager - the management console, Temenos Marketplace and Journey Analytics modules.
l Receipt Server - the background PDF generator.
2. Select the Form Spaces that can be:
l JM Web Plugin - the default Web Plugin for public facing anonymous and authenticated form applications integ-
rated with public web sites.
l JM Work Space - the default Work Space form space for business staff and often internal staff performing tasks,
collaboration jobs and help desk functions.
l JM Salesforce - a form space to support Salesforce integration.
3. Click Next.
If you need to create a custom Journey Manager Work Space, use the Create a Journey Manager Work-
space option .
Next
Modules and Form Spaces - 40 -
Server Monitoring Form | System Administrator |
The Server Monitoring Form screen allows you to deploy the Server Monitor Test form on the Journey Manager server,
which is designed to monitor server availability externally, so it can be used by your organization operational support team
(OPS).
Select the Deploy Monitoring Form checkbox to install the Transact Server Monitoring organization and the Server Mon-
itor Test form.
Next
Server Monitoring Form - 41 -
Logging Configuration | System Administrator |
The Logging Configuration page screen allows you to customize date and time format used in log files generated by
Journey Manager.
Next
Logging Configuration - 42 -
Configure Database | System Administrator |
The Database Configuration screen allows you to configure the database connection to the database server you've
selected previously. The installer will create configuration files and applications required for the specified database.
To configure the database:
1. Provide the database server name in the Server hosting the database field.
2. Provide the database port number in the Port field.
3. Enter the database name in the Database/schema name field. If you use an Oracle database, ensure you set the
database name correctly. For example, for the Oracle 11g Express Edition DB, the database name is XE.
4. Provide the database user name in the User login field.
5. Enter the database user password in the Password field.
6. Select the Create the database tables checkbox if you have already created the txmanager database and are
running the installer for the first time. The installer automatically creates the database tables and indexes. These
database operations are performed as a user you specify in the installer. If you are upgrading an existing Manager
server, the Create the database tables option is not available, because your server already uses a fully initialized
and working database. The schema will be automatically upgraded when Manager starts the first time after the
upgrade.
7. Click Next.
Next
Configure Database - 43 -
Perform Installation | System Administrator |
The Perform Installation screen allows you to review your Journey Manager installation configuration, so you can decide
whether you want to proceed or go back to correct the configuration.
To install Journey Manager, click Install.
If an error occurs during the installation, click Show Details to view the detailed installation log. You can click Back to nav-
igate to the previous screen to correct any configuration settings and then retry the installation.
Next
Perform Installation - 44 -
Create a Service | System Administrator |
Journey Manager has to be run as a OS service, so it performs as expected. This service is created differently depending
on your target OS.
Microsoft Windows
The Journey Manager installer automatically creates the Avoka Transaction Manager service, if you are installing Jour-
ney Manager on Microsoft Windows servers. The Avoka Transaction Manager service is configured as Automatic, so it
is started automatically when the Windows server is started or restarted.
Linux
You need to configure and start Journey Manager as a service using the txmanager script, if you are installing Journey
Manager on Linux servers. If you are upgrading Journey Manager, make sure you keep a copy of the previous txmanager
script.
To configure Journey Manager as a service:
1. Open an administrator command shell.
2. Navigate to the server bin installation directory, for example: /data/a-voka/transact/manager/server/bin.
3. Add execute permission (chmod +x) on all the .sh files.
4. Navigate to the database updater directory, for example: /data/a-voka/transact/manager/server/standalone/db-updater.
5. Add execute permission (chmod +x) on all the .sh files.
6. Navigate to the PhantomJS directory in the server installation directory, for example: /data/a-voka/transact/manager/phantomjs.
7. Add execute permission (chmod +x) to the PhantomJS file inside the folder: chmod +x phantomjs.
8. Navigate to the Puppeteer directory in the server installation directory, for example: /data/a-voka/transact/manager/puppeteer.
9. Add execute permission (chmod +x) to the puppeteer.sh file inside the folder: chmod +x puppeteer.sh.
10. Copy [JM artifacts folder]/linux/txmanager to the directory /etc/init.d. The "[JM arti-facts folder]" is the directory where the installer stores the artifacts it produces. The defaults is /us-r/avoka-tm-install.
11. Edit the txmanager file and ensure the variable JAVAPTH is set to JDK 11 bin directory in the installation folder.
12. Add execute permission (chmod +x) on the txmanager file.
13. Edit the txmanager file and change the associated parameters such as user, installation address, etc.
To start the service, run service txmanager start.
Create a Service - 45 -
To stop the service, run service txmanager stop.
Linux Service Script
The installer comes with the txmanager script located in [JM artifacts folder]/linux/txmanager. The
example service script is shown below:
# # $Id: jboss_init_redhat.sh 60992 2007-02-28 11:33:27Z [email protected] $ # chkconfig: 2345 65 35 # processname: txmanager # pidfile: /var/run/txmanager.pid #define where SFMANAGER is - this is the directory containing directories log, bin, conf etc SFMANAGER_HOME=${SFMANAGER_HOME:-"@{installation.dir}/server"} #define the user under which jboss will run, or use 'RUNASIS' to run as the current user SFMANAGER_USER=${SFMANAGER_USER:-"root"} #make sure java is in your path JAVAPTH=${JAVAPTH:-"@{installation.dir}/@{jdk.folder.name}/bin"} #define the script to use to start jboss SFMANAGERSH=${SFMANAGERSH:-"./standalone.sh"} SFMANAGER_CONSOLE=${SFMANAGER_CONSOLE:-"run.log"} if [ "$SFMANAGER_USER" = "RUNASIS" ]; then SUBIT="" else SUBIT="su -s /bin/bash $SFMANAGER_USER -c " fi if [ -n "$SFMANAGER_CONSOLE" -a ! -d "$SFMANAGER_CONSOLE" ]; then # ensure the file exists touch $SFMANAGER_CONSOLE if [ ! -z "$SUBIT" ]; then chown $SFMANAGER_USER $SFMANAGER_CONSOLE fi
Create a Service - 46 -
fi if [ -n "$SFMANAGER_CONSOLE" -a ! -f "$SFMANAGER_CONSOLE" ]; then echo "WARNING: location for saving console log invalid: $SFMANAGER_CONSOLE" echo "WARNING: ignoring it and using /dev/null" SFMANAGER_CONSOLE="/dev/null" fi #define what will be done with the console log SFMANAGER_CONSOLE=${SFMANAGER_CONSOLE:-"/dev/null"} SFMANAGER_CMD_UPDATE_DB="cd $SFMANAGER_HOME/standalone/db-updater; ./up-date.sh;" SFMANAGER_CMD_START="cd $SFMANAGER_HOME/bin; $SFMANAGERSH" SFMANAGER_CMD_STOP="cd $SFMANAGER_HOME/bin; ./jboss-cli.sh --connect com-mand=:shutdown" if [ -z "`echo $PATH | grep $JAVAPTH`" ]; then export PATH=$PATH:$JAVAPTH fi if [ ! -d "$SFMANAGER_HOME" ]; then echo SFMANAGER_HOME does not exist as a valid directory : $SFMANAGER_HOME exit 1 fi #echo SFMANAGER_CMD_START = $SFMANAGER_CMD_START case "$1" in start) cd $SFMANAGER_HOME/bin if [ -z "$SUBIT" ]; then eval $SFMANAGER_CMD_UPDATE_DB >${SFMANAGER_CONSOLE} 2>&1 & if [ -f $SFMANAGER_HOME/bin/db-update.success ]; then echo "Starting TM..." eval $SFMANAGER_CMD_START >${SFMANAGER_CONSOLE} 2>&1 & else echo "Aborting..." fi else
Create a Service - 47 -
$SUBIT "$SFMANAGER_CMD_UPDATE_DB >${SFMANAGER_CONSOLE} 2>&1 &" if [ -f $SFMANAGER_HOME/bin/db-update.success ]; then echo "Starting TM..." $SUBIT "$SFMANAGER_CMD_START >${SFMANAGER_CONSOLE} 2>&1 &" else echo "Aborting..." fi fi ;; stop) if [ -z "$SUBIT" ]; then $SFMANAGER_CMD_STOP else $SUBIT "$SFMANAGER_CMD_STOP" fi rm -rf $SFMANAGER_HOME/standalone/tmp ;; restart) $0 stop $0 start ;; *) echo "usage: $0 (start|stop|restart|help)" esac
Next
Create a Service - 48 -
Install Additional Components - Linux | System Administrator |
Font substitution errors can occur when rendering forms and receipts, when the form was designed using Windows fonts
which are not present on a Linux server. The Journey Manager installer includes the Microsoft Core TrueType fonts in the
msttcore package.
To install the additional Microsoft Core TrueType fonts on Linux (Centos 6.3):
1. Unzip the msttcore font package from [Manager artifacts folder]/linux/msttcore.zip to the
/usr/share/fonts directory on your server.
2. Execute the following command: sudo fc-cache -fv
To install the additional Nimbus Sans fonts, execute the following command:
sudo yum install urw-fonts
To clear the font cache and verify the font is installed, execute the following commands:
sudo fc-cache -fv sudo fc-list | grep Nimbus
To support dynamic PDF receipt rendering using PhantomJS 2, check the international component for Unicode library
l Copy the SSL public certificate to [Apache folder]\conf\ssl
l Copy the SSL private key to [Apache folder]\conf\ssl
l Copy the SSL chain or root CA to [Apache folder]\conf\ssl
l Copy the SSL chain or root CA to [Apache folder]\conf\ssl
10. Modify the httpd.conf and httpd-ssl.conf:
l Open the [Apache folder]\conf\httpd.conf.
l Find the ServerName and replace it with the server's hostname or Journey Manager URL.
l If the httpd zip file is extracted to other location than C:\, search for C:\ and replace it with the correct location
of [Apache folder].
l Save and exit.
11. Modify the httpd-ssl.conf:
l Open the [Apache folder]\conf\extra\httpd-ssl.conf.
l Find the ServerName and replace it with the server's hostname or Journey Manager URL.
l Update the SSLCertificateFile with your SSL public certificate location.
l Update the SSLCertificateKeyFile with your SSL private key location.
l Update the SSLCACertificateFile with your SSL root CA or chain certificate location.
l Find the RedirectMatch and replace the URL with the Journey Manager URL.
l Find the RewriteEngine and un-comment this line. |
l Find the RewriteCond %{HTTP_HOST} !^yoururl.com$, un-comment it and replace yoururl.com
with server's hostname or the Journey Manager URL. |
l Find the RewriteCond %{HTTP_HOST} !^HostIpAddress$, un-comment it and replace HostIpAd-dress with the server's IP address. This is to allow you to use it with a load balancer. |
l Find the RewriteRule .* - [R=400] and un-comment it. |
l If the httpd zip file is extracted to other location than C:\, search for C:\ and replace it with the correct location
of [Apache folder].
l Save and exit.
12. Create folders for mod_cache and mod_security:
l Create the [Apache folder]\httpd_cache folder .
l Create the [Apache folder]\logs\mod_security folder .
13. Modify the mod_cache.conf:
l Open the [Apache folder]\conf\mod_cache.conf.
l Find the CacheRoot and set it to [Apache folder]\httpd_cache.
l Save and exit.
14. Confirm that TCP port 80 and 443 are opened in Windows firewall.
15. Install Apache as a Windows service:
Configure Apache Server - Windows - 74 -
l Run CMD as an administrator.
l Go to [Apache folder]\bin.
l Type httpd -k install to install a Windows service called Apache22.
16. Start Apache service.
17. Check the log files for error:
l Error log: [Apache folder]\logs\error.log or [Apache folder]\logs\ssl_error.log
l Access log: [Apache folder]\logs\access.log or [Apache folder]\logs\ssl_access.-log
l SSL request log: [Apache folder]\logs\ssl_request.log
18. Go to https://localhost/manager or https://<Journey Manager URL>/manager to verity the
installation.
Next
Configure Apache Server - Windows - 75 -
Configure Apache Server - Linux | System Administrator |
You have to install and configure a public facing Apache server to connect to Journey Manager.
The Apache Software Foundation has EOL support for Apache 2.2 and will no longer provide security patches for
this version, so you are strongly recommended to upgrade to Apache 2.4 to allow you to obtain the latest security
patches.
Apache 2.4 is not distributed with CentOS 6 or RedHat 6, so you need to upgrade your OS to CentOS 7 or
RedHat 7 to obtain an Apache 2.4 distribution. While you can continue using Journey Manager with Apache 2.2,
we recommend upgrading to Apache 2.4.
To install Apache on Linux:
1. Install the httpd and mod_ssl packages from repository:
sudo yum install httpd mod_ssl
2. Backup your current httpd.conf and ssl.conf files:
l Find the ServerName and replace it with the server's hostname or Journey Manager URL.
l Save and exit.
8. Modify /etc/httpd/conf.d/ssl.conf:
Configure Apache Server - Linux - 77 -
l Open the /etc/httpd/conf.d/ssl.conf.
l Find the ServerName and replace it with the server's hostname or Journey Manager URL.
l Update the SSLCertificateFile with your SSL public certificate location.
l Update the SSLCertificateKeyFile with your SSL private key location.
l Update the SSLCACertificateFile with your SSL root CA or chain certificate location.
l Find the RedirectMatch and replace the URL with the Journey Manager URL.
l Find the RewriteEngine and un-comment this line. |
l Find the RewriteCond %{HTTP_HOST} !^yoururl.com$, un-comment it and replace yoururl.com
with server's hostname or the Journey Manager URL. |
l Find the RewriteCond %{HTTP_HOST} !^HostIpAddress$, un-comment it and replace HostIpAd-dress with the server's IP address. This is to allow you to use it with a load balancer. |
l Find the RewriteRule .* - [R=400] and un-comment it. |
Journey Manager allows you to scan all forms' attachments for viruses using ClamAV virus scanner software.
To configure ClamAV:
1. Install ClamAV on your server.
It's recommended to install it on the same server as Journey Manager, because the ClamAV STREAM pro-
tocol opens TCP listener sockets over a range of ports, which makes it more difficult to configure firewall
rules on remote servers.
2. Open the clamd.conf file to increase the default ClamAV maximum file size from 25MB to 50MB, as shown
below:
# Close the connection when the data size limit is exceeded. # The value should match your MTA's limit for a maximum attachment size. # Default: 25M StreamMaxLength 50M
3. Configure the ClamAV service, which will be called to scan attachments for viruses.
4. Click Make Default to make ClamAV Virus Scan the default virus scan service.
5. Configure the ClamAV service to automatically update the virus definitions.
The Journey Manager installer allows you to upgrade your current Journey Manager with a newer version of software by
using one of the two options: upgrade or reinstall.
To upgrade Journey Manager:
1. Check upgrade version notes to understand what additional configuration changes you must perform prior to the
upgrade.
2. Select the Upgrade a Journey Manager 4.3+ server option to upgrade the existing server using the Setup Wiz-
ard.
This option is only supported for Journey Manager version 4.3 and higher.
It's recommended to use the upgrade option, because the installer automatically backups your existing server
and provides an installation-details.txt file with the details of what files are changed during the
upgrade.
To reinstall Journey Manager:
1. Check upgrade version notes to understand what additional configuration changes you must perform prior to the
upgrade.
2. Uninstall the existing Journey Manager.
3. Select the Install a new Journey Manager server option to install a new version of Journey Manager using the
Upgrade Journey Manager - 84 -
Setup Wizard.
This option works for all Journey Manager versions.
The installer automatically upgrades the database when Journey Manager is restarted, regardless of the upgrade option
you have selected.
Next
Upgrade Journey Manager - 85 -
Data Retention Policy Mode | System Administrator |
The Data Retention Policy Mode screen allows you to specify data retention policy mode, strict or relaxed, during the
upgrade.
To choose data retention policy mode:
l Select Strict for installations and upgrades of newer Journey Manager versions, as it helps you ensure system per-
formance meets the SLAs and system upgrades outage windows are minimize.
l Select Relaxed for upgrades of older Journey Manager versions, as it supports older work flow configurations.
Next
Data Retention Policy Mode - 86 -
Back up the Journey Manager Database | System Administrator |
Before you start installing the new version, shut down the Manager service and back up the Journey Manager database.
Always back up the Journey Manager database before performing an upgrade.
Next
Back up the Journey Manager Database - 87 -
Upgrade Journey Manager Server | System Administrator |
To upgrade Journey Manager in-place:
1. Stop the Journey Manager service and check it has stopped.
2. Run all required manual DB statements, as described in the upgrade notes.
3. Run the Journey Manager installer to perform the upgrade using the Upgrade a Journey Manager 4.3+ server
option on the Setup Wizard screen.
Ensure the same database version and database connection details are used.
If you have custom server shared modules JAR files deployed, perform the upgrade as normal.
4. Review your customized modules.xml file to ensure your custom JAR files are still referenced. If the mod-ule.xml has been updated, edit it to add references to your custom JAR files.
5. Review the /avoka/transact/installation-details.txt installation log file, containing the details on
all files that have been added, updated or deleted.
Next
Upgrade Journey Manager Server - 88 -
Reinstall Journey Manager | System Administrator |
To upgrade Journey Manager by reinstalling it:
1. Stop the Manager service and check that it has stopped.
2. Uninstall the Journey Manager service:
l Windows Run the [JM server folder]/bin/service-uninstall.bat batch file with administrator
privileges.
l Linux (CentOS or RedHat Enterprise Linux) The service is removed automatically, so you don't need to uninstall
it.
3. Rename the existing Journey Manager service installation directory. so the new installation can use this path. This
will also provide you with a backup of the existing installation.
4. Install a new Journey Manager version using the Setup Wizard. For more information, see run the installer.
Check the same database version and database connection details are used and the Create the database
tables checkbox is not selected.
Reinstall Journey Manager - 89 -
5. Restore any Custom Portal WAR files from your previous installation to the server deployments [JM server folder]/standalone/deployments folder. If your Portal or Module WAR file contains Java code, you must
rebuild it so that it references the correct services. Otherwise, you may receive runtime errors
Next
Reinstall Journey Manager - 90 -
Update a Service - Linux | System Administrator |
Follow the steps described in create a service to ensure the Linux service uses the latest service script and all files have
the correct access permissions set.
Next
Update a Service - Linux - 91 -
Update the Journey Manager Database | System Administrator |
To update the database:
1. Backup the current Journey Manager database.
2. Apply database updates, contained in the new version of Journey Manager, to the existing database.
3. Start Journey Manager using a service. There is a separate module that runs before the Journey Manager server
starts, which updates the database and initializing the core system configuration.
4. Monitor the [JM server folder]/standalone/log/db-update.log file to check the status of the data-
base update.
l The successful database update contains the following output:
INFO [com.avoka.fc.core.service.DatabaseVersionService] ... Updating database... INFO [com.avoka.fc.core.service.DatabaseVersionService] ... Results will be written to C:\Avoka\transact\manager\server\standalone\log\db-update\db-version-updates-2013-03-25-1436.txt ... INFO [com.avoka.fc.admin.service.DatabaseVersionService] ... Update completed successfully at 30 Apr 2013 10:32:23 INFO [com.avoka.fc.admin.service.DatabaseVersionService] ... 1 change(s) were applied to the database. Database schema update complete. ... Configuration initialization complete.
l The failed database update contains the following output:
6. Ensure Apache starts successfully. If errors occur during the installation, you can roll back the Apache change by
deploying the previous configuration files you backed up and restarting Apache again.
Next
Update Apache Configuration - 95 -
Verify the Server Upgrade | System Administrator |
Now, that the database is up to date, the Journey Manager server should start up. Monitor the [JM server folder-]/standalone/log/server.log log file for any errors or abnormalities. If any unusual errors occur, contact our sup-
port team and provide them with the log files. Should functionality be impacted, you may need to roll back to the old
version of Journey Manager.
If you use Adobe LiveCycle, log on to Journey Manager, select System > Server Nodes and click Synchronize Repos-
itories to synchronize it with Adobe LiveCycle. Check the synchronization completes successfully. |
Finally, test core functionality, such as form submission and rendering, to ensure that the system runs as expected. Keep
on monitoring the error and event logs in Journey Manager.
Check the upgrade notes for version specific instructions on configuration changes.
Next
Verify the Server Upgrade - 96 -
Clean up the JDK Folder | System Administrator |
The Journey Manager server comes with the Java Development Kit (JDK), which is required to run it. We regularly update
the JDK and include it in the Journey Manager installer, so it is deployed on your server during an upgrade. However, the
installer doesn't automatically remove the old JDK, so you may want to do it manually to free up some space on your
server.
To delete obsolete JDK folders:
1. Verify the Journey Manager installation is successful.
2. Navigate to the JDK folders at [JM install folder], for example, C:\avoka\transact.
3. Delete the old JDK folder. If multiple JDK folders exist, you can delete the ones with lower version numbers.
This is not a requirement to remove the obsolete JDK folders. This is merely to reclaim your disk space.
Next
Clean up the JDK Folder - 97 -
Installation Rollback | System Administrator |
You must roll back your new installation to the old version of Journey Manager, if it fails due to some errors that you can't
fix in-flight.
To rollback the installation of your Journey Manager:
1. Stop Journey Manager, if it is running.
2. Uninstall the service:
Windows Execute the [JM server folder]/bin/service-uninstall.bat file as an administrator.
Linux Replace the service script when reinstalling the old version.
3. Delete the Journey Manager folder, for example, the default C:\Avoka\transact\manager on Windows.
4. Perform the following extra steps depending whether
You upgraded your Journey Manager using the installer's option Upgrade a Journey Manager 4.3+ server:
l Copy log files, so you can find the problem that caused the installation failed.
l Delete the content of the Journey Manager server directory:
Windows
C:\avoka\transact\manager
Linux
/opt/avoka/transact/manager
l Copy the content of the backup directory, which you've specified during installation, to the Journey Manager
server directory.
l Reinstall the service:
Windows Execute the [JM server folder]\server\bin\service.bat -install as an admin-
istrator.
Linux Redeploy the old txmanager file.
Or you did the clean Journey Manager installation to a different folder using the installer's option Install a new
Journey Manager server:
Installation Rollback - 98 -
l Run the installer for the old version of Journey Manager and make sure the installer doesn't create the database
tables.
5. Restore the Journey Manager database from the backup.
6. Start Journey Manager.
Next
Installation Rollback - 99 -
Upgrade Checklist | System Administrator |
To upgrade an existing Journey Manager server:
l Obtain Journey Manager License Keys for each Journey Manager environment to be upgraded.
l Ensure you have the Journey Manager installer for the old version, as well as any custom WAR files.
l Ensure you have the same resources for the new Journey Manager version, as well as the upgrade notes.
l Check the upgrade notes for any version specific configuration changes to be performed prior to the upgrade.
l Take a backup of the Journey Manager database.
l Remove the Journey Manager service on Windows or back up the txmanager file on RedHat and Solaris, if you are
doing a clean install rather than an upgrade of the current server directory.
l Perform a turnkey installation or an in-place upgrade using the new version of the Journey Manager installer and the
existing database.
l Upgrade the Journey Manager LiveCycle application and form server WAR, if applicable.
l Ensure the current service script is deployed and the correct file permissions have been applied on Linux.
l Start Journey Manager and monitor the log files.
l Verify the installation is successful.
l Check the upgrade notes for any version specific configuration changes to be performed after the upgrade.
Follow the more detailed instructions in the previous sections for each step. If an error occurs during the upgrade, refer to
installation rollback.
Next
Upgrade Checklist - 100 -
Upgrade Previous Versions | System Administrator |
This section details the notes for upgrading configurations from previous versions of Journey Manager. You are required to
review and apply any relevant instructions for your Journey Manager version to complete the Journey Manager upgrade.
With every major version upgrade, you should upgrade form spaces' content to pickup any new software features, cap-
abilities and security enhancements.
The minimum version of Journey Manager that you can upgrade from is version 4.3. For older Journey Manager versions,
you must reinstall your Journey Manager in order to upgrade it, refer to reinstall.
Next
Upgrade Previous Versions - 101 -
Version 5.0 Upgrade | System Administrator |
When upgrading a Journey Manager server to version 5.0 or later, review the upgrade notes below.
Next
Version 5.0 Upgrade - 102 -
Form Work Space Changes | System Administrator |
The following Form Web Portal content changes have been made in Journey Manager version 5.0 since version 4.3:
Page or Resource Path Content Changes
click/not-found.htm (Page) fixed redirect bug.
login.htm (Page) improved accessibility with error state role=alert attributes.
WEB-INF/jboss-deployment-structure.xml
updated library module includes.
For Manager deployments with form spaces containing custom Java classes in the WAR file, they need to be recompiled
to ensure any Journey Manager Java API changes are updated in custom Java code. Contact our support to obtain a
portal's Java source code compatible with Manager version 5.0, so you can merge it with your custom Java project. We
recommend that customers migrate away from customized Java portals to enable an easier upgrade process.
Minor Manager v4.3.x upgrades with custom Java classes also need to be recompiled to ensure any API changes are
accounted form.
Manager Portal Java source code will only be provide to existing customers with custom Java projects, and will not be
made available for new Java custom portals.
Next
Form Work Space Changes - 103 -
Updated Default Configurations | System Administrator |
The following default configuration changes have been made with Journey Manager version 5.0. New systems include
these new defaults, while upgrades systems will maintain their existing configurations.
Configuration Description
New
Value
Previous
Value
Data Retention - Trans-action History
Maximum period of time Transaction History records are kept for.
2 years
5 years
Form Submission Access Controller - CSP
Service parameter 'Form CSP Header Value' which enabled form CSP policies.
- -
Next
Updated Default Configurations - 104 -
Version 5.1 Upgrade | System Administrator |
When upgrading a Manager server to version 5.1, review the previous upgrade notes and review the upgrade notes below.
After starting the Manager server, check the Manager server nodes configuration, which is particularly important for deploy-
ments with Adobe LiveCycle integration.
Next
Version 5.1 Upgrade - 105 -
Form Work Space Changes | System Administrator |
The following Form Web Portal content changes have been made in Journey Manager version 5.1 compared to version
5.0:
Page or Resource Path Content Changes
confirmation.htm (Page) formatting change.
receipt-challenge.htm (Page) new page that is used to control access to user receipts under some circumstances.
redirect.jsp security hardening.
secure/account/submission.htm added category filter where applicable.
WEB-INF/click.xml improved XSS protection.
WEB- INF/jboss- deployment-structure.xml
updated library module includes.
Important Notes
When upgrading to Manager version 5.1, all WAR files need to be rebuilt. The Manager installer will take care of the stand-
ard Manager modules, such as Transact Manager and Business Reports, and form spaces, such as Web Plug-in, Work
Space, and Maguire, as part of the upgrade.
However, if you have custom work space WAR files, you need to rebuild them by running the installer and choosing the
option Create a Transact Work Space. For more information, see form spaces.
Additionally, if you have a T.Field form space deployed, you will need to deploy the updated WAR file manually. It is loc-
ated at [Manager setup directory]/war/avoka-sf-field-worker.war and needs to be deployed to
[Manager server directory]/standalone/deployments.
If you don't ensure that all custom WAR files are rebuilt, your spaces may not work after the upgrade. Contact our support
with any concerns you have before upgrading your Manager server.
When upgrading an existing Manager server to version 17.10, review the previous upgrade notes and review the upgrade
notes below.
Next
Version 17.10 Upgrade - 107 -
Apache 2.4 Support | System Administrator |
Up until now the Journey Manager installer included configuration files for Apache 2.2. This Apache version has reached
its End of Life (EOL) and is no longer being supported by the Apache Foundation.
Important Note: we strongly recommend you upgrade any existing Apache 2.2 servers to Apache 2.4 to obtain the the
latest security patches.
Journey Manager version 17.10.0 has introduced support for Apache 2.4, including mod_security 2.9.2, but we will con-
tinue to support Apache 2.2 while customers migrate to the new version of Apache.
On Linux, due to library compatibility issues, the following configurations are supported:
l CentOS 7 or RedHat 7 with Apache 2.4
l CentOS 6 or RedHat 6 with Apache 2.2
If you have an existing Manager server on CentOS 6 or RedHat 6 and want to move to Apache 2.4, you will need to:
1. Create a new CentOS 7 or RedHat 7 instance
2. Install a Manager server
3. Install and configure an Apache 2.4 server
4. Configure Manager to use your existing database
Next
Apache 2.4 Support - 108 -
New DB Unique Indexes | System Administrator |
Journey Manager version 17.10.0 introduces new database indexes around submission data that will help maintain data
integrity.
To ensure your Journey Manager servers are free of issues and will be able to apply the indexes successfully, we recom-
mend that you run the following database statements as part of the upgrade, after shutting down the Manager service and
backing up the database:
1. Find duplicate rows:
SELECT submission_oid FROM submission_extract_json GROUP BY submission_oid HAVING COUNT(*) > 1;
SELECT submission_oid FROM submission_data GROUP BY submission_oid HAVING COUNT(*) > 1;
If neither query returns any rows, your database is fine and you can continue with the Manager upgrade. Other-
wise, continue with the steps below.
2. Delete duplicates:
For submission_data:
DELETE FROM submission_data WHERE submission_data_oid IN ( SELECT min(sdA.submission_data_oid) FROM ( SELECT * FROM submission_data) as sdA WHERE sdA.submission_oid in ( SELECT submission_oid FROM (SELECT * FROM submission_data) as sdB GROUP BY submission_oid HAVING COUNT(*) > 1) GROUP BY sdA.submission_oid);
For extract_json:
DELETE FROM txmanager.submission_extract_json WHERE sub_extract_json_oid IN ( SELECT min(jsA.sub_extract_json_oid) FROM ( SELECT * FROM submission_extract_json) as jsA WHERE jsA.submission_oid in ( SELECT submission_oid FROM (SELECT * FROM submission_extract_json)
New DB Unique Indexes - 109 -
as jsB GROUP BY submission_oid HAVING COUNT(*) > 1) GROUP BY jsA.submission_oid);
Ensure all changes are committed.
3. Step 3: Repeat as necessary. After step 2, go back to step 1 and rerun the SELECT queries, then continue on to
step 2 if there are still results. This is necessary because the queries in step 2 delete only a single duplicate at a
time.
Next
New DB Unique Indexes - 110 -
Dynamic PDF Receipt 2 Service | System Administrator |
Journey Manager version 17.10.0 introduces an improved Dynamic PDF receipt render service using PhantomJS. The new
service allows for easier and more extensive customization and better error handling, and is available on both existing and
new Manager installations.
The service is named Dynamic PDF Receipt 2 and is the default receipt render service for new installations.
On existing installations, the default receipt render service will not change during the upgrade. You can test the new ser-
vice by either assigning it to specific form versions first:
Once you are satisfied with the new receipt rendering service, you can make it the system default service:
Dynamic PDF Receipt 2 Service - 111 -
Next
Dynamic PDF Receipt 2 Service - 112 -
Form Work Space Changes | System Administrator |
The following Form Web Portal content changes have been made in Manager version 17.10.0 compared to version 5.1:
Page or Resource Path Content Changes
create-account.htm (Page) removed support for eSignatures
error.htm (Page) by default, display less information for security reasons
click/error.htm (Page) by default, display less information for security reasons
Additionally, if you have a T.Field form space deployed, you will need to deploy the updated WAR file manually. It is loc-
ated at [Manager setup directory]/war/avoka-sf-field-worker.war and needs to be deployed to [Manager server directory]/standalone/deployments.
If you do not ensure that all custom WAR files are rebuilt, your spaces may not work after the upgrade. Contact our support
with any concerns you have before upgrading your Manager server.
Next
Form Work Space Changes - 114 -
Version 18.05 Upgrade | System Administrator |
When upgrading an existing Manager server to version 18.05, review the previous upgrade notes and review the upgrade
notes below.
There are no Work Space content changes in the 18.05 release which need to be merged with previous Form Work Space
portals.
Next
Version 18.05 Upgrade - 115 -
Submission Data DB Indexes | System Administrator |
Manager version 18.5.0 introduces new database indexes around submission data that will help maintain data integrity.
To ensure your Manager servers are free of issues and will be able to apply the indexes successfully, we recommend that
you run the following database statements as part of the upgrade, after shutting down the Manager service and backing up
the database:
1. Find duplicate rows:
SELECT submission_oid FROM submission_extract_json GROUP BY submission_oid HAVING COUNT(*) > 1; SELECT submission_oid FROM submission_data GROUP BY submission_oid HAVING COUNT(*) > 1;
If neither query returns any rows, your database is fine and you can continue with the upgrade. Otherwise, con-
tinue with the steps below.
2. Delete duplicates
For submission_data:
DELETE FROM submission_data WHERE submission_data_oid IN ( SELECT min(sdA.submission_data_oid) FROM (SELECT * FROM submission_data) as sdA WHERE sdA.submission_oid in (SELECT submission_oid FROM (SELECT * FROM sub-mission_data) as sdB GROUP BY submission_oid HAVING COUNT(*) > 1) GROUP BY sdA.submission_oid)
For extract_json:
DELETE FROM txmanager.submission_extract_json WHERE sub_extract_json_oid IN ( SELECT min(jsA.sub_extract_json_oid) FROM (SELECT * FROM submission_extract_json) as jsA WHERE jsA.submission_oid in (SELECT submission_oid FROM (SELECT * FROM sub-mission_extract_json) as jsB GROUP BY submission_oid HAVING COUNT(*) > 1) GROUP BY jsA.submission_oid)
Ensure all changes are committed.
Submission Data DB Indexes - 116 -
3. Repeat as necessary. After step 2, go back to step 1 and rerun the SELECT queries, then continue on to step 2 if
there are still results. This is necessary because the queries in step 2 delete only a single duplicate for any given sub-
mission at a time.
Next
Submission Data DB Indexes - 117 -
Form Work Space Changes | System Administrator |
While some HTML template changes were made to version 18.05 compared to version 17.10, these changes are not
required and are commented out. You also don't need to merge any HTML template changes from 18.05 into your existing
Portal content.
The following Form Web Portal content changes have been made in Manager version 18.05 compared to version 17.10:
Page or Resource Path Content Changes
resources\includes\account\tile-help-desk.html
Added section for displaying the Lazy Load message instead of the current No Records message. This requires the new "Search Data Load" property change to "Lazy Data Load".
secure\account\help-desk.htm Section added for startDateField or endDateField. Will need to uncomment 2 line starting ##<script
Important Notes
When upgrading to Manager version 18.05, all WAR files need to be rebuilt. The Manager installer will take care of the
standard Manager modules, such as Transact Manager and Business Reports, and form spaces, such as Web Plug-in and
Work Space, as part of the upgrade.
However, if you have custom work space WAR files, you need to rebuild them by running the installer and choosing the
option Create a Transact Work Space. For more information, see form spaces.
Additionally, if you have a T.Field form space deployed, you will need to deploy the updated WAR file manually. It is loc-
ated at [Manager setup directory]/war/tm-field-worker.war and needs to be deployed to [Manager server directory]/standalone/deployments.
If you do not ensure that all custom WAR files are rebuilt, your spaces may not work after the upgrade. Contact our support
with any concerns you have before upgrading your Manager server.
