Avoid pitfalls when working with an Update Set

Because Update Sets make changes to an instance, review the following best practice information to avoid errors and performance issues.

  • Do not delete Update Sets. If an Update Set is deleted, any updated records may be overwritten in the next update.
  • Do not include the system_id field from the ldap_server_config record in an Update Set. An Update Set from a working configuration points to the wrong system_id node for the target instance and does not work.
  • Do not back out the Default Update Set. This action causes damage to the system.
  • Never change the Update Set field value (update_set) in a Customer Update record (sys_update_xml). If a customization is made in the wrong Update Set, take the following action:
    1. Switch to the desired Update Set.
    2. Modify the object (record) that was originally changed. You can make a trivial change, such as adding a field.
    3. Save the record.
    4. Back out the change just performed, and then save the record again.

      This action ensures that the latest version of the object is included in the desired Update Set and prevents duplicate updates for the same object in a single Update Set.

  • Do not mark an Update Set as Complete until it is ready to migrate. Once an Update Set is complete, do not change it back to In progress. Instead, create another Update Set for the rest of the changes, and make sure to commit them together in the order that they were created. Naming conventions may help in this case (for example, Performance Enhancements and Performance Enhancements 2).
  • Do not manually merge updates into an Update Set. Always use the Merge Update Sets module. This tool compares duplicate files between Update Sets and selects the newest version.
  • If a committed Update Set has a problem in the test instance, build the fix in another Update Set in the development instance. Commit this set to the test instance, and then make sure both sets are migrated to the production instance and committed in the order they were made.
  • Always preview an Update Set before committing it.
  • Set completed Update Sets on the production instance to ignore. This state ensures the Update Set is not reapplied when cloning the instance.
  • Keep a to-do list of manual changes and data loads that need to be completed after an Update Set is applied.
  • Do not make too many changes at one time. Verify that the correct changes have been made incrementally.