The <column> element in an XML search definition defines a column in the Search Results screen, where the column values represent a field in the event record.
The supported entities are as follows:
(Optional) Specifies a name that uniquely identifies the column in the Search Results screen.
(Optional) Specifies the preferred column width in the Search Results screen.
Example:
width="20%" or width="120px"
(Optional) Specifies the column heading in the Search Results screen.
Example:
label="Audit Status"
(Optional) Specifies that the column heading label should not be shown, typically used when the column width is very narrow.
Example:
hide_label="true"
(Optional) Specifies the predefined function that is called when a reviewer clicks an individual value in the results column. A range of standard scripting functions are supported—see Standard Scripting Functions.
Example: This attribute is used by the Standard Search in the iConsole to show details about an email sender:
link_function="_UserDetails"
Note: Can be used in association with the ref attribute.
(Optional) Specifies the name of the column to be used as the unique reference for a 'column action'. The results element must include a column with this name (column names are specified using the name attribute).
If the ref attribute is omitted, a normal hyperlink is created.
Example: This attribute is used by the Standard Search in the iConsole to show details about an (Optional) email sender:
ref="user_uid"
Note: Always used with the link_function attribute.
Specifies the type of column. This must be compatible with the associated database types; see Search Result Column Type Mappings.
The supported column types are:
An identifier field containing values for the ref attribute.
Generic text field.
Generic numeric field.
Generic date field.
Generic timestamp field.
A two part field comprising the filename of the icon and a tooltip separated by a colon.
A list of values separated by semicolons.
A field which has a hyperlink to retrieve additional information such as user or event details. Link columns use the link_function attribute or display a popup.
Alternatively, if the ref attribute is not defined, the field is used as a URL to create a hyperlink to a page which is opened in a separate window. If required, the link can be displayed with alternative text (i.e. not the URL) by returning Label;URL as the column value.
A numeric field with unit information appended. For example, 123 MB, 30 days.
Generic Boolean field (that is, column values can be True or False).
A real (decimal) number, used in conjunction with the real-format attribute.
On Oracle 10 or later, the value returned must be a fixed-point value such as NUMBER(38,6).
(Optional) Specifies whether the column is hidden by default.
Example:
hidden="true"
Note: Typically used for id columns.
(Optional) Specifies the units to be appended to column values, typically when used with a quantity column.
Example:
units="%"
(Optional) Specifies that the full content of a cell is shown in a tooltip when the mouse pointer hovers over the cell. This is useful for narrow columns that contain very long values.
Example:
show_tooltip="true"
(Optional) Specifies that the column is a unique key. For the current release, this attribute is used to delete events from the Search Results screen (using the ToolbarDelete function) and for updating results (using the ToolbarUpdate function).
(Optional) Specifies a subfolder containing the icon images for an 'icon' column type. This must be subfolder of the \images folder in the CA DataMinder installation folder on the iConsole front-end Web server.
(Optional) Allows a tooltip to be defined for the column heading.
Example:
tooltip="My column tooltip"
(Optional) Specifies the format to be used for a real number using XML stylesheet formatting syntax.
Example: '#.00' will format a number to 2 decimal places, 1234.5678 will be formatted as1234.57.
real_format="#.00"
(Optional) When this attribute is included, the column is optional. It specifies whether the column should be included in the displayed results. When set to "false" the column is not displayed in the search results unless selected from the Column Selector of the search results or search properties page.
Example:
display="false"
(Optional) Specifies a style for this column. This will be applied to both the headings and cell contents and is used typically to specify text formatting.
Example:
style="text-align: center"
(Optional) Specifies the aggregate function to be used to calculate the total for this column. See Displaying Aggregate Totals.
Specifies a column in the results that will define the name of a CSS class in the stylesheet that will be used to define the style for each cell in this column.
The stored procedure is responsible for defining the class for each row; a NULL value will apply no class.
The precedence of certain styles (e.g. font-size) may need to be forced by using the '!important' rule.
.bigfont {font-size: x-large !important;}
|
Copyright © 2014 CA.
All rights reserved.
|
|