The information contained in the file can be used to specify which AutoCAD-based products and releases the plug-in can be loaded into, their supported operating system, and how the application should be loaded, such as load on startup or when a command is invoked.
The following elements are used to define and describe the plug-in:
- ApplicationPackage
- CompanyDetails
- Components
PackageContents.xml for Download versus Local Deployment
How you plan to deploy your plug-in determines what should be in the PackageContents.xml file. You need to supply more information when providing a plug-in for download versus a local deployment. The following table explains which elements and attributes are required, optional, or recommended for the deployment you want to use.
| |
For Download from the Autodesk Exchange Apps Website |
For Local Deployment |
ApplicationPackage element |
SchemaVersion |
Required |
Required |
AppVersion |
Required |
Required |
Author |
Required |
Optional |
Name |
Required |
Recommended |
Description |
Required |
Recommended |
Icon |
Required |
Recommended |
Helpfile |
Required |
Recommended |
ProductCode |
Required |
Required |
UpgradeCode |
Required |
Optional |
CompanyDetails element |
Name |
Required |
Optional |
Phone |
Optional |
Optional |
URL |
Optional |
Optional |
Email |
Required |
Optional |
RuntimeRequirements element – Required, if Components element present |
OS |
Optional |
Optional |
Platform |
Optional |
Optional |
SeriesMin |
Optional |
Optional |
SeriesMax |
Optional |
Optional |
SupportPath |
Optional |
Optional |
ToolPalettePath |
Optional |
Optional |
ComponentEntry element – Required, if Components element present |
AppName |
Required |
Required |
AppDescription |
Optional |
Optional |
AppType |
Optional |
Optional |
ModuleName |
Required |
Required |
PerDocument |
Optional |
Optional |
LoadReasons |
Optional |
Optional |
Commands element |
GroupName |
Required |
Optional |
Command element – Required, if Commands element present |
Global |
Required |
Required |
Local |
Required |
Required |
HelpTopic |
Optional |
Optional |
StartupCommand |
Optional |
Optional |