Content Platform Engine, Version 5.2.1              

generateconfig command

The generateconfig command generates the configuration XML file for the specified configuration task. The command name is not case sensitive.

generateconfig command syntax

The following syntax includes line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.

configmgr_cl generateconfig -appserver app_server_type
 -license license_type
 -repositorytype ldap_repository_type
 -db database_type -ldap ldap_type -bootstrap bootstrap_operation
 -deploy deploy_type -task task_type -taskname display_name 
 -profile myprofile [-silent] [-force] [-help]

generateconfig command parameters

-appserver appserver_name
The -appserver appserver_type specifies the type of application server and must be WebSphere, JBoss or WebLogic.
-license license_type
The -license license_type parameter is for specifying the type of license to apply to your installed products and must be one of the following types: "UVU", "PVU Production", or "PVU Non-Production". Note that the parameter value must be delimited by double quotes (") if it contains embedded blanks.
-repositorytype ldap_repository_type
WebSphere® Application Server only. The -repositorytype ldap_repository_type parameter is required only when you are generating the XML files. This parameter specifies the type of LDAP repository to use and must be standalone or federated.
-db database_type
The -db database_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurejdbcgcd or configurejdbcos option. This parameter specifies the type of database to be used by Content Platform Engine and must be mssql, oracle, oracle_rac, db2, db2zos, or db2pshadr.
-ldap ldap_type
The -ldap ldap_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configureldap option. This parameter specifies the type of directory service repository that Content Platform Engine uses for authenticating users and must be activedirectory, adam, ca, edirectory, oid, oracledirectoryse, or tivoli. The adam option applies to both Microsoft ADAM and AD LDS.
-bootstrap bootstrap_operation
The -bootstrap bootstrap_operation parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the configurebootstrap option. This parameter specifies the bootstrap and text extraction operation for the profile and must be new, modify, or upgrade.
-deploy deploy_type
The -deploy deploy_type parameter is required only when you are generating all the files at the same time or when you are generating a single file by using the deployapplication option. This parameter specifies the type of Content Platform Engine deployment. The value must be standard, cluster, or netdeploy (network deployment).

Specify standard if you are deploying Content Platform Engine to a stand-alone (that is, a server that is not managed or clustered) WebSphere Application Server, JBoss Application Server or Oracle WebLogic Server.

Specify cluster if you are deploying Content Platform Engine to a WebSphere Application Server, JBoss Application Server orOracle WebLogic Server cluster.

Specify netdeploy if you are deploying Content Platform Engine to a managed WebSphere Application Server instance. That is, you are using Network Deployment to manage individual servers that are not in a cluster.

-task task_type
The -task task_type parameter indicates which task to generate. You can omit the -task task_type parameter if you want to generate all the tasks. The task_type value is not case sensitive. The following table lists the valid task names, the associated configuration XML file, and a description of the Content Platform Engine settings affected by the task.
Table 1. task_type values
Option Configuration file to generate Description
omitted

applicationserver.xml

configurepricingmodel.xml

configurebootstrap.xml

configurejdbcgcd.xml

configurejdbcos.xml

configureldap.xml

configureloginmodules.xml

deployapplication.xml

If you omit the -task task_type parameter, then all the default configuration files for a profile are created.
configurepricingmodel

configurepricingmodel.xml

Generates the file that specifies the license choices for IBM® FileNet® Content Manager or IBM Content Foundation, IBM Case Foundation, and IBM Case Manager.

configurebootstrap

applicationserver.xml

configurebootstrap.xml

Generates the file for the application server properties and the file with the settings for the Content Platform Engine bootstrap on the application server. The bootstrap information is needed for creating the global configuration database and for starting Content Platform Engine.

configurejdbcgcd

applicationserver.xml

configurejdbcgcd.xml

Generates the file for the application server properties and the file with the settings for configuring the JDBC connections to the global configuration database database used by Content Platform Engine.

If the profile already contains an applicationserver.xml file, the existing file is retained.

configurejdbcos

applicationserver.xml

configurejdbcos.xml

configurejdbcos.n.xml, where n is an integer greater than or equal to 2

Generates the file for the application server properties and the file with the settings for configuring JDBC connections to a single object store database used by Content Platform Engine. You need to generate, edit, and apply the configurejdbcos task settings for each object store in your database.

When you generate a second object store JDBC configuration file, it is named configurejdbcos.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task.

If the profile already contains an applicationserver.xml file, the existing file is retained.

configureldap

applicationserver.xml

configureldap.xml

configureldap.n.xml, where n is an integer greater than or equal to 2

Generates the file for the application server properties and the file for configuring the connection to the directory server for authenticating Content Platform Engine users.

(WebSphere Application Server or Oracle WebLogic Server only.) When you generate a second LDAP configuration file, it is named configureldap.2.xml. The filename increments for each new file you generate. You cannot change the filename, but you can edit the value in the file for the name of the task.

JBoss does not support multiple LDAP tasks.

If the profile already contains an applicationserver.xml file, the existing file is retained.

configureloginmodules

applicationserver.xml

configureloginmodules.xml

(WebSphere Application Server or JBoss Application Server only.) Generates the file for the application server properties and the files for the login modules for the Content Platform Engine application.

If the profile already contains an applicationserver.xml file, the existing file is retained.

deployapplication

applicationserver.xml

deployapplication.xml

Generates the file for the application server properties and the file with settings for deploying the Content Platform Engine application on the application server.

If the profile already contains an applicationserver.xml file, the existing file is retained.

-taskname display_name
The -taskname display_name parameter is optional and is valid only for generating the files. This parameter specifies the value for the displayName attribute in the configuration XML file. If the display name includes spaces, put the entire name inside quotation marks. The display name is used in the graphical user interface to identify the task.
-profile myprofile
The -profile myprofile parameter specifies the profile to use. The myprofile value can be one of the following items:
  • The name of the profile, such as ce_was_tiv_db2. The profile must be located in the ce_install_path/tools/configure/profiles directory, where ce_install_path is the location where the Content Platform Engine software is installed.
  • The absolute path to the profile directory, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2.
  • The absolute path to the profile input file, such as "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfg" or /opt/IBM/FileNet/ContentEngine/tools/configure/profiles/ce_was_tiv_db2/ce_was_tiv_db2.cfg.
Remember: If the path includes a directory name with spaces, enclose the entire path in quotation marks. For example, enter "C:\Program Files\IBM\FileNet\ContentEngine\tools\configure\profiles\ce_was_tiv_db2\ce_was_tiv_db2.cfg".
-silent
The -silent parameter is optional. When -silent is specified, then no prompts or informational messages are displayed in the console, but the errors are written to the log. Failure messages and validation error messages are displayed 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.
-force
The -force parameter is optional and only applies when the -silent parameter is used. When -force is specified, then the task is run without pausing for required responses to validation error messages, such as messages about missing passwords or invalid port numbers.
-help
The -help parameter is optional and displays a brief message on the command syntax instead of running the command.

generateconfig command examples (WebSphere Application Server)

The following examples include line breaks to format the command for reading. Enter the command and options on a single line, without any line breaks.

Generate the configurepricingmodel (Choose Licenses) task file
The following command generates the configurepricingmodel.xml file to specify Processor Value Unit (PVU) Production licensing for IBM FileNet Content Manager or IBM Content Foundation, IBM Case Foundation, and IBM Case Manager:
WebSphere Application Server
configmgr_cl generateconfig -appserver websphere 
-task configurepricingmodel -license "PVU Production" 
-profile wstdb2jdbc
WebLogic Server
configmgr_cl generateconfig -appserver WebLogic 
-task configurepricingmodel -license "PVU Production 
-profile wblgprofile
JBoss Application Server
configmgr_cl generateconfig -appserver JBoss -appserverVession 6.x_EAP 
 -task configurepricingmodel -license "PVU Production -profile jbprofile
Generate all configuration files at the same time.
The following commands generates all the configuration XML files for a new installation profile for a standard deployment with IBM Tivoli® Directory Server that uses a stand-alone LDAP repository and DB2® in the ce_install_path/tools/configure/profiles/wstdb2 directory:
WebSphere Application Server
configmgr_cl generateconfig -appserver websphere 
-repositorytype standalone -db db2 -ldap tivoli -bootstrap new 
-deploy standard -profile wstdb2
WebLogic Server
configmgr_cl generateconfig -appserver WebLogic 
-repositorytype standalone -db mssql -ldap activedirectory 
-bootstrap new -deploy standard -profile wblgprofile
JBoss Application Server
configmgr_cl generateconfig -appserver JBoss -appserverVession 6.x_EAP 
-repositorytype standalone -db db2 -ldap activedirectory 
-bootstrap new -deploy standard -profile jbprofile
Generate only the configurejdbcos task file for an object store.
The following command generates only the configurejdbcos.n.xml file for a new installation profile for deployment on WebSphere that uses a stand-alone LDAP repository in the ce_install_path/tools/configure/profiles/wstdb2 directory:
WebSphere Application Server
configmgr_cl generateconfig -appserver websphere -db db2 
-repositorytype standalone -task configurejdbcos -profile wstdb2
WebLogic Server
configmgr_cl generateconfig -appserver WebLogic -db msssql 
-repositorytype standalone -task configurejdbcos -profile wblgprofile
JBoss Application Server
configmgr_cl generateconfig -appserver JBoss -appserverVession 6.x_EAP 
-db db2 -repositorytype standalone -task configurejdbos -profile jbprofile
Generate only the configurejdbcos task file for an object store and provide a display name for the task.
The following command generates only the configurejdbcos.n.xml file for a new installation profile for deployment on WebSphere that uses a stand-alone LDAP repository in the ce_install_path/tools/configure/profiles/wstdb2 directory and uses a display name of Configure Object Store OS23 Data Sources:
WebSphere Application Server
configmgr_cl generateconfig -appserver websphere -db db2
 -repositorytype standalone  -task configurejdbcos 
 -taskname "Configure Object Store OS23 Data Sources" 
 -profile wstdb2jdbc
WebLogic Server
configmgr_cl generateconfig -appserver WebLogic -db mssql
 -repositorytype standalone  -task configurejdbcos 
 -taskname "Configure Object Store OS23 Data Sources"
 -profile wblgprofile
JBoss Application Server
configmgr_cl generateconfig -appserver JBoss -appserverVession 6.x_EAP 
 -db db2 -repositorytype standalone -task configurejdbcos 
 -taskname "Configure Object Store OS23 Data Sources" 
 -profile jbprofile
Display the help for the generateconfig command.
The following command displays the help for the generateconfig command:
configmgr_cl generateconfig -help


Last updated: March 2016
p8pia034.htm

© Copyright IBM Corporation 2013, 2016.