AFD-definition Standard

4.2.1. File naming conventions

File naming conventions

Various parties within the financial services industry utilize the AFD-definition Standard for different purposes. Some compile JSON/XML Schemas and AFD validation rules, while others leverage them for software development. To ensure structure and clarity in the creation and utilization of the AFD-definition Standard, a file naming convention is employed.

This naming convention aims to elucidate how and when the files can be utilized by all parties involved. The file names are created based on attributes filled in the tooling AOS. For more information see Manual AOS (in Dutch).

File naming conventions for an AFD-definition – generic rules

The complete file name of an AFD-definition can contain the following elements:

  • Business line (Branchecode) – optional
    • Three positions (N3).
    • Refer to AFD codelist ADNBRA for possible values.
  • Company name description (POR-code) – optional
    • Four positions (AN4).
    • Refer to AFD codelist PORMAA for possible values.
  • AFD-definition name (AFD-definitienaam) – mandatory
    • Supplier-determined name.
    • Traditionally 70 positions (AN..70), or preferrably 35 positions (AN..35), to prevent issues with long names.
    • Hyphens should be avoided.
    • Spaces or underscores are recommended.
    • Include the AFD-definition name in the AFD label: AFDDEFN in AFD 1.0, afdDefinitionName in AFD 2.0.
  • Version definition (Versie Definitie) – mandatory
    • Determined by the supplier.
    • Three positions before the ‘.’ and two after (N3 + ‘.’ N2), example 101.00.
    • For changes without impact to the structure of a database, screen or message, the section after the dot is increased ’000.XX’. For example, adding ‘Hydrogen’ as a fuel or increasing the maximum sum insured from 70,000 to 90,000 euros.
    • For changes with impact to the structure the section before the dot is increased ‘*XXX*.00’. For example, if the attribute ‘TNO/SCM security class’ is added to a car insurance.
Example: Gemak Verzekerd-101.00.zip
* AFD-definition name: Gemak Verzekerd
* Version: 101.00
* zip: the AFD-definition is saved in a zip-file, so the extension of the file is '.zip'

Composition of the file name for the zip file containing the complete generic AFD-definition. The business line and the company name description are optional in a generic AFD-definition and are omitted in this example:


File naming conventions for an AFD-definition – domain specific agreements

On top of generic file naming conventions, extra naming conventions can apply to domain specific agreements. The following domain specific agreements are subject to extra naming conventions:

All following elements are mandatory in the file name of an AFD-definition for these protocols:

  • Business line (Branchecode)
  • Company name description (POR-code)
  • AFD-definition name (AFD-definitienaam)
  • Version definition (Versie Definitie)
Example: 021-Q001-Gemak Verzekerd-101.00.zip
* Business line: 021 (Auto)
* Company name description (POR-code): Q001
* AFD-definition name: Gemak Verzekerd
* Version: 101.00
* zip: the AFD-definition is saved in a zip-file, so the extension of the file is '.zip'

Composition of the file name for the zip file, containing the complete AFD-definition UIV or AFD-definition Registratie Polis:


File naming conventions at function level – generic rules

An AFD-definition contains one or more functions. Functions can be defined in the tooling AOS. For each function a different (partial) AFD-definition is composed. The file name for the generic AFD-definition of a function contains at least the AFD-definition name, the version and the name of the function. The business line (branchecode) and company name description (POR-code) can be part of a generic AFD-definition name, but are not mandatory:

  • Business line (Branchecode) – optional
  • Company name description (POR-code) – optional
  • AFD-definition name (AFD-definitienaam) – mandatory
  • Version definition (Versie Definitie) – mandatory
  • Function (Functie) – mandatory

The rules for the function in the file name are as follows:

  • Function (Functie)
    • Variable length (string).
    • Functions for the AFD-definition Standard can be:
      • Based on domain specific agreements (like UIV and Registratie Polis).
      • Based on functions in the SIVI AFS API-framework.
      • New functions created by suppliers: suppliers can add new functions of their own choice.
    • If the AFD-definition contains a request (aanroep) to and a response (resultaat) from a webservice, and the response is different from the request, it is possible to compose two different functions, one for the request and the other one for the response. In that case it is recommended to end the function name with ‘_request’ (‘_aanroep”) or ‘_response’ (‘_resultaat’).
Example: Gemak Verzekerd-101.00-nieuwePolis_aanroep.zip
* AFD-definition name: Gemak Verzekerd
* Version: 101.00
* Function: nieuwePolis_aanroep
* zip: the AFD-definition is saved in a zip-file, so the extension of the file is '.zip'

Composition of the file name for the zip file containing the AFD-definition for the function ‘nieuwePolis_aanroep’. The business line (branchecode) and the company name description (POR-code) are optional in a generic AFD-definition and are omitted in this example:


File naming conventions at function level – domain specific agreements

On top of generic file naming conventions, extra naming conventions can apply to domain specific agreements. The following domain specific agreements are subject to extra naming conventions:

  • Protocol AFD-definitions UIV
  • Protocol AFD-definitions Registratie Polis

All following elements are mandatory in the file name of an AFD-definition of a function for these protocols:

  • Business line (Branchecode)
  • Company name description (POR-code)
  • AFD-definition name (AFD-definitienaam)
  • Version definition (Versie Definitie)
  • Function (Functie)
Example Protocol AFD-definitions UIV: 021-Q001-Gemak Verzekerd-101.00-premieBerekening_aanroep.zip
* Business line: 021 (Auto)
* Company name description (POR-code): Q001
* AFD-definition name: Gemak Verzekerd
* Version: 101.00
* Function: premieBerekening_aanroep
* zip: the AFD-definition is saved in a zip-file, so the extension of the file is '.zip'

Composition of the filename for the zip file containing the AFD-definition for the function ‘premieBerekening_aanroep’ (Protocol AFD-definitions UIV):


Example Protocol AFD-definitions Registratie Polis: 021-Q001-Gemak Verzekerd-101.00-registreerContract.zip
* Business line: 021 (Auto)
* Company name description (POR-code): Q001
* AFD-definition name: Gemak Verzekerd
* Version: 101.00
* Function: registreerContract
* zip: the AFD-definition is saved in a zip-file, so the extension of the file is '.zip'

Composition of the filename for the zip file containing the AFD-definition for the function ‘registreerContract’ (Protocol AFD-definitions Registratie Polis):


File naming conventions for files within a function

Within a single function of an AFD-definition different files are present. The same file name convention applies as described above, but depending on the syntax and the purpose of the file, extensions or fixed text are automatically added to the file name:

  • Extension JSON/XML Schema
    • xsd (for XML Schema)
    • json (for JSON Schema)
  • Fixed text and extension AFD validation rules
    • XPathLibrary.xml
      • The term XPathLibrary is part of the filename
      • AFD validation rules are saved as XML-file
    • validationRules.json
      • The term validationRules is part of the filename
      • AFD validation rules are saved as a JSON file

Generic examples

The examples shown below are based on generic AFD-definitions. Because the business line (branchecode) and company name description (POR-code) are optional in a generic AFD-definition, they are omitted in these examples. In case of Protocol AFD-definitions UIV and Protocol AFD-definitions Registratie Polis these elements are mandatory and should be part of the file name.

Composition of the filename for XML Schema for a generic AFD-definition:

Composition of the filename for the corresponding AFD validation rules (AFD verbandscontroles) in XPath:

Composition of the filename for JSON Schema :

Composition of the filename for the corresponding AFD validation rules:

Examples for Protocol AFD-definitions UIV

The examples shown below are based on the AFD-definitions for Protocol AFD-definitions UIV. The business line (branchecode) and company name description (POR-code) are mandatory in this protocol and they are always part of the file name. This protocol does not use JSON, therefore only the XML-examples are presented.

Composition of the filename for XML Schema for an AFD-definition UIV:

Composition of the filename for the corresponding AFD validation rules (AFD verbandscontroles) in XPath:

Examples for Protocol AFD-definitions Registratie Polis

The examples shown below are based on the AFD-definitions for Protocol AFD-definitions Registratie Polis. The business line (branchecode) and company name description (POR-code) are mandatory in this protocol and they are always part of the file name. This protocol does not use JSON, therefore only the XML-examples are presented.

Composition of the filename for XML Schema for an AFD-definition Registratie Polis:

Composition of the filename for the corresponding AFD validation rules (AFD verbandscontroles) in XPath:

Feedback

Thanks for your feedback.

Post your comment on this topic.

Please do not use this for support questions.
If you have any support questions, do not hesitate to contact us.

Post Comment