Enabling the Update Service

Navigation: JIA Update Service:

Enabling the Update Service

Contents

Enabling the JIA Update Service involves:

•Updating values in the configuration files provided (jiaClientUpdater.config and jiaServerUpdater.config)

•Deploying the following required files to the relevant locations:

ojiaClientUpdater.config

oJIAClientUpdater.exe

oJIAClientUpdater.exe.config

ojiaServerUpdater.config

oJIAUpdaterService.exe

oJIAUpdaterService.exe.config

The following sections describe these files in detail and explain the configuration and deployment required:

•Understanding the Updates Folder (below)

•Updating the jiaClientUpdater.config File

•Updating the jiaServerUpdater.config File

•Updating Agent Configuration Settings

Understanding the Updates Folder

All files related to the JIA Update Service are provided in the Updates folder of the installation package. The files are listed and described in the following table.

File Name	Description	Deployed In:
ClientConfig.csd.xsd	Schema file for jiaClientUpdater.config	N/A
jiaClientUpdater.config	Configuration file for the Update Client. For information about settings, refer to Updating the jiaClientUpdater.config File.	JIARuntime client folder
JIAClientUpdater.exe	Client updated executable	JIARuntime client folder
JIAClientUpdater.exe. config	Client updated executable config file	JIARuntime client folder
jiaServerUpdater.config	Configuration file for the Update Server. For information about settings, refer to Updating the jiaServerUpdater.config File.	Update Server (shared file system, HTTP server, FTP server, etc.)
JIAUpdaterService.exe	Updater admin service installer and executable. To enable automatic updates, this file needs to be installed on every desktop for which the user has no write permissions for the JIARuntime client folder.	JIARuntime client folder
JIAUpdaterService.exe. config	Updated admin service config file	JIARuntime client folder
ServerConfig.csd.xsd	Schema file for jiaServerUpdater.config	N/A

Updating the jiaClientUpdater.config File

This file specifies the current client version and the location(s) of the server configuration file. The JIA agent compares the current client version to the version specified in the server configuration file. If the version specified in the server configuration file is higher, update packages are downloaded.

Properties that need to be configured are listed and described in the following table.

Property	Description	Example
productName	Name of the product.	JIA
installedVersion	The current project version. This is not the JIA core version, but a deployment version set by the project developers.	5.5
serverFileSites	Location of the server configuration file. Supported locations include network drives, FTP servers and HTTP servers. The path must be specified using standard URL convention. If a list of locations is provided, the first successful path is used, and the others are ignored.	file://C:/Dev/updater/jiaServerUpdater.config

Property

Description

Example

productName

Name of the product.

JIA

installedVersion

The current project version. This is not the JIA core version, but a deployment version set by the project developers.

5.5

serverFileSites

Location of the server configuration file. Supported locations include network drives, FTP servers and HTTP servers. The path must be specified using standard URL convention.

If a list of locations is provided, the first successful path is used, and the others are ignored.

file://C:/Dev/updater/jiaServerUpdater.config

Updating the jiaServerUpdater.config File

This file specifies the updated client version and the location(s) of the update packages. Properties that need to be configured are listed and described in the following table.

Property	Description	Example
latestVersion	The updated project version. This is not the JIA core version, but a deployment version set by the project developers.	5.6
updateFiles	Location of the update file(s). Supported locations include network drives, FTP servers and HTTP servers. The path must be specified using standard URL convention. If a list of locations is provided, the first successful path is used, and the others are ignored.	file:///C:/Dev/updater/jia5.6.zip
deleteFiles	A list of files to be deleted from the current build. If a specified file doesn't exist, it is skipped. This property is not mandatory.	dir2\b.txt
updateDescription	A message to be displayed following the update. This property is not mandatory.	Updated to build number 20
serverConfigurationSites	Location of the server configuration file. The configuration defined in this file overrides the corresponding client configuration. When the Update Service Client next checks for updates, the new configuration will be used.	file://C:/Dev/updater/jiaServerUpdater.config

Updating Agent Configuration Settings

Once the configuration files have been modified appropriately and all update files have been deployed, the Update Service tab appears in the JIA Configuration Settings. This tab enables you to view and update default runtime settings relevant to the JIA Update Service.

If the default settings are not modified, the JIA Update Service will run automatically every time the JIA runtime application is launched.