9 Appendix - Configuration Manager Command Line Interface

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

9.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. Configure AEM forms on JEE.

  2. Configure CRX

  3. Manually deploy the configured EAR files.

  4. Initialize AEM forms on JEE.

  5. Validate AEM forms on JEE.

  6. Deploy the AEM forms on JEE modules.

  7. Validate the AEM forms on JEE module deployment.

  8. Check system readiness for PDF Generator.

  9. Add administrator user for PDF Generator.

  10. Configure Connector for IBM Content Manager.

  11. Configure Connector for IBM FileNet.

  12. Configure Connector for EMC Documentum.

  13. Configure Connector for SharePoint.

9.2 Command Line Interface property file

The Configuration Manager CLI requires a property file containing the defined properties for your AEM forms on JEE environment. The template for the properties file, cli_propertyFile_template.txt, is located in the [aem-forms root] /configurationManager/bin folder. You must create a copy of this file 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.

  • Use the property file cli_propertyFile_template.txt file as a 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 [aem-forms root] /configurationManager/bin/ConfigurationManager.bat/sh file, the userValuesForCLI.properties file is created in the [aem-forms 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 .
    Note: The following modules depend on ALC-LFS-ContentRepository. If you are using the cli_propertyFile_template.txt as template then either remove the ALC-LFS-ContentRepository from excludedSolutionComponents list or add the following LFS in excludedSolutionComponents list:

    • ALC-LFS-ProcessManagement

    • ALC-LFS-CorrespondenceManagement

    • ALC-LFS-ContentRepository

    • ALC-LFS-MobileForms

    • ALC-LFS_FormsManager

9.3 General configuration properties

9.3.1 Common properties

Common properties are:

AEM forms on JEE Server specific properties: Required for the Initialize AEM forms on JEE and Deploy AEM forms on JEE Components operations.

These properties are required for the following operations:

  • Initialize AEM forms on JEE

  • Deploy AEM forms on JEE components.

Property

Values

Description

AEM forms on JEE Server specific properties

LCHost

String

The hostname of the server where AEM forms on JEE will be deployed.

LCPort

Integer

The web port number where AEM forms on JEE 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

ALC-LFS-CorrespondenceManagement,

ALC-LFS-ContentRepository,

ALC-LFS-MobileForms,

ALC-LFS_FormsManager

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

includeCentralMigrationService

true: to include service

false: to exclude servcie

The property to include or exclude Central Migration Bridge Service.

CRX Content repository

The following properties are specified in the cli_propertyFile_crx_template.txt file.

true:

false:

contentRepository.rootDir

Path of the CRX repository.

use.crx3.mongo

true: false:

If you have performed a fresh installation, to use Mongo DB with CRX3 set value to true. If the value is false CRX3 TAR is configured.

mongo.db.uri

<URI of Mongo DB>

If you are using Mongo DB, set URI of Mongo DB

mongo.db.name

<name of Mongo DB>

If you are using Mongo DB, provide name of Mongo DB instance

use.crx3.rdb.mk

true:

false:

When the value of this property is true, the CRX repository is configured with RDB MK. The default value is false where the repository is configured as CRX3 TAR.

Note: Clustered environments with relational databases are now supported for production use under a "gated" program. If you intend to use a relational database in a clustered environment, contact AEM Forms product team at forms_documents@adobe.com for approval. Also ensure that the mandatory patches are installed and configured.

9.3.2 Configure AEM forms on JEE properties

These properties only apply to the configure AEM forms on JEE 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.

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.

9.3.3 Configure or validate application server properties

9.3.3.1 Configure JBoss properties

If you are installing AEM forms on JEE with a JBoss application server, you must manually configure JBoss. See Manually configuring JBoss section in, Preparing to Install AEM forms on JEE (Single Server) Guide. Use the Adobe preconfigured JBoss provided on the AEM forms on JEE DVD, download from the internet or use the JBoss turnkey option.

9.3.4 Initialize AEM forms on JEE properties

These initialize AEM forms on JEE properties only apply to the initialize AEM forms on JEE operation.

Property

Values

Description

For more information, see 9.3.1 Common properties

9.3.5 Deploy AEM forms on JEE Components properties

These properties apply to the following operations:

  • Deploy AEM forms on JEE Components

  • Validate AEM forms on JEE Component Deployment

  • Validate AEM forms on JEE Server.

    Property

    Values

    Description

    You must configure the AEM forms on JEE Server Information section. For more information, see 9.3.1 Common properties

    LCAdminUserID

    String

    The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

    LCAdminPassword

    String

    The password to assign to the AEM forms on JEE Administrator user. This password is used to login to the Administrator Console.

9.3.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 AEM forms on JEE Server is installed.

LCPort

Integer

Port number where AEM forms on JEE application server is configured

LCAdminUserID

String

The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the AEM forms on JEE 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 AEM forms on JEE

LCServerMachineAdminUserPasswd

String

The password of the Administrator user of the Operation System hosting AEM forms on JEE

9.3.7 Configure Connector for IBM Content Manager

Property

Values

Description

LCHost

String

Hostname where AEM forms on JEE Server is installed.

LCPort

Integer

Port number where AEM forms on JEE application server is configured

LCAdminUserID

String

The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the AEM forms on JEE Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to AEM forms on JEE 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 AEM forms on JEE)

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).

9.3.8 Configure Connector for IBM FileNet

Property

Values

Description

LCHost

String

Hostname where AEM forms on JEE Server is installed.

LCPort

Integer

Port number where AEM forms on JEE application server is configured

LCAdminUserID

String

The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the AEM forms on JEE Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to AEM forms on JEE 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 AEM forms on JEE)

ConfigureFilenetCE

true or false

Specify true to configure Connector for IBM Filenet

FilenetConfigureCEVersion

String

The FileNet client version to configure. Specify FilenetClientVersion5.0 or FilenetClientVersion5.2

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

9.3.9 Configure Connector for EMC Documentum

Property

Values

Description

LCHost

String

Hostname where AEM forms on JEE Server is installed.

LCPort

Integer

Port number where AEM forms on JEE application server is configured

LCAdminUserID

String

The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the AEM forms on JEE Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to AEM forms on JEE 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 AEM forms on JEE)

ConfigureDocumentum

true or false

Specify true to configure Connector for EMC Documentum

DocumentumClientVersion

String

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

DocumentumClientPathDirectory

String

Location of EMC Documentum 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

9.3.10 Configure Connector for Microsoft SharePoint

Property

Values

Description

LCHost

String

Hostname where AEM forms on JEE Server is installed.

LCPort

Integer

Port number where AEM forms on JEE application server is configured

LCAdminUserID

String

The user ID to assign to the AEM forms on JEE Administrator user. This User ID is used to login to the Administrator Console.

LCAdminPassword

String

The password to assign to the AEM forms on JEE Administrator user. This password is used to login to the Administrator Console.

jndiPortNumber

String

JNDI port corresponding to AEM forms on JEE 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 AEM forms on JEE)

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

ConnectionString

String

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

9.3.11 Command Line Interface Usage

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

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

9.3.11.1 Configure CRX CLI Usage

The Configure CRX Repository requires the following syntax:

configureCRXRepository -f <propertyFile>

Where:

9.3.11.2 Manually deploy configured EAR files

For detailed instructions to manually deploy configured ear files, see 5.3 Deploying to JBoss Application Server

9.3.11.3 Initialize AEM forms on JEE CLI Usage

The initialize AEM forms on JEE operation requires the following syntax:

initializeLiveCycle -f <propertyFile>

Where:

9.3.11.4 Validate AEM forms on JEE Server CLI Usage

The Validate AEM forms on JEE Server operation is optional and requires the following syntax:

validateAEMformsserver -f <propertyFile> -LCAdminPassword <password>

Where:

  • -f <propertyFile>: A property file containing the required arguments. For more information on creating a property file, see 9.2 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.

9.3.11.5 Deploy AEM forms on JEE Components CLI Usage

The Deploy AEM forms on JEE 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 9.2 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.

9.3.11.6 Validate AEM forms on JEE Component Deployment CLI Usage

The Validate AEM forms on JEE 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 9.2 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.

9.3.11.7 Check system readiness for PDF Generator

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

pdfg-checkSystemReadiness

9.3.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:

9.3.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 9.2 Command Line Interface property file .

    Important: Modify the <propertyFile> called cli_propertyFile_ecm_ibmcm_template.txt located in the [aem-forms root] \configurationManager\bin\ directory.

  1. Copy the adobe-component-ext.properties file from [aem-forms root] /configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

  2. Restart the Application Server.

  3. Start the following services from administration console

    • IBMCMAuthProviderService

    • IBMCMConnectorService

9.3.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 9.2 Command Line Interface property file .

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

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

  1. Copy the adobe-component-ext.properties file from [aem-forms root] /configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

  2. Locate the lc_turnkey.xml file in the [ appserver root ]/standalone/configuration folder.In the file search for <security-domains>.Below this tag add and the contents of lc_turnkey.xml file available in [ aem-forms root ]/configurationManager/configure-ecm/jboss directory.

    Default jboss setup comes up with a [profile] value as "all". However, for Adobe Configured Jboss use [lc_DatabaseName] (e.g. lc_mysql, lc_oracle).

  3. Restart the Application Server.

  4. Start the following services from administration console

    • IBMFileNetAuthProviderService

    • IBMFileNetContentRepositoryConnector

    • IBMFileNetRepositoryProvider

    • IBMFileNetProcessEngineConnector(If configured)

9.3.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 9.2 Command Line Interface property file .

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

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

  1. Copy the adobe-component-ext.properties file from [aem-forms root] /configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

  2. Restart the Application Server.

  3. Start the following services from administration console

    • EMCDocumentumAuthProviderService

    • EMCDocumentumRepositoryProvider

    • EMCDocumentumContentRepositoryConnector

9.3.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 9.2 Command Line Interface property file .

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

9.4 Examples Usage

From the C:\Adobe\Adobe_Experience_Manager_forms\configurationManager\bin, type: 

ConfigurationManagerCLI configureLiveCycle -f cli_propertyFile.txt

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

9.5 Configuration Manager CLI Logs

If an error occurs, you can review the CLI logs located here in the [aem-forms 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.

9.6 Next steps

If you used Configuration Manager CLI to configure and deploy AEM forms on JEE, you can now do the following tasks:

// Ethnio survey code removed