CDT command-line arguments in text mode

There are multiple command line parameters as options when running the Configuration Deployment Tool.

The following table describes the Java™ cdtshell script command-line arguments. When you run the Configuration Deployment Tool, you can optionally use any of these arguments.

Table 1. Java cdtshell script command-line arguments
Arguments Description
Source The logical identifier for the source database.
Target The logical identifier for the target database.
ColonyId Specifies the Colony ID that you want to compare or deploy. You can pass only one colony at a time.

Example:

Windows: cdtshell.cmd -ColonyId E1

Linux/UNIX: cdtshell.sh -ColonyId E1
IgnoreMissingTables Specifies that when you compare source and target databases, you want to ignore tables that might be missing in the target schema. When comparing databases in a sharded deployment, ensure that you specify the IgnoreMissingTables argument.

For example, when comparing a Test Configuration schema with a Production Configuration schema, some Master tables, such as YFS_CUSTOMER and YFS_USER, do not exist in either the source or target schema. In this case, the CDT throws "table not found" errors. However, you can enable the CDT to ignore missing tables by passing -IgnoreMissingTables as Y.

Example:

Windows: cdtshell.cmd -IgnoreMissingTables Y

Linux/UNIX: cdtshell.sh -IgnoreMissingTables Y
LabelId Specifies the Label Id value that is used to create labels such as BEGIN_<LabelId> and END_<LabelId>, before and after the deployment, respectively. If this argument is not passed, labels are not created.

Example:

Windows: cdtshell.cmd -LabelId OrgA1

Linux/UNIX: cdtshell.sh -LabelId OrgA1
CompareOrganizationCode Specifies the organizations you want to compare based on the organization codes passed, as defined in the config-db.xml. If you do not pass the CompareOrganizationCode argument, the corresponding filter is not used.

Use a comma-delineated format to specify organizations to compare, such as Org-1, Org-2. If you use the CompareOrganizationCode argument and specify no organizations, the CDT compares all organizations. It is recommended that all participating organizations are compared together. For example, if two organizations, Org-01 and Org-02, participate with two ship nodes, Node-01 and Node-02, you should specify Org-1,Org-2,Node-01,Node-02.

Example:

Windows: cdtshell.cmd -CompareOrganizationCode Org-1,Org-2,Node-01,Node-02

Linux/UNIX: cdtshell.sh -CompareOrganizationCode Org-01,Org-02,Node-01,Node-02
SkipEmptyTableExport Indicates if you do not want to generate files for empty table in source database while exporting to XML. By default, the files are generated with empty records. The argument options are Y or N.

Example:

Windows: cdtshell.cmd -SkipEmptyTableExport Y

Linux/UNIX: cdtshell.sh -SkipEmptyTableExport Y
TTMode Indicates the type of table mode that you can load. The TTMode argument supports ConfigOnly and MasterOnly modes.

The ConfigOnly mode runs the config-db CDT config xml files. Whereas, the MasterOnly mode runs the master-db CDT config xml files.

Note: If you want the CDT to run efficiently and smoothly, run only one type of table at a time.
However, when you run the CDT in a multischema model, it is recommended not to use the ConfigOnly and MasterOnly modes. Instead, use the following TTMode arguments:
  • ConfigMS - Deploy changes related to tables in the configuration schema.
  • MasterMS - Deploy changes related to tables in the master schema.
  • Metadata - Deploy changes related to tables in the metadata schema.
For each of these modes, run the appropriate command. For example, for Windows, run the following command:
cdtshell.cmd -TTMode ConfigOnly
Note:
  • The ConfigOnly mode assumes that your config and metadata tables are in the same schema. If this is not true, ensure that you comment out the metadata tables from the runtime/database/cdt/config-db.xml file.
  • The MasterOnly mode assumes that your master and transaction tables are in the same schema. If this is not true, ensure that you comment out the YFS_TRAN_LOCN_ATTRS table element from the runtime/database/cdt/master-db.xml file.