Output Payload Overview

After a payload is executed, the resulting output, or output payload is either successful, or has failed.

Successful Execution

The following shows the output payload from a successful run: 

<?xml version="1.0" encoding="UTF-8" ?>
<SSC>
    <User>
        <Name>PKP</Name>
    </User>
    <SunSystemsContext>
        <BusinessUnit>PKP</BusinessUnit>
    </SunSystemsContext>
    <Payload>
        <AnalysisHierarchyAssignCodes status="success">
            <AnalysisCode>P001</AnalysisCode>
            <AnalysisDimension>13</AnalysisDimension>
            <AnalysisHierarchyCode>AHC001</AnalysisHierarchyCode>
            <AnalysisHierarchyLabel>AHL001</AnalysisHierarchyLabel>
        </AnalysisHierarchyAssignCodes>
    </Payload>
</SSC>

Failed Execution

The following shows how the output payload from a run in which an error was generated would be displayed: 

<?xml version="1.0" encoding="UTF-8" ?>
<SSC>
    <User>
        <Name>PKP</Name>
    </User>
    <SunSystemsContext>
        <BusinessUnit>PKP</BusinessUnit>
    </SunSystemsContext>
    <Payload>
        <AnalysisHierarchyAssignCodes status="fail" Reference="1">
            <AnalysisCode>XXX</AnalysisCode>
            <AnalysisDimension>13</AnalysisDimension>
            <AnalysisHierarchyCode>AHC002</AnalysisHierarchyCode>
            <AnalysisHierarchyLabel>AHL001</AnalysisHierarchyLabel>
            <AnalysisDimensions>
                <AnlCat_SHead>PROJECT</AnlCat_SHead>
            </AnalysisDimensions>
        </AnalysisHierarchyAssignCodes>
    </Payload>
    <ErrorMessages>
        <Message>
            <PayloadRef>1</PayloadRef>
            <UserText>
            <![CDATA[Not a valid Analysis Code]]>
            </UserText>
            <Exception>
            <![CDATA[
com.systemsunion.JBO.analysishierarchyassigncodes.AnalysisCodeNonExistentException:
Not a valid Analysis Code
at
com.systemsunion.JBO.analysishierarchyassigncodes.AnalysisHierarchyAssignCode.save
(Unknown Source)
at com.systemsunion.JBO.SSC.dataimport.Importer.importValueObject(Unknown Source)
at com.systemsunion.JBO.SSC.dataimport.Importer.importRecord(Unknown Source)
at com.systemsunion.JBO.SSC.dataimport.Importer.importData(Unknown Source)
at com.systemsunion.SSTS.components.business.analysishierarchyassigncodes.
AnalysisHierarchyAssignCodesImport.execute(AnalysisHierarchyAssignCodesImport
.java:54)
at com.systemsunion.SSTS.drivers.DJI.DJIMethod.execute(Unknown Source)
at com.systemsunion.SSTS.drivers.DJI.DJIDriver.execute(Unknown Source)
at com.systemsunion.SSTS.streaming.ExecutionFilter.execute(Unknown Source)
at com.systemsunion.util.streaming.AbstractFilter.execute(Unknown Source)
at com.systemsunion.util.streaming.AbstractStreamBase$1.run(Unknown Source)
at java.lang.Thread.run(Thread.java:536)
]]>
            </Exception>
        </Message>
    </ErrorMessages>
</SSC>

It shows that the execution of the payload failed and the runtime data values that were used.

In the example above, the component assigned a payload failure reference ( <AnalysisHierarchyAssignCodes status="fail" Reference="1">) to the particular error to allow you to find failing payload records if there are multiple records present. The error message text for this failure was written to the <ErrorMessages> element with the failure payload reference, allowing you to easily cross reference a particular error message with its matching payload record. In the example shown, the component could not find the Analysis Code.

Note: Although not shown in the example, the component does not stop executing when a data error is encountered. In the case of multiple payload records, the component issues an error message and then attempts to process the next payload record, assuming one exists.