Update set batching

Batch update sets enable you to group update sets together so you can preview and commit them in bulk.

Dealing with multiple update sets can lead to problems, including committing update sets in the wrong order or inadvertently leaving out one or more sets. You can avoid these problems by grouping completed update sets into a batch.

The system organizes update set batches into a hierarchy. One update set can act as the parent for multiple child update sets. A given set can be both a child and parent, enabling multiple-level hierarchies. One update set at the top level of the hierarchy acts as the base update set.

When you preview or commit the base update set, you preview or commit the entire batch. The system determines the processing order, and checks for collisions, based on the dates the changes were recorded, and on their sequential ancestry. Their ancestries are the specific instances in which the changes in the update sets took place.

Example of batched update sets

The list of update set records reflects the batch hierarchy in the Parent and Batch Base columns. Figure 2 shows the hierarchy defined by the list in Figure 1.
Figure 1. List of batched update sets

Screenshot of list of batched update sets
Figure 2. Diagram of batched update set hierarchy

Diagram of batched update set heirarchy

Create a batch update set

You include an update set in a batch by specifying another update set as its parent.

Before you begin

Role required: admin

Adding a WIP update set to a completed batch resets the batch base to WIP.

Procedure

  1. Navigate to System Update Sets > Local Update Sets.
  2. Select the record for an update set that you want to include as a child in the batch.
  3. On the Update Set record, navigate to the Parent field and select the update set to act as the parent.
  4. Click Update.
    The system returns to the list of Update Sets. If the Parent column is visible, it shows the parent for the newly-created child.

Retrieve batched update sets

You retrieve a batch of update sets using the same process you would as for any individual update set.

Before you begin

Role required: admin

Procedure

To retrieve a batch of update sets, follow the same process for the batch base as you would for any individual update set. The system will process the entire batch at once. For details, see Retrieve an update set.

Preview a batch of update sets

You can preview at once all the update sets belonging to a batch.

Before you begin

Role required: admin

You must have retrieved the update sets from the source instance.

Procedure

  1. Navigate to System Update Sets > Retrieved Update Sets
  2. From the list of retrieved update sets, select the batch base for the batch you want to preview.
    You cannot separately preview an update set that is a child in a batch. You must preview the entire batch by previewing the batch base. If necessary, you can remove the child update set from the batch by editing its record's parent field.
  3. Click Preview Update Set Batch.
  4. If the system found problems, click the Preview Problems for Batch and resolve the problems as you normally would for any update set. When you have resolved all the problems, click Run Preview Again for Batch.

Commit a batch of update sets

You can commit at once all the update sets belonging to a batch.

Before you begin

Role required: admin

Before committing, you must have previewed the update sets from the source instance and resolved any collisions.

Procedure

  1. Navigate to System Update Sets > Retrieved Update Sets
  2. From the list of retrieved update sets, select the batch base for the batch you want to preview.
    You cannot separately commit an update set that is a child in a bach. You must commit the entire batch by committing the batch base. If necessary, you can remove the child update set from the batch by editing its record's parent field.
  3. Click Commit All Update Sets.

Reorganize a batch of update sets

You can remove an individual update set from the batch or change its parent.

Before you begin

Role required: admin

Procedure

  1. Navigate to System Update Sets > Local Update Sets.
  2. Select the record for an update set that you want to move or remove as a child in the batch.
  3. On the update set record, navigate to the Parent field and select the new update set to act as the parent. To remove the update set from the batch, delete any text from the Parent field and leave it blank.
  4. Click Update.
    The system returns to the list of update sets. If the Batch Base column is visible, it shows the parent for the newly-created child.

What to do next

If the system property glide.update_set.auto_preview is set to true, the system automatically starts the preview process after the record is updated with a new parent. If this property is false, you must start the process manually. For more information on the preview process, see Preview a batch of update sets .

Back out batched update set

Back out a batched update set by following the back out procedure for the base update set for the batch. You can also back out any child update set independently.

The following rules apply when backing out an update set that belongs to a batch:
  • If the update set has a parent value, the system clears the parent value and treats the update set as an independent update set, or as a new batch base if it has any children.
  • The system backs out the selected update set, plus any children of the backed-out update set.

Example of backing out a batched update set

If you back out Update Set 1.1 from the batch shown in Figure 3, the result is the batch shown in Figure 4.

Figure 3. List of batched update sets before backing out an update set.

Screenshot of batched update sets
Figure 4. List of batched update sets after backing out Update Set 1.1

Screenshot of batched update set after backing out a child update set from the batch

Figure 5 shows the hierarchy both before and after the back out. The red boxes show the update sets the system backs out if you back out Update Set 1.1.

Figure 5. Hierarchical diagram of Update Set batch

Diagram of batched update set hierarchy with a child selected to back out