Configuration Data for Reports
The following tables describe the available settings for reports.
Report Definition
| Field | Description | Default Value |
|---|---|---|
| Partition | The partition the report resides in. | The current default partition |
| Name | The name of the report. | |
| Application | The application the report belongs to. | |
| Description | The description of the report. | |
| Query | The query used to generate the report, you have the choice between using a QueryFilter or using custom SQL. | |
| Limit | Restrain the amount of rows retrieved. |
Documentation
| Field | Description |
|---|---|
| Documentation | A comment about the report. |
Parameters
You need to choose Add to create a new parameter.
| Field | Description | Default Value |
|---|---|---|
| Name | The name of the parameter. | |
| Description | The description of the parameter, which will be used in the submit wizard. | |
| Documentation | A comment about the parameter. | |
| Type | The data type of the parameter. | Character |
| Default Expression | The default expression of the parameter. | |
| Display | Should this parameter be displayed in the submit wizard of a job? | Yes |
Columns
You choose which columns to display in the report. By default, only a subset of columns are selected.
| Field | Description |
|---|---|
| Name | Name of the column in the report, which does not have to match the real column name. |
| Description | A description of the column. |
| Documentation | A comment about the column. |
| Display | Should the column be displayed in the report, the default value is yes (checked). |
| Column Format > Raw | displays the data as it is stored in the database |
| Column Format > Formatted | formats the output to be more user-friendly |
| Column Format > Business Key | displays the name of the object, instead of its UniqueId |
| Column Format > Permalink | displays the full permalink instead of the value |
| Column Format > Permalink Business Key | displays a Business Key which links (via permalink) to the actual object |
| Value | You use Value field when you want to apply custom formatting to the value, for example to format a duration (process runtime); You use REL expressions to format values. |
note
Column formatting is only available in HTML reports. XML and CSV reports are note affected.
Selections
You can refine your query on the Selections tab by returning only rows that match particular criteria. Choose Add to create a new rule.
| Field | Description | Default Value |
|---|---|---|
| Left Report Column | The columns to use for comparison (on the left hand-side of the query). The field will let you choose any column in your report. | |
| Operation | The operation you want to perform on both values | Equal to |
| Column/Value | Column, value or parameter you want to compare to the value of Left Report Column. It can be another column in the report, a hard-coded value, a REL expression, or a report parameter. |
Sorts
Sorts allow you to order the row of a query by one or more columns in a certain order, like alphabetically, for example. You choose Add to create new sort criteria.
| Field | Description | Default Value |
|---|---|---|
| Report Column | The column on which to sort. | |
| Sort Order | The order in which to apply the sorting, used when more than one column are used for sorting, the lower number has higher priority. | |
| Ascending | The default sort order is ascending, uncheck this box to have a descending order. | Yes (checked) |
Report Preview
Allows you to see a preview of the report.
Security
Allows you set privileges directly on the report for users and custom roles. See Granting and Revoking Object Privileges for more information.
See Also
report reporting