Restricted List DTP

Defines a restricted list.

For example, in the Allocation system template, you can select a rounding method and then use a Restricted List design-time prompt to choose the type of rounding to use in the template.

In the script of the template, you can create script for each type of rounding, and the script is only used when the user selects that rounding option.

To create a Restricted List design-time prompt:

  1. In the Template Designer, open an existing template or create a new template.
  2. On the Design Time Prompt tab, click Add button.
  3. If you already have design-time prompts defined for the template, select where to enter the new design-time prompt.
  4. In the Create Prompt dialog box, on the Properties tab, do the following:

    • Enter a Name and select Restricted List as the Type.
    • Select the desired options:
      • Prompt It?—Select this option to allow the DTP to be used in a step. The DTP is shown in the template steps that prompt users for input when the template is used in a rule, or when a script template is launched in Planning.

      • Mandatory?—Select this option to make it mandatory to enter data for the design-time prompt.

      • Read Only—Select this option to make it so that users can only read the prompt.

      • Is Hidden—Select this option to hide the design-time prompt from the user. In Planning, on the Business Rules tab in form design, add the rule with the template or script template to the form. In the Business Rules Properties pane, select Hide Prompt, and then select Use Members on Form.

    • In DTP Text, enter the text that you want users to see when they are prompted for input.

      If you select Prompt It?, then DTP Text is required.

    • Optional. In Comments, enter a comment about the DTP.
  5. Select the Restricted List tab, and enter a Rule Builder Value and a Substituted Value.

  6. Optional. Go back to the Properties tab and enter a default value to be displayed in the design-time prompt.

    To define a default value, click the Default Value drop down, and then select a Rule Builder Value that you entered on the Restricted List tab.