Claim Type (CLT)

Claim Type represents a claim template – a preconfigured way to validate a certain type of Claim data from the distributor. As a developer you can set up what sheet from the XLS will be used, how the columns will be mapped to the Claim line item and which logic should be used for validations of the Claims.

Configuration

Claim types are managed in Channel Management › Claim Types.

Open

Fields

• uniqueName^* – Name of the Claim Type.

• label^* – Human readable name of the Claim Type, displayed to the user when they select which Claim Type they want to use for the Claim document.

• sheetName – When the claim data comes from XLS file, this is the name of the sheet which will be used. If not selected, the first sheet found in the XLS file will be used.

• formulaName^* (Validation Logic) – Name of the Claim logic which will do the validation of the uploaded Claim lines. It is executed for each Claim line item. See Claim Validation Logic.

• validationStateElementName – Name of an element of the validation logic which calculates and returns the validation status for the data row. For details about this element, see Claim Validation Logic. If not specified, the default validationState value will be used (see Claim Line Item (CLLI)).

• allocationFormulaName (Allocation Grid Logic) – Name of a Claim logic which will calculate and return a result matrix with a list of details for the selected Claim line item. See Claim Allocation Logic.

• configuration (mapping) – Configuration of mapping a data row or logic calculation result to a Claim line item.

• buttons – Configures the visibility of UI buttons. See How to Hide Claim Buttons for details. (Introduced in version 14.0)

Mapping Data Row and Calculation Results to Claim Line Item

When the Claim validation logic finishes the validation of the data row, the data from the data row (from the XLS file) and the results of the validation logic are mapped to the Claim line item.

The data flow is following:

Open

• Row with Claim data – Represents one Claim row either read from an XLS file or created by the source logic. It is provided to the validation logic as a Map object.

The mapping can be set up when you select one particular Claim type and click Edit.

In the mapping configuration, you can decide for each field of the Claim line item what data will end up in the field:

• name – Name of source element/column.

  • source element – If the Claim validation logic has a visible element with such name, the value to be mapped, it will be taken from the result of that element.

  • source column – If the Claim validation logic does NOT have a visible element with such name, the value will be taken from the Claim data row from a column with such name.

• attribute^* – Name of the destination field in the Claim Line Item object.

• fieldFormatType – Formatting of the destination field. If the name is set, then also the fieldFormatType must be set. The format is applied when the user reviews the destination field of a Claim line item on the screen. If the value of the destination field comes from the validation logic, the format type of the logic element (if defined) will override this format type.

• canEdit – Decides if the destination field will be editable (overridable) by the user. All the other fields will appear to the user as read-only.