Ga naar hoofdinhoud

CnRetentionWidget

The retention detail widget: what happens to a record when its business use ends, as OpenRegister decided it. Every value is read off the record's @self._retention: appraisal, disposal date, retention period, selection list row, the rule that decided it and when it was written. It also reads @self.archived. The widget derives nothing, so it can never disagree with the stored decision. Any app on OpenRegister uses it; dossiq's case Archiving tab is the first.

  • It fails closed: a failed read shows an error with a retry, never an empty archival block.
  • A record that nothing could nominate is drawn apart from a record that is not closed yet. The first keeps data past its lawful term; the second is nobody's problem yet.
  • When statusField is set, a mismatch between the record's own archive field and OpenRegister's @self.archived marker is said out loud rather than resolved silently.
  • An archivist (a member of archivistGroups) or an admin may ask OpenRegister to recompute the nomination, with a reason. Anyone else sees the control disabled, so they learn which role it needs.

Usage​

{
"id": "archiving",
"type": "retention",
"content": {
"statusField": "archiveStatus",
"archivedValues": ["archived", "archived_retention_period_unknown"],
"archivistGroups": ["archivaris"]
}
}

The record is read fresh from /apps/openregister/api/objects/{register}/{schema}/{id}, because _retention is attached when the object is read. Recomputing posts { reason } to /apps/openregister/api/archival/objects/{id}/nomination/recompute.

Content​

KeyDescription
title, subtitleTexts, through the app's translate (default "Archiving")
statusFieldA record field that also says whether it is archived
archivedValuesThe values of statusField that mean archived (default ["archived"])
archivistGroupsGroups that may recompute (default ["archivaris"]); admins always may
recomputefalse hides the recompute control
expectedBefore the record closes, the outcome its type expects: source: { register, schema, filter } lists the candidate rules (a case type's result types; filter tokens such as @object.caseType), fields: { appraisal, period, selectionListRow } names their fields, appraisalLabels names the appraisal values, periodText places the period ("{period} after the decision"), decidedBy says who decides. Agreeing rules fill the facts; disagreeing ones read "Depends on the result"; an unreadable list keeps the plain facts.
pendingNoteThe note under the facts of a record not closed yet
legalHoldtrue adds a section with the record's active legal holds (@self._retention.legalHold.holds), or says none applies
transfer{ keepValues } adds a section saying whether the record goes to the e-Depot, from the stored or expected appraisal (default keep values bewaren, blijvend_bewaren, retain, keep)

Props​

PropTypeDefaultDescription
contentObject{}The configuration above
objectDataObjectnullThe bound record on a detail page; its @self gives register, schema and id
registerString | Number''The record's register, overriding the bound record's
schemaString | Number | Object''The record's schema, overriding the bound record's
objectIdString | Number''The record's id, overriding the bound record's