Back up Workplace XT configuration files

Should a Workplace XT server fail, you must restore the software, either by reinstalling the software from the FileNet P8 Platform installation disk or by restoring the server files from a complete server backup. Once restored, you can restore Workplace XT's functionality to the state before the failure by restoring its configuration files.

NOTE  For optional expansion products installed on Workplace XT server:

What to back up

Workplace XT is installed as an application on your application server. FileNet recommends that you back up your application server according to the instructions of your application server vendor. Since application server configurations and directory structures vary from vendor to vendor, this topic only provides general information about how Workplace XT interacts with the application server. In general you should back up any Workplace XT files that you edit directly on the Workplace XT application server. Use the following table to determine the files to back up.

NOTE  Where the Windows and UNIX paths are identical except for the separators, the Windows format is used.

Backup target Default location Frequency of changes /
Can be recreated without backup
Comments
Site preference configuration files <WPXT_install_path>\<config_dir>
Infrequently

NOTE  The following files are modified when you edit Workplace XT site preferences.

  • Actions.xml
  • MenuActions.xml
  • PrimaryViews.xml
  • SystemPropertiesView.xml
  • bootstrap.properties

Back up all files located in this directory.

The config_dir is specified during installation and is stored in web.xml. For example, the default Windows path is:

C:\Program Files\FileNet\Config\WebClient

Logging properties file <WPXT_install_path>\<config_dir>\log4j.properties

Upon installation; subsequently, infrequently

/

Can be manually reconfigured

The config_dir is specified during installation and is stored in web.xml. For example, the default Windows path is:

C:\Program Files\FileNet\Config\WebClient

See Configure logging for more information.

Deployment descriptor file

<app_root>\WEB-INF\web.xml

Upon installation; subsequently, infrequently

/

Can be manually reconfigured

Back up any time you make manual edits to this file.

Consult your application server documentation to determine the location of the root application directory (<app_root>).

WcmApiConfig.properties file

<app_root>\WEB-INF\WcmApiConfig.properties

Upon installation; subsequently, infrequently

/

Can be manually reconfigured

Back up any time you make manual edits to this file.

Consult your application server documentation to determine the location of the root application directory (<app_root>).

See WcmApiConfig.properties file for more information.

Encryption keys

<WPXT_install_path>\FileNet\Authentication\

CryptoKeyFile.properties
UTCryptoKeyFile.properties

Upon installation; subsequently, infrequently

/

Can be manually reconfigured

Back up any time you make manual edits to these files.

Process Task Manager configuration files

<WPXT_install_path>\FileNet\Router\

taskman.properties
taskman.policy

Periodic

/

Can be manually reconfigured

Back up any time you make manual edits to these files.
Process Task Manager configuration file

<WPXT_install_path>\FileNet\Router\taskman.login.config

Upon installation; subsequently, infrequently

/

Can be manually reconfigured

This file is modified if you change the Process Engine Connection Point in the Workplace XT site preferences.