Consolidation

Consolidation allows you to specify whether or not to consolidate the returned event measures data for each process template specified.

Consolidation is specified as follows:

• NO_CONSOLIDATION - The event measures data for each specified process template is returned in a separate <measure > element.
• CONSOLIDATE - The event measures data for all specified process templates is consolidated in a single <measure > element.
• BOTH - The event measures data for each specified process template is returned in a separate <measure > element, plus it is also consolidated in a single <measure > element.

Note that this capability is most applicable when the request specifies multiple process templates.

Consolidation is specified in the <options > / <consolidation element. For example:

Request:
...
<options>
   <consolidation>BOTH</consolidation>
</options>
...

The following example shows the response from an event measure operation where consolidation is specified as BOTH:

Response:
...
<measure xmlns="">
   <index > 0</index
   <id xmlns:api="http://api.ec.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
      <processTemplateName>CSCallbackProcess</processTemplateName>
   </id>
...
</measure>
<measure xmlns="">
   <index > 1</index
   <id xmlns:api="http://api.ec.n2.tibco.com" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
      <processTemplateName>HelpDeskProcess</processTemplateName>
   </id>
...
</measure>
...
<measure xmlns="">
   <index > -1</index
   <isConsolidatedMeasure>true</isConsolidatedMeasure>
...
</measure>
...

The <measure elements for the individual process templates contain an index, starting at 0, as well as the name of the process template for which the event measure data inside the <measure element applies.

The <measure element that contains the consolidated event measure data always has an index of -1, as well as a <isConsolidatedMeasure element with a value of "true".