SystemDocumentListEntry : champ d’application, global

L’API SystemDocumentListEntry fournit des méthodes pour définir les champs d’enregistrement dans la table Entrées de la liste de documents [ds_document_list_entry].

Cette API requiert le module d’extension Document Management (com.snc.platform_document_management) et est fournie dans l’espace de noms sn_doc_services . Pour plus d’informations, consultez Services documentaires.

Avant d’utiliser les méthodes de cette API, ajoutez un document avec sa version et créez une liste de documents. Utilisez l’API DocumentListEntryService pour ajouter ou supprimer des documents d’une liste de documents.

Avant d’utiliser les méthodes de cette API, vous devez ajouter un document avec ses versions et créer une liste de documents.

• SystemDocument : définit un objet de document.
• DocumentService – Ajouter, mettre à jour ou supprimer un document.
• SystemDocumentVersion : définit une version de document.
• DocumentVersionService : ajoutez, mettez à jour ou supprimez une version de document.
• SystemDocumentList : définit une liste de documents.
• DocumentListService – Ajouter, mettre à jour ou supprimer une liste de documents.

SystemDocumentListEntry : SystemDocumentListEntry(chaîne listID)

Instancie un objet SystemDocumentListEntry .

Tableau 1. Paramètres

Nom	Type	Description
listSysId (ID système)	Chaîne	Sys_id d’un enregistrement de liste de documents dans la table Listes de documents [ds_document_lists].

Tableau 2. Renvoie

Type	Description
Néant

L’exemple suivant montre comment instancier un objet SystemDocumentListEntry .

var docList = new sn_doc_services.SystemDocumentListEntry("<docListSysId>");

SystemDocumentListEntry : description (description de la chaîne)

Définit le champ Description d’un enregistrement d’entrée de liste de documents.

Tableau 3. Paramètres

Nom	Type	Description
description	Chaîne	Description de l’entrée de la liste de documents.

Tableau 4. Renvoie

Type	Description
Néant

L’exemple suivant montre comment ajouter une description à l’entrée de la liste de documents fournie à l’aide du constructeur. Voir aussi API DocumentListEntryService .

var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');

docListEntry.description('birth');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Sortie :

{
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

SystemDocumentListEntry : document (String docSysId)

Spécifie le modèle de document à ajouter à une liste de documents.

Pour définir un document en tant que modèle :

• Définissez l’objet document en définissant la méthode SystemDocument – template() sur true. Créez ou mettez à jour l’enregistrement du document à l’aide des méthodes de l’API DocumentService .
• Cochez la case Modèle d’un document dans la table Documents [ds_document].

L’enregistrement de document spécifié doit avoir une version. Utilisez les API suivantes pour définir et ajouter une version de document :

• SystemDocumentVersion : définit une version de document.
• DocumentVersionService : ajoutez, mettez à jour ou supprimez une version de document.

Tableau 5. Paramètres

Nom	Type	Description
ID docSysId	Chaîne	Sys_id d’un enregistrement de document dans la table Documents [ds_document]. Le document spécifié doit être un modèle et avoir une version.

Tableau 6. Renvoie

Type	Description
Néant

L’exemple suivant montre comment ajouter un modèle de document en tant qu’entrée de liste de documents. Voir aussi API DocumentListEntryService.

var docListEntry = new sn_doc_services.SystemDocumentListEntry('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document("9acd7fea24587410f877a6fed1c2b060");
docListEntry.description('birth certificate');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Sortie :

{
  "message": "Create List Entry , List Entry sysId : d3f0b13624e8fc10f877a6fed1c2b0d9is successful.",
  "request_id": "d3f0b13624e8fc10f877a6fed1c2b0d9",
  "status": "success"
}

SystemDocumentListEntry : documentList(String listSysId)

Spécifie la liste de documents dans laquelle ajouter un document.

Remarque :

Vous pouvez également définir la liste de documents en tant que paramètre dans le constructeur SystemDocumentListEntry().

Utilisez les API suivantes pour définir et créer une liste de documents :

• SystemDocumentList : définit une liste de documents.
• DocumentListService – Ajouter, mettre à jour ou supprimer une liste de documents.

Tableau 7. Paramètres

Nom	Type	Description
listSysId (ID système)	Chaîne	Sys_id d’un enregistrement de liste de documents dans la table Listes de documents [ds_document_lists].

Tableau 8. Renvoie

Type	Description
Néant

L’exemple suivant montre comment définir la liste de documents dans laquelle ajouter un document. Voir aussi API DocumentListEntryService.

var docListEntry = new sn_doc_services.SystemDocumentListEntry();

docListEntry.documentList('21afddea2460fc10f877a6fed1c2b0dd');
docListEntry.document('deaef1ce24103410f877a6fed1c2b085');
docListEntry.description('passport');

var dlEntrySvc = new sn_doc_services.DocumentListEntryService();
gs.info(JSON.stringify(dlEntrySvc.createDocumentListEntry(docListEntry), null, 2));

Sortie :

{
  "message": "Create List Entry , List Entry sysId : c4ccaa8b24283050f877a6fed1c2b003is successful.",
  "request_id": "c4ccaa8b24283050f877a6fed1c2b003",
  "status": "success"
}