Deployment command-line reference

This topic describes the arguments that you can pass to FileNet Deployment Manager, and provides some examples of how to pass these arguments to the application. The arguments cannot be used in combination with each other, except for --operation and --password.

The application operates within the context of a deployment tree. This tree is a folder structure that contains deployment configuration files. (See the --samples argument in the following table for a listing of these files.) For more information on trees, see About deployment trees.

Argument Description
-h, --help Displays help information for the command-line arguments.

-v, --version Displays version information for the FileNet Deployment Manager.

-g, --gui Starts the FileNet Deployment Manager with the graphical user interface (GUI) displayed. By using the interface, you can work with and define the deployment configuration as stored in the various deployment files, and execute the defined configuration. (To execute the configuration using the command-line, use the --operation argument.)

The GUI prompts you for a deployment tree location. For information on selecting a tree, see Create or select a deployment tree. For more information on the deployment GUI in general, see Work with the interface.

-s, --samples Creates a subfolder named Samples in the current folder with sample XML files. If the subfolder already exists, it must be empty in order for the sample XML files to be generated.

The sample files include the following types of files:

  • Data map
    Data map files pair source data with destination data. The data can be object store or security principal data. For example, an object store data map might pair source object store A with destination object store B. Data maps are used during asset conversion operations. For more information, see the --operation argument.
  • DeploymentOperation
    DeploymentOperation files control the type of operation performed. For more information, see the --operation argument.
  • EnvironmentConfig
    EnvironmentConfig files define the configuration for an environment. This configuration consists of Content Engine connection information, the deployment modules to use for a deployment operation, and the half map files created for the environment.
  • Half map
    Half map files contain data for an environment (such as object store or security principal information); these files are used for creating data map files.
  • PairConfig
    PairConfig files identify the source and destination environments for a deployment operation. In addition, these files indicate which data map files to use (object store, principal, or both).

For more information on these files, see About deployment files. For information on the XML schema for the DeploymentOperation, data map, and half map files, see Deployment file formats.

-o, --operation <file> Performs the operation specified by the DeploymentOperation file (identified by <file>). The three main types of operations, along with the sample file for the operation type in question (generated by the --samples argument), are as follows:
  • Half map creation
    This operation retrieves information to create a half map. For a principal half map, the information is retrieved from the files exported from Content Engine (CE) or from LDAP. For an object store half map, the information is retrieved from the CE. When retrieving information from the CE, a password might be needed; for more information, see the --password argument. Sample files: DeploymentOperation_RetrieveOSInfo.xml and DeploymentOperation_RetrievePrincipalInfo.xml.
  • Data map creation
    This operation creates a data map from two half maps. Sample files: DataMap_ObjectStore.xml and DataMap_Principal.xml.
  • Asset conversion
    This operation prepares files exported from a source FileNet P8 environment for import into a destination FileNet P8 environment by converting data in accordance with data maps. Sample file: DeploymentOperation_Convert.xml.

For information on the XML schema of the DeploymentOperation file, see Deployment file formats.

-p, --password <password> Specifies the password to use in conjunction with the --operation argument when retrieving information from Content Engine for half map creation. This argument is needed when passwords are not persisted. (Password persistence is specified in the EnvironmentConfig file. For more information, see About passwords)

 

Invocation examples

        DeploymentManager.exe –-version
        DeploymentManager.exe --gui
        DeploymentManager.exe –-operation DeploymentOperation.xml –-password bird123