The Sum function calculates a numeric value based on the total of all iterations of a node in the input recordset or XML document. For example, if the input XML document contains multiple sales orders, you can use Sum to calculate the total net worth of the combined orders based on the values in the Sales Order Value node.

Sum functions are available as part of the Data Transformation Layer (DTLClosed When used as part of a BPA Platform tool, the Data Transformation Layer (DTL) extend the tool's functionality by transforming SML from schema to another. In addition, several transformation functions are available for use with the input data before such data is mapped to the destination schema.) feature.

Adding a Sum Function

Sum functions are used in the Mapping tab of the following tools:

Microsoft SQL Server Connector
Run Microsoft Reporting ServicesClosed The Run Microsoft Reporting Services tool automates the running of Microsoft Reporting Services (MSRS) reports.
Transform DataClosed Transform Data is a Format tool that enables a new structure to be created from an existing XML or recordset data source. The output generated by this tool is ready for use in a destination system which consumes or requires XML.
Web Service Connector
  1. Open the relevant task step and go to the Mapping tab.
  1. Click Functions to expand the Functions pane.
  2. Expand the Aggregation node and drag Sum to the Transformation Mappings pane.
  3. Drag the parent Input Data node to the new icon. This is the "folder" containing the elements you want to generate a total for.
  4. Drag the Input Data element whose values you want to total to the new icon.
  5. Do the same for the receiving Output Data node or elements.
  6. Double-click the icon.

The Transformation Mappings pane is replaced with the Sum's configuration pane:

Data Transformation Layer - Sum

  1. Enter a meaningful Function Name.
  2. Make sure the SumWithin and ItemToSum mappings are correct (hover over each Mapped To parameter in turn).

    To change an existing mapping, either Inputs or Output, use the drop-down lists under Mapped To to select a new node or element.

Selecting Error Handling Options

Use the Options tab to define error handling behaviour for this function.

At task run-time, if a mapped input element is not included in the received input recordset or XML, you can choose to:

Output an empty String — An empty string is passed to the mapped output node at task run time, for example, <country></country>.
Output no Data — The element isn't included in the output XML.
Output Value — Enter a static value in the provided text box; this value is passed to the mapped output at task run-time.
Error — The function logs an error to the BPA Platform Event Log. Depending on the parent task step's own error handling options, the task can either continue or fail completely.

Click OK to save the function and return to the parent task step's Mapping tab.