Configuring Effectivity for Object Type or Relationship

To define effectivity for an object type or relationship, you must add the ENO_Effectivity property to that type. The value for this property contains a comma-separated list of effectivity definitions.

By default, Configuration and Effectivity Services defines context date effectivity that can be added to a type or relationship. You can define additional effectivity types.

  1. Open the Run MQL window:
    1. From the compass, select Collaboration and Approvals.
    2. In the navigation pane, click Utilities > Run MQL.
    To run an MQL command, enter the command in the MQL Command box and click Run or press Enter.
  2. To add effectivity to a type or relationship, run the following MQL commands:

    add property ENO_Effectivity on type <TYPE> value <EFFTYPE>; 
add property ENO_Effectivity on relationship <RELATIONSHIP> value <EFFTYPE>;

    where:

    • <TYPE> is an object type.
    • <RELATIONSHIP> is a relationship.
    • <EFFTYPE> is the effectivity being defined:
      • Use ContextDate to add the date effectivity.
      • Use Milestone to add milestone effectivity.

    For example, to define Date and Unit effectivity for a requirements structure, run this command:

    add property ENO_Effectivity on relationship "Sub-Requirement" value "ContextDate, Unit";

    For example, to add Milestone effectivity to the GBOM structure, run this command:

    add property ENO_Effectivity on relationship "GBOM" value "Milestone";

  3. To add the Effectivity Framework interface to the relationship or type, run the following MQL commands:

    modify interface 'Effectivity Framework' add relationship <Relationship Name>;
modify interface 'Effectivity Framework' add type <Type Name>;
    where:
    • <Relationship Name> is the name of the relationship that you want to add.
    • <Type Name> is the name of the object type that you want to add.

  4. To add the relationship or type to the Effectivity Usage relationship:

    modify relationship <Relationship Name> from add type <Type Name>;
modify relationship <Relationship Name> from add relationship <Relationship Name>;
    where:
    • <Relationship Name> is the name of the relationship that you want to add.
    • <Type Name> is the name of the object type that you want to add.

  5. To add the Effectivity URL, run the following MQL command:

    modify menu <Menu Name> href <VALUE>;
    where:
    • <Menu Name> is the name of the menu where you want to add the object's effectivity command.
    • <HREF> is the HREF of the page that displays the object's effectivity.

  6. To create a command used for effectivity, run the following MQL command:

    add command <Command Name> description <STRING VLAUE> label <VALUE> setting Format <STRUCTURE> setting "Registered Suite" <SUIT> setting label <LABEL> setting categoryType <TYPE> setting keyword <KEYWORD>;
    where <Command Name> is the name of the menu where you want to add the object's effectivity command.

  7. To add the command created in the previous step to the Effectivity menu, run the following MQL command:

    modify menu <Menu Name> add command <command Name>;
    where:
    • <Menu Name> is the object type menu to which you want to add the command.
    • <Command Name> is the command that you want to add to the menu.

When effectivity is defined for a type, the Effectivity Framework interface is added to that type. This interface contains these attributes:

  • Effectivity Types
  • Effectivity Expression
  • Effectivity Expression Binary
  • Effectivity Compiled Form
  • Effectivity Variable Indexes
  • Effectivity Proposed Expression
  • Effectivity Ordered Criteria Dictionary
  • Effectivity Ordered Criteria
  • Effectivity Ordered Impacting Criteria