<!doctype html>
<html>
<head>
<title>Message Breakdown</title>
<link rel="stylesheet" href="styles/site.css" type="text/css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="styles/icons.css" type="text/css">
<script src="js/jquery.min.js"></script>
<script src="tree/collapsibleTreeMenu.js"></script>
<link href="tree/collapsibleTreeMenu.css" rel="stylesheet" type="text/css">
</head>
<body class="theme-default aui-theme-default">
<div id="page">
<div id="main" class="aui-page-panel">
<div id="main-header">
<div id="breadcrumb-section">
<ol id="breadcrumbs">
<li> <span><a href="Rhapsody-Integration-Engine-6.5_133160975.html">Rhapsody Integration Engine 6.5</a></span> </li>
<li> <span><a href="Monitoring-Rhapsody_133163664.html">Monitoring Rhapsody</a></span> </li>
<li> <span><a href="Management-Console_133163667.html">Management Console</a></span> </li>
<li> <span><a href="Reports_133163866.html">Reports</a></span> </li>
</ol>
</div>
<h1 id="title-heading" class="pagetitle"> <span id="title-text">Message Breakdown</span> </h1>
</div>
<div id="content" class="view">
<div id="main-content" class="wiki-content group">
<div class="table-wrap">
<table id="TBL1565043148572" class="confluenceTable" bordercolor="#ffcc66" bgcolor="#ffffcc">
<tbody>
<tr>
<td class="confluenceTd"><p><em>Menu Path</em> : <strong>Reports>Message Breakdown</strong></p></td>
</tr>
<tr>
<td class="confluenceTd"><p><em>Read <a href="Access-Rights_133161013.html">Access Rights</a>:</em></p>
<ul>
<li>Log in to Management Console</li>
<li>Generate message breakdown report</li>
</ul></td>
</tr>
<tr>
<td class="confluenceTd"><p><em>Write <em><a href="Access-Rights_133161013.html">Access Rights</a></em></em>:</p>
<ul>
<li>Export message breakdown statistics</li>
<li>View locker</li>
</ul></td>
</tr>
</tbody>
<script type="text/javascript">
$("table[id='TBL1565043148572']").data("appfire-table","true");
(new org_swift_TableSorter()).customTable('TBL1565043148572',[],'',
1,'lightgoldenrodyellow',false,
'Click to sort','',false,
false,false,true,
0,false,'',true,
'',false,false,'','','','',
true,'',
''
);
</script>
</table>
</div>
<p>A Message Breakdown report is a combined chart and table showing the number of processed messages, within lockers where the user has the 'View Locker' right, of each type or containing a specified property.</p>
<h2 id="MessageBreakdown-GeneratingorExportingReports">Generating or Exporting Reports</h2>
<p>To generate a Message Breakdown report or export the data as a <code>.csv</code> file:</p>
<ol>
<li><p>Navigate to <strong>Reports>Message Breakdown</strong>:</p><p><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-content-image-border" src="attachments/133163870/133163871.png" data-image-src="attachments/133163870/133163871.png" data-unresolved-comment-count="0" data-linked-resource-id="133163871" data-linked-resource-version="1" data-linked-resource-type="attachment" data-linked-resource-default-alias="generate message breakdown report.png" data-base-url="https://docs.rhapsody.health" data-linked-resource-content-type="image/png" data-linked-resource-container-id="133163870" data-linked-resource-container-version="1"></span> </p></li>
<li><p>Enter the following details:</p>
<div class="table-wrap">
<table class="confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>Field</p></th>
<th class="confluenceTh"><p>Description</p></th>
</tr>
<tr>
<td class="confluenceTd"><p>From</p></td>
<td class="confluenceTd"><p>Enter the start date and time for your generated report (set to 24 hours before the current time by default).</p></td>
</tr>
<tr>
<td class="confluenceTd"><p>To</p></td>
<td class="confluenceTd"><p>Enter the end date and time for your generated report.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Time Zone</p></td>
<td class="confluenceTd"><p>If you want to export the data using UTC (Coordinated Universal Time) as the time zone, select the <strong>Export times using UTC</strong> checkbox.</p>
<div class="confluence-information-macro confluence-information-macro-warning">
<span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>If this option is <em>not</em> selected, the data is exported using the local time of the Rhapsody engine, which could potentially result in lost or duplicated data if a daylight saving changeover occurs during the period the statistics were collected.</p>
</div>
</div></td>
</tr>
<tr>
<td class="confluenceTd"><p>Report On</p></td>
<td class="confluenceTd"><p>Select whether you want the report to be based on <strong>Incoming Messages</strong> or <strong>Outgoing Messages</strong> by toggling the radio buttons (set to <strong>Incoming Messages</strong> by default).</p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Input</p></td>
<td class="confluenceTd"><p>Allows you to select input components receiving messages from an external source and add them by clicking the <strong>Add Component</strong> button.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Output</p></td>
<td class="confluenceTd"><p>Allows you to select output components from which messages exit Rhapsody and add them by clicking the <strong>Add Component</strong> button.</p>
<div class="confluence-information-macro confluence-information-macro-note">
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p><strong>Output</strong> is disabled if <strong>Incoming Messages</strong> is selected.</p>
</div>
</div></td>
</tr>
<tr>
<td class="confluenceTd"><p>Using Property</p></td>
<td class="confluenceTd"><p>The indexed property value used to include or exclude messages from the report. This option is used for large groups of messages where that property has a discrete set of values, for example, the message type or source system. Options provided in a drop-down list could include: <br class="atl-forced-newline"> <strong>rhapsody:InputMessageType</strong> - the input message type (for example, whether it is an HL7 ADT or ORU message). <br class="atl-forced-newline"> <strong>rhapsody:OutputMessageType</strong> - the output message type (for example, whether it is a message or an acknowledgment to a message). <br class="atl-forced-newline"> <strong>rhapsody:MessageControlId</strong> - a unique value used for matching the message to its acknowledgment. This option is only available if you have message tracking.</p>
<div class="confluence-information-macro confluence-information-macro-note">
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>This list can be disabled if no indexed properties are available (in other words, if the Engine has not processed any messages).</p>
</div>
</div></td>
</tr>
</tbody>
</table>
</div></li>
<li><p>Choose one of the following options:</p>
<div class="table-wrap">
<table class="confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>If you want to...</p></th>
<th class="confluenceTh"><p>Then...</p></th>
</tr>
<tr>
<td class="confluenceTd"><p>Generate an on-screen display of the collected statistics</p></td>
<td class="confluenceTd"><p>Click the <strong>Generate Report</strong> button.</p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Export the statistics</p></td>
<td class="confluenceTd"><p>Click the <strong>Export Raw CSV Data</strong> button to export the data as a zipped <code>.csv</code> file.</p>
<div class="confluence-information-macro confluence-information-macro-note">
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>To view the <strong>Export Raw CSV Data</strong> link you must have permission to export message breakdown statistics.</p>
</div>
</div></td>
</tr>
</tbody>
</table>
</div>
<div class="confluence-information-macro confluence-information-macro-information">
<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>When the user clicks the <strong>Generate Report</strong> button, a "Generating Report" message (with a throbber icon) appears indicating the report is being generated. A progress message indicating the percentage of completion is also displayed if the generation is expected to take more than a reasonable amount of time. The user can click the <strong>Cancel</strong> link to stop the report generation.</p>
</div>
</div>
<div class="confluence-information-macro confluence-information-macro-information">
<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>You can navigate to another page without interrupting the report generation process. User-selected values in the fields are preserved.</p>
</div>
</div></li>
<li>When you have finished, click the <strong>Discard Report</strong> link to clear the Message Breakdown report.</li>
</ol>
<h2 id="MessageBreakdown-MessageBreakdown">Message Breakdown</h2>
<p>The generated report is displayed in the following format:</p>
<p><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image" src="attachments/133163870/133163872.png" data-image-src="attachments/133163870/133163872.png" data-unresolved-comment-count="0" data-linked-resource-id="133163872" data-linked-resource-version="1" data-linked-resource-type="attachment" data-linked-resource-default-alias="messbreakrepxx.png" data-base-url="https://docs.rhapsody.health" data-linked-resource-content-type="image/png" data-linked-resource-container-id="133163870" data-linked-resource-container-version="1"></span></p>
<div class="confluence-information-macro confluence-information-macro-information">
<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>The message breakdown report has multiple columns. The limit of the number of columns to be generated can be set via the <code>rhapsody.properties</code> file's <code>ReportingService.maximumUniqueValuesForMessageBreakdown</code> property. The allowable range of values for this property is limited to a minimum value of <code>50</code> (also the default value) and a maximum of <code>600</code>.</p>
<p>Users can access the entire set of data by exporting the raw <code>.csv</code> file to which no such limit applies.</p>
</div>
</div>
<h3 id="MessageBreakdown-TimePeriod">Time Period</h3>
<p>The <strong>Time Period</strong> table lists the total message count and breakdowns in divisions of the period covered by the report. Click a date/time range division to regenerate the chart and table for the reduced period. Additional columns are based on the search criteria and the selected property in the <strong>Using Property</strong> field.</p>
<div class="confluence-information-macro confluence-information-macro-note">
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p><span>The Message Breakdown report truncates any</span> message property value to 30 characters if it is greater than 30 characters <span>in length</span>.</p>
</div>
</div>
<p>Table data can be exported to a <code>.csv</code> file by clicking the <strong>Export as CSV</strong> link.</p>
<h3 id="MessageBreakdown-CommunicationPoint">Communication Point</h3>
<p>The <strong>Communication Point</strong> table lists the total message count and breakdowns in divisions of the period covered by the report for each of the communication points through which the messages included in the report have passed. Click the name of the communication point to display its <strong>Details</strong> page. Refer to <a href="Communication-Point-Details_133163702.html">Communication Point Details</a>.</p>
<div class="confluence-information-macro confluence-information-macro-note">
<span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>The communication point name link requires the 'View Locker' access right on the appropriate locker.</p>
</div>
</div>
<p>Additional columns are displayed based on the search criteria.</p>
<p>Table data can be exported to a <code>.csv</code> file by clicking the <strong>Export as CSV</strong> link.</p>
<h3 id="MessageBreakdown-ErrorHandling">Error Handling</h3>
<div class="table-wrap">
<table class="confluenceTable">
<tbody>
<tr>
<th class="confluenceTh"><p>Error Type</p></th>
<th class="confluenceTh"><p>Error Message</p></th>
</tr>
<tr>
<td class="confluenceTd"><p>No date and time values entered in the <strong>From</strong> field.</p></td>
<td class="confluenceTd"><p><code>From time is a required field.</code></p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Either date or time value not entered in the <strong>From</strong> field.</p></td>
<td class="confluenceTd"><p><code>From time is invalid.</code></p>
<div class="confluence-information-macro confluence-information-macro-information">
<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>If characters not recognized as date or time values are entered, the date or time input turns red.</p>
</div>
</div></td>
</tr>
<tr>
<td class="confluenceTd"><p>No date and time values entered in the <strong>To</strong> field.</p></td>
<td class="confluenceTd"><p><code>To time is a required field.</code></p></td>
</tr>
<tr>
<td class="confluenceTd"><p>Either date or time value not entered in the <strong>To</strong> field.</p></td>
<td class="confluenceTd"><p><code>To time is invalid.</code></p>
<div class="confluence-information-macro confluence-information-macro-information">
<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
<div class="confluence-information-macro-body">
<p>If characters not recognized as date or time values are entered, the date or time input turns red.</p>
</div>
</div></td>
</tr>
<tr>
<td class="confluenceTd"><p>Value in the <strong>To</strong> field older than the value in the <strong>From</strong> field</p></td>
<td class="confluenceTd"><p><code>From time must not be after To time.</code></p></td>
</tr>
<tr>
<td class="confluenceTd"><p>No value available for <strong>Using Property</strong> field.</p></td>
<td class="confluenceTd"><p><code>Using property is a required field.</code></p></td>
</tr>
</tbody>
</table>
</div>
<p> </p>
</div>
</div>
</div>
</div>
</body>
</html>