Define Rows for a Matrix Widget
Use the Rows page (accessed from within the Matrix Widget Properties window) to define how the rows look and behave on a Matrix Widget. Properties include:
- Where to get the data for the rows, either:
- List of Rows Come From a Field: Rows come from values in a Field (example: A row for each status).
- List of Rows are Based on Date: Bases rows on periods within a date range (example: If your range is a year, and your periods are months, you will have a row for each month of the specified year).
- Totaling/averaging options:
- Total Row: Adds a row to total other rows in the matrix.
- Average Row: Adds a row to average other rows in the matrix.
- Visibility: When to hide the row (example: Use an Expression to hide the row when the values are negligible).
- Field for List of Rows: Business Object and Field that provide the values for the row. You can also define sorting (Sort By field and ascending/descending) and a limiting Expression.
- Limit Values by Date: Limit values to a specific date range (example: All, Today, Yesterday, Within last 1 week/month/quarter/year, custom range, etc.).
The Matrix Widget Properties window is accessed from within the Widget Manager when you create or edit a Matrix Widget.
To define rows that come from a Field for a Matrix Widget:
- Create a Widget..
- In the Type drop-down, select Matrix.
- Click the Rows page.
- Select the List of Rows come from a Field radio button.
When you select List of rows come from a Field, you specify the Lookup table that will provide the values to display. For example, if you want a row for each status, you might select the Status field from the Incident Status Lookup table. You are not limited to Lookup tables; however, performance will be better if you select a cacheable Lookup table rather than the Status field from the Incident Business Object.
- Define totaling/averaging options:
- Total Row: Select this check box to add a row to total other rows in the matrix.
- Average Row: Select this check box to add a row to average other rows in the matrix.
- Define visibility:
- Define an Expression to conditionally hide a row, using either:
- Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
- Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
- Define an Expression to conditionally hide a row, using either:
- Define the values for the row:
- Business Object/Field:
Select the Lookup table and field that supply all the possible values (example: For Incident, it might be the Status field in the Incident Status Lookup table, with Status values like New, In Progress, Assigned, etc.).
- Order By:
Select the field to use to order the values, as well as an ascending or descending order. Rarely will the alphabetical order match the order in which the values should appear in your item, unless you prefix the values with numbers or letters (example: For status, you would likely want lifecycle order, not alphabetical order); therefore, it is common to define a field that contains a sequence number purely for controlling the order (example: Status Order).
- Limit Rows:
Define a Saved Search or Custom Query to limit the rows (example: Limit the rows to only those where the Department = Network Support).
- Business Object/Field:
- Limit values by date:
This does not affect the list of rows; instead, it adds an additional criteria to the data in each column. If you select to set up a User selectable option, then a small drop-down is displayed to show the various options.
- Provide a date range limit for your data, using either:
- Range: Select this radio button to use a single date range to limit the data. Then, select the date range (example: Any time, Today, etc.), or click New to open the Custom Date Range window where you can define a custom date range.
- User-Selectable: Select this radio button to display a drop-down list on the matrix so that Users can select how to limit the data. Then, click the Ellipses button to open the Multiple Date Ranges window, where you can select one or more date ranges to include in the drop-down.
- Field Used for Date Range: Select the Field to use to give the range perspective (example: "LastModDateTime" gives "Previous Year" perspective).
- Provide a date range limit for your data, using either:
-
Select OK.
To define rows that are based on a date for a Matrix Widget:
- Create a Widget.
- In the Type drop-down, select Matrix.
- Click the Rows page.
- Select the List of Rows are Based on Date radio button.
- Define totaling/averaging options:
- Total Row: Select this check box to add a row to total other rows in the matrix.
- Average Row: Select this check box to add a row to average other rows in the matrix.
- Define visibility:
- Define an Expression to conditionally hide a row, using either:
- Custom Expression: Click the Custom Expression button to open the Custom Expression Builder, and then create a custom Expression specifically for this scenario.
- Stored Expression: Click the Ellipses button to open the Expression Manager, and then select an existing stored Expression or create a new stored Expression. Stored Expressions can be reused in numerous places in CSM.
- Define an Expression to conditionally hide a row, using either:
- Define the date range:
- Provide a date range limit for your data, using either:
- Range: Select this radio button to use a single date range to limit the data. Then, select the date range (example: Any time, Today, etc.), or click New to open the Custom Date Range window, where you can define a custom date range.
- User-Selectable: Select this radio button to display a drop-down list on the matrix so that Users can select how to limit the data. Then, click the Ellipses button to open the Multiple Date Ranges window, where you can select one or more date ranges to include in the drop-down.
This option works differently for date-based rows. Instead of limiting the data that is pulled, it modifies the rows that are displayed (example: If you allow the User to select between Last Year, This Year, and Next Year, the rows change to show the months from the specified year).
- Break Range Into Periods: Select the range covered by each row. If your date range does not contain complete periods (example: You select monthly, but have a range that starts halfway through a month), the date range automatically expands to make up complete periods.
- Provide a date range limit for your data, using either:
-
Select OK.