Aller au contenu

Retention Mgt. Pub (Retention Labels)

Document Central fournit des fonctions publiques pour supprimer ou définir un label de rétention sur un document. Ces fonctions sont disponibles dans la codeunit "Retention Mgt. Pub" (ID: 5737062) dans le namespace Simova.DMS.Feature.Compliance.RetentionLabel.

Les conditions suivantes doivent être remplies :

  • Document Central doit être présent comme référence dans l'extension.
  • La fonctionnalité Compliance est activée et les labels de rétention sont configurés avec succès.

RemoveRetentionLabel

La fonction RemoveRetentionLabel supprime un label de rétention d'un document. Le comportement dépend du type de dépôt :

  • SharePoint : Supprime le label de rétention à la fois dans Azure et sur le Document Entry.
  • Azure Blob Storage : Supprime uniquement le label de rétention sur le Document Entry.

Paramètres

Var Nom Type de données Sous-type Longueur Description
Oui ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" L'enregistrement Document Entry dont le label de rétention doit être supprimé

Valeur de retour

Type de données Description
Boolean True si le label de rétention a été supprimé avec succès, False sinon. En cas d'erreur, une Error est générée

Exemple de code

Afficher l'exemple de code
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
    // Récupérer le Document Entry dont vous souhaitez supprimer le label de rétention
    LocalRecordSIMDMSDocumentEntry.Get(...);

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

SetRetentionLabel

La fonction SetRetentionLabel définit un label de rétention sur un document. Le comportement dépend du type de dépôt :

  • SharePoint : Définit le label de rétention à la fois dans SharePoint et sur le Document Entry.
  • Azure Blob Storage : Définit le label de rétention sur le Document Entry et la version du Document Entry.

Paramètres

Var Nom Type de données Sous-type Longueur Description
Non ParamRecordSIMDMSUserSetup Record "SIM_DMS User Setup" L'enregistrement de configuration utilisateur pour l'authentification
Oui ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" L'enregistrement Document Entry sur lequel le label de rétention doit être défini
Non ParamRetentionLabelText Text Le nom du label de rétention à appliquer
Oui ParamRecordSIMDMSDocumentEntryVersion Record "SIM_DMS Document Entry Version" L'enregistrement de version du Document Entry (utilisé pour Azure Blob Storage)

Valeur de retour

Type de données Description
Boolean True si le label de rétention a été défini avec succès, False sinon. En cas d'erreur, une Error est générée

Exemple de code

Afficher l'exemple de code
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
    // Récupérer la configuration utilisateur pour l'authentification
    LocalRecordSIMDMSUserSetup.Get(UserId());

    // Récupérer le Document Entry sur lequel vous souhaitez définir le label de rétention
    LocalRecordSIMDMSDocumentEntry.Get(...);

    // Récupérer la version du Document Entry
    LocalRecordSIMDMSDocumentEntryVersion.Get(...);

    LocalResult := LocalCodeunitRetentionMgtPub.SetRetentionLabel(
        LocalRecordSIMDMSUserSetup,
        LocalRecordSIMDMSDocumentEntry,
        'Nom de votre label de rétention',
        LocalRecordSIMDMSDocumentEntryVersion
    );
end;