Reporting Dashboard - Writing a Report

Reporting Dashboard - Writing A Report

The basic XML-style syntax of a report is presented below:

Example

The elements of the report are described below:

ReportTitle: The Main Report Title. This is displayed at the top of the report and may include HTML markup*.

ReportHeader: The Report Header. This is displayed under the Report Title and just before the report output and may include HTML markup*.

ReportFooter: The Report Footer. This is displayed under the report output and may include HTML markup*.

Parameters: Defines a list of optional parameters that are available to the operator when running the report.

Queue: Defines whether the the Queue list is available to the operator. The value of this parameter must be set to either true or false.**

SkillGroup: Defines whether the Skill Group list is available to the operator. The value of this parameter must be set to either true or false.**

User: Defines whether the User list is available to the operator. The value of this parameter must be set to either true or false.**

CallType: Defines whether the Received By list is available to the operator. The value of this parameter must be set to either true or false.**

ReceivedBy: Defines whether the Received By list is available to the operator. The value of this parameter must be set to either true or false.**

Status: Defines whether the Status list is available to the operator. The value of this parameter must be set to either true or false.**

Priority: Defines whether the Priority list is available to the operator. The value of this parameter must be set to either true or false.**

Key1: Defines whether the Key 1 list is available to the operator. The value of this parameter must be set to either true or false.**

Key2: Defines whether the Key 2 list is available to the operator. The value of this parameter must be set to either true or false.**

Key3: Defines whether the Key 3 list is available to the operator. The value of this parameter must be set to either true or false.**

Title: Defines the title of the report. This is displayed directly above the report output defined by the element Query. The Title may include HTML markup.*

Totals: Defines whether the report will support column totals. The value of this parameter must be set to either true or false.**

Query: Defines the SQL syntax of the report.

Columns: Optionally defines the visibility, headings and totals on each of the output columns.

* Because the report is based on an XML document, you must make sure that the HTML is valid XML. Alternatively, you can enclose your text within a CDATA section:

Example

<ReportTitle>My Report<br>My Company</ReportTitle> This is invalid <ReportTitle>My Report<br />My Company</ReportTitle> This is valid <ReportTitle><![CDATA[My Report<br/>My Company]]</ReportTitle> This is valid

** If a value is not set, the system will apply the default value of false.

Example: This example shows how to construct a report showing the Current Calls for the Help Desk Queue.

Example

<Reporting> <ReportTitle>Current Calls For Help Desk Queue</ReportTitle> <ReportHeader></ReportHeader> <ReportFooter></ReportFooter> <Parameters> <Queue></Queue> <SkillGroup></SkillGroup> <User></User> <CallType></CallType> <ReceivedBy></ReceivedBy> <Status></Status> <Priority></Priority> <Key1></Key1> <Key2></Key2> <Key3></Key3> </Parameters> <Report> <Title>Current Calls</Title> <Totals></Totals> <Query>SELECT CallID, Subject FROM tbl_Calls WHERE QueueID = 1 AND CallStatusID IN (1, 2, 4, 7)</Query> <Columns></Columns> </Report> </Reporting>

Reporting Dashboard - Writing A Report

See Also