Specific TSR Parameters

CreateConsolidatedTSR - Enhanced TSR Report

A consolidated TSR actually represents an additional report for your workflow, summing up the TSRs for each of the subprocesses of your workflow. This option can be useful when you want to have several task responses on a single file.

On this page

1 CreateConsolidatedTSR - Enhanced TSR Report
2 IncludeExtractStats - Add Extract Stats to TSRs for Extracts
3 IncludeRecordErrorDetails - Optimize TSR Detail Information

To enable this kind of reply messages, please add the following task parameter to your control message:

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

Consolidated TSR has the following structure:

First of all this report provides some general information adding separate blocks which refer to different files. Each of these blocks starts with load details for the file followed by the description of errors if any occurred.

IncludeExtractStats - Add Extract Stats to TSRs for Extracts

Please note, that this feature is supported for a limited number of interfaces: Schedule, GenericSMF, WarehouseCashActivity, WarehouseCashFlowProjection, WarehouseCloseLot, CustodyRestrictionActivity, CustodyRestrictionBalance, WarehouseDisclosureStatus, WarehouseGLBalances, WarehouseNAVMonthEnd, WarehouseNAVMulti, WarehouseNAV, WarehouseOpenLot, WarehousePendingTrade, WarehousePerformance, WarehousePosition, WarehouseTrade, WarehouseWashSaleTrade

The following model with additional information can be added to extract TSRs:

<extractStats>
   <extractFilename>65B4103E3B9CD110__WAREHOUSEPERFORMANCE__1_4_20180425.xml</extractFilename>
   <transactionCount>4</transactionCount>
   <objectCount>4</objectCount>
   <rowCount>4</rowCount>
</extractStats>

by setting IncludeExtractStats task parameter in the control message or W_INCLUDE_EXTRACT_STATS global parameter with the value of Y.

IncludeRecordErrorDetails - Optimize TSR Detail Information

Sometimes you want to make TSR information more compact and return only the "summary". In this case you should use IncludeRecordErrorDetails parameter in the control message or W_INCLUDE_RECORD_ERROR_DETAILS global parameter with the value of N. It also improves execution time of queries.

This parameter does not work for Pace Upload events. To exclude errors from Pace Uploader from TSR there should be set W_DISABLE_EXT_ERR_DESC_PACE_UPLOADER global parameter with the value of N.

Valid values are: Y or N.

Y (default value) - if the parameter is not set or its value is ‘Y’, Detail information is added to TSR.
N - if its value is ‘N’, only Summary information is added.

If IncludeRecordErrorDetails=N, the part of TSR marked with yellow will be removed from TSR.

If you use IncludeRecordErrorDetails=N with ConsolidatedTSR=Y, the record details will be removed from all blocks:

<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>1NFNLYM1S1NDEXU2</messageId>
<sentBy>http://www.eagleinvsys.com/</sentBy>
<sendTo>http://www.client.com/Eagle Control Messages</sendTo>
<creationTimestamp>2018-10-03T08:50:44-04:00</creationTimestamp>
</header>
<statusItem>
<taskIdentifier>
<correlationId correlationIdScheme="correlationIdScheme">kk_GENLOaD_TEST1_020</correlationId>
<businessTaskId correlationIdScheme="businessTaskIdScheme">k_GENLOaD_TEST1_020</businessTaskId>
</taskIdentifier>
<status>FAILED</status>
<severityCode>1</severityCode>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>1</reasonCode>
<description></description>
</reason>
<taskUnit>
<loadDetails>
<URI>file://*20181003-084842-PBJN1PAMBAGGH003_kk_GENLOaD_TEST1_020_TESTLOAD*.zip</URI>
<details>
<file>
<fileName>PROCESSING\5C20181003-084842-PBJN1PAMBAGGH003_KK_GENLOAD_TEST1_020_TESTLOAD.ZIP</fileName>
<type>CUSTOM</type>
<summary>
<eagleStatId>819963</eagleStatId>
<failedRecords>0</failedRecords>
<totalRecords>1</totalRecords>
<taskType>Stream</taskType>
<taskName>eagle_ml-2-0_default_cm_unpacker</taskName>
</summary>
</file>
</details>
</loadDetails>
</taskUnit><taskUnit>
<loadDetails>
<URI>file://*20181003-084850-PBJN1PAMBAGGH003*.trigger</URI>
<details>
<file>
<fileName>PROCESSING\5C20181003-084850-PBJN1PAMBAGGH003.TRIGGER</fileName>
<type>CUSTOM</type>
<summary>
<eagleStatId>819964</eagleStatId>
<failedRecords>0</failedRecords>
<totalRecords>1</totalRecords>
<taskType>Stream</taskType>
<taskName>eagle_ml-2-0_default_cm_unpacker_exec</taskName>
</summary>
</file>
</details>
</loadDetails>
</taskUnit><taskUnit>
<loadDetails>
<URI>file://*20181003-084914-6JNZRQ0VFOIZS006_EML_GP_GENERICSMF_EMLSCR007_kk_GENLOaD_TEST1_020_20181003*.xml</URI>
<details>
<file>
<fileName>PROCESSING\5C20181003-084914-6JNZRQ0VFOIZS006_EML_GP_GENERICSMF_EMLSCR007_KK_GENLOAD_TEST1_020_20181003.XML</fileName>
<type>CUSTOM</type>
<summary>
<eagleStatId>819973</eagleStatId>
<failedRecords>3</failedRecords>
<totalRecords>4</totalRecords>
<taskType>Stream</taskType>
<taskName>eagle_ml-2-0_default_in_xml_smf_generic</taskName>
</summary>
<record>
<transactionId>OHZ02WYBAN5YXM5</transactionId>
<eagleDetailId>14500</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_13</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_13</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>ASSET CURRENCY IS NULL</description>
<reasonTag>85</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
<record>
<transactionId>1HO7L7RYG3F4A16KT</transactionId>
<eagleDetailId>14501</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_12</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_12</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>ASSET CURRENCY IS NULL</description>
<reasonTag>85</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
<record>
<transactionId>GCO64L1LCFQMSLWW</transactionId>
<eagleDetailId>14499</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_12</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>SMF_EXTRACT_PSTYPE_12</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>ASSET CURRENCY IS NULL</description>
<reasonTag>85</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
</file>
</details>
</loadDetails>
</taskUnit><taskUnit>
<loadDetails>
<URI>file://*20181003-084959-NHFH1AXFIMSXE004_EML_GP_GENERICCA_C2_kk_GENLOaD_TEST1_020_20181003*.xml</URI>
<details>
<file>
<fileName>PROCESSING\5C20181003-084959-NHFH1AXFIMSXE004_EML_GP_GENERICCA_C2_KK_GENLOAD_TEST1_020_20181003.XML</fileName>
<type>CUSTOM</type>
<summary>
<eagleStatId>819985</eagleStatId>
<failedRecords>3</failedRecords>
<totalRecords>3</totalRecords>
<taskType>Stream</taskType>
<taskName>eagle_ml-2-0_default_in_xml_reference</taskName>
</summary>
<record>
<transactionId>5N7GZNQQK0DIE56</transactionId>
<eagleDetailId>14513</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>toId</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>identifier2</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>Security for the identifier(s) does not exist in Eagle: 
BADVALUE/INTERNAL. Resolution options: Exchange: US, Currency: USD.</description>
<reasonTag>10</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
<record>
<transactionId>15B62GH1N0LPXPBW</transactionId>
<eagleDetailId>14514</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>toId</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>identifier2</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>Security for the identifier(s) does not exist in Eagle: 
BADVALUE/INTERNAL. Resolution options: Exchange: US, Currency: USD.</description>
<reasonTag>10</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
<record>
<transactionId>6O4JXWAOHXV3FAC</transactionId>
<eagleDetailId>14515</eagleDetailId>
<identifier><identifierName>fromId</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>toId</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><identifier><identifierName>referenceNumber</identifierName><identifierValue>0</identifierValue>
</identifier><identifier><identifierName>identifier1</identifierName><identifierValue>BADVALUE</identifierValue>
</identifier><identifier><identifierName>identifier2</identifierName><identifierValue>INTERNAL</identifierValue>
</identifier><reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>Security for the identifier(s) does not exist in Eagle: 
BADVALUE/INTERNAL. Resolution options: Exchange: US, Currency: USD.</description>
<reasonTag>10</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
</file>
</details>
</loadDetails>
</taskUnit><taskUnit>
<loadDetails>
<URI>file://*20181003-085024-AGDMO3S5W210QC033__WAREHOUSEPOSITIONXMLDBAPI_WH_017_Position_XMLDBAPI_Long_Insert_kk_GENLOaD_TEST1_020_20181*.xml</URI>
<details>
<file>
<fileName>PROCESSING\5C20181003-085024-AGDMO3S5W210QC033__WAREHOUSEPOSITIONXMLDBAPI_WH_017_POSITION_XMLDBAPI_LONG_INSERT_KK_GENLOAD_TEST1_020_20181.XML</fileName>
<type>WAREHOUSE</type>
<summary>
<eagleStatId>819998</eagleStatId>
<failedRecords>2</failedRecords>
<totalRecords>2</totalRecords>
<taskType>Stream</taskType>
<taskName>eagle_ml-2-0_default_in_xml_warehouse</taskName>
</summary>
<record>
<eagleDetailId>14531</eagleDetailId>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>Xref Account ID 'BADVALUE' (type=XREF1) is not found in reference table RULESDBO.ENTITY_XREFERENCE</description>
<reasonTag>1233</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
<record>
<eagleDetailId>14530</eagleDetailId>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>Xref Account ID 'BADVALUE' (type=XREF1) is not found in reference table RULESDBO.ENTITY_XREFERENCE</description>
<reasonTag>1233</reasonTag>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-21</reasonCode>
<description>The message hasn't been sent to engine due to EditCheck violation. Sending Reject Message.</description>
</reason>
<reason>
<reasonTypeEnum>ERROR</reasonTypeEnum>
<reasonCode>-10</reasonCode>
<description>The request was not processed</description>
</reason>
</record>
</file>
</details>
</loadDetails>
</taskUnit>
</statusItem>
</EagleML>