TSR for STAR Events

Owned by Natalie Gesin (Deactivated)
Last updated: Oct 22, 2024 by Kinga Huszno
5 min read

Task status responses (TSR) for STAR Events can have a specific structure which is slightly different from common EJM TSRs.

By default they contain only the status and errors with short descriptions:

<EagleML   eaglemlVersion="2-0"   eaglemlType="TaskStatusResponse"   xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd"   xsi:type="TaskStatusResponse"   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"   xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0">  <header>   <messageId>B60JFK71DLESUQLL</messageId>   <sentBy>http://www.eagleinvsys.com/</sentBy>   <creationTimestamp>2016-09-15T11:07:13-05:00</creationTimestamp>  </header>  <statusItem>   <taskIdentifier>    <correlationId correlationIdScheme="correlationIdScheme">TST_20160915_105002845</correlationId>    <businessTaskId correlationIdScheme="businessTaskIdScheme">TST_20160915_105002845</businessTaskId>   </taskIdentifier>   <status>FAILED</status>   <severityCode>1</severityCode>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Schedule TST_Schedule_START_OF_DAY execution status is ERROR</description>   </reason>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Failed to execute panel processor with panel- /eagle/star/global/pan-qmature.htm. 221 Maturity Processing Date (ERR)- Value required</description>   </reason>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Panel processor errors-</description>   </reason>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Maturity Processing Date- Value required</description>   </reason>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Failed to execute panel processor with panel- /eagle/star/global/pan-qmature.htm. 221 Maturity Processing Date (ERR)- Value required</description>   </reason>  </statusItem> </EagleML>

 

However, you can configure them to display additional details - entity details and execution details - for each failed subevent of STAR event.

These details are available since September 2016 EagleML Release (Entity details for subevents) and October 2016 EagleML Release (execution details for subevents).

This enhancement is not supported for AEW STAR Schedules (STAR Schedules with type ‘AEW’ or name starting with ‘EAGLE CC-AEW-‘)

Details for a failed subevent are placed in <taskUnit> nodes. The first <taskUnit> contains the information summary: overall schedule execution status, name of the STAR schedule, schedule run id, common error description, total number of processed entities, number of failures for processed entities (the number of failures can be greater than the total number of entities defined for current schedule, because for one entity more than one STAR messages can be failed).

Example of the first taskUnit with summary details:

<taskUnit>     <status>FAILED</status><!-- whole schedule execution status -->     <severityCode>1</severityCode>     <eventDetails>         <eventName>DK_Test_Schedule</eventName><!-- name of STAR schedule -->         <eagleInstanceId>144749389</eagleInstanceId><!-- schedule run id -->         <reason>             <reasonTypeEnum>ERROR</reasonTypeEnum>             <reasonCode>1</reasonCode>             <description>Schedule DK_Test_Schedule execution status is ERROR</description><!-- common error description -->         </reason>         <eventEntities>             <summary>                 <failedRecords>2</failedRecords><!-- total number of processed entities -->                 <totalRecords>2</totalRecords><!-- number of failures for processed entities -->             </summary>         </eventEntities>     </eventDetails> </taskUnit>

The 2nd, 3rd etc <taskUnit> nodes contain reports for each failed subevent, including information about event execution status, subevent id, event execution error description, processed entity id and the following execution details in the Identifiers section (all details from the Event Detail box in Star Scheduler are reported):

  • Start Time

  • End Time

  • Start Date

  • End Date

  • User Name

  • Report Group

  • Message Type

  • Event Type

  • Entry Profile Name

  • Result Profile Name

  • Entry Profile Panel Name

  • Result Profile Panel Name

  • Schedule Group

  • Report Viewer Group

  • Server IP

  • Process ID

  • Process Address

  • Process Port

<taskUnit>    <status>FAILED</status><!-- event execution status -->    <severityCode>1</severityCode>    <eventDetails>     <eventName>DK_Test_Schedule</eventName>     <eagleInstanceId>1802318</eagleInstanceId><!-- subevent id -->     <reason>      <reasonTypeEnum>ERROR</reasonTypeEnum>      <reasonCode>1</reasonCode>      <description>[Q-POSITION]Failed to execute panel processor with panel: /eagle/star/research/pan-currposoneportallpos.htm. 21 Accounting Basis (ERR): Value required 86 Base Currency (ERR): Value required Panel processor errors: Accounting Basis: Value required Base Currency: Value required      </description><!-- event execution error description -->     </reason>     <eventEntities>      <summary>       <failedRecords>1</failedRecords>       <totalRecords>1</totalRecords>      </summary>      <eventEntity>       <entityId>BT698_E1</entityId><!-- processed entity id -->      </eventEntity>     </eventEntities>     <identifier><!-- execution details -->      <identifierName>Start Time</identifierName>      <identifierValue>2016-09-13 07:38:31</identifierValue>     </identifier>     <identifier>      <identifierName>End Time</identifierName>      <identifierValue>2016-09-13 07:38:31</identifierValue>     </identifier>     <identifier>      <identifierName>User Name</identifierName>      <identifierValue>MCADMIN</identifierValue>     </identifier>     <identifier>      <identifierName>Report Group</identifierName>      <identifierValue>Reports</identifierValue>     </identifier>     <identifier>      <identifierName>Message Type</identifierName>      <identifierValue>Q-POSITION</identifierValue>     </identifier>     <identifier>      <identifierName>Event Type</identifierName>      <identifierValue>STAR Message</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^S^test_bt_T142698(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^R^DEFAULT(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Schedule Group</identifierName>      <identifierValue>BASELINE</identifierValue>     </identifier>     <identifier>      <identifierName>Report Viewer Group</identifierName>      <identifierValue>DEFAULT</identifierValue>     </identifier>     <identifier>      <identifierName>Server IP</identifierName>      <identifierValue>10.70.147.246</identifierValue>     </identifier>     <identifier>      <identifierName>Process ID</identifierName>      <identifierValue>27974</identifierValue>     </identifier>     <identifier>      <identifierName>Process Address</identifierName>      <identifierValue>mmfpoc2-e01.eagleaccess.com</identifierValue>     </identifier>     <identifier>      <identifierName>Process Port</identifierName>      <identifierValue>20030</identifierValue>     </identifier>    </eventDetails> </taskUnit>
<EagleML     eaglemlVersion="2-0"     eaglemlType="TaskStatusResponse"     xsi:schemaLocation="http://www.eagleinvsys.com/2011/EagleML-2-0 eagleml-main-2-0.xsd"     xsi:type="TaskStatusResponse"     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"     xmlns="http://www.eagleinvsys.com/2011/EagleML-2-0">  <header>   <messageId>B60JDE85FGZXCNIK</messageId>   <sentBy>http://www.eagleinvsys.com/</sentBy>   <sendTo>www.client.com</sendTo>   <creationTimestamp>2016-09-13T13:08:55-05:00</creationTimestamp>  </header>  <statusItem>   <taskIdentifier>    <correlationId correlationIdScheme="correlationIdScheme">DK_Test_Schedule_test_1_new_14</correlationId>    <businessTaskId correlationIdScheme="businessTaskIdScheme">DK_Test_Schedule_test_1_new_14</businessTaskId>   </taskIdentifier>   <status>FAILED</status>   <severityCode>1</severityCode>   <reason>    <reasonTypeEnum>ERROR</reasonTypeEnum>    <reasonCode>1</reasonCode>    <description>Schedule DK_Test_Schedule execution status is ERROR</description>   </reason>   <taskUnit>    <status>FAILED</status>    <severityCode>1</severityCode>    <eventDetails>     <eventName>DK_Test_Schedule</eventName>     <eagleInstanceId>147395250</eagleInstanceId>     <reason>      <reasonTypeEnum>ERROR</reasonTypeEnum>      <reasonCode>1</reasonCode>      <description>Schedule DK_Test_Schedule execution status is ERROR</description>     </reason>     <eventEntities>      <summary>       <failedRecords>2</failedRecords>       <totalRecords>2</totalRecords>      </summary>     </eventEntities>    </eventDetails>   </taskUnit>   <taskUnit>    <status>FAILED</status>    <severityCode>1</severityCode>    <eventDetails>     <eventName>DK_Test_Schedule</eventName>     <eagleInstanceId>73102671</eagleInstanceId>     <reason>      <reasonTypeEnum>ERROR</reasonTypeEnum>      <reasonCode>1</reasonCode>      <description>[Q-POSITION]Failed to execute panel processor with panel: /eagle/star/research/pan-currposoneportallpos.htm. 21 Accounting Basis (ERR): Value required 86 Base Currency (ERR): Value required Panel processor errors: Accounting Basis: Value required Base Currency: Value required      </description>     </reason>     <eventEntities>      <summary>       <failedRecords>1</failedRecords>       <totalRecords>1</totalRecords>      </summary>      <eventEntity>       <entityId>BT698_E1</entityId>      </eventEntity>     </eventEntities>     <identifier>      <identifierName>Start Time</identifierName>      <identifierValue>2016-09-13 13:08:52</identifierValue>     </identifier>     <identifier>      <identifierName>End Time</identifierName>      <identifierValue>2016-09-13 13:08:52</identifierValue>     </identifier>     <identifier>      <identifierName>User Name</identifierName>      <identifierValue>MCADMIN</identifierValue>     </identifier>     <identifier>      <identifierName>Report Group</identifierName>      <identifierValue>Reports</identifierValue>     </identifier>     <identifier>      <identifierName>Message Type</identifierName>      <identifierValue>Q-POSITION</identifierValue>     </identifier>     <identifier>      <identifierName>Event Type</identifierName>      <identifierValue>STAR Message</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^S^test_bt_T142698(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^R^DEFAULT(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Schedule Group</identifierName>      <identifierValue>DK TEST</identifierValue>     </identifier>     <identifier>      <identifierName>Report Viewer Group</identifierName>      <identifierValue>DEFAULT</identifierValue>     </identifier>     <identifier>      <identifierName>Server IP</identifierName>      <identifierValue>10.130.42.224</identifierValue>     </identifier>     <identifier>      <identifierName>Process ID</identifierName>      <identifierValue>37834</identifierValue>     </identifier>     <identifier>      <identifierName>Process Address</identifierName>      <identifierValue>sv14lvm00050.eagleinvsys.com</identifierValue>     </identifier>     <identifier>      <identifierName>Process Port</identifierName>      <identifierValue>20030</identifierValue>     </identifier>    </eventDetails>   </taskUnit>   <taskUnit>    <status>FAILED</status>    <severityCode>1</severityCode>    <eventDetails>     <eventName>DK_Test_Schedule</eventName>     <eagleInstanceId>73102671</eagleInstanceId>     <reason>      <reasonTypeEnum>ERROR</reasonTypeEnum>      <reasonCode>1</reasonCode>      <description>[Q-POSITION]Failed to execute panel processor with panel: /eagle/star/research/pan-currposoneportallpos.htm. 21 Accounting Basis (ERR): Value required 86 Base Currency (ERR): Value required Panel processor errors: Accounting Basis: Value required Base Currency: Value required      </description>     </reason>     <eventEntities>      <summary>       <failedRecords>1</failedRecords>       <totalRecords>1</totalRecords>      </summary>      <eventEntity>       <entityId>BT698_E2</entityId>      </eventEntity>     </eventEntities>     <identifier>      <identifierName>Start Time</identifierName>      <identifierValue>2016-09-13 13:08:52</identifierValue>     </identifier>     <identifier>      <identifierName>End Time</identifierName>      <identifierValue>2016-09-13 13:08:52</identifierValue>     </identifier>     <identifier>      <identifierName>User Name</identifierName>      <identifierValue>MCADMIN</identifierValue>     </identifier>     <identifier>      <identifierName>Report Group</identifierName>      <identifierValue>Reports</identifierValue>     </identifier>     <identifier>      <identifierName>Message Type</identifierName>      <identifierValue>Q-POSITION</identifierValue>     </identifier>     <identifier>      <identifierName>Event Type</identifierName>      <identifierValue>STAR Message</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^S^test_bt_T142698(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Name</identifierName>      <identifierValue>BUSINESSUSERGROUP[Q-POSITION]^R^DEFAULT(G)^tpe^dynamic^dat^eagle^star^research^pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Entry Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Result Profile Panel Name</identifierName>      <identifierValue>pan-currposoneportallpos.htm</identifierValue>     </identifier>     <identifier>      <identifierName>Schedule Group</identifierName>      <identifierValue>DK TEST</identifierValue>     </identifier>     <identifier>      <identifierName>Report Viewer Group</identifierName>      <identifierValue>DEFAULT</identifierValue>     </identifier>     <identifier>      <identifierName>Server IP</identifierName>      <identifierValue>10.130.42.224</identifierValue>     </identifier>     <identifier>      <identifierName>Process ID</identifierName>      <identifierValue>37834</identifierValue>     </identifier>     <identifier>      <identifierName>Process Address</identifierName>      <identifierValue>sv14lvm00050.eagleinvsys.com</identifierValue>     </identifier>     <identifier>      <identifierName>Process Port</identifierName>      <identifierValue>20030</identifierValue>     </identifier>    </eventDetails>   </taskUnit>  </statusItem> </EagleML>

Example of this task parameter in the RTR:By default STAR subevent details are switched off. To switch on adding STAR subevent details (both entity and execution details) to the Final TSR the task parameter ReportEventEntitiesDetails = Y should be populated in the RTR message or W_CONFIG_INCLUDE_ENTITIES_DETAILS = Y should be set in w_config_custom.inc.

<taskParameter>   <name>ReportEventEntitiesDetails</name>   <dataType>S</dataType>   <value>Y</value> </taskParameter>

Â