Skip to main content

Using data quality validation

info

The “Data quality: description & validation” features are in pilot phase.

The FinDock Data Quality component can be used to validate data according to specific data requirements for the following objects:

  • Installment
  • Payment Schedule

Configuring the data quality component#

The FinDock Data Quality component is automatically available on the default Lighting page layout for the Payment Schedule object. For installments and custom payment schedule page layouts, you need to manually add the component.

To configure the data quality component:

  1. Go to the Lightning record page layout editor of the object you wish to validate.
  2. Drag the Custom Managed component FinDock Data Quality to the layout.
  3. Click Save.

Using the data quality component#

On payment schedules, simply click the Validate button to start the validation. On installments, the component validates automatically.

Validation component

When the validation is complete, you are presented with the results for each rule. The rule status options are described in the table below.

Validated rule status

IconStatusDescription
Passed iconPassedThe rule was executed and passed validation.
Failed iconFailedThe rule was executed and did not pass validation.
Pending iconPendingThe rule was not executed because a (required) field it is dependent on had no value. A failed rule on the required field is to be expected. It could be executed once the missing data is entered.
Skipped iconSkippedThe rule was not executed because it was not applicable in this context.

If you want to see all rules that were selected and applied, you can click Show all results. This also shows rules that were passed and rules that were skipped because they were not relevant for this specific record.

Validating payment schedule data#

On a payment schedule record, the data quality component validates:

  • Whether all (qualified) installments are ready for collection

  • Whether the payment schedule is defined correctly

  • Whether the data provided in the selected target is complete

    The validation uses the following steps:

  1. Determine what rules apply, the component looks at:
    • Payment method
    • Payment processor
  2. Selects the appropriate ruleset.
  3. Applies the ruleset to the data on the record and related records like Installments. If there are many Installments related to this Payment Schedule, this step may take a long time. Please do not close or refresh your browser window because it will cancel the process. At any time you can cancel the validation manually by pressing Cancel.
  4. Reports on its findings. The outcome can be either:
    • Ready to be run
    • Not ready ready to be run

If the outcome is Not ready to be run the component shows:

  • What fields have not passed the rules and the result of the validation. This information can be used to update the payment schedule to make it ready to be run.
  • A count of failed installments.
  • What errors were encountered while validating the related installments and how many times they occurred.
  • The Ids of the first (max) 25 invalid installment records and the first error on the installment.

Installment validation results

Invalid installments can be either corrected for collection or removed from the payment schedule. Re-validate to make sure the payment schedule is ready to be run.

Validating installment data#

Simply click the Validate button to start the validation. On an installment record, the data quality component validates whether the installment is ready for collection as follows:

  1. Determine what rules apply, the component looks at:
    • Payment method
    • Payment processor
  2. Selects the appropriate ruleset.
  3. Applies the ruleset to the data on the record and related records like payment profile and mandate.
  4. Reports on its findings. The outcome can be either:
    • Ready for collection
    • Not ready for collection

If the outcome is not ready for collection, the component shows what fields of the installment or related records relevant for collection have not passed the rules, and the result of the validation against these rules. This information can be used to update the installment to make it ready for collection.

Validation results