(Updated via BpDeleteTranslateTags script) |
|||
Line 1: | Line 1: | ||
− | + | = 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 == |
The top level "BPcsvReport" element contains optional "parameters" and "queryString" sub-elements. | The top level "BPcsvReport" element contains optional "parameters" and "queryString" sub-elements. | ||
− | |||
"queryString" is a common SQL statement, and it can contain some parameters. | "queryString" is a common SQL statement, and it can contain some parameters. | ||
Line 13: | Line 12: | ||
[[Reporting-database-specification/GeneralInformationAboutDetailedRecords|General Information About Detailed Records]] | [[Reporting-database-specification/GeneralInformationAboutDetailedRecords|General Information About Detailed Records]] | ||
− | === Parameter Types === | + | === Parameter Types === |
The following is the full set of supported parameters: | The following is the full set of supported parameters: | ||
* '''"agent"''' – agent selector | * '''"agent"''' – agent selector | ||
Line 28: | Line 27: | ||
** '''"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"> | ||
Line 51: | Line 50: | ||
</BPcsvReport> | </BPcsvReport> | ||
− | == Examples == | + | == 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>. | ||
− | === "agentlist" Usage Sample === | + | === "agentlist" Usage Sample === |
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"> | ||
Line 79: | Line 78: | ||
</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"> | ||
Line 106: | Line 105: | ||
]]> | ]]> | ||
</queryString> | </queryString> | ||
− | </BPcsvReport | + | </BPcsvReport> |
− | |||
− | |||
− | |||
− | |||
− |
Revision as of 04:01, 29 May 2024
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.
Links
Reporting DB structure for Statistical Data.
General Information About Detailed Records
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>