Content Platform Engine bootstrap properties
Content Platform Engine needs bootstrap information in order to create the Global Configuration Database (GCD), and thereafter to provide the resources it needs to boot up. During Content Platform Engine configuration, Configuration Manager configures the bootstrap file with information supplied by the user. Once Content Platform Engine is configured and the new FileNet® P8 domain is created and functioning, the bootstrap file continues to provide the information below to allow Content Platform Engine to load. The bootstrap file is named CEMPBoot.properties and is contained in the Content Platform Engine EAR file.
There are two reasons why you would edit the bootstrap file:
- The value of the Username property has to be changed. The account defined in the Username property is referred to in documentation as the "Content Platform Engine system user" (cpe_bootstrap_admin).
- The Java™ Naming and Directory Interface (JNDI) data sources are no longer available.
With planning and normal precautions, you can typically avoid these situations so that you never need to edit the bootstrap file. However, if these situations do occur, you can use either the Configuration Manager tool or the command line Bootstrap Configuration Utility (BCU) to edit the file, as described below. Note that changing the bootstrap password is a more complex procedure. For complete instructions on changing the password, see How to change Bootstrap administrator password.
All deployments of the EAR file, for the purpose of adding additional Content Platform Engine servers to the FileNet P8 domain, must use identical values for the bootstrap properties. Therefore, any changes you make to the EAR file for a system in production must be made to all such EAR files. Depending on how your Java EE application server is configured, these changes could be made as part of an automated deployment process.
- Sample CEMPBoot.properties file
The following is a sample bootstrap file showing sample values for the properties. In the example, the value for EncryptedPassword has already been set and programmatically encrypted by the Master Key.
com.filenet.gcd.CipherKeyLength=128
com.filenet.gcd.Username=CEMPAdmin
com.filenet.gcd.DigestAlgorithm=SHA
com.filenet.gcd.GCDConnection=jndiname\=Domain1DS;jndinamexa\=Domain1DSXA
com.filenet.gcd.EncryptedPassword=8dd56a9d9331b9cbe43536a42ce8146d
com.filenet.gcd.CipherAlgorithm=AESThese properties are defined in the following table:
| CEMPBootstrap properties | Definition |
|---|---|
| CipherKeyLength | Default length of the cipher key that will be used to encrypt GCD credentials. |
| Username | A directory service account that is granted the role of application
server administrator while running Configuration Manager's Configure
Bootstrap Properties task. This account will be used to log in to
the application server and access the datasources named in the GCDConnection
property. Content Platform Engine runs
as this account, and it is therefore referred to in documentation
as the "Content Platform Engine system
user" or cpe_bootstrap_admin. The value for this property is entered while running Configuration Manager's Configure Bootstrap Properties task, which refers to this account as the "Bootstrap user". See the entry for "Content Platform Engine system user" in Users and Groups. |
| DigestAlgorithm | Default digest algorithm used to perform encryption using the Master Key. See Content Platform Engine Encryption for information about the Master Key. |
| GCDConnection | The two datasource names that will be used in the creation of the GCD. Entered while running Configuration Manager's Configure Bootstrap Properties task. |
| EncryptedPassword | The encrypted password of the user identified by the Username property. Entered while running Configuration Manager's Configure Bootstrap Properties task. The encryption was carried out using the Master Key. |
| CipherAlgorithm | Default algorithm used to perform encryption using the Master Key. |
- Edit Content Platform Engine Bootstrap properties with the Bootstrap Configuration Utility
The Bootstrap Configuration Utility is a tool that edits the CEMPBoot.properties file. The bootstrap tool is contained in the BootstrapConfig.jar file, which is installed by the Content Platform Engine installation program into the Program Files\FileNet\ContentEngine\lib folder.
Use the command as follows:
java -jar BootstrapConfig.jar ...
-h
-v
-e file -l
-e file -rf
-e file -j file
-e file [-fnq] [-b bits] [-c algorithm] ...
[-g name] [-i name] [-k key] [-m algorithm] ...
[-p password] [-s name] [-u name] [-x name] ...
[-y class] [-o Boolean] [-w port] [-j file]
where- -b bits
- Cryptographic key length (in bits)
- -c algorithm
- Cryptographic cipher algorithm
- -e file
- Filename and optional path of the EAR file
- -f
- Forces the utility to ignore warnings
- -g name
- Cryptographic message digest provider
- -h
- Displays this help message
- -i name
- Cryptographic cipher provider
- -j file
- File path of the EAR file to be patched with bootstrap info
- -k key
- Optional. The seed string used to generate the Master cryptographic key. Using a seed is not FIPS-140 compliant. If there is no seed string the key will be generated randomly.
- -l
- Lists the current configuration
- -m algorithm
- Cryptographic message digest algorithm
- -n
- Forces the utility to store a plaintext password
- -o Boolean
- Forces master key safe mode
- -p password
- Password associated with username
- -q
- Suppresses text output
- -r
- Restores the configuration to default values
- -s name
- JNDI datasource name (non-XA)
- -t filepath
- Inserts the specified file into the EAR file
- -u name
- Username of an app server administrator
- -v
- Displays version and copyright information
- -w port
- HTTP Port for WSI (wasp.servlet.httpport)
- -x name
- JNDI datasource name (XA)
- -y class
- Keystore handler class name (with package)
Example
The following example shows how you would upgrade a new CEMPBoot.properties file by copying the CEMPBoot.properties file from a source (old) EAR file's props.jar file to a target (new) EAR file. The properties in the target will be overwritten. (The example shows WebSphere as the application server.)
java -jar BootstrapConfig.jar -e /opt/FileNet/ContentEngine/lib/
bootstrap_path/Engine-ws.ear -j /temp_device/Engine-ws.ear.where:
- -e
- introduces the source (old) EAR file
- -j
- introduces the target (new) EAR file
- ws
- denotes WebSphere
- wl
- denotes WebLogic
- jb
- denotes single JBoss
- jbc
- denotes the cluster installation of JBoss
If the props.jar or CEMPBoot.properties files do not exist in the target, they will be created based on the source. Creating the files can fix some cases of malformed target EAR files.
- Backup the old EAR file (the file referenced by the -e switch in the above example).
- Run the command shown in the example.
- Copy the new EAR file (the file referenced by the -j switch in the example) in the temp_device. Paste it so that it overwrites the old EAR file in the current bootstrap directory.
- Use the Configuration Manager tool to create a new profile, or open an existing profile, that includes the Deploy Application task. Run that task to re-deploy the updated EAR file. Alternatively, you can manually redeploy the EAR file.