Skip to content

Set Experiment Definition Version as Effective#

🔒 ExperimentDefinition.SetEffective

Overview#

This operation is used to set an Experiment Definition version as Effective.

Setup#

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

Preconditions#

  • The Experiment Definition version exists in the system and it is Active.
  • The Experiment Definition must contain at least one Experiment Definition Step.
  • There must be at least one Experiment Definition Step that belongs to the Experiment Definition Flow.

  • When changing an already Effective version to a new one, the following checks are performed:

    • If the Experiment Definition version being set as Effective defines a Product or Product Group different from the previous effective Experiment Definition, all Active current Materials associated with the Experiment Definition (via the Experiment object) must have that Product or Product Group set.

    • If the Experiment Definition version being set as Effective has any difference from the previous Effective Experiment Definition regarding any Experiment Definition Step with the respective Contents, then if there are current Active Materials associated with the Experiment Definition located at that Experiment Definition Step Flow Path:

      • The name of all previous Experiment Definition Step Material Groups must be retained.
      • The Mode of the Experiment Definition Step Material Groups must remain unchanged.
      • The composition of all previous Experiment Definition Step Material Groups remains the same, considering only Material Groups currently at that Experiment Definition Flow Path Step and ignoring No-Action groups. However, an Experiment Definition may be divided in two or more.

      Note

      These checks apply only to Experiment Material Groups that are located in the affected Experiment Definition Steps.

      • The New Processing Required is false.
      • If a Step Material Group within an Experiment Definition Step is divided in two or more groups, excluding No-Action groups:
        • The Mode of the Experiment Definition Step Material Groups must be Enter.
        • For the Experiment Definition Step Material Group that remains:
          • There must be a Material in state Queued at that Experiment Definition Step Flow Path for that Experiment Definition Step Material Group - required because the new Materials will be split from this one.
          • That Material must contain the Sub-Materials required by all the new Material Groups created from it.
        • There must be a Split Type defined for the new created groups - it cannot be None.
        • The New Processing Required is true.
      • At that Experiment Definition Step, for all retained Experiment Definition Step Material Group, the following properties must remain unchanged: Type, Split Type, and Split Scope.

    • If there are active Experiments, there cannot be any change between versions of the following properties:

      • Auto Close
      • Mode
      • Empty Sub-Materials
    • The Max Number of Materials, Required Material Form, Required Material Type, and Required Sub-Materials Form is not checked at Set Effective.

    Info

    These checks are not performed when setting the Experiment Definition as effective for the first time.

  • If the Experiment Definition version being set as Effective defines a Required Sub-Materials Count different from the previous effective Experiment Definition, if there are current Active Materials associated with the Experiment Definition, then the system must abort the use case and report an error.

  • The Experiment Definition version is set as Effective, and the previous Experiment Definition version that was Effective (if any) is set as Active.
  • If New Processing Required, the system must, for all the Experiment Definition Step Material Groups that have been divided and for which a Material exists at that Experiment Definition Step Flow Path in State Queued:
    • Run the defined logic to create the Split Future Actions.
  • If a new version of the Experiment Definition version defines actions for a Material in the Processed state, those actions will not have any effect even if the associated Material is still in the Queued state.

Sequence of Steps#

The Set Experiment Definition Version as Effective wizard can be called from the Experiment Definition page within the Business Data Group.

Step 1: General Data#

  1. Review the information on the Set Experiment Definition Version as Effective wizard.
  2. Select Set Effective to complete the operation.

set_experiment_definition_version_as_effective