Outline of this manual

This manual describes and explains the AFD-definition Standard. It starts with a description of the context and effects of the use of AFD-definitions (chapter 2 Background, followed by a general explanation of AFD-definitions (chapter 3 AFD-definition: introduction), including a more generic and technical introduction in message schemas and validation rules. Chapter 4 outlines how to create of AFD-definitions, including the tooling available for composing AFD-definitions (chapter 4 How to create an AFD-definition?).
In chapter 5 Use of AFD-definition for autocompletion, we explain how autocompletion and autofill can help developers to implement these AFD-definitions in their software.
In specific areas supplementary agreements apply: protocols. A short explanation of the protocols for UIV and UIP is available in chapter 6 AFD-definition Protocols. The final chapter (chapter 7 Examples of AFD-definitions) shows some general examples of AFD-definitions in XML and JSON. These examples are the basis for other, more specific examples.

If you have any questions about this manual or suggestions for improvement, please do not hesitate to contact support@sivi.org.

Version management

Version Date Status Changes
001.000.000 15-04-2024 final pre-release
001.000.001 01-07-2024 final Chapter 7: changed example AFD-definition for service
001.000.002 01-08-2024 final Chapter 3: added an explanation about custom functions in JMESPath
001.000.003 01-09-2024 final Chapter 3 (par 3.3 Specifications of validation rules): converted validation rule examples to XPath notation
001.000.004 01-10-2024 final Chapter 3: split par 3.3 (Specifications of validation rules) into par 3.3 Validation rules in XPath and par. 3.43 Validation rules in JMESPath.
001.000.005 01-11-2024 final Chapter 7: changed figure 7.1-4. It referred to a JSON Schema, but it should have been an XML Schema.

Feedback

Thanks for your feedback.

Post your comment on this topic.

Post Comment