Set attribute rules

In the Administration Console, edit a lifecycle flow to set attribute rules for lifecycle states.

To manage attribute rules, you need the Manage Object Types privilege.

Create an attribute rule

Define attribute rules to set specific conditions for a lifecycle transition.

For details on how to create and manage transitions, see Manage transitions.

To create an attribute rule:

  1. In the Administration Console, go to Configuration Object Management > Lifecycles.

  2. In the Lifecycles navigation pane, make sure that the top-level Lifecycles node is selected. A list of lifecycles is displayed in the content pane.

  3. In the content pane, click the name of the relevant lifecycle. The Edit Lifecycle dialog box opens.

  4. In the Filter bar, from the Object Type list, select the object type for which you are creating the attribute rule.

  5. (Optional) In the lifecycle model, select the state to which to add the attribute rule.

  6. Under the lifecycle model, select the Attribute Rules tab, and click the Add button.

  7. In the New Attribute Rule dialog box, set the following attribute rule details:

    Field Description
    Attribute name Select the attribute for which you want to create a rule.
    From state

    Select the state from which the rule applies.

    You can use the following references:

    • $PENDING. A generic reference to any required From state. This user who has the object in their Pending list should specify a state.

    • $TO_BE_DEFINED. The object is checked out (item) or held (request).

    To state

    To apply the rule to a transition, select the To state.

    The To state must belong to the same transition as the From state. An attribute rule applies only to a single transition.
    Role

    Select a role to associate with the attribute rule.

    You can use the following special roles:

    • $ORIGINATOR. Specifies the creator of a particular request, item, or baseline.

    • $ALL_ROLES. Specifies all the roles used in the lifecycle, including $ORIGINATOR.

      If a role has been associated with another attribute rule, then the rule for the individual role overrides the $ALL_ROLES rule.

    Required when actioned to the To state

    Select this flag to require a value for the attribute before the attribute can be actioned to another state.

    By denfault, the attribute can be actioned even if it doesn't have a value.
    Writeable at the From state Select this flag to allow the attribute to be updated by the selected role when the object type is at the From state.
    Display in this role section

    Select this flag to allow the attribute to be displayed for the selected role and transition.

    Caution: For multifield, multivalue block attributes, ensure that all preceding attributes in the multifield block are visible to the user for a given role section and transition. If you have not selected the option Required when actioned to the To state or Writeable at the From state, you need to select Display in this role section for all the preceding attributes in the block. This ensures that the multifield multivalue attribute is displayed correctly in the desktop and web clients.
    Keep open Select this option to continue adding more rules without closing the dialog box.

  8. Click OK.

Back to top

Edit or delete attribute rules

Edit attribute rules to change how the attributes are displayed and updated for a specified transition and role. You can create a .csv file with attribute rules and import it into a lifecycle.

Export attribute rules to download them to your machine as a .csv file. Delete attribute rules when you no longer need them.

To edit one or more attribute rules:

  1. In the Administration Console, go to Configuration Object Management > Lifecycles.

  2. In the Lifecycles navigation pane, make sure that the top-level Lifecycles node is selected. A list of lifecycles is displayed in the content pane.

  3. In the content pane, click the name of the relevant lifecycle. The Edit Lifecycle dialog box opens.

  4. In the Filter bar, from the Object Type list, select the object type for which you are editing the attribute rule.

  5. (Optional) In the lifecycle model, select the state for which to change the attribute rule.

  6. Under the lifecycle model, select the Attribute Rules tab.

  7. From the Attribute Rules list, select one or more rules.

  8. To delete the rules, click the Delete selected objects button, and confirm.

  9. To download the rules as a .csv file, click the Export button.

  10. To modify the rules, click the Edit selected objects button. In the Edit Attribute Rule dialog box, update the details, as described in Create an attribute rule.

    Note: You cannot change the name of the attribute rule. To change the role and the From or To states, edit one rule at a time.

  11. To upload the rules for the selected object type, click the Import button. In the Import Attribute Rules dialog box, select a .csv file and click OK. The imported rules are appended to the Attribute Rules list.

    Tip: To prepare a .csv file, enter the details of each attribute rule on a new row in the same order as the columns in the Attribute Rules list: Attribute, From, To, Role, Rule, Display order.

Back to top

See also: