generateConfig for WebSphere Application Server

Use the generateConfig command to generate the configuration XML files that you need to deploy an instance of IBM® Content Navigator, IBM ECM CMIS, or IBM FileNet® Collaboration Services on WebSphere® Application Server.

Command description

The generateconfig command generates the configuration XML files for the type of web application that you plan to deploy. The XML files comprise a configuration profile. You must edit the XML files to contain the appropriate values for your environment before you run the tasks. The XML files are named after the configuration task.

The syntax of the command varies depending on the type of application that you are deploying:

If you are deploying an IBM Content Navigator web client application that can connect to one or more repositories, you must specify at least one of the following parameters:
- -configure_CM
- -configure_CMOD
- -configure_FileNetP8
If you are deploying IBM Content Navigator as a front-end web client application with no connected repository, you must specify the -configure_NR parameter.
If you are deploying an IBM Content Navigator web client application and you want to use the task manager service, you must specify the -configure_TM parameter.
If you are deploying an IBM Content Navigator web client application and you want to use IBM Content Cortex for Microsoft Outlook, you must specify the -configure_OFFICE_ADDIN parameter.
If you are deploying an IBM ECM CMIS application, you must specify at least one of the following parameters:
- -configure_CMIS_CM
- -configure_CMIS_CMOD
- -configure_CMIS_FileNetP8
Important: IBM CMIS for Content Manager or IBM CMIS for Content Manager OnDemand cannot be configured and deployed in a profile with other applications.
If you are deploying IBM FileNet Collaboration Services, specify the -configure_FNCS parameter.

For information about which applications can be deployed in the same profile, see Configuring and deploying IBM Content Navigator components.

generateConfig command syntax

To deploy an instance of IBM Content Navigator, IBM ECM CMIS, or IBM FileNet Collaboration Services on WebSphere Application Server, enter the command with the following syntax.

Important: The command syntax lists only the common configuration parameters. See the command parameter section for a description of all parameters including optional and dependent parameters.

To see the status of the command through a page, append | more to the end of the command.

configmgr_cl generateConfig
-appserver websphere
-appserverVersion version
-securitydomain default
-configure_NR yes/no  
-configure_CMIS_CM yes/no
-configure_CMIS_CMOD yes/no
-configure_CMIS_FileNetP8 yes/no 
-configure_CM yes/no
-configure_CMOD yes/no
-configure_FileNetP8 yes/no 
-configure_FNCS yes/no
-configure_TM yes/no
-configure_OFFICE_ADDIN yes/no 
-db dbType
-icn_sso authMethod
-deploy deployEnv 
-profile profileName

Important:

Before you run the command, change to the configure subdirectory of the IBM Content Navigator installation directory. The default location is:
- AIX, Linux, and Linux for System z: /opt/IBM/ECMClient/configure
- Windows: C:\Program Files\IBM\ECMClient\configure
Enter the command and parameters on a single line, without any line breaks.
The command name is not case-sensitive.
The parameter names and parameter values are case-sensitive.

Examples of use cases on WebSphere Application Server

The following examples show you how to generate the configuration XML files for instances of IBM Content Navigator with or without repositories, IBM ECM CMIS, or IBM FileNet Collaboration Services.

Connect IBM Content Navigator to Content Cortex and IBM Content Manager repositories

configmgr_cl generateConfig -appserver websphere 
-appserverVersion 8.5 -configure_FileNetP8 yes -configure_CM yes 
-db db2 -icn_sso none -deploy standard 
-ldap_Repository federated -ldap tivoli 
-profile myProfile

Configure IBM Content Navigator with no repository connection

configmgr_cl generateConfig -appserver websphere 
-appserverVersion 8.5 -configure_NR yes -db db2 
-icn_sso fba -deploy standard -ldap_Repository federated 
-ldap tivoli -profile myProfile

Configure an IBM CMIS for Content Manager web application

configmgr_cl generateConfig -appserver websphere 
-appserverVersion 8.5 -configure_CMIS_CM yes -db db2 
-deploy standard 
-profile myProfile

Configure a FileNet Collaboration Services web application

configmgr_cl generateConfig -appserver websphere 
-appserverVersion 8.5 -configure_FNCS yes -localFNCSCE yes 
-db db2  -deploy standard 
-ldap_Repository federated -ldap tivoli
-profile myProfile

Add a task to an existing profile

configmgr_cl generateConfig -appserver websphere 
-appserverVersion 8.5 -db db2 -icn_sso none 
-deploy standard -ldap_Repository standalone -ldap tivoli 
-task configureldap -taskfile configure.2.ldap.xml
-profile myProfile

Command parameters

Specify the following parameters to deploy an instance of IBM Content Navigator, IBM ECM CMIS, or IBM FileNet Collaboration Services on WebSphere Application Server:

-appserver

Required: Yes

Description: Specifies that the web application will be deployed on WebSphere Application Server.

Valid values: websphere

-appserverVersion

Required: Yes

Description: Specifies the WebSphere Application Server version on which you will deploy your web application.

Valid values: For a list of valid values, use the generateConfig help command:

configmgr_cl generateConfig -help

For any platforms other than Microsoft Windows, ensure that you surround the value with single quotation marks ('); for example: -appserverVersion '8.5'

-securitydomain

Required: Yes

Description: Specifies whether to use the default security settings of the application server or the security settings that are defined in a security domain on the server where your applications are deployed. You can map multiple security domains to an application server.

Valid values:

securityDomainName: The name of the security domain that you want to use to manage the security of the web applications on the server where you deploy your applications.
default: No security domains are mapped to the server where you deploy your application. The global security settings for the application server apply.

-configure_NR

Required: For instances of IBM Content Navigator without a repository only.

Description: Specifies whether to configure IBM Content Navigator with no repository connection.

Valid values:

yes: Configure IBM Content Navigator with no repository connection.
no: Configure IBM Content Navigator with a repository.

-configure_CMIS_CM

Required: For IBM CMIS for Content Manager applications only. This repository configuration parameter cannot be specified with any other repository parameters.

Description: Specifies whether to configure an IBM CMIS for Content Manager web application.

Valid values:

yes

Configure an IBM CMIS for Content Manager web application.

Dependent parameter:

-cmisAuth

Required: Yes

Description: Specifies the authentication method to IBM ECM CMIS.

Valid values:

httpbasic: Enables direct user authentication (application managed authentication).
wssecurity: Authentication is managed by WebSphere Application Server.

no

Do not configure an IBM CMIS for Content Manager web application.

-configure_CMIS_CMOD

Required: For IBM CMIS for Content Manager OnDemand applications only. This repository configuration parameter cannot be specified with any other repository parameters.

Description: Specifies whether to configure an IBM CMIS for Content Manager OnDemand web application.

Valid values:

yes

Configure an IBM CMIS for Content Manager OnDemand web application.

Dependent parameter:

-cmisAuth

Required: Yes

Description: Specifies the authentication method to IBM ECM CMIS.

Valid values:

httpbasic: Enables direct user authentication (application managed authentication).
wssecurity: Authentication is managed by WebSphere Application Server.

no

Do not configure an IBM Content Manager OnDemand web application.

-configure_CMIS_FileNetP8

Required: For IBM CMIS for FileNet Content Manager applications only. This repository configuration parameter can be specified with other repository parameters except for another IBM ECM CMIS parameter.

Description: Specifies whether you want to configure an IBM CMIS for FileNet Content Manager web application.

Valid values:

yes

Configure an IBM CMIS for FileNet Content Manager web application.

Dependent parameters:

-cmisAuth

Required: Yes

Description: Specifies the authentication method to IBM ECM CMIS.

Valid values:

httpbasic: Enables direct user authentication (application managed authentication).
wssecurity: Authentication is managed by WebSphere Application Server.

-ldap

Required: Yes. If you configure multiple applications in a profile, you can only specify this parameter once. You cannot specify different LDAP providers for each application in the profile.

Description: Specifies the directory service (LDAP) provider of your Content Engine or Content Platform Engine LDAP server.

Valid values:

activedirectory: Your LDAP server is an Active Directory server.
adam: Your LDAP server is an ADAM or AD LDS server.
ca: Your LDAP server is a CA Directory server.
edirectory: Your LDAP server is an eDirectory server.
oid: Your LDAP server is an Oracle Internet Directory server.
oracledirectorySE: Your LDAP server is an Oracle Directory Server Enterprise Edition server.
tivoli: Your LDAP server is a IBM Verify Directory server.

-ldap_Repository

Required: Yes. This parameter is related to the -ldap parameter and can only be specified once in a profile.

Description: Specifies the type of repository on which your LDAP server is running.

Valid values:

federated: Your LDAP server is a federated repository.
standalone: Your LDAP server is a stand-alone LDAP registry.

no

Do not configure an IBM CMIS for FileNet Content Manager web application.

-configure_CM

Required: For IBM Content Navigator applications connecting to IBM Content Manager repositories only.

Remember: If you are configuring IBM Content Navigator, you must specify at least one repository configuration parameter.

Description: Specifies whether to configure IBM Content Navigator to connect to IBM Content Manager repositories.

Valid values:

yes: Configure IBM Content Navigator to connect to IBM Content Manager repositories.
no: Do not configure a connection to IBM Content Manager.

-configure_CMOD

Required: For IBM Content Navigator applications connecting to IBM Content Manager OnDemand repositories only.

Remember: If you are configuring IBM Content Navigator, you must specify at least one repository configuration parameter.

Description: Specifies whether to configure IBM Content Navigator to connect to IBM Content Manager OnDemand repositories.

Valid values:

yes: Configure IBM Content Navigator to connect to IBM Content Manager OnDemand repositories.
no: Do not configure a connection to IBM Content Manager OnDemand repositories.

-configure_FileNetP8

Required: For IBM Content Navigator applications connecting to IBM Content Cortex repositories only.

Remember: If you are configuring IBM Content Navigator, you must specify at least one repository configuration parameter.

Description: Specifies whether to configure IBM Content Navigator to connect to IBM Content Cortex repositories.

Valid values:

yes

Configure IBM Content Navigator to connect to IBM Content Cortex repositories.

Dependent parameters:

-ldap

Required: Yes. If you configure multiple applications in a profile, you can only specify this parameter once. You cannot specify different LDAP providers for each application in the profile.

Description: Specifies the directory service (LDAP) provider of your Content Engine or Content Platform Engine LDAP server.

Valid values:

activedirectory: Your LDAP server is an Active Directory server.
adam: Your LDAP server is an ADAM or AD LDS server.
ca: Your LDAP server is a CA Directory server.
edirectory: Your LDAP server is an eDirectory server.
oid: Your LDAP server is an Oracle Internet Directory server.
oracledirectorySE: Your LDAP server is an Oracle Directory Server Enterprise Edition server.
tivoli: Your LDAP server is a IBM Verify Directory server.

-ldap_Repository

Required: Yes. This parameter is related to the -ldap parameter and can only be specified once in a profile.

Description: Specifies the type of repository on which your LDAP server is running.

Valid values:

federated: Your LDAP server is a federated repository.
standalone: Your LDAP server is a stand-alone LDAP registry.

no

Do not configure a connection to IBM Content Cortex repositories.

-configure_FNCS

Required: For IBM FileNet Collaboration Services applications only.

Description: Specifies whether to configure an IBM FileNet Collaboration Services application.

Valid values:

yes

Configure a FileNet Collaboration Services application.

Dependent parameter:

-localFNCSCE

Required: Yes

Description: Specifies whether to collocate IBM FileNet Collaboration Services with Content Engine.

Valid values:

yes: Collocate FileNet Collaboration Services with Content Engine.
no: Do not collocate FileNet Collaboration Services with Content Engine.

no

Do not configure a FileNet Collaboration Services application.

-configure_TM

Required: No.

Description: Specifies whether to configure IBM Content Navigator to use the task manager service. If you do not specify this parameter, IBM Content Navigator cannot use the task manager service.

Valid values:

yes: Include the task for configuring the task manager service in the configuration profile.
no: Do not include the task for configuring the task manager service.

-configure_OFFICE_ADDIN

Required: No.

Description: Specifies whether to configure IBM Content Navigator to use the IBM Content Cortex for Microsoft Outlook. If you do not specify this parameter, IBM Content Navigator cannot use the IBM Content Cortex for Microsoft Outlook.

Valid values:

yes: Include the task for configuring the IBM Content Cortex for Microsoft Outlook on the server.
no: Do not include the task for configuring the IBM Content Cortex for Microsoft Outlook.

-db

Required: For the following types of applications only:

An IBM Content Navigator application connected to one or more repositories
An IBM Content Navigator application with no repository
An IBM CMIS for Content Manager application

Description: Varies depending on the type of application:

For an IBM Content Navigator application: Specifies the type of database on which you plan to store your configuration data.
For an IBM CMIS for Content Manager application: Specifies the type of database that your Content Manager library server uses.

Valid values:

db2

Value meaning varies depending on the application type:

For an IBM Content Navigator application: Store the configuration data on a Db2® database.
For an IBM CMIS for Content Manager application: The Content Manager library server uses a Db2 database.

db2zos

Value meaning varies depending on the application type:

For an IBM Content Navigator application: Store the configuration data on a Db2 for z/OS® database.
For an IBM CMIS for Content Manager application: The Content Manager library server uses a Db2 for z/OS database.

db2pshadr

Store the configuration data on a Db2 pureScale® or high availability disaster recovery (HADR) database. This value is not supported for IBM CMIS for Content Manager.

mssql

Store the configuration data on a Microsoft SQL Server database. This value is not supported for IBM CMIS for Content Manager.

oracle

Value meaning varies depending on the application type:

For an IBM Content Navigator application: Store the configuration data on an Oracle database.
For an IBM CMIS for Content Manager application: The Content Manager library server uses an Oracle database.

oracle_rac

Store the configuration data on an Oracle Real Application Cluster (Oracle RAC) database. This value is not supported for IBM CMIS for Content Manager.

oracle_ssl

Store the configuration data on an Oracle database with SSL enabled. This value is supported only on WebSphere Application Server.

db2ssl

Store the configuration data on an IBM DB2 database with SSL enabled. This value is supported only on WebSphere Application Server.

mssqlssl

Store the configuration data on a Microsoft SQL Server database with SSL enabled.

postgresql

Store the configuration data on a PostgreSQL Server database.

postgresqlssl

Store the configuration data on a PostgreSQL Server database with SSL enabled.

-icn_sso

Required: For IBM Content Navigator applications only.

Description: Specifies where the initial authentication for IBM Content Navigator occurs. For a complete description of the different options, see Authentication and authorization.

Valid values:

none

Control access to IBM Content Navigator by authenticating users against the repository that is configured as the authenticating repository for a desktop.

cca

Only if -configure_FileNetP8 is set to yes.

Control access to IBM Content Navigator by authenticating users against the web application server where IBM Content Navigator is deployed before they can access the IBM Content Navigator web application.

This option only applies if you have one of the following environments configured:

CA SiteMinder
SPNEGO/Kerberos
IBM Security Access Manager

IBM Content Navigator desktop authentication is also required if the authenticating repository for a desktop is not configured for single sign-on.

fba

Control access to IBM Content Navigator by using a login form to gather and send user credentials to your web application server.

To use form-based authentication, you must have a login page and a login error page deployed in your environment.

IBM Content Navigator desktop authentication is also required if the authenticating repository for a desktop is not configured for single sign-on.

-profile

Required: Yes

Description: The fully qualified directory where the configuration XML files are located. When you specify the -profile parameter, the default location of the configuration XML files is ..\Program Files\IBM\ECMClient\configure\profiles or /opt/IBM/ECMClient/configure/profiles. If the profile directory is at this location, you only need to specify the name of the profile directory.

-deploy

Required: Yes

Description: Specifies the type of environment in which the application will be deployed:

Valid values:

cluster: Deploy the application on a highly available server cluster.
netdeploy: Deploy the application to a WebSphere Application Server Network Deployment environment without a cluster.
standard: Deploy the application to a stand-alone server.

-silent

Required: No

Description: Runs the command silently, without any user interaction, which means that no prompts or informational messages are displayed on the console. Instead, the errors are written to the log files. Failure messages and validation error messages are displayed as needed, such as messages about missing passwords.

-force

Required: If the -silent parameter is used.

Description: Overrides the checks that the command runs. The task is forced to run without pausing to prompt you for required input or responses to validation error messages. The force parameter should always be used with caution; otherwise, it might result in the loss of data.

-help

Required: No

Description: Use the help parameter to get information about the command syntax, valid parameters, and values.