MOD

Description

Modulo function. Returns the remainder value after performing a division operation between two nodes. The input values are 'Number', 'Divisor', and an optional validation option. If no validation is required, the same result can be achieved using the % symbol, for example 'Number' % 'Divisor'. The operation is performed along the linked levels between the nodes.

Use when you need the remainder after dividing one value by another, for example for bucket logic or periodic patterns.

Syntax

MOD('Number', 'Divisor' [, "Validation"])

Parameters

• Number: Input node.

• Divisor: Input node.

• Validation (optional): Causes the node executing the function to error with a message explaining why if conditions are not met. Note that using validation can affect performance. The following values can be used:

  • “NoValidation”: Behaves the same as using the % symbol. This is the default option if no validation is specified.

  • ”FailOnMissingFirst”: The calculation fails if any row in ‘Number’ is not matched with any row in ‘Divisor’.

  • ”FailOnMissingSecond”: The calculation fails if any row in ‘Divisor’ is not matched with any row in ‘Number’.

  • ”FailOnMissing”: Combines “FailOnMissingFirst” and FailOnMissingSecond” validation options.

Note

For this operation, the result of the division only returns whole numbers such as 0, 1, 2, or 3.