Classification System and Class

Classification System

Classification System (Klassifikasjonssystem) is an entity used for grouping Classes (Klasse) which are related to a single concept from the business domain of the archived data. Classification Systems and Classes are the primary means to add comprehensive labeling to folders in the archive.

• Entity name in the API : Klassifikasjonssystem.
• Being a core Noark5 model entity, Classification System (Klassifikasjonssystem) is created/modified using the Transaction :: POST /transaction operation.
• Classification System (Klassifikasjonssystem) can have multiple Classes (Klasse) related to them.
• Classification System (Klassifikasjonssystem) are associated to Series (Arkivdel) as either primary (main classifcation system) or secondary classification systems. This way Classes (Klasse) from the Classification Systems (Klassifikasjonssystem) can be used to lable/tag folders (Saksmappe,Mappe, Moetemappe) under the Series (Arkivdel)

Data Fields

Common Data Fields

Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :

Klassifikasjonssystem Specific Data Fields

Reference Fields

Class

Class (Klasse) is an entity representing a single concept instance part of a Classification System (Klassifikasjonssystem). Classes are classification criterias which greatly facilitates data retrieval and provides the required data structuring. Classes (Klasse) are associated to folders (Saksmapppe, Mappe, Moetomappe) or records (Journalpost, Basisregistrering, Moeteregistrering) and act as labels for those entities.

• Entity name in the API : Klasse.
• Being a core Noark5 model entity, Class (Klasse) is created/modified using the Transaction :: POST /transaction operation.
• Class (Klasse) can be part of only single Classification System (Klassifikasjonssystem).
• Classes can be defined in a hierarchy as specified in the Noark5 specification, but only Classes without children classes can be linked to folders/records.
• Class (Klasse) are uniquely identified by the klasseIdent field, still when making changes/lining classes the id of the class is used.

Data Fields

Common Data Fields

Following the Noark5 specification requirements and the internal implementation details the following set of data fields are present for all entities :

Klasse Specific Data Fields

Reference Fields

Working with Classification System and Class

Creating Class with BSM values

Classes (Klasse) are created with the POST /transaction operation. Important unique data field for the Classes (Klasse) is klasseIdent. The sample below also adds sample BSM (business specific metadata) values to the class.

The BSM values associated with the Class are visible in the user interface when the class linked to folder (Saksmappe, Mappe, etc.)

• transaction::save - new Class (Klasse) with BSM field qsid (Quality System ID) defined in BSM group qs1 (Quality System 1)
• transaction::link - link the new Class (Klasse) to the existing Classification System (Klassifikasjonssystem).

As a result of the transaction new Class (Klasse) is created with ID = 3168047

POST https://<documaster-instance>.local.documaster.tech:8083/rms/api/public/noark5/v1/transaction HTTP/1.1
... 
Authorization: Bearer {{accessTokenIntegrator}}
Content-Type: application/json
X-Documaster-Error-Response-Type: application/json

{
    "actions": [
        {
            "action": "save",
            "type": "Klasse",
            "id": "klasse-temp-id-1",
            "fields": {
                "klasseIdent": "TST-IDENT-2106",
                "tittel": "Sample Class with BSM",
                "beskrivelse": "Test Class with BSM - QualitySystem ID",
                "virksomhetsspesifikkeMetadata": {
                    "qs1": {
                        "qsid": {
                            "values": [
                                "QS1-ID-820621"
                            ]
                        }
                    }
                }
            }
        },
        {
            "action": "link",
            "type": "Klasse",
            "id": "klasse-temp-id-1",
            "ref": "refKlassifikasjonssystem",
            "linkToId": "1444539"
        }
    ]
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "saved": {
        "klasse-temp-id-1": {
            "type": "Klasse",
            "id": "3168047",
            "version": "4",
            "fields": {
                "uuid": "ff3a1497-f18f-4111-a05a-a3383c0a1ae8",
                "opprettetDato": "2022-06-07T14:08:31.496+0200",
                "opprettetAv": "Integrator",
                "opprettetAvBrukerIdent": "d730e776-c10f-4986-99d7-5fab7bf4c3ee",
                "klasseIdent": "TST-IDENT-2106",
                "tittel": "Sample Class with BSM",
                "beskrivelse": "Test Class with BSM - QualitySystem ID",
                "virksomhetsspesifikkeMetadata": {
                    "qs1": {
                        "qsid": {
                            "type": "string",
                            "values": [
                                "SPDADM-ID-820621"
                            ]
                        }
                    }
                }
            },
            "links": {
                "refKlassifikasjonssystem": 1444539
            }
        }
    }
}