Saltar al contenido

Retention Mgt. Pub (Retention Labels)

Document Central proporciona funciones públicas para eliminar o establecer una etiqueta de retención en un documento. Estas funciones están disponibles en la codeunit "Retention Mgt. Pub" (ID: 5737062) en el namespace Simova.DMS.Feature.Compliance.RetentionLabel.

Se deben cumplir los siguientes requisitos:

  • Document Central debe estar presente como referencia en la extensión.
  • La función de Compliance está activada y las etiquetas de retención están configuradas correctamente.

RemoveRetentionLabel

La función RemoveRetentionLabel elimina una etiqueta de retención de un documento. El comportamiento depende del tipo de repositorio:

  • SharePoint: Elimina la etiqueta de retención tanto en Azure como en el Document Entry.
  • Azure Blob Storage: Solo elimina la etiqueta de retención en el Document Entry.

Parámetros

Var Nombre Tipo de dato Subtipo Longitud Descripción
Sí ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" El registro de Document Entry del cual se eliminará la etiqueta de retención

Valor de retorno

Tipo de dato Descripción
Boolean True si la etiqueta de retención se eliminó correctamente, False en caso contrario. Si ocurre un error, se genera un Error

Ejemplo de código

Mostrar ejemplo de código
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
    // Obtener el Document Entry del cual desea eliminar la etiqueta de retención
    LocalRecordSIMDMSDocumentEntry.Get(...);

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

SetRetentionLabel

La función SetRetentionLabel establece una etiqueta de retención en un documento. El comportamiento depende del tipo de repositorio:

  • SharePoint: Establece la etiqueta de retención tanto en SharePoint como en el Document Entry.
  • Azure Blob Storage: Establece la etiqueta de retención en el Document Entry y en la versión del Document Entry.

Parámetros

Var Nombre Tipo de dato Subtipo Longitud Descripción
No ParamRecordSIMDMSUserSetup Record "SIM_DMS User Setup" El registro de configuración de usuario para autenticación
Sí ParamRecordSIMDMSDocumentEntry Record "SIM_DMS Document Entry" El registro de Document Entry en el cual se establecerá la etiqueta de retención
No ParamRetentionLabelText Text El nombre de la etiqueta de retención a aplicar
Sí ParamRecordSIMDMSDocumentEntryVersion Record "SIM_DMS Document Entry Version" El registro de versión del Document Entry (utilizado para Azure Blob Storage)

Valor de retorno

Tipo de dato Descripción
Boolean True si la etiqueta de retención se estableció correctamente, False en caso contrario. Si ocurre un error, se genera un Error

Ejemplo de código

Mostrar ejemplo de código
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
    // Obtener la configuración de usuario para autenticación
    LocalRecordSIMDMSUserSetup.Get(UserId());

    // Obtener el Document Entry en el cual desea establecer la etiqueta de retención
    LocalRecordSIMDMSDocumentEntry.Get(...);

    // Obtener la versión del Document Entry
    LocalRecordSIMDMSDocumentEntryVersion.Get(...);

    LocalResult := LocalCodeunitRetentionMgtPub.SetRetentionLabel(
        LocalRecordSIMDMSUserSetup,
        LocalRecordSIMDMSDocumentEntry,
        'Nombre de su etiqueta de retención',
        LocalRecordSIMDMSDocumentEntryVersion
    );
end;