8 Appendix - Configuration Manager Command Line Interface

LiveCycle provides a Command Line Interface (CLI) for the Configuration Manager. The CLI is intended to be used by advanced users of LiveCycle, for example in server environments which do not support the use of the Graphical User Interface (GUI) of the Configuration Manager.

8.1 Order of operations

The Configuration Manager CLI must follow the same order of operations as the GUI version of the Configuration Manager. Ensure that you use the CLI operations in this order:

  1. Shut down the JBoss application server (Upgrade Turnkey only)

  2. Migrate the GDS directory contents. (Upgrade Turnkey only)

  3. Migrate the custom datasources. (Upgrade Turnkey only)

  4. Configure LiveCycle.

  5. Update LiveCycle core settings.

  6. Configure Content Services.

  7. Migrate existing turnkey database (Upgrade Turnkey only).

  8. Configure the application server.

  9. Initialize LiveCycle.

  10. Validate LiveCycle.

  11. Perform critical tasks before component deployment.

  12. Deploy the LiveCycle modules.

  13. Validate the LiveCycle module deployment.

  14. Retrieve the LiveCycle ES Update 1 or LiveCycle ES2 form templates to migrate to LiveCycle.

  15. Migrate Data Essential to LiveCycle

  16. Post deployment configurations.

  17. Check system readiness for PDF Generator.

  18. Add administrator user for PDF Generator.

  19. Configure Connector for IBM Content Manager.

  20. Configure Connector for IBM FileNet.

  21. Configure Connector for EMC Documentum.

  22. Configure Connector for SharePoint.

  23. Configure Correspondance Mangement.

Important: You must restart your application server after you complete Configuration Manager CLI operations.

8.2 Command Line Interface property file

The Configuration Manager CLI requires two property files containing the defined properties for your LiveCycle environment. The templates for the properties files, cli_propertyFile_template.txt and cli_propertyFile_upgrade_template.txt, are located in the [LiveCycle root]/configurationManager/bin folder.

  • cli_propertyFile_template.txt file that contains properties that apply to LiveCycle installation and configuration scenarios, in general.

  • cli_propertyFile_upgrade_template.txt file that contains properties specific to upgrading tasks. Both are required for upgrading from a previous version of LiveCycle.

You must create copies of these files and edit the values. You can customize this file based on the Configuration Manager operations you intend to use. The following section describes the properties and values required.

You should create the property file according to your installation. Use one of the following methods.

  • Create a property file and populate the values according to your installation and configuration scenarios.

  • Copy the property file cli_propertyFile_template.txt to use them as cli_propertyFileupgrade_template.txt template and edit the values based on the Configuration Manager operations you intend to use.

  • Use the GUI of the Configuration Manager and then use the property file created by the GUI version as the CLI version property file. When you run the [LiveCycle root]/configurationManager/bin/ConfigurationManager.bat file, the userValuesForCLI.properties file is created in the [LiveCycle root]/configurationManager/config directory. You can use this file as input for the Configuration Manager CLI.

    Note: In the CLI properties file, you must use the escape character (\) for Windows paths directory separator (\). For example, if the Fonts folder to be mentioned is C:\Windows\Fonts, in the Configuration Manager CLI script, you should enter it as C:\\Windows\\Fonts.

8.3 Upgrading LiveCycle Commands

8.3.1 (Turnkey and Partial Turnkey only) Shutdown command for LiveCycle ES Update 1 or LiveCycle ES2 JBoss

Note: This command would run only if your existing LiveCycle ES3 Turnkey installation and your LiveCycle Turnkey installation coexist on the same machine and you have chosen to perform an upgrade installation while installing LiveCycle ES3 in Turnkey mode.

The upgrade-shutdownPreviousJboss command shuts down the JBoss service installed with your previous LiveCycle turnkey or partial turnkey installation and sets the service run mode to 'manual'.

This command requires no properties.

8.3.2 (Turnkey and Partial Turnkey only) Migrate LiveCycle GDS command

Note: This command would run only if your existing LiveCycle ES3 Turnkey installation and your LiveCycle Turnkey installation coexist on the same machine and you have chosen to perform an upgrade installation while installing LiveCycle ES3 in Turnkey mode.

The upgrade-migrateGDS command migrates the Global Document Storage (GDS) directory contents from default LiveCycle GDS location to the default LiveCycle GDS location.

This command works only for turnkey or partial turnkey installations, and when the default GDS is being used. If a custom GDS is being used, the contents need to be manually migrated. This command also migrates the Connectors for ECM properties file from the LiveCycle JBoss bin directory to the new JBoss location.

This command requires no input properties.

8.3.3 (Turnkey and Partial Turnkey only) Migrate LiveCycle datasources command

Note: This command would run only if your existing LiveCycle ES3 Turnkey installation and your LiveCycle Turnkey installation coexist on the same machine and you have chosen to perform an upgrade installation while installing LiveCycle ES3 in Turnkey mode.

The upgrade-migrateDataSources command migrates the custom datasource definitions that might have been added to the adobe-ds.xml or <database>-ds.xml datasource files in the JBoss /server/<profile name>/deploy directory. If no custom datasources are defined, skip this command.

The following properties are available for the upgrade-migrateDataSources command.

Property

Description

Required

Can be empty

adobeDSDatasourcesToMigrate

A comma separated list of the JNDI_NAME of custom datasources that need to be migrated from the LiveCycle adobe-ds.xml file

No

Yes

mysqlDSDatasourcesToMigrate

A comma separated list of the JNDI_NAME of custom datasources that need to be migrated from LiveCycle <database>-ds.xml file.

No

Yes

Note: The mysqlDSDatasourcesToMigrate property refers to any LiveCycle database that you may have installed, and not just a MySQL database.

8.3.4 Update LiveCycle core settings command

The upgrade-configureCoreSettings command updates various core settings for LiveCycle. For example, if in your previous LiveCycle system you had the Global Document Storage (GDS) directory set at C:\LC\GDS and in LiveCycle ES3 you plan to set it to E:\DS\GDS, then the new location is not updated in the database unless this CLI command is executed. Other core settings that can be updated in the same manner are: Adobe server fonts directory, Customer fonts directory, System fonts directory, Enable FIPS, LiveCycle temp directory, LiveCycle global document storage directory.The following properties are available for the upgrade-configureCoreSettings command.

Property

Description

Required

Can be empty

prevLCVersion

The version of LiveCycle from which upgrade is being performed. Valid values are 821 or 9x.

Yes

No

excludedSolutionComponents

Comma separated list of modules not being upgraded/installed. This is equivalent to deselecting installed/licensed solution components in the Configuration Manager GUI.

No

Yes

8.3.5 (Turnkey Only) Migrate existing turnkey database command

The upgrade-migrateTurnkeyDatabase command is used to migrate data from 'adobe' schema of a previous LiveCycle ES3 Turnkey MySQL installation to 'adobe' schema of LiveCycle ES3 Turnkey MySQL installation. Before you run this command, make sure that both the MySQL services are running and are accessible. Also, both the MySQL services should be running on different ports.The following properties are available for the upgrade-migrateTurnkeyDatabase command.

Note: This command would run only if your existing LiveCycle ES3 Turnkey installation and your LiveCycle ES3 Turnkey installation coexist on the same machine and you'd chosen to perform an upgrade installation while installing LiveCycle ES3 Turnkey.

Property

Description

Required

Can be empty

lcDatabaseHostName

Hostname for LiveCycle turnkey database.

Yes

No

lcDatabaseName

Database name for LiveCycle turnkey database. Default is adobe.

Yes

No

lcDatabaseUserName

Username for accessing LiveCycle turnkey database.

Yes

No

lcDatabaseUserPassword

Password for accessing LiveCycle turnkey database. If you don't provide a password in the file, you will prompted to provide it on command line

No

Yes

lcDatabaseDriverFile

Path to driver file for LiveCycle turnkey database.

Yes

No

lcDatabasePortNumber

Port used by LiveCycle turnkey database.

Yes

No

lcDatabaseType

Type of database configured for LiveCycle turnkey database. Default is mysql.

Yes

No

lcPrevDatabaseHostName

Hostname for previous LiveCycle turnkey database.

Yes

No

lcPrevDatabaseName

Database name for previous LiveCycle turnkey database. Default is adobe.

Yes

No

lcPrevDatabaseUserName

Username for accessing previous LiveCycle turnkey database.

Yes

No

lcPrevDatabaseUserPassword

Password for accessing previous LiveCycle turnkey database. If you don't provide a password in the file, you will prompted to provide it on command line

No

Yes

lcPrevDatabaseDriverFile

Path to driver file for previous LiveCycle turnkey database.

Yes

No

lcPrevDatabasePortNumber

The port used by previous LiveCycle turnkey database.

Yes

No

lcPrevDatabaseType

Type of database configured for previous LiveCycle turnkey database. Default is mysql.

Yes

No

8.3.6 Perform critical tasks before component deployment command

The upgrade-configurePreDeploy command is used to execute plug-ins to upgrade the components of your previous LiveCycle installation, and make them compatible with LiveCycle, before these components are actually deployed on the LiveCycle Server.The following properties are available for the upgrade-configurePreDeploy command.

Property

Description

Required

Can be empty

prevLCVersion

The version of LiveCycle being upgraded. Valid values are 821 or 9x

Yes

No

excludedSolutionComponents

Comma separated list of components not being installed. This is equivalent to deselecting installed/licensed solution components in the Configuration Manager GUI.

No

Yes

8.3.7 Retrieve the ECM form templates to migrate command

The upgrade-getFormTemplatesToMigrate command can be used to retrieve a list of form templates that can be migrated from ECM repositories to the LiveCycle Native repository.

Use of the ECM repository for storing form templates is being deprecated, therefore this migration is required.

Once the list is obtained, use the upgrade-configurePostDeploy command to actually migrate the templates from the list. You can skip this command and set the skipFormTemplatesImport property to true in the upgrade-configurePostDeploy command to skip migration of form templates

The following properties are available for the upgrade-getFormTemplatesToMigrate command.

Property

Description

Required

Can be empty

prevLCVersion

The version of LiveCycle being upgraded. Valid values are 821 or 9x.

Yes

No

excludedSolutionComponents

Comma separated list of LiveCycle components not being installed. This is equivalent to deselecting installed/licensed solution components in the GUI.

No

Yes

LiveCycle Host and Authorization information

Property

Description

Required

Can be empty

LCHost

Hostname of the LiveCycle Server.

Yes

No

LCPort

Port number on which LiveCycle application server is configured.

Yes

No

lcJndiPort

JNDI port corresponding to LiveCycle application server.

Yes

No

LCAdminUserID

Username of LiveCycle administrator user

Yes

No

LCAdminPassword

Password for administrator user. If you don't provide a password in the file, you will prompted to provide it on command line

No

Yes

LiveCycle Database information

Property

Description

Required

Can be empty

lcDatabaseType

Type of database configured for LiveCycle. Values can be mysql, db2, oracle, or sqlserver

Yes

No

lcDatabaseHostName

Hostname for the LiveCycle database.

Yes

No

lcDatabasePortNumber

The port number for the LiveCycle database.

Yes

No

lcDatabaseDriverFile

Path to driver file for the database.

Yes

No

lcDatabaseUserName

Username for accessing the database.

Yes

No

lcDatabaseName

Database name.

Yes

No

lcDatabaseUserPassword

Password for accessing database. If you don’t provide a password in the file, you will prompted to provide it on command line

No

Yes

ECM Form template Migration properties

Property

Description

Required

Can be empty

documentumFormTemplatesFile

A file to which the list of form templates that can be migrated from ECM Documentum will be written. This file can be used as a input to upgrade-configurePostDeploy command later.

No

Yes

filenetFormTemplatesFile

A file to which the list of form templates that can be migrated from IBM FileNet will be written. This file can be used as input to upgrade-configurePostDeploy command later.

No

Yes

8.3.8 Post-deployment Configuration command

The upgrade-configurePostDeploy command does the actual upgrade of the system and is run after LiveCycle EAR files and modules have been deployed.

The following properties are available for the upgrade-configurePostDeploy command:

Property

Description

Required

Can be empty

prevLCVersion

The version of LiveCycle being upgraded. Valid values are 821 or 9x.

Yes

No

excludedSolutionComponents

Comma separated list of LiveCycle components not being installed. This is equivalent to deselecting installed/licensed solution components in the GUI.

No

Yes

jboss.clientjar.location

The location of the jbossall-client.jar file (JBoss only)

Yes

Yes

LiveCycle Host and Authorization information

Property

Description

Required

Can be empty

LCHost

Hostname of the LiveCycle Server.

Yes

No

LCPort

Port number on which LiveCycle application server is configured.

Yes

No

lcJndiPort

JNDI port corresponding to LiveCycle application server.

Yes

No

localServer.appServerRootDir

This is used to access appserver client JAR files. (Local application server root directory required for WebLogic and WebSphere only)

Yes

Yes

LCAdminUserID

Username of LiveCycle administrator user

Yes

No

LCAdminPassword

Password for administrator user. If you don't provide a password in the file, you will prompted to provide it on command line

No

Yes

LiveCycle Database information

Property

Description

Required

Can be empty

lcDatabaseType

Type of database configured for LiveCycle. Values can be mysql, db2, oracle, or sqlserver

Yes

No

lcDatabaseHostName

Hostname for the LiveCycle database.

Yes

No

lcDatabasePortNumber

The port number for the LiveCycle database.

Yes

No

lcDatabaseDriverFile

Path to driver file for the LiveCycle database.

Yes

No

lcDatabaseUserName

Username for accessing the LiveCycle database.

Yes

No

lcDatabaseName

LiveCycle database name. Default is adobe.

Yes

No

lcDatabaseUserPassword

Password for accessing database. If you don’t provide a password in the file, you will prompted to provide it on command line

No

Yes

ECM Form template Migration properties

Property

Description

Required

Can be empty

skipFormTemplatesImport

Whether to import form templates from ECM repositories to LiveCycle native repository or skip this step. If set to false, the template files (see the next two properties) containing a list of template names to migrate should be provided.

No

Yes

documentumFormTemplatesFile

File containing a list of form templates to migrate from EMC Documentum repository to LiveCycle Native repository. This file is generated using the upgrade-getFormTemplatesToMigrate command.

No

Yes

filenetFormTemplatesFile

File containing a list of form templates to be migrated from IBM FileNet repository to LiveCycle Native repository. This file is generated using the upgrade-getFormTemplatesToMigrate command.

No

Yes

8.4 General configuration properties

8.4.1 Common properties

Common properties are:

LiveCycle Server specific properties: Required for the Initialize LiveCycle and Deploy LiveCycle Components operations.

These properties are required for the following operations:

  • Initialize LiveCycle

  • Deploy LiveCycle components.

Property

Values

Description

LiveCycle Server specific properties

LCHost

String

The hostname of the server where LiveCycle will be deployed.

LCPort

Integer

The web port number where LiveCycle will be deployed.

excludedSolutionComponents

String. Values include:

ALC-LFS-Forms,

ALC-LFS-ConnectorEMCDocumentum,

ALC-LFS-ConnectorIBMFileNet,

ALC-LFS-ConnectorIBMContentManager,

ALC-LFS-DigitalSignatures,

ALC-LFS-DataCapture,

ALC-LFS-Output,

ALC-LFS-PDFGenerator,

ALC-LFS-ProcessManagement,

ALC-LFS-ReaderExtensions,

ALC-LFS-RightsManagement

(Optional) List the LiveCycle modules you do not want to configure. Specify the excluded modules in a comma separated list.

excludedSolution

ALC-SA-CorrespondenceManagement

You can include or exclude Correspondence Management Solution by specifying this property.

8.4.2 Configure LiveCycle properties

These properties only apply to the configure LiveCycle operation.

Property

Values

Description

AdobeFontsDir

String

Location of the Adobe server fonts directory.

This path must be accessible from the server being deployed to.

customerFontsDir

String

Location of the customer fonts directory.

This path must be accessible from the server being deployed to.

systemFontsDir

String

Location of the system fonts directory.

This path must be accessible from the server being deployed to.

LCTempDir

String

Location of the temporary directory.

This path must be accessible from the server being deployed to.

LCGlobalDocStorageDir

String

The global document storage root directory.

Specify a path to an NFS shared directory used to store long-lived documents and to share them among all cluster nodes.

Specify this property only when deploying LiveCycle components in a clustered environment.

This path must be accessible from the server being deployed to.

EnableDocumentDBStorage

true or false

Default: false

Enables or disables document storage in database for persistent documents.

Even if you enable document storage in database, you will need the file system directory for GDS.

Content Services Note: The following properties are specified in the cli_propertyFile_content_services_template.txt file.

contentServices.rootDir

String

[Content Services only] Specify the root directory used by Content Services. If LiveCycle is in clustered environment, this directory must be a location shared by all nodes in a cluster with the same path across all nodes.

contentServices.indexesDir

String

[Content Services only] Specify the indexes directory used by Content Services. This directory is unique for each cluster node and must have the same name and location on all nodes. For example, contentServices.indexesDir=C:\\Adobe\\Adobe LiveCycle ES3\\lccs_indexes

contentServices.topology

String. Specify either SERVER or CLUSTER.

Default: SERVER

[Content Services only] SERVER for single node, CLUSTER for a cluster configuration.

contentServices.cifs.enable

true or false

Default: false

[Content Services only] Enables or disables CIFS.

contentServices.cifs.servername

String

[Content Services only] Server name of the CIFS server.

contentServices.cifs.implementation

String. Specify one of the following:

  • NetBIOS

  • PureJava

[Content Services only] Specifies how Content Services connects to the CIFS server.

contentServices.cifs.dllpath

String.

Specify the path from where the NetBIOS DLL will be copied.

[Content Services only] Path where NetBios DLL will be copied. Required if "contentServices.cifs.implementation=NetBIOS". This path must be present in the environment.

contentServices.cifs.alternateIP

Numeric

[Content Services only] Alternate IP Address of the CIFS Server. It should be static IP and it is required field if "contentServices.cifs.implementation=PureJava".

contentServices.cifs.WinsOrBrdcast

String. Specify one of the following:

  • winsServer

  • broadcast

[Content Services only] DNS discovery method. It can be "winsServer" or "broadCast" and it is required field if "contentServices.cifs.implementation=PureJava".

contentServices.cifs.winsPrmIP

Numeric

[Content Services only] Primary WINS Server IP address. It can obtained from ipconfig /all command. It is required field if "contentServices.cifs.implementation=PureJava" and "contentServices.cifs.WinsOrBrdcast=winsServer".

contentServices.cifs.winsSecIP

Numeric

[Content Services only] Secondary WINS Server IP address. It can obtained from ipconfig /all command. It is required field if "contentServices.cifs.implementation=PureJava" and "contentServices.cifs.WinsOrBrdcast=winsServer".

contentServices.cifs.brdCastIP

Numeric

[Content Services only] Broadcast IP address. It is required field if "contentServices.cifs.implementation=PureJava" and "contentServices.cifs.WinsOrBrdcast=broadCast".

contentServices.dbType

String

[Content Services only] Content Services database type.

contentServices.configureamps.selectedLCAMPs

Comma separated list of strings

[Content Services only] File names of Content Services AMPs that need to be installed.

For example, genericservice-action.amp, lc-assemble-clipboard-items.amp

contentServices.configureamps.externalAMPsDir

String

[Content Services only] Directory containing the custom AMPs that need to be installed.

Note: All AMPs present in this directory will be installed.

contentServices.ftp.port

NumericDefault : 8021

FTP Port Value for Content Services.

contentServices.ftp.enable

True or False

True to enable internal email server settings and False to disable

contentServices.email.serverDomain

String

Domain of the internal email server. If email settings are enabled, this is a required field.

contentServices.email.serverPort

NumericDefault: 25

Email Server Port. If email settings are enabled, this is a required field.

contentServices.internalEmailSettings.enable

True or false

True to enable internal email server settings and False to disable

contentServices.propagateEventsToLC.enable

True or false

True to propogate events to LiveCycle and False to disable

contentServices.usageQuota

Numeric

If disk quota is enabled, this is a required field.

contentServices.email.serverAllowedSenders

String

These are the senders from whom emails will be accepted.

contentServices.email.serverBlockedSenders

String

These are senders for whom emails will be blocked.

contentServices.email.unknownUsers

String

The username to authenticate when sender address is not recognized.

contentServices.audit.enable

True or false

When selected, application or user interactions with Content Services repository can be recorded.

(WebSphere only) contentServices.myfacesDir

String

Directory where myfaces jars will be copied and used as shared libs

8.4.3 Configure or validate application server properties

8.4.4 Initialize LiveCycle properties

These initialize LiveCycle properties only apply to the initialize LiveCycle operation.

Property

Values

Description

For more information, see 8.4.1 Common properties

8.4.5 Deploy LiveCycle Components properties

These properties apply to the following operations:

  • Deploy LiveCycle Components

  • Validate LiveCycle Component Deployment

  • Validate LiveCycle Server.

    Property

    Values

    Description

    You must configure the LiveCycle Server Information section. For more information, see Common properties

    LCAdminUserID

    String

    The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

    LCAdminPassword

    String

    The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

8.4.6 Add administrator user for PDF Generator

These properties apply only to the adding administrator user for PDF Generator operation. These properties are present in cli_propertyFile_pdfg_template.txt

Property

Values

Description

LCHost

String

Hostname where LiveCycle Server is installed.

LCPort

Integer

Port number where LiveCycle application server is configured

LCAdminUserID

String

The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

LCServerMachineAdminUser

String

The user ID of the Administrator user of the Operation System hosting LiveCycle

LCServerMachineAdminUserPasswd

String

The password of the Administrator user of the Operation System hosting LiveCycle

8.4.7 Configure Connector for IBM Content Manager

Note: The following properties are specified in the cli_propertyFile_ecm_ibmcm_template.txt file.

Property

Values

Description

LCHost

String

Hostname where LiveCycle Server is installed.

LCPort

Integer

Port number where LiveCycle application server is configured

LCAdminUserID

String

The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to LiveCycle application server.

jboss.clientjar.location

String

The location of the jbossall-client.jar file (JBoss only)

CDVTopology.appserverrootdir

String

The root directory of the application server instance that you are configuring on a remote server (on which you plan to deploy LiveCycle)

ConfigureIBMCM

true or false

Specify true to configure Connector for IBM Content Manager

IBMCMClientPathDirectory

String

Location of IBM Content Manager client installation directory.

DataStoreName

String

Name of the DataStore of IBM Content Manager Server that you want to connect to

IBMCMUsername

String

The user name assign to the IBM Content Manager Administrator user. This User ID is used to login to the IBM Content Manager.

IBMCMPassword

String

The password to assign to the IBM Content Manager Administrator user. This password is used to login to the IBM Content Manager.

ConnectionString

String

Additional arguments used in the connection string to connect to IBM Content Manager(Optional).

8.4.8 Configure Connector for IBM FileNet

Note: The following properties are specified in the cli_propertyFile_ecm_filenet_template.txt file.

Property

Values

Description

LCHost

String

Hostname where LiveCycle Server is installed.

LCPort

Integer

Port number where LiveCycle application server is configured

LCAdminUserID

String

The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to LiveCycle application server.

jboss.clientjar.location

String

The location of the jbossall-client.jar file (JBoss only)

CDVTopology.appserverrootdir

String

The root directory of the application server instance that you are configuring on a remote server (on which you plan to deploy LiveCycle)

ConfigureFilenetCE

true or false

Specify true to configure Connector for IBM Filenet

FilenetConfigureCEVersion

String

The FileNet client version to configure. Specify FilenetClientVersion4.0 or FilenetClientVersion4.5

FilenetCEClientPathDirectory

String

Location of IBM Filenet Content Manager client installation directory.

ContentEngineName

String

Hostname or IP address of the machine where IBM Filenet Content Engine is installed

ContentEnginePort

String

The port number used by IBM Filenet Content Engine

CredentialProtectionSchema

CLEAR or SYMMETRIC

Specify the level of protection.

EncryptionFileLocation

String

Location of the encryption file. This is required only when you select SYMMETRIC option for CredentialProtectionSchema attribute.

Use a forward slash (/) or double backward slashes (\\) as a path seperator.

DefaultObjectStore

String

Name of the ObjectStore for the Connector for IBM Filenet Content Server.

FilenetContentEngineUsername

String

The user ID to connect to the IBM FileNet Content server.

The user ID with read-access privileges would be allowed to connect to the Default object Store.

FilenetContentEnginePassword

String

The password to assigned to the IBM FileNet user. This password is used to connect to Default object Store.

ConfigureFilenetPE

true or false

Specify true to configure Connector for IBM FileNet

FilenetPEClientPathDirectory

String

Location of IBM FIleNet client installation directory

FilenetProcessEngineHostname

String

Hostname or IP address of the process router.

FilenetProcessEnginePortNumber

Integer

Port number for IBM FileNet Content Server

FilenetPERouterURLConnectionPoint

String

Name of the process router.

FilenetProcessEngineUsername

String

The user ID to connect to the IBM FileNet Content Server

FilenetProcessEnginePassword

String

The password to connect to the IBM FileNet Content Server

8.4.9 Configure Connector for EMC Documentum

Note: The following properties are specified in the cli_propertyFile_ecm_documentum_template.txt file.

Property

Values

Description

LCHost

String

Hostname where LiveCycle Server is installed.

LCPort

Integer

Port number where LiveCycle application server is configured

LCAdminUserID

String

The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to LiveCycle application server.

jboss.clientjar.location

String

The location of the jbossall-client.jar file (JBoss only)

CDVTopology.appserverrootdir

String

The root directory of the application server instance that you are configuring on a remote server (on which you plan to deploy LiveCycle)

ConfigureDocumentum

true or false

Specify true to configure Connector for EMC Documentum

DocumentumClientVersion

String

The EMC Documentum client version to configure. Specify DocumentumClientVersion6.0 or DocumentumClientVersion6.0

DocumentumClientPathDirectory

String

Location of EMC Docum,entum client installation directory

ConnectionBrokerHostName

String

Hostname or IP address of the EMC Documentum Content Server.

ConnectionBrokerPortNumber

String

Port number for EMC Documentum Content Server

DocumentumUsername

String

The user ID to connect to the EMC Documentum Content Server.

DocumentumPassword

String

The password ID to connect to the EMC Documentum Content Server.

DocumentumDefaultRepositoryName

String

Name of the default repository of MC Documentum Content Server

8.4.10 Configure Connector for Microsoft SharePoint

Note: The following properties are specified in the cli_propertyFile_ecm_sharepoint_template.txt file.

Property

Values

Description

LCHost

String

Hostname where LiveCycle Server is installed.

LCPort

Integer

Port number where LiveCycle application server is configured

LCAdminUserID

String

The user ID to assign to the LiveCycle Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the LiveCycle Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to LiveCycle application server.

jboss.clientjar.location

String

The location of the jbossall-client.jar file (JBoss only)

CDVTopology.appserverrootdir

String

The root directory of the application server instance that you are configuring on a remote server (on which you plan to deploy LiveCycle)

ConfigureSharePoint

true or false

Specify true to configure Connector for Microsoft SharePoint

SharePointServerAddress

String

Hostname or IP address of the Sharepoint Server

SharePointUsername

String

The user ID to connect to the Sharepoint Server

SharePointPassword

String

The password to connect to the Sharepoint Server

SharePointDomain

String

The Domain Name of the Sharepoint Server

SharePointVersion

String

The version of the Microsoft Sharepo installed for LiveCycle.

ConnectionString

String

Additional arguments used in the connection string to connect to the Sharepoint Server(optional

8.4.11 Command Line Interface Usage

Once you have configured your property file, you must navigate to the [LiveCycle root]/configurationManager/bin folder.

To view a complete description of the Configuration Manager CLI commands, type: ConfigurationManagerCLI help <command name>.

Configure LiveCycle CLI usage

The Configure LiveCycle operation requires the following syntax:

configureLiveCycle -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

Extract CRX Bundles in LiveCycle

The Configure CRX Repository requires the following syntax:

extractCRXInstallationContent [- crx_password<password>] -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

Configure Correspondence Management

The Configure CRX Repository requires the following syntax:

configureCRXRepository -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

8.4.11.1 Configure Content Services (deprecated) CLI Usage

The Configure Content Services operation requires the following syntax:

configureContentServices -f <propertyFile>

where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

    Note: The Content Services is deprecated and does not appear in the list of selected components. To include Content Services in the list of selected components remove or comment out excludedSolutionComponents=ALC-LFS-ContentServices property from cli_propertyFile_template.txt file.

8.4.11.2 Initialize LiveCycle CLI Usage

The initialize LiveCycle operation requires the following syntax:

initializeLiveCycle -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

8.4.11.3 Deploy LiveCycle Components CLI Usage

The Deploy LiveCycle Components operation requires the following syntax:

deployLiveCycleComponents -f <propertyFile> -LCAdminPassword <password>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

  • -LCAdminPassword <password>: Allows you to set the Admin password on the command line. If this argument is present, it will override the targetServer.adminPassword property in the property file.

8.4.11.4 Validate database connectivity CLI Usage

The validate Database Connectivity operation is optional and requires the following syntax:

validateDBConnectivity -f <propertyFile> -datasource_dbPasssword <password>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

  • -datasource_dbPassword <password>: Allows you to set the database user password on the command line. If this argument is present, it will override the datasource.dbPassword property in the property file.

8.4.11.5 Validate LiveCycle Server CLI Usage

The Validate LiveCycle Server operation is optional and requires the following syntax:

validateLiveCycleServer -f <propertyFile> -LCAdminPassword <password>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

  • -LCAdminPassword <password>: Allows you to set the Admin password on the command line. If this argument is present, it will override the targetServer.adminPassword property in the property file.

8.4.11.6 Validate LiveCycle Component Deployment CLI Usage

The Validate LiveCycle Component Deployment operation is optional and requires the following syntax:

validateLiveCycleComponentDeployment -f <propertyFile> -LCAdminPassword <password>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

  • -LCAdminPassword <password>: Allows you to set the Admin password on the command line. If this argument is present, it will override the targetServer.adminPassword property in the property file.

8.4.11.7 Check system readiness for PDF Generator

The Checking system readiness for PDF Generator operation requires the following syntax:

pdfg-checkSystemReadiness

8.4.11.8 Adding administrator user for PDF Generator

The adding administrator user for PDF Generator operation requires the following syntax:

pdfg-addAdminUser -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

8.4.11.9 Configure Connector for IBM Content Manager

The Configure Connector for IBM Content Manager operation is optional and requires the following syntax:

IBMCM-configurationCLI -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

    Important: Modify the <propertyFile> called cli_propertyFile_ecm_ibmcm_template.txt located in the [LiveCycle root]\configurationManager\bin\ directory.
  1. Restart the Application Server.

  2. Start the following services from LiveCycle Administration Console
    • IBMCMAuthProviderService

    • IBMCMConnectorService

8.4.11.10 Configure Connector for IBM FileNet

The Configure Connector for IBM FileNet operation is optional and requires the following syntax:

filenet-configurationCLI -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

    Important: Modify the <propertyFile> called cli_propertyFile_ecm_filenet_template.txt located in the [LiveCycle root]\configurationManager\bin\ directory.

Perform the following steps manually to complete the configuration for Connector for IBM Content Manager.

  1. (Only for FileNet 4.x) Add the Java option -Dwasp.location=[FileNetClient root]/wsi to the Application Server startup options.

  2. Restart the Application Server.

  3. Start the following services from LiveCycle Administration Console
    • IBMFileNetAuthProviderService

    • IBMFileNetContentRepositoryConnector

    • IBMFileNetRepositoryProvider

    • IBMFileNetProcessEngineConnector(If configured)

8.4.11.11 Configure Connector for EMC Documentum

The Configure Connector for EMC Documentum operation is optional and requires the following syntax:

documentum-configurationCLI -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

    Important: Modify the <propertyFile> called cli_propertyFile_ecm_documentum_template.txt located in the [LiveCycle root]\configurationManager\bin\ directory.

Perform the following steps manually to complete the configuration for Connector for EMC Documentum.

  1. Restart the Application Server.

  2. Start the following services from LiveCycle Administration Console
    • EMCDocumentumAuthProviderService

    • EMCDocumentumRepositoryProvider

    • EMCDocumentumContentRepositoryConnector

8.4.11.12 Configure Connector for Microsoft SharePoint

The Configure Connector for Microsoft SharePoint operation is optional and requires the following syntax:

sharepoint-configurationCLI -f <propertyFile>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see Command Line Interface property file.

    Important: Modify the <propertyFile> called cli_propertyFile_ecm_sharepoint_template.txt located in the [LiveCycle root]\configurationManager\bin\ directory.

8.5 Examples Usage

From the C:\Adobe\Adobe LiveCycle ES3\configurationManager\bin, type:

ConfigurationManagerCLI configureLiveCycle -f cli_propertyFile.txt

Where cli_propertyFile.txt is the name of the property file you created.

8.6 Configuration Manager CLI Logs

If an error occurs, you can review the CLI logs located here in the [LiveCycle root]\configurationManager\log folder. The log file generated will have a naming convention such as lcmCLI.0.log where the number in the filename (0) will increment when the log files are rolled over.

8.7 Next steps

If you used Configuration Manager CLI to configure and deploy LiveCycle, you can now do the following tasks:

  • Verify the deployment. (See Verify the deployment.)

  • Access Administration Console. (See Accessing Administration Console.)

  • Configure LiveCycle modules to access LDAP. (See Configuring LDAP access.)

// Ethnio survey code removed