Contents x
Sum
  • 31 Oct 2024
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
  • PDF
Contents

Sum

  • Updated on 31 Oct 2024
  • 3 Minutes to read
  • Contributors
  • Print
  • Dark
    Light
  • PDF
Article summary

Overview

The Sum node serves multiple functions within your Processes:

  • Calculates the total value of the specified parameters of the passing tasks and stores the accumulated results
  • Generates statistics and monitors specific parameters
  • Integrates seamlessly with other nodes and Processes, enhancing its compatibility and usability in various workflows

Sum flow

Unlike other nodes, in the Sum node, the total value is not added to the tasks but is stored within the node itself.

Settings

The Sum node has the following parameters:

  1. (Optional) Title and Description: Name and details of the node.

  2. Summation Parameters:

    • Key: Key to specify variables; use a unique name. When updating existing variables, use their original names as a key.
    • Value: The value you want to assign to the corresponding Key parameter. The value can be a constant or a variable reference and must have the Number type.

    Note: For more information, go to Parameters and functions.

    • To add a key-value, click + Add “key-value” below the Key field.
    • To see the Sum ID, click the Info icon on the right side of the Value field.
    • To delete the key-value line, click the trash icon Delete icon on the right side of the Value field.

    Sum_add actions

  3. Other:

    • Alert if the number of tasks in the node queue reaches the following number: Helps monitor whether the number of tasks in the node exceeds the specified threshold. When selecting the checkbox, you have to enter the needed number of tasks in the field that appears below.
    • Maximum interval, for which the task stays in the node before being forwarded: The amount of time a task is allowed to be in the node; can be set in seconds, minutes, hours, and days.
      Note: The checkbox has a minimum value of 30 seconds. You can set a shorter interval by using the Unixtime function.

    Sum settings

Examples

Using the Sum node as a counter

Description: In the example below, you can see how to use the Sum node as a counter.

Precondition:

  1. Add the Sum node to your Process.
  2. In Summation Parameters of the Sum node details panel, add the Count parameter and the 1 value (a positive or negative number).

Flow: Each time a task passes through the Sum node, the Counter value increases by 1, effectively counting the number of tasks that have passed through the node.

Such a counter can be used to monitor the number of payments or charges on an account or to record different types of payments/multiple accounts.

Sum ex_1

You can view the current Counter value on a Dashboard or access its value in a Process or a State Diagram.

Summing up a parameter

Description: In the example below, you can see how to use the Sum node to calculate a parameter value.

Precondition:

  1. Add the Sum node to your Process or State Diagram.
  2. In Summation Parameters of the Sum node details panel, add the Payment_total parameter and the {{amount}} value (as a variable).

Sum ex_2

Flow: Each time a task passes through the Sum node, the Sum node tracks and accumulates the values of the {{amount}} task parameter, calculates the total, and stores it in the Payment_total parameter.

You can sum multiple task parameters within the Sum parameter by using the $.math({{param1}}+{{param2}}) math function.

Error handling & troubleshooting

When an error occurs during the task processing, you may see the following error parameter names in the task.

Error parameter nameError type
__conveyor_api_sum_return_type_error__Hardware (system error), Software (error in a node logic/settings).
__conveyor_api_sum_return_type_tag__*Error tag.
__conveyor_api_sum_return_type_description__Error description in human-readable language; can be static or dynamic.

*The error tag __conveyor_api_sum_return_type_tag__ may have the following values.

ValueCauseSolution
access_deniedYou don't have access to the Process.Contact the Process owner to give you access.
access_deniedYou are trying to send or receive tasks from another stage.It's not allowed to get and send tasks between stages. Use the same stage to send and receive tasks.
access_refusedThe Process you are working in is not a State Diagram but has to be it.Check the logic of using a State Diagram. For more information, go to State Diagram.
api_sum_wrong_convert_paramParameter value failed to convert with the specified parameter type.Check and correct the data type of the parameter mentioned in the error message.
conv_not_found_or_deletedYou are trying to work with a non-existent Process.Use an existing Process.
not_found_conv_by_aliasYour alias refers to a Process that no longer exists.Use an existing Process.
bad_callback_nodeThe Process you are calling doesn't have the Callback node.Create the Callback node in the Process you are calling.
api_sum_fatal_errorA hardware error has occurred.Contact the support team for further assistance.

When working with your Process, you may encounter the following issues.

IssueCauseSolution
The summed parameter is not a number.A parameter in the Sum node is not of the Number type.Change the parameter type to Number.
Was this article helpful?
What's Next