Product Documentation
Abstract
Three distinct procedures exist to deploy the Content Platform Engine (FileNetEngine) application into a WebSphere or WebLogic domain:
Install – Creating a Content Platform Engine application instance on your application server for the first time.
Upgrade - Moving from a down-level release to a new major release. For example, changing a FileNet P8 domain managed by CPE 5.2.0.3 to be managed by CPE 5.5.1 is defined to be an “upgrade”.
Update - Deploying an interim fix or test fix on top of an existing CPE 5.5.1 deployment. For example, moving from CPE 5.5.1 to 5.5.1.0-P8CPE-IF001 is defined to be an “update”.
This document describes how to use Configuration Manager to perform a deployment update.
Content
Three distinct procedures exist to deploy the Content Platform Engine (FileNetEngine) application into a WebSphere or WebLogic domain:
- Install – Creating a Content Platform Engine application instance on your application server for the first time.
- Upgrade - Moving from a down-level release to a new major release. For example, changing a FileNet P8 domain running CPE 5.2.0.3 to running CPE 5.5.1 is defined as an “upgrade”.
- Update - Deploying an interim fix or test fix on top of an existing CPE 5.5.1 deployment. For example, moving from CPE 5.5.1 to CPE 5.5.1.0-P8CPE-IF001 is defined as an “update”.
The Configuration Manager task "Deploy Update" is used to deploy the Content Platform Engine when an update is needed. The task utilizes an existing FileNetEngine application instance and performs a WebSphere update application or a WebLogic redeploy application using the Engine-xx.ear from the fix.
Important:
- If you are using an interim fix or test fix during a new installation as directed by the Knowledge Center topic "Installing Content Platform Engine software updates", install and deploy the fix files as directed in the Readme for the fix. Then return to the instructions in the Knowledge Center topic to complete the new installation process. Do not use the CMUI "Deploy Update" task for new installations.
- If you are using an interim fix or test fix during an upgrade from a release prior to 5.5.1 as directed in the Knowledge Center topic "Installing Content Platform Engine software updates", install the fix files as directed in the Readme for the fix. Then return to the instructions in the Knowledge Center topic to complete the upgrade process. Do not use the CMUI "Deploy Update" task for major version upgrades.
If the FileNetEngine application is not present in the application server, the CMUI "Deploy Update" task cannot be used. Instead use the CMUI "Deploy Application" task to reinstall the FileNetEngine application again. If the FileNet P8 Domain was previously upgraded to the new major release that the fix applies to, the Content Platform Engine automatically detects the level of the FileNet P8 domain and associated object stores. Use of the "Deploy Application" task will not cause the upgrade process to be repeated. However the values provided for the choice of license and the GCD data sources will be reapplied to the WebSphere JVM arguments or the WebLogic deployment plan by the "Deploy Application" task.
The application server manages the replacement of the FileNetEngine application including the push of the new ear file to any WebSphere nodes or WebLogic managed servers. If this push of the files completes in a timely manner, the application server also manages the restart of the FileNetEngine application. In a WebSphere network deployment environment, for example, binary files are extracted after node synchronization is complete. The application can be restarted after the system pushes and extracts all binary files synchronizing the nodes or managed servers. A manual restart of the FileNetEngine application may be required.
Adding and Running the Deploy Update task interactively
Using an existing CPE 5.5.1 Configuration Manager profile or creating a new CPE 5.5.1 Configuration Manager profile, you add the new task Deploy Update to the profile. You can then edit and save the task values without redeploying. When you run the task, the Content Platform Engine is redeployed as an application on the application server.
Adding the Deploy Update task
Procedure
To add the Deploy Update task:
1. Log on to the application server machine as the account utilized as the Configuration Manager user.
2. Start Configuration Manager.
Option |
Description |
AIX®, Linux, Linux on System z® |
Type the following command: <ce_install_path>/tools/configure/configmgr where <ce_install_path> is the location where the Content Platform Engine server software is installed |
Windows |
Complete one of the following actions:
where ce_install_path is the location where the Content Platform Engine server software is installed |
3. Use the File menu option to either:
- Open Profile to open an existing CPE 5.5.1 Configuration Manager profile
- New Installation Profile to create a new CPE 5.5.1 Configuration Manager profile
4. Verify or enter the Application Server Properties using the Test Connection button to verify the connection before using Finish
5. Right-click on the main profile node in the profile pane (left pane) and choose Add New Task
6. From the list of tasks, select Deploy Update
7. Right-click the Deploy Update task that appears in the profile pane (left pane), and select Edit Selected Task.
8. Provide the property values for your deployment. For details on the fields, hover your mouse over the ? icon to view the property description.
9. Select File > Save.
Running the Deploy Update task
You can update/redeploy a Content Platform Engine Server instance on the application server by using the graphical user interface. Redeploying makes the new version of the FileNetEngine application available for use.
1. Right-click the Deploy Update task in the left pane, and select Run Task .
Running the Deploy Update task might take several minutes. The task status messages are displayed in the Console pane below the deploy update properties.
Note: Due to the time it might take to distribute the application files, the Configuration Manager might report successful completion of the Deploy Update task before the application server pushes and extracts each binary file.
2. If the application server was shutdown before the Deploy Update task was executed, or if the application server does not restart the FileNetEngine application in a timely fashion, manually restart the FileNetEngine application after confirming the new files were distributed by the application server to all nodes or managed servers.
3. Open the Content Engine (CE) Ping Page and verify the build number and other information is as expected.
Update of the FileNetEngine application is now complete.
Adding and Running the Deploy Update task using command-line
Using an existing CPE 5.5.1 Configuration Manager profile or creating a new CPE 5.5.1 Configuration Manager profile, you add the new task deployupdate to the profile. You then edit the deployupdate.xml verifying the values provided. When you run the task, the Content Platform Engine is redeployed as an application on the application server.
Adding the deployupdate task
- Log on to the Content Platform Engine server as the user who is designated as the config_mgr_user user.
- Change the current directory to ce_install_path/tools/configure, where ce_install_path is the path where you installed Content Platform Engine. For example, ce_install_path might be /opt/FileNet/ContentEngine.
- Generate the deployupdate.xml task file for an existing CPE 5.5.1 Configuration Manager profile or as part of a new CPE 5.5.1 Configuration Manager profile. See the table below for more information about these and additional parameters.
configmgr_cl generateconfig -appserver appserver_type -deploy deploy_type -task deployupdate -taskfile deployupdate.xml -profile myprofile
4. In the deployupdate.xml task file, replace each occurrence of ****INSERT VALUE**** with a value appropriate for your site. See the descriptions in the file for more information.
The following table lists the descriptions for the configmgr_cl generateconfig for deployupdate command parameters:
Parameter |
Description |
-appserver appserver_type |
This parameter specifies the type of application server and must be one of the following values: WebSphere, or WebLogic. |
-deploy deploy_type |
The -deploy deploy_type parameter specifies the type of Content Platform Engine deployment. The value must be standard, cluster, or netdeploy (network deployment).
|
-task deployupdate |
The -task deployupdate parameter indicates the server to update the existing application deployment. |
-taskfile deployupdate.xml | Where the named task file contains Deploy Update information. Default is deployupdate.xml. |
-profile myprofile |
The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items:
|
-silent |
The -silent parameter is optional. When -silent is specified, no prompts or informational messages display in the console, but errors are written to the log. Failure messages and validation error messages display as needed, such as messages about missing passwords or invalid port numbers. If you run the execute command to run all the tasks in a profile, and you specify the -silent parameter, you must also specify the -force parameter. |
-help |
When -help is specified, a brief message displays on the command syntax instead of running the command. |
Running the deployupdate task
- Run the Configuration Manager Deploy Update command to update the existing configuration profile.
configmgr_cl execute -task deployupdate -taskfile deployupdate.xml -profile myprofile
Checking the completion status of the deployupdate task
From the command line you can check the status of a single task, such as the deployupdate task. Checking the completion status does not validate the information in the XML files.
- Set the current directory to ce_install_path/tools/configure, where ce_install_path is the location where Content Platform Engine is installed.
- From the command line, run the following command:
configmgr_cl checkStatus -task deployupdate -profile myprofile
Note: Due to the time it might take to distribute the application files, the Configuration Manager might report successful completion of the deployupdate task before the application server pushes and extracts each binary file.
3. If the application server was shutdown before the deployupdate task was executed, or if the application server does not restart the FileNetEngine application in a timely fashion, manually restart the FileNetEngine application after confirming the new files were distributed by the application server to all nodes or managed servers.
4. Open the Content Engine (CE) Ping Page and verify the build number and other information is as expected.
Original Publication Date
24 August 2018
Document Location
Worldwide
Product Synonym
Content Platform Engine (CPE)
Configuration Manager User Interface (CMUI)
Was this topic helpful?
Document Information
More support for:
FileNet Content Manager
Software version:
5.5.1
Operating system(s):
AIX, Linux, Windows
Document number:
719883
Modified date:
26 September 2022
UID
ibm10719883