Create a reconciliation function

Step 1 – General information

  1. In the main screen, click Create new reconciliation function.
  2. Fill in the identification details:
  3. Field Contents
    Name Name of the reconciliation. The full path must be unique. It must not contain ASCII characters lower than code 32 or the "/" character.
    Folder Parent folder of the reconciliation and the request associated to it. If you do not specify a folder, the reconciliation is directly stored under the root folder.
    Source Identifier of the data store. The value is automatically displayed with the first configured source. Specifying a source here enables you to query several data stores.
    Description Description of the reconciliation
  4. Fill in the input details:
  5. Field Contents
    Reconciliation definition The reconciliation definition configured in Designer. You can choose from multiple reconciliation definitions deployed from Designer.
    Reconciliation identifier property name Name of the property that gives the reconciliation id. This property is common to the collections involved in the reconciliation and identifies these collections.
  6. The following details are defined for each source:
  7. Field Contents
    Object type name Object type to be reconciled. Automatically filled from the reconciliation definition selected.
    Version Version of the object type to be reconciled. If no version is given, all versions of the object type are taken into consideration. Automatically filled from the reconciliation definition chosen.
    Collection start date Start date – default value {yesterday}.
    Can have empty value. If that is the case it will be set at execution time.
    Collection end date End date – default value {today}.
    Can have empty value. If that is the case it will be set at execution time.
    Keys An ordered list of properties of the object type to be reconciled. From this list the reconciliation key will be calculated. Automatically filled from the reconciliation definition selected.
    Additional properties Additional properties, other than keys, amount or direction, in order to have more information in the reconciliation results. Automatically filled from the reconciliation definition selected.
  8. Check the output details:
  9. Field Contents
    Result object Name of the object type that will store the result of the reconciliation. Automatically filled from the reconciliation definition selected.
  10. Click Next. See Step 2 – Configuration.

Step 2 – Configuration

  1. Fill in the amount fields for each source:
  2. Field Contents
    Amount property Property of numeric type which will be "aggregated" in the reconciliation amount result. Can be selected from a list of amount properties coming from the reconciliation definition. It is mandatory to have an amount for each source.
  3. Fill in the direction fields for each source:
  4. Field Contents
    Direction Property to be taken into consideration to sum up or subtract the amount in the reconciliation amount result
    Credit possible values List of possible values for the credit
    Debit possible values List of possible values for the debit
  5. A reconciliation function must have a request associated. You can select a request that has already been defined, or you can choose to have a request generated by default. Fill in the request association fields:
  6. Field Contents
    Generate request with name Name of the default request associated with the reconciliation. Default value: <ReconciliationFunctionName>_ViewResults.
    Select existing request

    Request already defined that can be associated with a reconciliation. The request must be defined on the object type of the reconciliation result.

    You can choose from a list of requests already identified as valid.

  7. The generated request will have the following:
    • all the properties of the result object as columns
    • a filter on SYS.COLLECTION_ID for the reconciliation collection
  8. Click Save.

After saving the reconciliation function, if a default request was associated to it, two entries will be created in the Navigation pane: the reconciliation function and the default request.

Related Links