Managing requirements for an activation validation set


About the requirements

Filtering the list of requirements for a validation set

Adding, editing, and removing requirements

Setting the requirement name and type

Selecting the trigger products

Configuring the validation or quantity calculation expression

Selecting the error message to display if the validation or quantity calculation fails

Saving the requirement


About the requirements

Each activation validation set is made up of one or more requirements. Each requirement represents a single validation check or quantity calculation, and consists of:

Filtering the list of requirements for a validation set

On the Activation Validation Set Maintenance page, the Requirements section contains the list of requirements that belong to the validation set.

To filter the list, you can use these criteria:

Requirement name To search for a requirement with a specific name, type the name into the field.

The field supports partial criteria using the wildcard character (%). For example, to search for all requirements with names that start with the letter A, type "A%" into the field.

Trigger product # To search for a requirement that includes a specific trigger product number, type the product number into the field. To search for and select a product, click the find icon.

The field supports partial criteria using the wildcard character (%). For example, to search for all requirements with trigger products with product numbers that start with "super", type "super%" into the field.

Expression To search for a requirement with a specific expression, type the expression into the field.

The field supports partial criteria using the wildcard character (%). For example, to find a requirement that includes ProductA in the expression, type "%ProductA%" into the field.

Validation type To search for requirements with a specific type, select the type from the dropdown.

After providing the criteria, to filter the list, click Filter Requirements. For each requirement, the list can include:

Adding, editing, and removing requirements

To add a new requirement to the validation set, click Add requirement.

To edit a requirement from the list, click its Edit link.

The Requirement Maintenance page displays.

To remove a requirement from the validation set, click its Remove link.

Setting the requirement name and type

On the Requirement Maintenance page:

  1. In the Requirement name field, type the name of the requirement.
  2. From the Type dropdown, select the type of requirement. The available values are:
    Activation Validation - Compatibility The trigger products can be activated with a specific list of products from the activation validation set domain.
    Activation Validation - Dependency The trigger products require the presence of another product or some combination of other products.

    The required products do not need to be in the activation validation set domain.

    Activation Validation - Quantity match The trigger product quantity must be equal to a specific value. The value may be a number or may be calculated based on the quantity of other products.

    The other products do not need to be in the activation validation set domain.

    Activation Validation - Quantity by step The trigger product quantity must be an increment of a specific value, starting with a minimum value.

    For example, the quantity must be a multiple of 16, but can be no less then 32.

    Activation Validation - Quantity within range The trigger product quantity must be within a specific range of minimum and maximum values.

    For example, the quantity must be no less than 10 but no more than 50.

    Quantity Calculation - Required product The trigger product is required. The quantity calculator uses the first matching calculation rule to calculate the quantity.
    Quantity Calculation - Optional product The trigger product is optional. The quantity calculator uses the first matching calculation rule to calculate the quantity.

Selecting the trigger products

The trigger products are the products that cause this requirement to be processed. The requirement is triggered if any one of the trigger products is activated.

The trigger product list is a comma-separated list of product numbers. The products must all belong to the validation set domain. The list cannot include any other characters.

If product security categories are used (Registry IS_PRODUCT_SECURITY_CATEGORY_SUPPORTED is true), then:

You can type the list manually, or, to search for and select a list of products:

  1. Click the find icon.
  2. On the Search Products form, provide search criteria for the products you want to select.
  3. Click Search Products.
  4. In the results list, check the check box next to each product you want to include in the trigger product list.
  5. Click Select checked products.

    The selected products are appended to the end of the current list.

Configuring the validation or quantity calculation expression

In the expression field, type the expression used for the validation or quantity calculation. The required format depends on the type of validation. See Configuring validation set requirement expressions for details.

Selecting the error message to display if the validation or quantity calculation fails

About the requirement error message

When the validation or quantity calculation for a requirement fails, Poetic returns an error.

Each requirement type is assigned a default error message. You can also create and select a custom error message to use.

Selecting a different custom error message

To select a different custom error message:

  1. Click Select Custom Error Message.

    The Search Custom Error Messages form displays.

  2. Provide search criteria, then click Search Custom Errors. You can search by:
    • The name of the error message
    • The default message text or message description
    • The build when the message was added
  3. To select an error, click its Select link.

Creating a new error

On the Search Custom Error Messages form, to create a new message:

  1. Click Add a message.
  2. On the Custom Error Maintenance form:
    Name You use the Name field to set the name that represents the error message in the application code.

    All custom error message names begin with "CUSTOM_", which is provided automatically.

    In the field following "CUSTOM_", type the remainder of the name.

    Be sure not to use any spaces in the name.

    Description In the Description field, type a brief description of the message.
    Default message In the Default message field, type the default text of the message.

    Errors created for validation set requirements allow the following dynamic values:

    • {0} - Trigger product that violates the rule
    • {1} - Family the trigger product belongs to
    • {2} - Trigger product quantity
    • {3} - Requirement name
    • {4} - Expression
    • {5} - List of incompatible products
    How to use In the How to use field, type a longer description of when and how the message is used.
  3. Click Save.

    The message is saved and is selected as the error for the requirement.

To localize the text of the error, use the error message maintenance function. See Editing and localizing error messages for details.

Restoring the default error message

To restore the default error message, on the Validation Requirement Maintenance form, click Restore Default.

Saving the requirement

To save the changes to the requirement, click Save.