Create a dynamic filter option

Dynamic filter options enhance filters by allowing users to run a set query against a reference field without having to enter JavaScript code in the condition builder.

Before you begin

Role required: admin

About this task

All dynamic filter options use the is (dynamic) operator and call a particular scripted filter.
Note: Dynamic filters are not supported in scoped applications.
Figure 1. Dynamic operands

For more information about using dynamic operators, see Dynamic operators.

Procedure

  1. Create a scripted filter as a client-callable script include or business rule.
  2. Navigate to System Definition > Dynamic Filter Options.
  3. Click New.
  4. Complete the form.
    Table 1. Dynamic filter options
    Field Description
    Label Enter the text you want to appear as an option when a user selects the is (dynamic) operator.
    Script Enter the name of the function you created.
    Field type Select Reference.
    Referenced table Select the table this filter option applies to.
    Order Enter a number to designate the placement of this option in the filter option choice list.
    Roles Select the role a user must have to see this option.
    Active Enable or disable the option.
    Reference script Select the client-callable script include or business rule you created for the scripted filter.
    Available for filter Select this option to display the option as a filter breadcrumb.
    Available for default Select this option to allow it to be a default in a dictionary entry.
    Available for ref qual Select this option to allow it to be selected as a reference qualifier in a dictionary entry.
  5. Click Submit.