Object Formats

Objects in the data XML file of a CLI script can be specified in three formats: base, full, and reference.

Base Format

Base format uniquely identifies the object. Base format is defined in the schema amxdata_base.xsd. The base format is a convenience so that you do not have to give all the descriptive attributes of an object to work with it. Base format:

  • Captures the ID attributes of an object as XML attributes
  • Captures the parent-child relationships of an object as XML elements
  • Doesn’t capture any parent information about the object as that information is derived from the XML structure

You use the base format to:

  • Delete an object
  • Perform a runtime action on an object
  • Add a child to an object
  • Perform an action on a child of an object

Full Format

Full format is derived from the base format and includes all the base format information plus additional attributes that describe the objects. Full format in defined in the schema amxdata.xsd. Full format:

  • Is derived from base format
  • Captures the ID and description attributes of an object as XML attributes
  • Captures the parent-child and associative relationships of an object as XML elements
  • Doesn’t capture any parent information about the object as that information is derived from the XML structure

You use full format:

  • Whenever the base format can be used
  • To add or edit an object

Reference Format

Reference format is used for making associations between two objects. Reference format is defined in the schema amxdata_reference.xsd. Reference format:

  • Captures the ID attributes of an object as XML attributes
  • Objects not residing directly under the Enterprise object have parent information because it cannot be derived from the XML structure

You use reference format:

  • When associating that object to another object