Configure The Workbench Filters

The Redwood Finance Automation Workbench allows users to specify a number of customizable filter criteria for the data about jobs. When you specify a parameter, you will be able to filter on the different values of that parameter. For example, assuming your processes have run for four periods ( 001 to 004 ), you can easily display processes that have run for either period 002 or 003 by choosing the filter and checking the 002 and 003 checkboxes. You choose the Filter twice (double-click) to display all processes again.

To configure the workbench filters, the following tables are used:

• CUS_FCA_Workbench_BoardConfiguration - used to specify the filters in the workbench; it is evaluated at runtime.
• CUS_FCA_Workbench_Filter_Display_Names - used to specify the display names of Filters; it is evaluated at runtime.

You use the following read-only tables as templates:

• FCA_Workbench_Filter_Display_Names
• FCA_Workbench_BoardConfiguration

note

It is expected for any values in FilterParamName column within the CUS_FCA_Workbench_BoardConfiguration table to also be included as a FilterParamName within the CUS_FCA_GlobalMonitor_BoardConfiguration table. This will ensure that users are able to smoothly navigate through the Global Monitor hierarchy and drill into the Workbench. Failure to include any FilterParamName in both tables may result in unexpected behavior.

Workbench Configuration

You specify the JobParameter's that hold the values for the Filters, you then filter on parameter value.

CUS_FCA_Workbench_BoardConfiguration Table Structure

The FCA_Workbench_BoardConfiguration and CUS_FCA_Workbench_BoardConfiguration tables has the following structure:

Column Name	Description	Valid Values
Key	A unique identifier for the row.	Any positive integer
FilterParamName	The name of the parameter used to filter jobs by.	Any valid process definition parameter name.
DisplayOrder	The order in which to display filters.	Positive integer.

In addition to specifying any valid process definition parameter name, there are four job attributes that can also be added as a filter:

• TASK_DEFINITION - the task defintion
• TASK_DESCRIPTION - the description provided for the task (either in Orchestrator or in the process definiton)
• STATUS - the status of the task within the Workbench (Completed, Error, Warning or Unknown)
• OWNER - the task owner (Approver, Supervisor, Both or Other)

Each of these four job attributes that can be used as filters are included in the template table FCA_Workbench_BoardConfiguration.

note

If any Filter is added that does not have any valid values for the processes being displayed, then it will not be added as a Filter.

note

The Workbench will pull the description of parameter name for display of Filter, if no description can be found on the process definition then a default value of Unknown will be assigned.

Mapping Filter Parameter Names

You override the display value, per locale, in the CUS_FCA_Workbench_Filter_Display_Names table.

CUS_FCA_Workbench_Filter_Display_Names Table Structure

The FCA_Workbench_Filter_Display_Names and CUS_FCA_Workbench_Filter_Display_Names tables have the following structure:

Column Name	Description	Valid Values
Key	A unique identifier for the row	Any positive integer
FilterParamName	The name of the parameter used to filter jobs by.	Any valid process definition parameter name.
Locale	The locale language the DisplayName is used with	A supported language, as listed in the User Settings; supports the ISO 15897 locale syntax for language. Such as en (English), fr (French) and de (German). Territory
DisplayValue	Any UTF-8 character combination, excluding some characters from the Symbol, Other category and non-printable characters. Note that the browsers you use must be able to display the characters you choose.

Example

You wand to have two Filters on TASKLIST_PERIOD and TASKLIST_YEAR displayed on the left-hand side of the Workbench.

The CUS_FCA_Workbench_BoardConfiguration table was edited to have the following two entries:

Key	FilterParamName	DisplayOrder
0000	TASKLIST_PERIOD	0
0001	TASKLIST_YEAR	1

You want to adapt the display name of the Filters and edit the CUS_FCA_Workbench_Filter_Display_Names table as follows:

Key	FilterParamName	Locale	DisplayName
0000	TASKLIST_PERIOD	en	Fiscal Period
0001	TASKLIST_YEAR	en	Fiscal Year

All users now see Fiscal Period and Fiscal Year filters.

financeTopic