Add a Filter to a Component

By adding a filter to a component, you can restrict the records displayed in one or more of that component's views or fields. For example you may want to restrict a list of open records to particular records within a date range, and only to users in specific roles. Such a restriction requires the user in one of the permitted roles to enter a date range before they can access that view. Another use of a component filter on a view could be to display records relevant to the user's department or location (can be based on the user profile values). For a field, you may want to restrict the selection list of people to show just those in a particular department.

Quick summary

1. Create a new filter on a component ( Main Menu Designer Filters Component Filters).
2. Add or select roles that this filter applies to, then enter the filter value for these roles.
3. Optional: Add parameters to narrow the filter further.
4. Optional: Add default values that apply to members of particular roles.
5. Save the filter, then perform a Publish.
6. Apply the filter to a view or field.

To add a filter to a component (detail)

1. In the web application, select Main Menu Designer Filters Component Filters from the menu.

   A list view of existing filters displays.

2. Click New. The Component Filters page displays.
3. Complete these fields:
   • Name: Enter a short but meaningful name for this filter.
   • Description: Enter a longer description for this filter.
   • Component: Select the component to be filtered, then click OK and then click SAVE.
4. Mandatory: In the Role Settings section, click the Add New Role Settings link.
5. Complete these fields in the Role Setting section:
   • Roles: Select one or more roles that this component filter is to apply to, then click OK.
   • Name: Enter a short name for this role. This name displays in the summary row.
   • Description: Enter a description for this role, perhaps related to this filter. The description appears in the collapsed section.
   • Value: Enter a filter condition using the Condition Builder. This is the filter that applies to the component.
6. Optional: If filter parameters are required, click the Add New Parameters link in the Parameters section.

   Filter parameters are similar to report parameters, and may include such things as a start and end date, location or department, and the like.

7. Complete these fields in the Parameter Value Definition section:
   • Name: Enter a name for this parameter with no spaces. Note: Only letters, numbers, and underscores are acceptable characters for this field.
   • Label: Enter the text for this parameter; this text displays to the user.
   • User Access: Select an option from Modifiable (user can view and change), Read Only (user can view but not change), or Hidden (user cannot view or change).
   • Mandatory: Select this checkbox to make this parameter required.
   • Field Type: Select a field from the list, then click OK.
8. Optional: In the Role Defaults section, click the Add New Role Defaults link.
9. Complete these fields in the Role Default section:
   • Roles: Select one or more roles, then click OK.
   • Value: Enter a default value for the selected roles.
10. Click Save.

    Note: Changes are not visible to the user until they are published. If you have only changed an existing component filter, you do not need to republish - just restart the web server and the system will apply the changes.

11. Next step: Apply this filter to a view or a field.