Export Changes Command
Once changes have been made on the source system, they can be previewed and exported. The export command can be used with various options to preview changes made to administrative objects and then to export those changes into a ZIP file. The exported ZIP file is named using the following naming convention: <packagename>_<targetname>_<exportID>.zip
|
Option
|
Required?
|
Description
|
|---|---|---|
|
-v
--previewOnly
|
Preview: Yes
Export: No
|
Provides an CSV file that lists identifying information for the objects that are ready to be exported from the system. Use this option to verify that the expected administrative changes are included in the exported data.
|
|
-t
--target
|
Preview: No
Export: No
|
Name of the target system to which the exported ZIP file will be sent. The target system name is the same as the name specified in the manageRepository command.
It is not mandatory to register a target system during export.
|
|
-n
--name
|
Preview: Yes
Export: Yes
|
Recommended option when multiple exports are expected for the same target system.
Name of the package created to hold the ZIP file output. If additional export operations are expected with the same data, creating a package with a name that you remember is recommended. For example, you can use the --refresh option on the package at a future time to create an incremental export to the same target system. You can also send the same package to a different target system.
|
|
-d
--description
|
Preview: No
Export: No
|
This option creates a description for the package created to hold the ZIP file output. The description for the package can contain information about the type of data exported to the target system.
|
|
-s
--objectType
|
Preview: Yes
Export: Yes
|
The object types to be exported. The following object types are available for export:
• All: Export additions and changes made to all supported object types.
• PolicyAccessControlRule: Export new, updated, and deleted policy access control rules. When exporting to a synchronized system, information about the deleted policy access control rules is also included.
• Profile: Export new, updated, and deleted profiles. When exporting to a synchronized system, information about the deleted profiles is also included.
• OIR: Export new, updated, and deleted object initialization rules.
• Preference: Export new, updated, and deleted preferences.
• LifeCycleTemplate: Export new, updated or iterated, and deleted lifecycle templates.
• WorkflowProcessTemplate: Export new, updated or iterated, and deleted workflow process templates.
• TypeDefinition:Export new, updated, and deleted attribute templates.
• MeasurementSystem: Export new, updated, and deleted measurement systems.
• QOM: Export new, updated, and deleted quantities of measure.
• GlobalEnumeration: Export new, updated, and deleted global enumerations, modeled enumerations, and custom UI text.
• ReusableAttribute: Export new, updated or iterated, and deleted reusable attributes.
• DocumentTemplate: Export new, updated, and deleted document templates.
• ReportTemplate: Export new, updated or iterated, and deleted report templates.
• ContextTemplate: Export new, updated or iterated context templates.
• TaskFormTemplate: Export new, updated or iterated, and deleted task form templates.
• Report: Export new, updated, and deleted reports.
• RuleSets: Export new and deleted Rule Set objects (rule, rule set, and rule set link).
• TableView: Export new, updated, and deleted report shared table views and system table views.
• specfile.xml: Upload an XML file which specifies the objects that need to be collected for export. This option is available only if you have set the com.ptc.windchill.bac.features.enabled property in wt.properties to 2666518. Without this configuration, any attempt to upload a spec file will be rejected with an error. This option is available for both selective, synchronized modes and development modes.
When you use this option in a synchronized mode, you can export only a specific list of object types. Containers, domains, or attributes are not supported in the XML spec file in synchronized mode systems. For more information about the spec file, see Creating a Spec XML File.
For more information about the supported object types, see Objects Supported for Business Administrative Change Promotion.
|
|
-o
--outputdir
|
Preview: No
Export: No
|
File path to the location where the preview file or the exported ZIP file is generated and saved. If this option is not specified, the files are saved to the directory from where the command is executed.
|
|
-b
--modificationBeginTime
|
Preview: No
Export: No
|
Required option when exporting to a selective system. This option can also be specified for the --previewOnly option to show changes between a time range.
Start time after which changes should be exported. The start time should be specified in the following 24 hour date/time format: MM/dd/yyyy HH:mm:ss
|
|
-e
--modificationEndTime
|
Preview: No
Export: No
|
Required option when exporting to a selective system. This option can also be specified for the --previewOnly option to show changes between a time range.
End time before which changes should be exported. The end time should be specified in the following 24 hour date/time format: MM/dd/yyyy HH:mm:ss
|
|
-r
--refresh
|
Preview: No
Export: No
|
Use this option if an existing package is specified in the -name parameter.
Refreshes the content of the ZIP file to include incremental updates made since the last export of the same information.
If -r or --refresh is provided, then -s or --objectType will be disregarded. Specify either the -s or -r option in the command.
|
|
-x
--excludeBaseline
|
Preview: No
Export: No
|
This option excludes baseline while sending information to target systems. This is valid only for development mode. By default, baseline is established for development mode.
|
|
-u
--user
|
Preview: No
Export: No
|
The user name of the Windchill user running the command. The user running the command must be a valid Windchill user who has organization administrator permissions with access to all the required objects and a site administrator.
|
|
-p
--password
|
Preview: No
Export: 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 appropriate options listed in the table for the action you want to take: windchill wt.scm.client.SCMCMD export
Preview Changes
To preview the changes made to administrative objects such as profiles, the following command is used: windchill wt.scm.client.SCMCMD export -v -o "<file path>" -n "<package name>" -s "Profile" -u “<username>” -p “<password>” -t “<target name>”
The resulting preview file contains the following information:
• Report header: name of the package, package description, context, and time stamp on when the package was created
• Object type
• Object identity
• Object description
• Type of action: create, modify, delete
The following is a sample export preview report:
Export Changes
To export all new, updated, and deleted records of profiles to a selective system, the following command is used: windchill wt.scm.client.SCMCMD export -u "<username>" -p "<password>" -t "<target name>" -s "Profile" -b "<start time>" -e "<end time>" -n "<package name>" -d "<description>" -o "<file path>"
The ZIP file contains folders with object information and a report.html file that lists the following information:
• Package identity — number, name, description, and creation date and time
• Exported object information — object type, object identity, description, and type of action