Report Elements

The reports in IT-Conductor use the IT-Conductor XML markup identified by "itc" namespace prefix. At this time, the XML is not validated against the IT-Conductor schema.

Global Variables

"variables ${self/....}, ${report/...}" are supported in any report element

Qualifiers

  • self - report object like ${self/OBJECT_Name}

  • report - report specific Variables

Section

Dynamic Sections behave the same way as "<query>", producing a list of objects based on select criteria:

<itc:section  
    <itc:parameter name="OBJECT_ClassName">class-name</itc:parameter>  
    <itc:select name="attr-name" [oper="Operator"]>value</itc:select>    
        ...  
    <itc:select ... > ...
    <itc:parameter name="maintenance">true|false</itc:parameter> - Optional, allows for selection of objects based on the effective Maintenance Mode
    <itc:parameter name="linkClassName">Link Target Class</itc:parameter>                - Optional, if the intent is to return a list of linked objects,
                                                                                         this is the class of the link objects
     <itc:parameter name="linkAttrName">Link target object attribute name</itc:parameter> - Optional, if the intent is to return a list of linked objects
                                                                                         and the selection targets Links, this attribute contains 
                                                                                         the target object id in the link, normally LINK_LinkedObjectId or LINK_ObjectId
                                                                                         the opposite of what is used in the select criteria
     ...
 </itc:section>

Where content can be any other construct including another.

The essence of sections is that for each object found in the query, the content will be replicated, and if "${context/...}" variables are used in any of the parameters they will be resolved with the query result Object attribute.

Nested "<section>" push the context into a FIFO stack so all children will have the new object instance set as a context.

Assuming the section query finds 3 objects, it will create the following construct:

Variable

Sets report variable:

The variables can be accessed anywhere in the report elements as ${report/var-name}

The variable must be decalred in the report xml before it is used - IT-Conductor processes xml sequentially.

If

Conditional block:

The optional mode parameter (defaults to "context") - determines what the condition criteria (selects) are applied to:

  • context - the current context object (report external context or section-derived context)

  • variables - report variables (assigned with <itc:variable>)

If the criteria (all "<itc:select>" elements) evaluates to true the content of the if is included and evaluated according to report-type supported elements, otherwise it is skipped.

Icon

Insert Icon:

For available icon names, please refer to: https://service.itconductor.com/iconList

Path

Displays service element path:

Note: For PDF reports this is the only itc:... construct currently supported inside heading markup <h..></h..>

Object & Context Selectors

In all constructs we now support dynamic object and context selectors in addition to parameters "OBJECT_Id" & "context":

See detail in "Where".

Chart

Reports Chart:

Where Category ID is either category Object Id (for multi-line graphs) or "Alarm", "Warning", "Severity", "itconductor.Annotations", "itconductor.Summary".

Threshold

Locates & reports a threshold, based on the target Object ID and value Attribute Name.

Note: Only Regular thresholds are supported. Collection thresholds should be accessed using "<chart>" construct.

Parameters "THRESHOLD_ObjectId" and "THRESHOLD_AttributeName" allow for the selection of the relevant threshold (search is performed).

If parameter "OBJECT_Id" is specified, it overrides the above and the construct behaves fully as "<chart>".

Parameters scale, unit, and format are threshold specific and allow to override of how the value is charted.

Otherwise "<threshold>" behaves exactly like "<chart>".

Alerts

Report alerts for the selected criteria**:**

Service Query

Query on a service tree (applies the search criteria to each element in the sub-tree):

Query

Free-form object query:

Object Details

Display all visible object attributes as a vertical table with "Name:Value" rows:

Counter

Object counter based on query returns the number of objects in the query result:

Saved Search

Audit Log

Report audit log events:

Subscriptions

Creates a table displaying the email addresses of tenant subscriptions:

Attribute Text

Display object attribute text based on the attribute Display format. For the HTML report, it is wrapped with "<p>value</p>". For PDF, a paragraph is created with the value:

Note: Avoid HTML content. It can not be converted to PDF

Where

Object Selector:

Context Selector:

Operator: EQ|NE|GT|GE|LT|LE|MATCH|NOT_MATCH|IN|NOT_IN|NULL|NOT_NULL default: EQ

Time Scale: MIN|5MIN|QUARTER_HOUR|HALF_HOUR|HOUR|DAY|WEEK|MONTH|QUARTER|YEAR

Range:

  • YTD - year to date

  • QTD - quarter to date

  • MTD - month to date

  • WTD - week to date

  • DTD - day to date

  • M# - last # full month (M12 - last 12 month)

  • D# - last # full days (D1 - yesterday, D7 - last 7 days)

  • H# - last # full hours

  • TY - This Year

  • TQ - This Quarter

  • TM - This Month

  • TW - This Week

  • TD - Today

  • LY - Last year

  • LM - Last Month

  • LW - Last week

  • LD - Yesterday

  • MH1 - First half (1-15) of the prior or current month (if current month day is after 15)

  • MH1P - First half (1-15) of the prior month (even if the current month day is after 15)

  • MH2 - Second half (16-30/31) of the prior month

Time:

  • User's locale/timezone-specific time format: US: dd/MM/yyyy hh:mm:ss a

(Please refer here for more details.)

  • now - current time/date snapped to TimeScale interval

  • before - time/date snapped to previous from now TimeScale interval

  • after - time/date snapped to next from now TimeScale interval

Parameter Width and Height

For HTML reports Chart/Threshold parameters width and height now accept UOM: 100%, 5em, 10ex, 100px, etc. If no UOM is provided and only the number is supplied the PX is assumed.

Output Type CSV

Reports now support CSV output. In this mode:

  • All graphical constructs are ignored.

  • Charts/Thresholds are displayed as tables regardless of the table parameter value.

  • Headers (h1/h2/...) are rendered as a line of text.

  • Other HTML (non itc:) markup is exploded but not rendered (if you specify "<p><itc:chart>....</p>", the "<itc:chart>" will be rendered without any formatting associated with "<p>").

Examples

The following example will produce a report that includes Availability (Table and Chart) for each SAP System with a Development application role.

This work is in both PDF and HTML mode ("<pbr />" is a page break and only rendered in PDF).

PreviousAutomated HANA ReportsNextArchived Alerts Reporting

Last updated