From Bright Pattern Documentation
m |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
<translate>= BPXML Syntax and Samples= | <translate>= BPXML Syntax and Samples= | ||
You can create a custom BPXML report template and use it to export CSV data. This section explains the syntax and structure of BPXML report templates. | You can create a custom BPXML report template and use it to export CSV data. This section explains the syntax and structure of BPXML report templates. | ||
| − | |||
== Syntax == | == Syntax == | ||
| Line 22: | Line 21: | ||
** '''"end"''' (only one pair per report) – start and end dates selector | ** '''"end"''' (only one pair per report) – start and end dates selector | ||
** '''"string"''' - an arbitrary string value | ** '''"string"''' - an arbitrary string value | ||
| − | |||
== Sample BPXML Report == | == Sample BPXML Report == | ||
| − | + | <?xml version="1.0" encoding="UTF-8"?> | |
| − | <?xml version="1.0" encoding="UTF-8"? | + | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports"> |
| − | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports" | + | <parameters> |
| − | + | <parameter name="start_time" type="timeframe" subtype="start"/> | |
| − | + | <parameter name="end_time" type="timeframe" subtype="end"/> | |
| − | + | <parameter name="login_id" type="agent" /> | |
| − | + | </parameters> | |
| − | + | <queryString> | |
| − | + | <![CDATA[ | |
| − | + | SELECT | |
| − | + | start_time, | |
| − | + | first_name, | |
| − | + | last_name, | |
| − | + | num_calls_in, | |
| − | + | num_calls_answered, | |
| − | + | team_name | |
| − | + | FROM agent_performance | |
| − | + | WHERE start_time > $P{start_time} AND login_id=$P{login_id} | |
| − | + | ]]> | |
| − | ]] | + | </queryString> |
| − | </queryString | + | </BPcsvReport> |
| − | </BPcsvReport | ||
| − | |||
| − | + | == Examples == | |
| − | == | ||
The following are examples of various types of BPXML reports. Values that differ from the Sample BPXML Report given above are shown in <font color="ff33cc">pink</font color>. | The following are examples of various types of BPXML reports. Values that differ from the Sample BPXML Report given above are shown in <font color="ff33cc">pink</font color>. | ||
| Line 56: | Line 51: | ||
In this sample, parameter ''agentlist'' is being used to add agent data to the Agent Performance report. | In this sample, parameter ''agentlist'' is being used to add agent data to the Agent Performance report. | ||
| − | + | <?xml version="1.0" encoding="UTF-8"?> | |
| − | <?xml version="1.0" encoding="UTF-8"? | + | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports"> |
| − | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports" | + | <parameters> |
| − | + | <parameter name="start_time" type="timeframe" subtype="start"/> | |
| − | + | <parameter name="end_time" type="timeframe" subtype="end"/> | |
| − | + | <parameter name="login_id" type="<font color="ff33cc">agentlist</font color>" /> | |
| − | + | </parameters> | |
| − | + | <queryString> | |
| − | + | <![CDATA[ | |
| − | + | SELECT | |
| − | + | start_time, | |
| − | + | first_name, | |
| − | + | last_name, | |
| − | + | num_calls_in, | |
| − | + | num_calls_answered, | |
| − | + | team_name | |
| − | + | FROM agent_performance | |
| − | + | WHERE start_time > $P{start_time} AND login_id IN ($P{login_id})<br />]]> | |
| − | + | </queryString> | |
| − | </queryString | + | </BPcsvReport> |
| − | </BPcsvReport> | ||
| − | |||
| − | |||
=== "call_detail" Usage Sample === | === "call_detail" Usage Sample === | ||
In this sample, metrics ''hold_time'', ''held'', and ''max_hold'' are being used to add hold time data to the Call Detail report. | In this sample, metrics ''hold_time'', ''held'', and ''max_hold'' are being used to add hold time data to the Call Detail report. | ||
| − | + | <?xml version="1.0" encoding="UTF-8"?> | |
| − | <?xml version="1.0" encoding="UTF-8"?> | + | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports"> |
| − | <BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports" | + | <parameters> |
| − | <parameters | + | <parameter name="start_time" type="timeframe" subtype="start"/> |
| − | <parameter name="start_time" type="timeframe" subtype="start" | + | <parameter name="end_time" type="timeframe" subtype="end"/> |
| − | <parameter name="end_time" type="timeframe" subtype="end" | + | <parameter name="login_id" type="agent" /> |
| − | <parameter name="login_id" type="agent" | + | </parameters> |
| − | </parameters | + | <queryString> |
| − | <queryString | + | <![CDATA[ |
| − | <![CDATA[ | + | SELECT |
| − | SELECT | + | start_time, |
| − | start_time, | + | first_name, |
| − | first_name, | + | last_name, |
| − | last_name, | + | num_calls_in, |
| − | num_calls_in, | + | num_calls_answered, |
| − | num_calls_answered, | + | <font color="ff33cc">hold_time,</font color> |
| − | <font color="ff33cc">hold_time,</font color | + | <font color="ff33cc">held,</font color> |
| − | <font color="ff33cc">held,</font color | + | <font color="ff33cc">max_hold,</font color> |
| − | <font color="ff33cc">max_hold,</font color | + | team_name |
| − | team_name | + | FROM <font color="ff33cc">call_detail</font color> |
| − | FROM <font color="ff33cc">call_detail</font color | + | WHERE start_time > $P{start_time} AND login_id=$P{login_id} |
| − | WHERE start_time > $P{start_time} AND login_id=$P{login_id} | + | ]]> |
| − | ]] | + | </queryString> |
| − | </queryString | + | </BPcsvReport> |
| − | </BPcsvReport> | + | |
| − | |||
</translate> | </translate> | ||
Latest revision as of 17:00, 29 August 2018
Contents
- Introduction
- Configuring Jaspersoft Studio
- Prerequisites
- Downloading Libraries and Localization Resources
- Importing Libraries
- Importing Localization Resources
- Customizing JRXML Report Templates
- Downloading Report Templates
- Importing and Modifying Report Templates
- Previewing and Saving Modified Report Templates
- Uploading Modified Report Templates
- Customizing BPXML Report Templates
- Appendix
Custom Reporting Tutorial
BPXML Syntax and Samples
You can create a custom BPXML report template and use it to export CSV data. This section explains the syntax and structure of BPXML report templates.
Syntax
The top level "BPcsvReport" element contains optional "parameters" and "queryString" sub-elements.
"queryString" is a common SQL statement, and it can contain some parameters.
Parameter Types
The following is the full set of supported parameters:
- "agent" – agent selector
- "agentlist" – agent multiple selector
- "end_time"
- "service" – service selector
- "servicelist" – service multiple selector
- "start_time"
- "team” – team selector
- "teamlist" – team multiple selector
- "timeframe" subtypes:
- "start"
- "end" (only one pair per report) – start and end dates selector
- "string" - an arbitrary string value
Sample BPXML Report
<?xml version="1.0" encoding="UTF-8"?>
<BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports">
<parameters>
<parameter name="start_time" type="timeframe" subtype="start"/>
<parameter name="end_time" type="timeframe" subtype="end"/>
<parameter name="login_id" type="agent" />
</parameters>
<queryString>
<![CDATA[
SELECT
start_time,
first_name,
last_name,
num_calls_in,
num_calls_answered,
team_name
FROM agent_performance
WHERE start_time > $P{start_time} AND login_id=$P{login_id}
]]>
</queryString>
</BPcsvReport>
Examples
The following are examples of various types of BPXML reports. Values that differ from the Sample BPXML Report given above are shown in pink.
"agentlist" Usage Sample
In this sample, parameter agentlist is being used to add agent data to the Agent Performance report.
<?xml version="1.0" encoding="UTF-8"?>
<BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports">
<parameters>
<parameter name="start_time" type="timeframe" subtype="start"/>
<parameter name="end_time" type="timeframe" subtype="end"/>
<parameter name="login_id" type="agentlist" />
</parameters>
<queryString>
<![CDATA[
SELECT
start_time,
first_name,
last_name,
num_calls_in,
num_calls_answered,
team_name
FROM agent_performance
WHERE start_time > $P{start_time} AND login_id IN ($P{login_id})
]]>
</queryString>
</BPcsvReport>
"call_detail" Usage Sample
In this sample, metrics hold_time, held, and max_hold are being used to add hold time data to the Call Detail report.
<?xml version="1.0" encoding="UTF-8"?>
<BPcsvReport version="1.0" resourceBundle="com.brightpattern.reports.oob_reports">
<parameters>
<parameter name="start_time" type="timeframe" subtype="start"/>
<parameter name="end_time" type="timeframe" subtype="end"/>
<parameter name="login_id" type="agent" />
</parameters>
<queryString>
<![CDATA[
SELECT
start_time,
first_name,
last_name,
num_calls_in,
num_calls_answered,
hold_time,
held,
max_hold,
team_name
FROM call_detail
WHERE start_time > $P{start_time} AND login_id=$P{login_id}
]]>
</queryString>
</BPcsvReport>