Basic Record

Basic Record

Basic Record is an entry collecting documents in no particular relation to correspondence parties or any other entities. It is used as a general type of record for archiving.

  • Basic Record (Basisregistrering) is a subtype of AbstraktRegistrering and as such inherits fields part of the parent object.
  • Being a core Noark5 model entity, Basic Record is managed using the POST /transaction operation.
  • Basic Record can be linked under a Basic Folder (Mappe) or Case File (Saksmappe).
  • Basic Record cannot be created without a transaction::link action to an entity on the folders level through refMappe
  • Basic Record are referenced by Document(Dokument) entities during Document, DocumentVersion creation

Table below contains the names with which the entity can be used in transaction and query operations.

Context Entity Name
referred to in transaction::save action as Basisregistrering
referred to in transaction::link action Basisregistrering
referred to in transaction::unlink action Basisregistrering
referred to in query operation Basisregistrering or AbstraktRegistrering

Diagram showing the relation of Basic Record entity (Basisregistrering) to any other entities through its reference fields. The diagram depicts the most important set of fields, leaving some of the use cases out of it for simplicity. child-parent-relation

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 :

Field Name Type Noark Metadata No. Required on Create Value Always Available Modifiable Description
id string unique entity identifier in the specific Documaster installation, used for referencing the entity in the API. The id for created entities is a numeric value.
Default : new value generated on creation
Sortable
version string contains the verions of the entity, used for optimistic locking
Default : sequence version number of the entity
uuid string M001 globally unique identification of the entity, an UUID value (sysemId)
Default : new value generated on creation
Indexed, Sortable
opprettetDato timestamp M600 date and time at which the entity was created (createdDate)
Default : current date time
Indexed, Sortable
opprettetAv string M601 name of the user that created the entity (createdBy)
Default : logged in user name
Sortable
opprettetAvBrukerIdent string M601 identifier of the user that created the entity (createdByIdent)
Default : logged in user identifier
Sortable

Basisregistrering Specific Data Fields

Field Name Type Noark Metadata No. Required on Create Value Always Available Modifiable Description
avsluttetDato timestamp M602 date and time when the archive unit was finalized (finalizedDate)
Sortable
avsluttetAv string M603 name of the user who finalized the archive unit (finalizedBy)
Sortable
avsluttetAvBrukerIdent string M603 unique identifier of the user who finalized the archive unit (finalizedByIdent)
Sortable
registreringsIdent string M004 unambiguous identification of the registry entry within the fonds to which the case file belongs (fileId)
Default : journalaar/journalsekvensnummer in archive, example 2022/109
Indexed, Sortable
tittel string M020 title of the registry entry (title)
Indexed, Sortable
offentligTittel string M025 public title of the registry entry, words that should be screened have been removed from the content of the title (replaced with ******) (publicTitle)
Sortable
beskrivelse string M021 description of the registry entry (description)
forfatter string M024 author of the registry entry
Sortable
dokumentmedium string M300 indication of whether the archive unit contains physical documents, electronic documents or a mixture of physical and electronic documents
Code List : dokumentmedium
Default : E - Elektronisk arkiv
Indexed
registreringsDato date M101 date at which the registry entry was journaled (caseResponsible)
Default : current date
Indexed, Sortable
dokumentetsDato date M103 date attached to the registry entry/document
Sortable
forfallsdato date M109 date indicating the deadline for the incoming registry entries to be answered (dueDate)
Sortable
kassasjonsvedtak string M450 action to be performed at the end of the preservation period (disposalAction)
Code List : kassasjonsvedtak
kassasjonshjemmel string M453 authority for disposal (disposalAuthority)
Code List : kassasjonshjemmel
bevaringstid number M451 number of year the document should be kept before being scheduled for disposal (retentionPeriod)
Sortable
skjerming string M500 indication that the documents belonging to the registry entry are not publicly available in accordance with the Public Access to Information Act (offentlighetsloven) or for any other reason (accessRestriction)
Code List : skjerming
Indexed
virksomhetsspesifikkeMetadata object M711 overarching metadata element that can contain custom metadata. When metadata for an entity is updated, the whole of it is ovewritten. Examples for handling business specific metadata can be found in the usage section of the page. (businessSpecificMetadata)
Not Queryable

Reference Fields

Field Name Referenced Entity Type Cardinality Link Required on Create Modifiable Description
refMappe AbstraktMappe 1 reference to the Case File (Saksmappe) to which the Registry Entry (Journalpost) belongs
Returned
refArkivdel Arkivdel 0 . . 1 reference to the Series (Arkivdel) to which the Registry Enty (Journalpost) belongs. Either this reference or the refMappe reference can be set, but not both.
refKorrespondansepart Korrespondansepart 1 . . * reference to a list of Correspondence Party (Korrespondansepart) entities. Each Registry Entry (Journalpost) must have at least one Correspondence Party (Korrespondansepart).
refDokument Dokument 0 . . * reference to a list of Documents (Dokument) associated with the Registry Entry (Journalpost)
refPrimaerKlasse Klasse 0 . . * reference to a list of primary Classes (Klasse) associated with the Registry Entry (Journalpost)
refSekundaerKlasse Klasse 0 . . * reference to a list of secondary Classes (Klasse) associated with the Registry Entry (Journalpost)
refEksternId EksternId 0 . . * reference to a list of External ID (EksternId) entities, containing the case file identification in external systems
refNoekkelord Noekkelord 0 . . * reference to a list of Keywords (‘Noekkelord’) entities associated with the Registry Entry (Journalpost)
refMerknad Merknad 0 . . * reference to a list of Notes (‘Merknad’) entities associated with the Registry Entry (Journalpost)
refNasjonalIdentifikator NasjonalIdentifikator 0 . . * reference to a list of National Identifiers (‘NasjonalIdentifikator’) entities associated with the Registry Entry (Journalpost)
refKryssreferanseTilMappe AbstraktMappe 0 . . * reference to a list of Folders (AbstraktMappe) to which the current registry entry has cross-reference
refKryssreferanseFraMappe AbstraktMappe 0 . . * reference to a list of Folders (AbstraktMappe) from which the current registry entry is being cross-referenced
refKryssreferanseTilRegistrering AbstraktRegistrering 0 . . * reference to a list of Folders (AbstraktMappe) to which the current registry entry has cross-reference
refKryssreferanseFraRegistrering AbstraktRegistrering 0 . . * reference to a list of Folders (AbstraktMappe) from which the current registry entry is being cross-referenced