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

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

    2. Configure the application server.

    3. Initialize LiveCycle.

    4. Validate LiveCycle.

    5. Deploy the LiveCycle modules.

    6. Validate the LiveCycle module deployment.

    7. Check system readiness for PDF Generator.

    8. Add administrator user for PDF Generator.

    9. Configure Connector for IBM Content Manager.

    10. Configure Connector for IBM FileNet.

    11. Configure Connector for EMC Documentum.

    12. Configure Connector for SharePoint.

    13. Configure Correspondance Mangement.

      9.2 Command Line Interface property file

      The Configuration Manager CLI requires a property file containing the defined properties for your LiveCycle environment. The template for the properties file, cli_propertyFile_template.txt, is located in the [LiveCycle 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.

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

        9.3 General configuration properties

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

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

          9.3.3 Configure or validate application server properties

            9.3.3.1 Configure JBoss properties

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

            9.3.4 Initialize LiveCycle properties

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

            Property

            Values

            Description

            For more information, see 9.3.1 Common properties

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

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

            9.3.7 Configure Connector for IBM Content Manager

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

            9.3.8 Configure Connector for IBM FileNet

            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

            9.3.9 Configure Connector for EMC Documentum

            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

            9.3.10 Configure Connector for Microsoft SharePoint

            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

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

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

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

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

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

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

            9.3.11.6 Check system readiness for PDF Generator

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

            pdfg-checkSystemReadiness

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

            9.3.11.8 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. Copy the adobe-component-ext.properties file from [LiveCycle root]/configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

            2. Restart the Application Server.

            3. Start the following services from LiveCycle Administration Console

              • IBMCMAuthProviderService

              • IBMCMConnectorService

            9.3.11.9 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. Copy the adobe-component-ext.properties file from [LiveCycle root]/configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

            2. Locate the login-config.xml file in the [appserver root]/server/[profile]/conf folder and add to it contents of login-config.xml file available in [LiveCycle 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. Copy the logkit.jar file from [appserver root]/client to the following [appserver root]/server/[profile]/lib 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).

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

            5. Restart the Application Server.

            6. Start the following services from LiveCycle Administration Console

              • IBMFileNetAuthProviderService

              • IBMFileNetContentRepositoryConnector

              • IBMFileNetRepositoryProvider

              • IBMFileNetProcessEngineConnector(If configured)

            9.3.11.10 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. Copy the adobe-component-ext.properties file from [LiveCycle root]/configurationManager/configure-ecm/jboss to the following [appserver root]/bin directory.

            2. Restart the Application Server.

            3. Start the following services from LiveCycle Administration Console

              • EMCDocumentumAuthProviderService

              • EMCDocumentumRepositoryProvider

              • EMCDocumentumContentRepositoryConnector

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

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

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

                9.6 Next steps

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

                  // Ethnio survey code removed