Cumulative Functoids Reference

 

Use Cumulative functoids to perform various types of accumulation operations for values that occur multiple times within an instance message. For example, you can use the Cumulative Sum functoid to provide the combined total for a value that occurs in multiple records within a specified scope in an instance message.

In Microsoft BizTalk Server, all Cumulative functoids accept two input parameters, the second of which is an optional scoping parameter that was not used in the Cumulative functoids in earlier versions of BizTalk Server. The two parameters are:

• Parameter 1: The value to be accumulated. This value must be numeric for all Cumulative functoids other than the Cumulative Concatenate functoid, which expects a string value. You supply this value by creating a link between a Field Attribute, Field Element, or Record (with its Mixed property set to True) node that has an appropriate data type and the Cumulative functoid.

  Note

  If none of the ancestor Record nodes in the schema tree are repeating, using a Cumulative functoid is pointless.

• Parameter 2: The scope to which the value specified as the first parameter should be accumulated. This optional numeric value indicates how closely "related" the specified values in an instance message must be in order to participate in the accumulation, as follows:

  • The default value of zero (0) indicates that the element or attribute value, as indicated by its element or attribute name, should be accumulated over the entire instance message.

  • A scoping value of one (1) indicates that only element or attribute values that have the same parent element should be accumulated.

  • A scoping value of two (2) indicates that only element or attribute values that have the same grandparent element should be accumulated, and so on.

Note

All Cumulative functoids provide backward compatibility with Microsoft BizTalk Server 2000 and Microsoft BizTalk Server 2002, both of which required only one input parameter. They default to a scoping parameter of zero (0), meaning a scope of the entire instance message.

For additional conceptual information about Cumulative functoids, including the scoping parameter, see Cumulative Functoids.

The following table shows the functoids in the Cumulative category.

Cumulative functoid	Description
Cumulative Average	Calculates the accumulated average of a numeric value that recurs within corresponding instance messages.
Cumulative Concatenate	Concatenates multiple instances of a string value that recurs within corresponding instance messages.
Cumulative Maximum	Determines the maximum value of a numeric value that recurs within corresponding instance messages.
Cumulative Minimum	Determines the minimum value of a numeric value that recurs within corresponding instance messages.
Cumulative Sum	Calculates the accumulated sum of a numeric value that recurs within corresponding instance messages.

See Also

How to Add Basic Functoids to a Map