Zum Inhalt

Retention Mgt. Pub (Retention Labels)

Document Central stellt öffentliche Funktionen zur Verfügung, um ein Aufbewahrungsetikett auf einem Dokument zu entfernen oder zu setzen. Diese Funktionen sind in der Codeunit "Retention Mgt. Pub" (ID: 5737062) im Namespace Simova.DMS.Feature.Compliance.RetentionLabel verfügbar.

Die folgenden Voraussetzungen müssen erfüllt sein:

  • Document Central muss als Referenz in der Extension vorhanden sein.
  • Das Compliance-Feature ist aktiviert und Aufbewahrungsetiketten sind erfolgreich eingerichtet.

RemoveRetentionLabel

Die Funktion RemoveRetentionLabel entfernt ein Retention Label von einem Dokument. Das Verhalten hängt vom Repository-Typ ab:

  • SharePoint: Entfernt das Aufbewahrungsetikett sowohl in Azure als auch auf dem Document Entry.
  • Azure Blob Storage: Entfernt das Aufbewahrungsetikett nur auf dem Document Entry.

Parameter

Var Name Datentyp Subtyp Länge Beschreibung
Ja ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" Der Document Entry-Datensatz, von dem das Aufbewahrungsetikett entfernt werden soll

Rückgabewert

Datentyp Beschreibung
Boolean True, wenn das Aufbewahrungsetikett erfolgreich entfernt wurde, False wenn nicht. Bei einem Fehler wird ein Error ausgelöst

Code-Beispiel

Code-Beispiel anzeigen
AL
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
var
    LocalRecordSIMDMSDocumentEntry: Record "SIM_DMS Document Entry";
    LocalCodeunitRetentionMgtPub: Codeunit "Retention Mgt. Pub";
    LocalResult: Boolean;
begin
    // Den Document Entry abrufen, von dem das Aufbewahrungsetikett entfernt werden soll
    LocalRecordSIMDMSDocumentEntry.Get(...);

    LocalResult := LocalCodeunitRetentionMgtPub.RemoveRetentionLabel(LocalRecordSIMDMSDocumentEntry);
end;

SetRetentionLabel

Die Funktion SetRetentionLabel setzt ein Retention Label auf einem Dokument. Das Verhalten hängt vom Repository-Typ ab:

  • SharePoint: Setzt das Aufbewahrungsetikett sowohl in SharePoint als auch auf dem Document Entry.
  • Azure Blob Storage: Setzt das Aufbewahrungsetikett auf dem Document Entry und der Document Entry Version.

Parameter

Var Name Datentyp Subtyp Länge Beschreibung
Nein ParamRecordSIMDMSUserSetup Record "SIM_DMS User Setup" Der Benutzereinrichtungs-Datensatz zur Authentifizierung
Ja ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" Der Document Entry-Datensatz, auf dem das Aufbewahrungsetikett gesetzt werden soll
Nein ParamRetentionLabelText Text Der Name des anzuwendenden Aufbewahrungsetikett
Ja ParamRecordSIMDMSDocumentEntryVersion Record "SIM_DMS Document Entry Version" Der Document Entry Version-Datensatz (verwendet für Azure Blob Storage)

Rückgabewert

Datentyp Beschreibung
Boolean True, wenn das Aufbewahrungsetikett erfolgreich gesetzt wurde, False wenn nicht. Bei einem Fehler wird ein Error ausgelöst

Code-Beispiel

Code-Beispiel anzeigen
AL
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
var
    LocalRecordSIMDMSUserSetup: Record "SIM_DMS User Setup";
    LocalRecordSIMDMSDocumentEntry: Record "SIM_DMS Document Entry";
    LocalRecordSIMDMSDocumentEntryVersion: Record "SIM_DMS Document Entry Version";
    LocalCodeunitRetentionMgtPub: Codeunit "Retention Mgt. Pub";
    LocalResult: Boolean;
begin
    // Benutzereinrichtung zur Authentifizierung abrufen
    LocalRecordSIMDMSUserSetup.Get(UserId());

    // Den Document Entry abrufen, auf dem das Aufbewahrungsetikett gesetzt werden soll
    LocalRecordSIMDMSDocumentEntry.Get(...);

    // Die Document Entry Version abrufen
    LocalRecordSIMDMSDocumentEntryVersion.Get(...);

    LocalResult := LocalCodeunitRetentionMgtPub.SetRetentionLabel(
        LocalRecordSIMDMSUserSetup,
        LocalRecordSIMDMSDocumentEntry,
        'Ihr Retention Label Name',
        LocalRecordSIMDMSDocumentEntryVersion
    );
end;