Skip to main content
Version: 20.05

Global Filters

The globalFilters property is used to show/hide and configure global filters in the List Screen. Currently, Workspaces supports three global filters: GroupName, FormName and DateCreated.

Options

Note

Note that globalFilters is not mandatory, but if not set, all queries will have a dateCreated range of one year from the current date.

Group Name

The GroupName is used to show/hide the Group Name select that allows Workspaces users to filter Txns by group names.

GroupName relies on globalActions.GroupName.options in order to display the group list.

Form Name

The FormName is used to show/hide the Form Name select that allows Workspaces users to filter Txns by form names.

FormName relies on globalActions.FormName.options in order to display the form list.

Date Created

The DateCreated is used to show/hide the Date Created input that allows Workspaces to filter Txns by date created ranges.

Example

The following example showcases how to configure a label, options and a value for different global filters.

src/configs/custom/process.ts

import { ConfigCurrentSpace } from '@transact-open-ux/workspaces/dist/types';

export const processConfig = ({ date }: any): ConfigCurrentSpace => ({
...
globalFilters: {
GroupName: {
label: 'Queues',
options: ['Error Review', 'Fraud Review', 'Manual Review'],
value: 'All',
},
DateCreated: {
label: 'Created Date',
value: [date('4 weeks ago'), date('now')],
},
},
...
});

export default processConfig;

Attributes

To review the possible attributes please check the API Reference.