IBM FileNet P8, Version 5.2

Workplace XT configuration file backup

If a Workplace XT server fails, you must restore the software, either by reinstalling the same version of the software from the installation image or by restoring the server files from a complete server backup. If you reinstall the software, you can restore Workplace XT functionality to the state before the failure by restoring its configuration files.

For optional components that are installed on an Workplace XT server:

IBM® Enterprise Records: See Backing up IBM Enterprise Records configuration files for detailed requirements.
IBM FileNet® eForms for P8: Configuration files for eForms are stored in the Workplace XT configuration directory. Backing up Workplace XT as described in the following section automatically backs up eForms configuration files.

What to back up

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

Use the following table to determine the files to back up.

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 reconfigured manually	Comments
Site preference configuration files	`workplace_xt_installation_path`\`config_dir`	Infrequently The following files are modified when you edit Workplace 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	`workplace_xt_installation_path`\`config_dir`\log4j.properties	Upon installation; subsequently, infrequently	Yes	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 For more information, see Configure logging.
Deployment descriptor file	In `app_root`\WEB-INF: web.xml	Upon installation; subsequently, infrequently	Yes	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	In `app_root`\WEB-INF: WcmApiConfig.properties	Upon installation; subsequently, infrequently	Yes	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	In `workplace_xt_installation_path`\FileNet\Authentication: CryptoKeyFile.properties UTCryptoKeyFile.properties	Upon installation; subsequently, infrequently	Yes	Back up any time you make manual edits to these files.
Process Task Manager configuration files	In `workplace_xt_installation_path`\FileNet\Router: taskman.properties taskman.policy	Periodic	Yes	Back up any time you make manual edits to these files.
Process Task Manager configuration file	In `workplace_xt_installation_path`\FileNet\Router: taskman.login.config	Upon installation; subsequently, infrequently	Yes	This file is modified if you change the connection point in the Workplace XT site preferences.