Basic Folder

Basic Folder

Basic Folder (Mappe) is a folder used to keep records in no particular order, mostly used as a storage container for data.

• Entity name in the API : Mappe.
• Being a core Noark5 model entity, Basic Folder (Mappe) is created/modified using the Transaction :: POST /transaction operation.
• Basic Folder (Mappe) should be associated to a Series (Arkivdel)
• Only single type of records - Basic Record (Basisregistrering) can be created under a Basic Folder (Mappe)

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		no	yes	no	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		no	yes	no	contains the verions of the entity, used for optimistic locking Default : sequence version number of the entity
uuid	string	M001	no	yes	cond	globally unique identification of the entity, an UUID value (sysemId) Default : new value generated on creation Indexed, Sortable
opprettetDato	timestamp	M600	no	yes	cond	date and time at which the entity was created (createdDate) Default : current date time Indexed, Sortable
opprettetAv	string	M601	no	yes	cond	name of the user that created the entity (createdBy) Default : logged in user name Sortable
opprettetAvBrukerIdent	string	M601	no	yes	cond	identifier of the user that created the entity (createdByIdent) Default : logged in user identifier Sortable

Mappe Specific Data Fields

Field Name	Type	Noark Metadata No.	Required on Create	Value Always Available	Modifiable	Description
avsluttetDato	timestamp	M602	no	no	cond	date and time when the archive unit was finalized (finalizedDate) Sortable
avsluttetAv	string	M603	no	no	cond	name of the user who finalized the archive unit (finalizedBy) Sortable
avsluttetAvBrukerIdent	string	M603	no	no	cond	unique identifier of the user who finalized the archive unit (finalizedByIdent) Sortable
prefiks	string		no	no	no	optional identifier of the system from which the basic folder originated, the value cannot be changed once set Sortable
mappeIdent	string	M003	no	yes	cond	unambiguous identification of the basic folder within the fonds to which the basic folder belongs (fileId) Default : year/sequenceNumber in archive, example 2022/109 Indexed, Sortable
mappetype	string		no	no	yes	Code List : mappetype Indexed
tittel	string	M020	yes	yes	yes	title of the archive (title) Indexed, Sortable
offentligTittel	string	M025	no	no	yes	public title of the basic folder, words that should be screened have been removed from the content of the title (replaced with ******) (publicTitle) Sortable
beskrivelse	string	M021	no	no	yes	description of the basic folder (description)
dokumentmedium	string	M300	no	yes	yes	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
skjerming	string	M500	no	no	yes	indication that the documents belonging to the basic folder 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	no	no	yes	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
refArkivdel	Arkivdel	1	yes	yes	reference to the Series (Arkivdel) to which the Case File (Saksmappe) belongs Returned (if under Series)
refRegistrering	AbstraktRegistrering	0 . . *	no	yes	reference to a list of Records (AbstraktRegistrering) which can be either Basic Record (BasisRegistrering) or Registry Entry (Journalpost)
refForelderMappe	Mappe	0 . . 1	cond	yes	reference to a parent Basic Folder (Mappe), in case the folders are kept in hierarchy. Note : only one of the two references - refArkivdel or refForelderMappe should be set during creation, meaning the folder can be under a Serie (Arkivdel) or under another Basic Folder (Mappe), but not both. Returned (if under another folder)
refBarnMappe	Mappe	0 . . *	no	yes	reference to a list Basic Folders (Mappe) for which the current folder is parent, in case folders are kept in hierarchy. Note : only one of the two references - refRegistrering or refBarnMappe should be set during creation, meaning the folder have Records (Regisrering) or other Basic Folders (Mappe), but not both.
refPrimaerKlasse	Klasse	1 . . *	yes	yes	reference to the primary Class (Klasse) associated with the Case File (Saksmappe) Returned
refSekundaerKlasse	Klasse	0 . . *	no	yes	reference to a list of secondary Classes (Klasse) associated with the Case File (Saksmappe)
refEksternId	EksternId	0 . . *	no	yes	reference to a list of External ID (EksternId) entities, containing the basic folder identification in external systems
refNoekkelord	Noekkelord	0 . . *	no	yes	reference to a list of Keywords (‘Noekkelord’) entities associated with the Case File (Saksmappe)
refMerknad	Merknad	0 . . *	no	yes	reference to a list of Notes (‘Merknad’) entities associated with the Case File (Saksmappe)
refNasjonalIdentifikator	NasjonalIdentifikator	0 . . *	no	yes	reference to a list of National Identifiers (‘NasjonalIdentifikator’) entities associated with the Case File (Saksmappe)
refKryssreferanseTilMappe	AbstraktMappe	0 . . *	no	yes	reference to a list of Folders (AbstraktMappe) to which the current basic folder has cross-reference
refKryssreferanseFraMappe	AbstraktMappe	0 . . *	no	yes	reference to a list of Folders (AbstraktMappe) from which the current basic folder is being cross-referenced
refKryssreferanseTilRegistrering	AbstraktRegistrering	0 . . *	no	yes	reference to a list of Folders (AbstraktMappe) to which the current basic folder has cross-reference
refKryssreferanseFraRegistrering	AbstraktRegistrering	0 . . *	no	yes	reference to a list of Folders (AbstraktMappe) from which the current basic folder is being cross-referenced