Skip to content

Create Change Set#

🔒 ChangeSet.Create

Overview#

This operation is used to create a Change Set (a bundle of change-controlled object versions).

Note

Change Set items are added to the Change Set at the time of creation of the version.

Setup#

No specific setup is required other than to meet the preconditions of the transaction.

Preconditions#

  1. When the Change Set is being created, the name must be system-wide unique.
  2. A particular version of an object can only be part of one Change Set.
  3. In a Change Set, there cannot be two different versions of the same object.
  4. All Change Set items refer to objects in Created status.
  5. The Change Set can only be edited if it is in state Created.
  6. When the Change Set is being edited, it must be in the Active or Created status.

Sequence of Steps#

Step 1 - General Data#

  1. Select New to open the Change Set creation wizard.
  2. Provide a unique name and, optionally, enter a description.
  3. Select the Type.
  4. In the Information section, optionally, provide a Category, Urgency, and Owner.
  5. If you want to define an approval for the Change Set, set Requires Approval to true and, optionally, select either a Change Set Approval Role or an Approval Workflow.
  6. Optionally, set the Make Change Set Items Effective on Approval to true so that the Change Set items become effective when the Change Set is approved.
  7. Select whether you want to send email notifications to the requester by setting Send Email Notifications To Requester to true (default to false). If set to true, requester receives a notification when there are changes in the Change Set.
  8. Select whether you want to send email notifications to the approvers by setting Send Email Notifications To Approvers to true (default to false). If set to true, members of the Change Set Approval Role receives a notification in the following situations:
  9. If there are any Change Set Items in the Waiting for Approval state;

  10. If all Change Set Items have been approved, indicating that there is a Change Set in Waiting for Approval state.

  11. Optionally, enter a Reason for Change.

  12. Optionally, enter a Description of Change.
  13. Select Create to complete the operation and the system will confirm that the Change Set was created successfully.

create_change_set