Execution Summary Record object

The Execution Summary Record object enables the retrieval of run information for processes that use the Low Latency option.

You can use this information to populate the Real-time Dashboard in the user interface. Each object represents a block of time and contains summary information for runs occurring during that time block.

Structure

<ExecutionSummaryRecord elapsedVarSum="" maxElapsedTime="" executionCount="" returnDocSize="" 
returnDocCount="" outboundDocSize="" outboundDocCount="" inboundDocSize="" outboundDocSize="" 
launchElapsedTime="" elapsedTime="" processName="" atomName="" status="" atomID="" 
timeBlock="" processId="" accountId="" reportKey="" launcherId""/>

Field	Type	Description
elapsedVarSum	float	A composite value enabling computation of the standard deviation of elapsed run time for the processes that occurred using the parallel algorithm.
maxElapsedTime	int	The time, in milliseconds, it took for the most time-consuming run that occurred.
executionCount	int	The number of runs that occurred.
returnDocSize	long	The aggregate size, in bytes, of resulting documents for the runs that occurred.
returnDocCount	int	The aggregate number of resulting documents for the runs that occurred.
outboundDocSize	long	The aggregate size, in bytes, of the processed outbound documents for the runs that occurred.
outboundDocCount	int	The aggregate number of processed outbound documents for the runs that occurred.
inboundDocSize	long	The aggregate size, in bytes, of the processed inbound documents for the runs that occurred.
inboundDocCount	int	The aggregate number of processed inbound documents for the runs that occurred.
launchElapsedTime	long	The aggregate elapsed wait time, in milliseconds, before the start of processing for the runs that occurred.
launcherId	string	The API Service component that kicks off the run. Note: The Runtime must have the API Type set to Advanced on the Shared Web Server tab of Runtime Management to specify launcherId.
elapsedTime	long	The aggregate elapsed processing time, in milliseconds, of the runs that occurred.
processName	string	The name of the process that was run.
atomName	string	The name of the Atom on which the runs occurred.
status	string	The status of the runs. Allowed values include COMPLETE, COMPLETE_WARN, ERROR.
atomId	string	The component ID of the Atom on which the processes ran.
timeBlock	dateTime yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2013-01-31T15:32:00Z	The start time of the represented time block.
processId	string	The component ID of the processes that ran.
accountId	string	The account under which the processes ran.
reportKey	string	The web service user that authenticated to make the run request. Note: For Runtimes with an Authentication Type of External Provider, the reportKey is the API Key. Otherwise, it is the specified user name.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not supported	Supported	Not supported	Not supported	Not supported	Not supported

You can use the following fields as QUERY filters for the Execution Summary Record object:

Field	Allowed values
status	COMPLETE, COMPLETE_WARN, ERROR.
atomId	Any string value (valid Runtime ID).
timeBlock	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2016-01-31T15:32:00Z. To specify a time block, use the BETWEEN operator with two arguments, one representing the start time and the other representing the end time. Boomi recommends setting a time block in all queries, particularly for heavy users of Low Latency processes. Use this to prevent the return of huge amounts of data.
processId	Any string value. Specifying a value that is not a valid process ID will not return a beneficial result.
reportKey	Any string value. Specifying a value that is not a valid API Key will not return a beneficial result.
launcherId	Any string value. Specifying a value that is not a valid API Service component will not return a beneficial result.

The operators allowed for the Execution Summary Record object filters are:

• BETWEEN

• EQUALS

• GREATER_THAN

• GREATER_THAN_OR_EQUAL

• LESS_THAN

• LESS_THAN_OR_EQUAL

• LIKE

For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.

SOAP implementation

The following example query returns all run summary records with a processId of 789abcde-f012-3456-789a-bcdef0123456 for runs occurring during the time block starting May 1, 2016 and ending August 31, 2016.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:query>
         <api:objectType>ExecutionSummaryRecord</api:objectType>
         <api:queryConfig>
             <api:QueryFilter>
                <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression"> 
                    <api:nestedExpression operator="EQUALS" property="processId"
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                       <api:argument>789abcde-f012-3456-789a-bcdef0123456</api:argument>
                    </api:nestedExpression>
                    <api:nestedExpression operator="BETWEEN" property="timeBlock"  
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                        <api:argument>2016-05-01T00:00:00Z</api:argument>
                        <api:argument>2016-08-31T23:59:59Z</api:argument>
                    </api:nestedExpression>
                </api:expression>
             </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="100">
            <bns:queryToken>EXAMPLE_QUERY_TOKEN</bns:queryToken>
               <bns:result xsi:type="bns:ExecutionSummaryRecord" elapsedVarSum="0.0"
                   maxElapsedTime="32460" executionCount="1" returnDocSize="222"
                   returnDocCount="1" outboundDocSize="0" outboundDocCount="0"
                   inboundDocSize="222" inboundDocCount="1" launchElapsedTime="30216"
                   elapsedTime="32460" processName="Initial Load Accounts" atomName="Desktop Atom"
                   status="COMPLETE" atomID="3456789a-bcde-f0123-4567-89abcdef012"
                   timeBlock="2016-05-14T15:57:00Z" processID="789abcde-f012-3456-789a-bcdef0123456"
                   accountID="account-123456" reportKey="userXYZ"/>
               ...
               <bns:result xsi:type="bns:ExecutionSummaryRecord" elapsedVarSum="4.5"
                   maxElapsedTime="60286" executionCount="2" returnDocSize="0"
                   returnDocCount="0" outboundDocSize="0" outboundDocCount="0"
                   inboundDocSize="368" inboundDocCount="2" launchElapsedTime="98"
                   elapsedTime="120569" processName="Initial Load Accounts" atomName="Desktop Atom"
                   status="COMPLETE" atomID="3456789a-bcde-f0123-4567-89abcdef012"
                   timeBlock="2016-08-28T19:00:00Z" processID="789abcde-f012-3456-789a-bcdef0123456"
                   accountID="account-123456" reportKey="userXYZ"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.