Skip to content
View as markdown Ask ChatGPT Ask Claude

Create Change Package#

🔒 ChangePackage.Create

Overview#

This operation is used to create a Change Package, which groups Master Data changes that can be published to the Global Data Orchestrator and deployed to other Customer Environments.

Setup#

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

Preconditions#

  • You must have an active Critical Manufacturing MES license that includes the Global Data Orchestrator module.
  • A Local Customer Environment ID must be configured.
  • You must have access to a Customer Portal account.

Sequence of Steps#

There are several ways to create a new versioned object. Depending on the level, follow these steps to get started:

  • Entity - in the landing page of this entity type in the Business Data menu or in the details page of an existing entity of the same type, select New on the top ribbon. For more information, see Creating Entity Objects.
  • Revision - if you want to create a new revision, go to the New dropdown button on the top ribbon and select Revision. For more information, see Revisions.
  • Version - if you want to create a version associated to an existing revision, go to the New dropdown button on the top ribbon and select Version. For more information, see Versions.

Step 1: Log in to the Customer Portal#

  1. Authenticate in Customer Portal with your credentials.

    Warning

    You must be signed in to the Customer Portal to select a Master Data Deployment Plan.

Step 2: Change Set#

  1. Choose an existing Change Set or select Create to create a new Change Set. If configured to support implicit Change Sets, it is also possible to check the Use Automatic Change Set option.
  2. Optionally, select an Approval Role.
  3. 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.

Info

For more information, see Create Change Set.

Step 3: General Data#

  1. Provide a name for the Change Package.

  2. If you are creating a new entity or revision, provide a name for the revision or it will be automatically generated for you. For more information on revision naming, see Revision Naming.

    Note

    Change Packages do not support new versions. Use revisions to update an existing Change Package.

  3. Optionally, provide a description of the Change Package.

  4. Select the type of Change Package. The list of possible values is taken from the ChangePackageType lookup table.
  5. Optionally, associate it with a Data Group.

  6. Select a Master Data Deployment Plan.

    Info

    The Master Data Deployment Plan defines the Customer Environments to which the package contents are deployed. For more information, see the Global Data Orchestrator ↗ documentation.

  7. Select a Publication Mode:

    • Automatic - when the Change Package is set effective, the system approves it and calls the Publish operation automatically.
    • Manual - when the Change Package is set effective, the system approves it, but it must be published later by using the Publish operation.

  8. Optionally, edit the Release Notes.

  9. Select Create to complete the operation.

Screenshot showing the "Create" button in the context of entering general data for a new object.

After the Change Package is created, the system sets its initial system state to Draft, associates it with the current Local Customer Environment and MES version, and sets the item count to zero until contents are added to the package.

A Change Package must contain at least one item to be approved or published. For more information on adding contents to the Change Package, see Manage Change Package Items.

Screenshot showing the Change Package created.