Systemflags verwenden

Sie verwenden Systemflags, um Ordner, Dokumente oder andere Objekte mit zusätzlichen Einschränkungen abseits von ACLs zu versehen, etwa wenn:

• Benutzer Dokumente aus Ordnern nicht verschieben dürfen
• Benutzer trotz ALL-/WRITE-Recht Dokumente / Ordner nicht löschen dürfen
• Dokumente revisionssicher, also nicht änderbar, abgelegt werden

Systemflags überschreiben vorhandene ACLs. Auch wenn ein Benutzer ein ALL-Recht in einem Ordner hat und somit Löschrechte besitzt, darf dieser mit Systemflags versehene Dokumente nicht verändern, löschen oder verschieben.

Die Systemflags stellen ein Bitfeld dar, über das Sie ein oder mehrere Systemflags abfragen oder setzen können.

Besonderheiten der Systemflags

Ein Systemflag darf nur auf einem Objekt sitzen. In der Regel sollen jedoch einem Objekt mehrere Einschränkungen übergeben werden. Sie können dies bei Systemflags anhand von Zahlen (Bits) umsetzen. Diese Bits können Sie aufsummieren.

• Jedes Systemflag besitzt einen eigenen Bit, der eindeutig ist.
• Systemflags sitzen auf dem Objekt und nicht auf den Links.
• Sie setzen etwa auf ein Objekt ein Systemflag. Anschließend verlinken Sie es in andere Ordner. Diese Verlinkung besitzt dann dieselben Systemflags und andersherum. Sobald Sie ein verlinktes Objekt mit einem Systemflag versehen, enthalten alle anderen Verlinkungen ebenfalls dieses Systemflag.

Frühere Bezeichnungen der Systemflags

Mit agorum core 10.0 haben die Systemflags neue Bezeichnungen erhalten. Geändert haben sich ausschließlich die Namen. Die Zahlenwerte (Bits) und die Wirkung der einzelnen Systemflags sind unverändert geblieben.

Daraus folgt für bestehende Systeme:

• Eine Konfiguration, in der noch die früheren Bezeichnungen oder die Zahlenwerte stehen, funktioniert unverändert weiter.
• Sie müssen bestehende Konfigurationen, Skripte oder Suchabfragen nicht anpassen.
• Eine bereits gesetzte Zahl bedeutet heute genau dasselbe wie vor der Umbenennung. Aus NOTDELETE (1) wurde etwa DISALLOW_DELETE, der Wert 1 und der Löschschutz dahinter sind dieselben geblieben.

Damit Sie eine Ihnen bekannte Bezeichnung wiederfinden, nennen die folgenden Übersichtstabellen zu jedem Systemflag in der Spalte Frühere Bezeichnung den Namen, unter dem es bis agorum core 10.0 geführt wurde.

Übersicht Systemflags

Allgemein

Flags bezogen auf ein Objekt

Flags bezogen auf Ordner und deren Objekte

Flags für Objekte in der Historie

Flags für spezielle Prozesse

Wichtige berechnete Systemflags

Die folgenden Systemflags besitzen keinen eigenen Bit. Sie fassen mehrere Einzelflags zu einem Summenwert zusammen und sind erst mit den neuen Bezeichnungen eingeführt worden. In älteren Konfigurationen finden Sie stattdessen die aufsummierte Zahl oder die Einzelflags.

systemflag:(1 2048 524288)

systemflag:(16 8 4)

Gesetzte Systemflags in der Oberfläche erkennen

Sie müssen nicht erst ein Skript ausführen, um zu sehen, ob ein Objekt geschützt ist. agorum core zeigt gesetzte Systemflags an zwei Stellen direkt an.

Voraussetzung

• Sie sind als Administrator in agorum core angemeldet und der Administrationsmodus ist aktiv.

An der Karte des Objekts

• Besitzt ein Objekt mindestens ein Systemflag, zeigt agorum core dieses als orangefarbenen Chip an der Karte des Objekts an.
• Der Tooltip des Chips listet die im Wert enthaltenen Einzelflags jeweils mit ihrem Zahlenwert auf.
• Ein Klick auf den Chip öffnet den Dialog Systemflags setzen für dieses Objekt (vorausgesetzt, Sie haben die entsprechende Berechtigung).

Im Berechtigungsprüfer

• Der Berechtigungsprüfer zeigt zu einem Objekt neben ACLs, Scope-ACLs und Sperrstatus auch die gesetzten Systemflags an, jeweils mit einer Beschreibung in Klartext, etwa Löschen nur für Administratoren erlaubt für RESTRICT_DELETE.
• Sie öffnen ihn über das Kontextmenü eines Objekts unter Administration > Werkzeuge > Berechtigungsprüfer (vom gewählten Objekt).

Systemflags berechnen

Sie können über das Kontextmenü die long-Werte der gewählten Systemflags berechnen:

Voraussetzungen

• Sie sind als Administrator in agorum core angemeldet.
• Sie haben das Plugin agorum core template manager installiert.

1. Öffnen Sie an einer beliebigen Stelle im System mit der rechten Maustaste das Kontextmenü.
2. Wählen Sie agorum core template manager - Edit > Administration > Systemflags > Systemflags - berechnen.

Systemflags abfragen

Sie können Systemflags sowohl manuell als auch per JavaScript, Selektor oder Solr abfragen.

Systemflags manuell abfragen

Voraussetzungen

• Sie sind als Administrator in agorum core angemeldet.
• Sie haben das Plugin agorum core template manager installiert, oder folgende Standardkonfiguration ist Bestandteil Ihrer agorum core smart assistant Konfiguration.

Sie können per Kontextmenü Systemflags zu einem bestimmten Objekt abfragen.

1. Klicken Sie mit der rechten Maustaste auf ein Objekt.
2. Wählen Sie im Kontextmenü agorum core template manager - Edit > Administration > Systemflags > Systemflags - welche sind gesetzt.
   
   Ergebnis: Ein Dialog erscheint und zeigt an, welche Flags auf das gewählte Objekt gesetzt sind.

Ergebnis der abgefragten Systemflags

Systemflags per JavaScript abfragen

Sie prüfen mit einer Bit-&-Abfrage, ob ein Systemflag vergeben ist. Zuerst lesen Sie das Systemflag aus dem Objekt aus, um es danach folgendermaßen per JavaScript-API abzufragen:

let objects = require('common/objects'));

let obj = objects.find(59115185);
let sf = obj.systemFlags; // auslesen

let ret = '2048 nicht gesetzt';

// abfragen
if (sf & 2048) {
  ret = '2048 gesetzt';
}

ret;

Systemflags per Selektor abfragen

Voraussetzungen

• Sie haben die Migration alter Daten in den Solr-Index durchgeführt.
• Sie verwenden mindestens agorum core 8.1.3.

Sie können in einem Selektor einzelne oder ganze (berechnete) Systemflags abfragen.

Beispiel für ganze (berechnete) Systemflags

[systemFlags=2051]

Beispiel für einzelne Systemflags

[systemFlag=2048][systemFlag=2][systemFlag=1]

Systemflags per Solr abfragen

Beispiel für die Suche eines ganzen (berechneten) Systemflags

systemflags:2051

Beispiel einzelne Systemflags

Sie suchen nach einzelnen Systemflags im Systemflag 2051. Zuerst indizieren Sie ein weiteres Array in Solr, das folgendermaßen aussieht:

"systemflag":[1, 2, 2048]

Beispiel für die Suche eines einzelnen Flags (Bit)

systemflag:2048

Bei mehreren gesetzten Flags

systemflag:(<flag1> <flag2> ...)

Beispiele für häufige Suchen

systemflag:1

systemflag:32

systemflag:(1 2048 524288)

systemflag:(4 8 16)

Systemflags setzen

Systemflags manuell setzen

Sie können über das Kontextmenü Systemflags manuell auf Dokumente und Ordner setzen.

• Manuell gesetzte Systemflags können Sie nicht von einem Testsystem auf ein Produktivsystem übertragen.
• Sie müssen Systemflags in jedem dieser Systeme manuell setzen.

1. Klicken Sie mit der rechten Maustaste auf ein Objekt.
2. Wählen Sie im Kontextmenü Administration > Werkzeuge > Systemflags setzen.
   
   Ergebnis: Ein Dialog mit einer Auswahl von Systemflags erscheint.

Systemflags manuell setzen

Welche Systemflags der Dialog anbietet

Der Dialog lässt nur die Systemflags zu, die für den fachlichen Einsatz vorgesehen sind:

Systemflags per JavaScript setzen

Mit der Funktion objects.SystemFlags erhalten Sie eine Aufzählung (Enumeration) aller verfügbaren Systemflags, die auf ein Objekt gesetzt werden können.

let sysFlags = objects.SystemFlags;

Beispiel

Dieses Beispiel zeigt, wie Sie bestimmte Systemflags mithilfe der Bitoperatoren prüfen, setzen und entfernen können.

let objects = require('common/objects');
let sysFlags = objects.SystemFlags;

/**
 * Show all system flags in a readable JSON format
 */
console.log(JSON.stringify(sysFlags, null, 2));


/**
 * Check if a system flag is set using bitwise AND operator &
 */
let objFolder = objects.find( '/agorum/roi/Files/Demo');
if (objFolder.systemFlags & sysFlags.DISALLOW_DELETE) {
  console.log('Der Ordner ' + objFolder.name + ' darf von niemanden gelöscht werden');
} else if (objFolder.systemFlags & sysFlags.RESTRICT_DELETE) {
  console.log('Der Ordner ' + objFolder.name + ' darf nur von Benutzern mit Administrationsrechten gelöscht werden');
} else {
  console.log('Der Ordner ' + objFolder.name + ' darf gelöscht werden');
}


/**
 * Set a system flag using bitwise OR assignment operator |=
 */
objFolder.systemFlags |= sysFlags.RESTRICT_DELETE;


/**
 * Clear a system flag using bitwise AND assignment operator &= and NOT operator ~
 */
objFolder.systemFlags &= ~sysFlags.RESTRICT_DELETE;

Dokumente revisionssicher setzen

Szenario 1
Ein Dokument besitzt keine Systemflags, aber ein Ablaufdatum.
Ergebnis
Ist das Ablaufdatum erreicht, löscht ein CronJob (Expiration Service) das Dokument.

Szenario 2
Ein Dokument besitzt die Systemflags DISALLOW_DELETE (1) und DISALLOW_DELETE_LOCKED (2048) (Dokument nicht änderbar oder löschbar) und KEIN Ablaufdatum.
Ergebnis
Das Dokument behält seine Systemflags dauerhaft, sie können nicht entfernt werden. Das Dokument kann außerdem nicht gelöscht oder geändert werden.

Szenario 3
Ein Dokument besitzt die Systemflags DISALLOW_DELETE (1) und DISALLOW_DELETE_LOCKED (2048) (Dokument nicht änderbar oder löschbar) und ein Ablaufdatum.
Ergebnis
Ist das Ablaufdatum erreicht, können die Systemflags DISALLOW_DELETE (1) und DISALLOW_DELETE_LOCKED (2048) geändert werden, um etwa das Dokument als solches zu ändern oder zu löschen.

Die folgenden Systemflags schützen den Inhalt des Objekts. Sie können dank des Systemflags DISALLOW_CONTENT_WRITE (524288) weiterhin Metadaten auf das Objekt setzen.

Diese Kombination entspricht dem berechneten Systemflag RESISTANT.

Beispiel 1 – ohne Ablaufdatum

Dieses Beispiel setzt die Zahl 526337 per JavaScript-API ohne Ablaufdatum. Das Objekt ist dauerhaft revisionssicher.

/* global sc */

let objects = require('common/objects');
let sysFlags = objects.SystemFlags;

// agorum-Objekt mit ID holen
let obj = objects.find(59115185);

// Systemflags setzen
let sf = sysFlags.DISALLOW_DELETE + sysFlags.DISALLOW_DELETE_LOCKED + sysFlags.DISALLOW_CONTENT_WRITE;

// Entfernen Sie den Kommentar in folgender Zeile, um die Änderung endgültig wirksam werden zu lassen

// obj.systemFlags = sf;

Beispiel 2 – mit Ablaufdatum

Dieses Beispiel setzt die Zahl 526337 per JavaScript-API mit Ablaufdatum. Das Objekt ist elf Jahre revisionssicher.

/* global sc */

let objects = require('common/objects');
let sysFlags = objects.SystemFlags;

// agorum-Objekt mit ID holen
let object = objects.find(59115185);

// Ablaufdatum initiieren
let newExpirationDate = new Date();

// Systemflags setzen
// Das Objekt revisionssicher setzen // 1 = DISALLOW_DELETE - Schützt das Dokument vor einer Löschung // 2048 = DISALLOW_DELETE_LOCKED - Sorgt dafür, dass DISALLOW_DELETE nicht mehr entfernt werden kann // 524288 = DISALLOW_CONTENT_WRITE - Sorgt dafür, dass der Dateiinhalt nicht mehr bearbeitet werden kann
let sf = sysFlags.DISALLOW_DELETE + sysFlags.DISALLOW_DELETE_LOCKED + sysFlags.DISALLOW_CONTENT_WRITE;

// Ablaufdatum wählen (Aufbewahrung mindestens 10 Jahre,
// hier beträgt das Ablaufdatum 11 Jahre)
newExpirationDate.setFullYear(newExpirationDate.getFullYear() + 11);

// Ablaufdatum für das Objekt setzen
object.expirationDate = newExpirationDate;

// Entfernen Sie den Kommentar in folgender Zeile, um die Änderung endgültig wirksam werden zu lassen
//object.systemFlags = sf;

Systemflags über die Datei „structure.yml“ setzen

Sie können Ihre Systemflags über die Datei structure.yml definieren und setzen. Dies ist möglich bei einer festgelegten Ordnerstruktur und erlaubt das Exportieren dieser Einstellung von einer Testumgebung in das Produktivsystem.

Systemflags entfernen

Systemflags manuell entfernen

1. Folgen Sie den Anweisungen unter Systemflags manuell setzen.
2. Deaktivieren Sie die entsprechenden Systemflags, indem Sie den Haken entfernen.

Systemflags per JavaScript entfernen

Setzen Sie auf folgende Eigenschaft einen neuen Wert, um Systemflags per JavaScript zu entfernen:

obj.systemFlags

Beispiel, in dem ein geschützter Ordner mit folgenden Flags umbenannt wird (durch DISALLOW_RENAME hat auch der Super-Administrator roi kein Recht, den Namen anzupassen):

• RESTRICT_DELETE = 4
• RESTRICT_WRITE = 8
• RESTRICT_ITEM_REMOVE = 16
• DISALLOW_RENAME = 32

/* global sc, data */

let objects = require('common/objects');
let sysFlags = objects.SystemFlags;

let obj = objects.tryFind(<Objekt-ID/Objekt>);

// Systemflag wird nur gesetzt und DISALLOW_RENAME entfernt, indem die Summe ohne DISALLOW_RENAME angegeben wird
let systemflag = sysFlags.RESTRICT_DELETE + sysFlags.RESTRICT_WRITE + sysFlags.RESTRICT_ITEM_REMOVE;
obj.systemFlags = systemflag;

// Neue Metadaten werden gesetzt oder bestehende Werte überschrieben
// Dabei wird der Ordnername (name) angepasst
let new_metadata = {
  identifier: '06 - Juli',
  area: '06 - Juli',
  name: '06 - Juli'
};
// einzelnes Objekt
metadata(new_metadata).save(obj);
//*/

// Systemflag wird wiederhergestellt
systemflag = sysFlags.RESTRICT_DELETE + sysFlags.RESTRICT_WRITE + sysFlags.RESTRICT_ITEM_REMOVE + sysFlags.DISALLOW_RENAME;
obj.systemFlags = systemflag;