Save an update set as a local XML file

Administrators can export an update set as an XML file to save a specific version of an application or set of changes.

About this task

Typically you create an XML file of an update set when one of the following conditions apply:
  • The two instances do not have network connectivity so you cannot retrieve update sets from the remote instance nor create a data source to pull, or import, data directly from the source instance.
  • You do not want to provide administrator credentials to the source instance (for example, you do not want to share an administrator password with people outside your company) so you cannot retrieve update sets nor create a data source.
  • You want to back up important customizations locally.
The ability to export and import customizations as an XML file is provided by the following UI Actions:
  • Export to XML on the Update Set [sys_update_set] table.
  • Export to XML on the Retrieved Update Set [sys_remote_update_set] table.
  • Import Update Set from XML on the Retrieved Update Set [sys_remote_update_set] table.

The Export to XML UI Action on Update Set [sys_update_set] table calls a processor called UnloadRetrievedUpdateSet, which transforms a local update set into a retrieved update set, exports the retrieved update set with its related list, and then deletes the temporary update set, if necessary.

Both Export to XML UI actions depend on the script include ExportWithRelatedLists, which exports a record and manually defined related lists to a single XML file.

Procedure

  1. Navigate to System Update Sets and click either Local Update Sets or Retrieved Update Sets.
  2. Select an update set that is in the Complete state.
  3. On the Update Set form, click the Export to XML Related Link.
  4. Save the XML file.
    An XML file is created. When the file is uploaded to another instance, it appears as a retrieved update set regardless of whether it is local or retrieved on the instance where it is created.

Load customizations from a single XML file

Administrators can load an update set XML file to apply a specific version of an application or set of changes.

  1. Elevate privileges to the security_admin role.
  2. Navigate to System Update Sets > Retrieved Update Sets.
  3. Click the link Import Update Set from XML.
  4. Click Choose File and select an XML file.
  5. Click Upload.
    The customization is now available as a retrieved update set with state Loaded.
  6. Follow standard procedure to commit the update set.
    Figure 1. Retrieved update sets
    Retrieved update set