Naming rules and guidelines

This page contains rules and guidelines for naming of the different element that comprises the interfaces for the Orchestration Component, especially for elements where a strict naming is required.

Editor: Kurt Hansen

 

Overview

 This version of the naming rules contains guidelines for:

  • Naming of data models

  • ItSystemID - assignment of the ItSystemID and naming af data sources

  • MyndighedsId - Id for a authority

  • Visningsklient - Id for display client

Naming of data models

Usage: Utilised when the Index functionality is used. Is also utilised internally in the Index component when index data is updated and in the Orchestrations component.

 

Rule:

Data models are named by adding a standard prefix to the name of the data domain in scope for the data model. Hyphen or similar characters are not allowed.

Prefix for all data models arer: Borgervendt

The following data domains are identified:

  • Sag

  • OekonomiskYdelse

  • Serviceydelse

  • Akkreditiv

  • GaeldogBetaling

  • AftaleFrister

Example:

  • BorgervendtSag 

Data source

Usage: Data-source is used by the Orchestration component for routing data request to the proper Data source provider. (aka context based routing).

Rule:

For each Data source two attributes has to be assigned a proper value:

  • ItSystemID: The attribute ItSystemId is assigned a UUID. The UUID is generated by operationsteam for the Orchestration component

  • ItSystemnavn: The value of the attribute itSystemnavn is a free text, but it is recommend to concatenate the CVR-number for the organisation that is system owner for the data source with the name of the data source system separated with a hyphen:

Format: <CVR-nummer><-><systemnavn> 

Example: 

  • KOMBIT iTSystemID: 0f52fab1-6c18-448e-99c3-6f68e343d52b

  • KOMBIT itSystemnavn: 19435075-BOB

Display client

Usage: The Display-client is used internally in the Orchestration component for enforcing data agreement policies and for selecting which Data sources that should be called and orchestrated data from.

Rule:

For each Display-client two attributes has to be assigned a proper value:

  • VisningsklientID: The attribute visningsklientId is assigned a UUID. The UUID is generated by operationsteam for the Orchestration component

  • Visningsklientnavn: The value of the attribute visningsklientnavn is a free text, but it is recommended to concatenate the CVR-number for the organisation that is system owner for the Display client with the name of the system displaying the digital overview, separated with a hyphen:

Format: <CVR-nummer><-><systemnavn>

 

Example: 

 

 

MyndighedsId

Usage: The attribute myndighedsId in entity OffentligOrganisationskal is used by the Orchestration component to verify if there exists a valid “databehandleraftale” for the data that is requested to be orchestrated from a data source.

Rule:

  • MyndighedsId is assigned by the operationsteam for the Orchestration component.

  • For municipalities the value of myndighedsid must be the municipality code registred in the authority register maintained by the CPR administration. Please notice that the value must consist of four (4) digits, including any preceding “0”.

  • For governmental authorities the myndighedsId must be equal to the CVR-number registred in the danish Central Business Register for the authority. 

 

Example:

  • Uddannelses og Forskningsstyrelsen: 34042012

  • Roskilde kommune: 0265

 

Version Date Comment
Current Version (v. 1) Jul 29, 2024 12:17 Kurt Hansen