User Manual

Operating Refere
nce
Reports
3
A6V10415471_en_a_40 261 | 352
Keyword Group Box
Keywords are pre-defined templates that can be added anywhere in a Report
Definition. They are replaced with actual data in Run mode and when the report
document (PDF, XLS) is created.
There are two types of keywords:
● Content-specific, which can be inserted only above tables/plots. For example,
content-specific keywords, such as Content Type, Name filter or Record Count,
cannot be inserted in the header/footer section of a Report Definition.
● Generic, which can be inserted anywhere including the header and footer of
the Report Definition
For example, you can add the Date keyword in the Report Definition header to
display the date on which the report is executed.
A default report template may contain generic and content-specific keywords.
Creating a new Report Definition displays generic keywords, but not the content-
specific keywords. The applicable content-specific keywords are automatically
inserted above an inserted table and/or plot; however certain keywords are not
applicable for certain types of tables/plots. For example, if the default template
contains the content-specific keyword Time Range and you insert the Active
Events table in the Report Definition, the Time Range keyword will not be inserted
above the Active Events table in the Report Definition as the Time filter is not
applicable for the Active Events table.
The following keywords are supported by Reports:
Content-specific Keyword List
Content-specific
Keyword
Description
CONTENT TYPE Displays the name of the content provider – Alarm, Log, Reference, Objects, and
Graphics.
NAME FILTER Displays the Name filters set for the content provider.
CONDITION
FILTER
Displays the Condition filter expression set for a table. In case of Plot content, this
keyword remains empty.
TIME RANGE Displays the Time filter set for the content provider.
CONTENT
START
Displays the Date and Time when execution started for the content provider.
CONTENT STOP Displays the Date and Time when execution completed or stopped for the content
provider.
CONTENT
DURATION
Displays the time difference between Content Start and Content Stop.
CONTENT STATE Succeeded – Displays if content provider’s execution succeeds.
Cancelled – Displays if content provider’s execution stops or fails.
CONTENT
ERRORSTATE
Provides additional information about Content execution. It is independent of the
Content state. The following states are possible:
OK - Succeeded
Errors - Errors occurred
Failures - Severe errors occurred
CONTENT
ERRORSTATE
MESSAGE
Displays the error description of Content ErrorState.
CONTENT
ACTIVITY
Displays the detailed information about the Content creation activity.
CONTENT
PROGRESS
Displays the Content execution progress from 0% to 100%.
RECORD COUNT Displays the number of records in the table.
SYSTEM NAME Displays the name of the system on which the current report is present.