| Redirect |
|---|
| visible | false |
|---|
| location | AIPCORE:TCC - Use the Command Line Interface (CLI) |
|---|
|
| Panel |
|---|
In this section: Target audience: |
...
 | An installation of CAST AIP is required - either a Full Installation or a All Application Intelligence Platform Applications installation (see Install CAST AIP from setup), which , which must be located on the machine you wish to run the CLI from. |
...
This option imports a setup from file into the root [Templates] node - the path and file name are required (the file extension .TCCSetup can be omitted). The currently existing configuration, if any changes occurred, is discarded before being replaced by the newly imported one.
Required arguments
Example
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ImportTemplatesSetup "C:\TCC\MyTemplatesSetup.TCCSetup" |
...
This option updates the root [Templates] node configuration with the setup from file - the path and file name are required (the file extension .TCCSetup can be omitted), merging the current [Templates] node configuration with the one of the file according to rules explained in the "Update Configuration" section of the CAST Transaction Configuration Center help. Thus, it is particularly useful for configuring the root [Templates] node with Setups related to multiple technologies. This option can appear multiple times in a command if multiple setup files need to be imported.
Required arguments
Example
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -UpdateTemplatesSetup "C:\TCC\MyTemplatesSetupForJava.TCCSetup" -UpdateTemplatesSetup "C:\TCC\MyTemplatesSetupForPHP.TCCSetup" -UpdateTemplatesSetup "C:\TCC\MyTemplatesSetupForSHELL.TCCSetup" |
...
This option exports the Setup of the root [Templates] node to file - the path and file name are required (the file extension .TCCSetup can be omitted).
Required arguments
Example
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ExportTemplatesSetup "C:\TCC\MyTemplatesSetup.TCCSetup" |
...
This option imports a setup from file - the path and file name are required (the file extension .TCCSetup can be omitted) into the specified System > Application node. This option can appear multiple times in a command if the configuration of several applications must be imported. If <system-name> contains a slash (/), it must be enclosed with single quotes (').
Required arguments
Examples
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ImportAppliSetup "C:\TCC\MyApplicationSetup.TCCSetup" "My System/My Application"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ImportAppliSetup "C:\TCC\CustomersBillingSetup.TCCSetup" "My System/Customers Billing" -ImportAppliSetup "C:\TCC\AccntMngtSetup.TCCSetup" "My System/Account Management"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ImportAppliSetup "C:\TCC\MyApplicationSetup.TCCSetup" "'My Systems/John'/My Application" |
...
This option exports the Setup of the System > Application node to file - the path and file name are required (the file extension .TCCSetup can be omitted). This option can appear multiple times in a command if the configuration of several applications must be exported. If <system-name> contains a slash (/), it must be enclosed with single quotes (').
Required arguments
Examples
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ExportAppliSetup "C:\TCC\MyApplicationSetup.TCCSetup" "My System/My Application"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ExportAppliSetup "C:\TCC\CustomersBillingSetup.TCCSetup" "My System/Customers Billing" -ExportAppliSetup "C:\TCC\AccntMngtSetup.TCCSetup" "My System/Account Management"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ExportAppliSetup "C:\TCC\MyApplicationSetup.TCCSetup" "'My Systems/John'/My Application" |
...
If the application has unsaved changes in the calibration of its data functions and/or of its transactions, or if the Snapshot Preparation action should be run prior to the computation of the function points of the application, the computation will continue, or abort, according to the current settings of, respectively, the -SaveCalibrationChanges and the -RunSnapshotPreparation options.
Required arguments
Examples
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ComputeAppliFP "My System/My Application"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -RunSnapshotPreparation YES -SaveCalibrationChanges YES -ComputeAppliFP "My System/Customers Billing" -ComputeAppliFP "My System/Account Management"
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ComputeAppliFP "'My Systems/John'/My Application" |
...
This option exports the Transaction Entry Points of the System > Application > Setup > Transaction entry points node, ordered by Full Name, to file in XML format - the path and file name are required (the file extension .xml can be omitted). If the <system-name> contains a slash (/), it must be enclosed with single quotes (').
Required arguments
Example
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -ExportAppliEntryPoints "C:\TCC\MyAppEntryPoints.xml" "My System/My Application" |
...
- BRIEF: the brief statistics will contain, in text (.txt) file format, only numeric values (such as the count of transactions, function points, % of artifacts involved in transactions, etc.).
Required arguments
Example
| Code Block |
|---|
|
CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile CAST_MNGT -CreateAppliStatsForTR "C:\TCC\MyApp_BriefStats.txt" BRIEF "My System/My Application" |
...
| Info |
|---|
Note that: - All rules are taken into account: i.e. they can be created under "Free Definition", "By Naming", "By Inheritance" and "By Type".
- a rule's ID is stored in the cal_objsetdef table in the CAST Management Service schema. Therefore, you can query this table to find the ID of the rule you need. For example, a rule called "TABLES" has been created in the GUI. Running the following query will return the ID of the rule:
| Code Block |
|---|
| select set_id from mngt.cal_objsetdef
where setname = 'TABLES' |
|
Required arguments
Example
| Code Block |
|---|
|
By rule type: CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile <profile_name> -GenerateSets "SYSTEM/APPLICATION" <ENTRY | DATA | END | EXCLUDED>
By rule ID: CAST-TransactionConfig-CLI.exe -HideGUI -ConnectProfile <profile_name> -GenerateSets "SYSTEM/APPLICATION" <rule_ID> |
...
| Code Block |
|---|
|
...
SET_OBJECT:objectId1;objectName1;objectType1;objectFullName1
SET_OBJECT:objectId2;objectName2;objectType2;objectFullName2
SET_OBJECT:objectId3;objectName3;objectType3;objectFullName3
... |
-SaveAfterAutomatedOperations
This option asks the CAST Transaction Configuration Center to save all pending changes such as, for example, those resulting from a Setup import at the level of either the root Templates node or the level of one/some System > Application nodes. Saving is mandatory for ensuring that the results of any operation that has modified the configuration will not be lost after the CAST Transaction Configuration Center is exited.
...
