Working with Special Fields
Special fields are defined by Logi Report. You can use them to easily obtain system information and report-related data. This topic introduces the special fields Logi Report provides, how you can insert them in a report, and add conditional formats to the special fields.
This topic contains the following sections:
- Special Fields Supported by Logi Report
- Inserting Special Fields in a Report
- Adding Conditional Formats to Special Fields
See an example: The SampleComponents catalog, included with Designer, contains reports that have examples of how you could use each component type in a report. For the special field example, open
Logi Report classifies the special fields it supports into the following categories: Date-time, Computed, and System.
Special fields of the DateTime type.
- Print Date
Prints today's date (or the current date from your computer).
- Print Time
Prints the current time from your computer.
- Fetch Date
Prints the date when Logi Report retrieves the data from the database.
- Fetch Time
Prints the time when Logi Report retrieves the data from the database.
- Modified Date
Prints the last modified date of the catalog.
- Modified Time
Prints the last modified time of the catalog.
Special fields that Logi Report computes based on the report.
- Record Number
Prints the record number (usually placed in the detail panel).
- Group Name
Prints the group name (usually placed in the group header/footer panel).
- Total Records
Prints the total number of records after Logi Report performs all the filter conditions, except the ones created in the Filter dialog box of Page Report Studio, and the Group Filter dialog box and Top N/Bottom N condition in Designer.
- Total Fetched Records
Prints the total number of records which take part in grouping calculation. The possible result of the special field is as follows:
- If you don't set any filter condition in the Filter dialog box of Page Report Studio, print the number of the record obtained after setting the property Maximum Records.
- If you set filter conditions in the Filter dialog box of Page Report Studio, print the number of records obtained after performing the filters, even though you have set the property Maximum Records before setting the filters.
- Group Number
Prints the group number (usually placed in the group header/footer).
- Total Group Number
Prints the total group number (usually placed in the group header/footer).
- Page Number
Prints the page number of the component which it is placed in.
- Global Page Number
Prints the global page number of the whole report wherever it is placed.
- Total Page Number
Prints the total number of pages of the component which it is placed in.
- Global Total Page Number
Prints the global total number of pages of the whole report wherever the field is placed.
- Page N of M
Prints a specific page number out of the total page number of the component which the field is placed in.
You can specify the format of this special field. To do this, select this special field, then in the Report Inspector, find the Format property and choose an item from the value drop-down list. You can also customize the format by yourself. For example, if you want to display it as "This is page n of m pages", you can type the format string "This is page @PageNumber of @TotalPageNumber pages" in the Format value box.
- Global Page N of M
Prints a specific global page number out of the global total page number of the report. You can specify the format of this special field in the Report Inspector. The operation is the same as Page N of M.
- SQL Statement
Prints the SQL statements used to execute the query. This is often useful for resolving performance issues as you can see exactly what is passed to the database after Logi Report applies all the parameter substitutions and filters.
- Query Filter
Prints in the report result the condition of the query filters applied to the parent data container of the special field.
Prints in the report result the filter conditions applied to the parent data container of the special field, which are created using the Filter dialog box and via the Filter option on a field’s shortcut menu.
- On-screen Filter
Prints in the report result the on-screen filter conditions applied to the parent data container of the special field, which are created using filter controls and via the Filter panel in Web Report Studio.
- Go To Filter
Prints in the report result the filter conditions applied to the parent data container of the special field, which are generated via the drill-down and drill-to-by-value actions.
Special fields which get values from the system.
- User Name
Prints the User ID. When viewing the report in Designer, it is the name specified for the User Name option in the General category of the Options dialog box (to open the dialog box, select File > Options); at runtime, it is the user name used to log onto Server.
Besides using as a component in report directly, you can also use the "User Name" special field in the following cases:
- The PARAMETER string of general hierarchical data sources
- The PARAMETER string of user-defined data sources
- Parameters of stored procedures
- Imported SQL statements
- Aggregation pipeline expressions (APE) in MongoDB connections
- JSON connections
- Elasticsearch connections
- Filter conditions of query filter, business view filter, and dataset filter
- Security conditions of Record Level Security (RLS) at data source scope
You should use it as username in stored procedures and formulas, and as @username in HDS, UDS, Imported SQL, APE, JSON, filter conditions, and RLS security conditions.
- Task ID
Prints the internal task ID (a unique time stamp). This special field only works in the Server environment. It returns a "NULL" value when running in Designer.
- Report Path on Server
Prints the full path of the report in the resource tree of Server. If the report is not running on Server, it returns the full disk path of the report. It returns a "NULL" value if the report is unsaved.
- Report Path on Disk
Prints the full disk path of the report. It returns a "NULL" value if the report is unsaved.
- Catalog Path on Server
Prints the full path of the report's catalog in the resource tree of Server. If the report is not running on Server, it returns the full disk path of the catalog. It returns a "NULL" value if the report is unsaved.
- Catalog Path on Disk
Prints the full disk path of the report's catalog. It returns a "NULL" value if the report is unsaved.
You can insert all special fields into web reports and library components in Designer. However, due to the characteristics of Web Report Studio and JDashboard, they can only render these at runtime: Modified Date, Modified Time, Print Date, Print Time, Fetch Date, Fetch Time, Record Number, Total Records, Group Number, Total Group Number, User Name, Report Path on Server, Report Path on Disk, Catalog Path on Server, Catalog Path on Disk, Query Filter, Filter, On-screen Filter, and Go To Filter.
You can insert special fields in the report areas listed in Component Placement.
To insert a special field into a report:
- Position the mouse pointer at the destination where you want to insert the special field.
- Select Insert > Special Fields or Home > Insert > Special Fields, and then select the required field from the drop-down menu.
You can add conditional formats to special fields in a report, then when a specified condition is fulfilled, Logi Report automatically applies the format defined on the condition to the field values. This is very useful to highlight values that the report users may need to act on at runtime.
You can only apply conditional format to the two special fields: Page Number and User Name.
To add conditional format to the special field Page Number/User Name, right-click it and select Conditional Formatting from the shortcut menu, then take the same procedure as described in Adding Conditional Formats to DBFields.