Claim Allocation Logic

Use Case

When a user (e.g. claim approver) reviews the Claim line item and they want to see how the Claim would be allocated (e.g. to see which Quote defines the quantity limits and which other Claims use that approved quantity), they select the Claim line item and click the Allocation Grid button.

claim detail
Figure 1. How to open the Allocation Grid information for a Claim line item
claim allocation grid
Figure 2. Sample Allocation Grid with quoted 1000 pieces but the distributor claimed better price 2x600000 pieces in two different Claim documents

This helps the claim approver to quickly check if the claimed price reflects the reality, if it is a valid claim.

The system will call the Claim "allocation" logic which calculates the data and then the system provides the result matrix table in a popup to the user.

Alternative Use Case

The data displayed in the grid does not necessarily need to relate to allocations. From a technical perspective, the grid can show any data (in form of a table) which helps the claim approver to decide.

So you can use it, for example, to:

  • Show details of a problem with a Claim line.

  • Show a list of sales transactions related to that Claim from distributor and the product sold.

  • See which Quote defines the quantity limits and which other Claims use that approved quantity.

API of Claim Allocation Logic

  • Nature: claim

    • Logic type: default (generic)

  • Input fields: not relevant

  • Context:

    • api.currentItem() – Claim data (header)

    • api.getClaimContext() – API for reading data of the selected Claim line item. Specifically you might need these methods:

      • api.getClaimContext().getLineItemTypedId()

      • api.getClaimContext().getRow().get("<row_ColumnName>")

      • api.getClaimContext().getAttributeName("<claimLineItem_MappingFieldName>")

  • Elements:

    • There can be only one element with Display Mode Everywhere, others must not be displayed.

    • The displayed element:

      • Has Format Type Matrix or Charts.

      • Returns a ResultMatrix object which:

        • Does not allow any complex content, only text and numbers.

        • Can have styled cells, e.g. color of text.

  • Non-functional requirements:

    • The calculation must be fast because it is executed at the moment when the user clicks the Allocation Grid button and the result is shown once the logic returns the result matrix.

Found an issue in documentation? Write to us.