Enterprise Administration > Business Administrative Change Promotion > Running the Business Administrative Change Promotion Command-Line Utility > Manage Business Administrative Change Package Commands
Manage Business Administrative Change Package Commands
The following sections provide commands that are used on a source Windchill system to manage the administrative packages created as part of the business administrative change promotion process.
packageInfo
The packageInfo command is used to view information about the administrative packages available on the Windchill system. Using this command, you can list all packages available on the system with the --list option. You can also view information about a specific package using the --detail option.
Option
Required?
Description
-l
--list
List: Yes
Detail: No
Lists all packages available on the system.
This option is not used with the --detail option.
-d
--detail
List: No
Detail: Yes
Provides details about a specific package, including the package name, description, and exported files.
This option is not used with the --list option.
-n
--packageName
List: No
Detail: Yes
The name of the package.
This option is not used with the --list option.
-o
--outputFile
List: No
Detail: Yes
The location where a file containing the package details is saved. If this option is not specified for the --list option, the list of packages available in the system is displayed in the command prompt window.
-a
--allIterations
List: No
Detail: No
Use this option with the --detail option to display package information about all iterations of a specific package. If this option is not specified, only information about the latest version of the specified package is displayed.
-u
--user
List: No
Detail: No
The user name of the Windchill user running the command. The user running the command must be a valid Windchill user and a site administrator.
-p
--password
List: No
Detail: No
The password of the Windchill user running the command.
-h
--help
List: No
Detail: No
Use this option to display help text for the utility. The help text lists full descriptions of each option as well as the syntax for running the utility.
To run the utility in a Windchill shell, specify the following command with the appropriate options listed in the table for the action you want to take: windchill wt.scm.client.SCMCMD packageInfo
For example, to display information about the latest version of the Integration package, the following command is used: windchill wt.scm.client.SCMCMD packageInfo -u "user" -p "password" -d -n "Integration" -o "D:/PackageInfoFiles"
deletePackage
The deletePackage command is used to delete an existing package, along with all associated deliveries.
Option
Required?
Description
-n
--name
Yes
The name of the package to be deleted.
-a
--all
No
Use this option to delete all iterations of the package specified. If this option is not specified, only the latest version of the package is deleted.
-u
--user
No
The user name of the Windchill user running the command. The user running the command must be a valid Windchill user and a site administrator.
-p
--password
No
The password of the Windchill user running the command.
-h
--help
No
Use this option to display help text for the utility. The help text lists full descriptions of each option as well as the syntax for running the utility.
To run the utility in a Windchill shell, specify the following command with the options listed in the table: windchill wt.scm.client.SCMCMD deletePackage -u "<username>" -p "<password>" -n “<package name>”
deleteExportID
The deleteExportID command is used to delete an existing export file, also known as a delivery.
Option
Required?
Description
-n
--number
Yes
The number of the delivery, or export file, to be deleted.
The delivery number can be found using the packageInfo command with the --detail option.
-f
--force
No
Use this option to delete all dependent delivery files. For example, if a subsequent export of the same package has been completed, additional related delivery files are available. By using the --force option, these related delivery files from subsequent exports are also deleted. If this option is not specified and dependent delivery files exist, an error message displays.
-u
--user
No
The user name of the Windchill user running the command. The user running the command must be a valid Windchill user and a site administrator.
-p
--password
No
The password of the Windchill user running the command.
-h
--help
No
Use this option to display help text for the utility. The help text lists full descriptions of each option as well as the syntax for running the utility.
To run the utility in a Windchill shell, specify the following command with the options listed in the table: windchill wt.scm.client.SCMCMD deleteExportID -u "<username>" -p "<password>" -n “<delivery number>”
Was this helpful?