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

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

  5. Configure CRX

  6. Update AEM forms on JEE core settings.

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

  8. Manually deploy the configured EAR files.

  9. Initialize AEM forms on JEE.

  10. Validate AEM forms on JEE.

  11. Perform critical tasks before component deployment.

  12. Deploy the AEM forms on JEE modules.

  13. Validate the AEM forms on JEE module deployment.

  14. Migrate Data Essential to AEM forms on JEE

  15. Post deployment configurations.

  16. Check system readiness for PDF Generator.

  17. Add administrator user for PDF Generator.

  18. Configure Connector for IBM Content Manager.

  19. Configure Connector for IBM FileNet.

  20. Configure Connector for EMC Documentum.

  21. Configure Connector for SharePoint.

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

7.2 Command Line Interface property file

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

  • cli_propertyFile_template.txt file that contains properties that apply to AEM forms on JEE 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 AEM forms on JEE.

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 files cli_propertyFile_template.txt and cli_propertyFile_upgrade_template.txt to use these 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

7.3 Upgrading AEM forms on JEE Commands

7.3.1 (Turnkey and Partial Turnkey only) Shutdown command for JBoss for previous LiveCycle version

Note: This command would run only if your AEM forms on JEE Turnkey installation and your previous Turnkey installation coexist on the same machine and you have chosen to perform an upgrade installation while installing AEM forms on JEE 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.

7.3.2 (Turnkey and Partial Turnkey only) Migrate AEM forms on JEE GDS command

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

The upgrade-migrateGDS command migrates the Global Document Storage (GDS) directory contents from default GDS location of previous LiveCycle to the default GDS location of AEM forms on JEE.

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 AEM forms on JEE JBoss bin directory to the new JBoss location.

This command requires no input properties.

7.3.3 (Turnkey and Partial Turnkey only) Migrate AEM forms on JEE datasources command

Note: This command would run only if your AEM forms on JEE Turnkey installation and your previous Turnkey installation coexist on the same machine and you have chosen to perform an upgrade installation while installing AEM forms on JEE 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 AEM forms on JEE adobe-ds.xml file

No

Yes

mysqlDSDatasourcesToMigrate

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

No

Yes

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

7.3.4 Update AEM forms on JEE core settings command

The upgrade-configureCoreSettings command updates various core settings for AEM forms on JEE. For example, if in your previous LiveCycle system you had the Global Document Storage (GDS) directory set at C:\LC\GDS and in AEM forms on JEE 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, AEM forms on JEE temp directory, AEM forms on JEE global document storage directory.The following properties are available for the upgrade-configureCoreSettings command.

Property

Description

Required

Can be empty

prevLCVersion

The version of AEM forms on JEE from which upgrade is being performed. Valid values are 9x, ADEP, or 10.0

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

7.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 Turnkey MySQL installation to 'adobe' schema of AEM forms on JEE 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 AEM forms on JEE Turnkey installation and your previous Turnkey installation coexist on the same machine and you'd chosen to perform an upgrade installation while installing AEM forms on JEE Turnkey.

Property

Description

Required

Can be empty

lcDatabaseHostName

Hostname for AEM forms on JEE turnkey database.

Yes

No

lcDatabaseName

Database name for AEM forms on JEE turnkey database. Default is adobe.

Yes

No

lcDatabaseUserName

Username for accessing AEM forms on JEE turnkey database.

Yes

No

lcDatabaseUserPassword

Password for accessing AEM forms on JEE 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 AEM forms on JEE turnkey database.

Yes

No

lcDatabasePortNumber

Port used by AEM forms on JEE turnkey database.

Yes

No

lcDatabaseType

Type of database configured for AEM forms on JEE turnkey database. Default is mysql.

Yes

No

lcPrevDatabaseHostName

Hostname for previous AEM forms on JEE turnkey database.

Yes

No

lcPrevDatabaseName

Database name for previous AEM forms on JEE turnkey database. Default is adobe.

Yes

No

lcPrevDatabaseUserName

Username for accessing previous AEM forms on JEE turnkey database.

Yes

No

lcPrevDatabaseUserPassword

Password for accessing previous AEM forms on JEE 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 AEM forms on JEE turnkey database.

Yes

No

lcPrevDatabasePortNumber

The port used by previous AEM forms on JEE turnkey database.

Yes

No

lcPrevDatabaseType

Type of database configured for previous AEM forms on JEE turnkey database. Default is mysql.

Yes

No

7.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 AEM forms on JEE, before these components are actually deployed on the AEM forms on JEE Server.The following properties are available for the upgrade-configurePreDeploy command.

Property

Description

Required

Can be empty

prevLCVersion

The version of AEM forms on JEE being upgraded. Valid values are 9x, ADEP, or 10.0

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

jboss.clientjar.location

Location of the jbossall-client.jar file.

Yes

Yes

7.3.7 Post-deployment Configuration command

The upgrade-configurePostDeploy command does the actual upgrade of the system and is run after AEM forms on JEE 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 AEM forms on JEE being upgraded. Valid values are 821 or 9x .

Yes

No

excludedSolutionComponents

Comma separated list of AEM forms on JEE 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

AEM forms on JEE Host and Authorization information

Property

Description

Required

Can be empty

LCHost

Hostname of the AEM forms on JEE Server.

Yes

No

LCPort

Port number on which AEM forms on JEE application server is configured.

Yes

No

lcJndiPort

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

AEM forms on JEE Database information

Property

Description

Required

Can be empty

lcDatabaseType

Type of database configured for AEM forms on JEE. Values can be mysql , db2 , oracle , or sqlserver

Yes

No

lcDatabaseHostName

Hostname for the AEM forms on JEE database.

Yes

No

lcDatabasePortNumber

The port number for the AEM forms on JEE database.

Yes

No

lcDatabaseDriverFile

Path to driver file for the AEM forms on JEE database.

Yes

No

lcDatabaseUserName

Username for accessing the AEM forms on JEE database.

Yes

No

lcDatabaseName

AEM forms on JEE 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 AEM forms on JEE 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 AEM forms on JEE 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 AEM forms on JEE Native repository. This file is generated using the upgrade-getFormTemplatesToMigrate command.

No

Yes

7.4 General configuration properties

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

is.new.installation.of.crx.repository

true: to create a new repository

false: to upgrade an existing repository

If the content repository did not exist before upgrade and you have installed the Content Repository for the very first time then set the value to true.

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

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

7.4.3 Configure or validate application server properties

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

7.4.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 7.4.1 Common properties

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

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

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

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

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

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

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

7.4.11.1 Configure CRX CLI Usage

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.

7.4.11.2 Manually deploy configured EAR files

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

7.4.11.3 Initialize AEM forms on JEE CLI Usage

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

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

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.

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

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

7.4.11.7 Check system readiness for PDF Generator

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

pdfg-checkSystemReadiness

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

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

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

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

7.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 [aem-forms root] \configurationManager\bin\ directory.

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

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

7.7 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