SystemDocumentListEntry – Scoped, Global

Die SystemDocumentListEntry- API stellt Methoden zum Festlegen der Datensatzfelder in der Tabelle „Dokumentlisteneinträge“ [ds_document_list_entry] bereit.

Diese API erfordert das Plugin Document Management (com.snc.platform_document_management) und wird im Namespace sn_doc_services bereitgestellt. Weitere Informationen finden Sie unter Document Services.

Fügen Sie vor der Verwendung der Methoden in dieser API ein Dokument mit seiner Version hinzu, und erstellen Sie eine Dokumentliste. Verwenden Sie die DocumentListEntryService -API, um Dokumente aus einer Dokumentliste hinzuzufügen oder daraus zu entfernen.

Bevor Sie die Methoden in dieser API verwenden können, müssen Sie ein Dokument mit seinen Versionen hinzufügen und eine Dokumentliste erstellen.

• SystemDocument : Definieren Sie ein Dokumentobjekt.
• DocumentService : Dokument hinzufügen, aktualisieren oder löschen.
• SystemDocumentVersion : Definieren Sie eine Dokumentversion.
• DocumentVersionService : Dokumentversion hinzufügen, aktualisieren oder löschen.
• SystemDocumentList : Definieren Sie eine Dokumentliste.
• DocumentListService : Dokumentliste hinzufügen, aktualisieren oder löschen.

SystemDocumentListEntry – SystemDocumentListEntry(String listID)

Instantiiert ein SystemDocumentListEntry- Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
listSysId	Zeichenfolge	Sys_id eines Dokumentlistendatensatzes in der Dokumentlistentabelle [ds_document_lists].

Tabelle : 2. Ausgabe

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie ein SystemDocumentListEntry- Objekt instanziiert wird.

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

SystemDocumentListEntry – description(String description)

Legt das Beschreibungsfeld eines Dokumentlisteneintragsdatensatzes fest.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
description	Zeichenfolge	Beschreibung des Dokumentlisteneintrags.

Tabelle : 4. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie dem Dokumentlisteneintrag, der mit dem Konstruktor bereitgestellt wird, eine Beschreibung hinzugefügt wird. Siehe auch DocumentListEntryService -API.

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));

Ausgabe:

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

SystemDocumentListEntry – document(String docSysId)

Gibt die Dokumentvorlage an, die einer Dokumentliste hinzugefügt werden soll.

So definieren Sie ein Dokument als Vorlage:

• Definieren Sie das Dokumentobjekt, indem Sie die SystemDocument – template()- Methode auf true setzen. Erstellen oder aktualisieren Sie den Dokumentdatensatz mit den Methoden in der DocumentService -API.
• Aktivieren Sie das Kontrollkästchen Vorlage eines Dokuments in der Tabelle „Dokumente“ [ds_document].

Der angegebene Dokumentdatensatz muss eine Version haben. Verwenden Sie die folgenden APIs, um eine Dokumentversion zu definieren und hinzuzufügen:

• SystemDocumentVersion : Definieren Sie eine Dokumentversion.
• DocumentVersionService : Dokumentversion hinzufügen, aktualisieren oder löschen.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
docSysId	Zeichenfolge	Sys_id eines Dokumentdatensatzes in der Tabelle „Dokumente“ [ds_document]. Das angegebene Dokument muss eine Vorlage sein und eine Version haben.

Tabelle : 6. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie eine Dokumentvorlage als Dokumentlisteneintrag hinzugefügt wird. Siehe auch DocumentListEntryService-API.

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));

Ausgabe:

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

SystemDocumentListEntry – documentList(String listSysId)

Gibt die Dokumentliste an, in der ein Dokument hinzugefügt werden soll.

Hinweis:

Alternativ können Sie die Dokumentliste als Parameter im SystemDocumentListEntry()- Konstruktor festlegen.

Verwenden Sie die folgenden APIs, um eine Dokumentliste zu definieren und zu erstellen:

• SystemDocumentList : Definieren Sie eine Dokumentliste.
• DocumentListService : Dokumentliste hinzufügen, aktualisieren oder löschen.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
listSysId	Zeichenfolge	Sys_id eines Dokumentlistendatensatzes in der Dokumentlistentabelle [ds_document_lists].

Tabelle : 8. Ausgabe

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie Sie die Dokumentliste festlegen, in der ein Dokument hinzugefügt werden soll. Siehe auch DocumentListEntryService-API.

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));

Ausgabe:

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