DocumentListService: Bereichsbezogen, Global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 4 Minuten Lesedauer

    • Die DocumentListService -API bietet Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste.

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

    Das Plugin Dokumentverwaltung unterstützt auch das Erstellen von Listen mit Dokumentvorlagen, die Ihrem Dokument zugeordnet werden können. Zum Beispiel eine Stellenbewerbung, die mehrere Dokumente erfordert, z. B. Abschlussdiplom, Ausweis oder Reisepass. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:
    So definieren Sie ein Dokument als Vorlage:
    • Definieren Sie das Dokumentobjekt, indem Sie die Methode „SystemDocument – template()“ auf „wahr“ festlegen. 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].
    Mit den folgenden APIs können Sie Dokumente definieren und verwalten:
    So definieren Sie ein Dokument als Vorlage:
    • Definieren Sie das Dokumentobjekt, indem Sie die Methode „SystemDocument – template()“ auf „wahr“ festlegen. 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].

    Siehe auch Systemdokumentliste.

    DocumentListService: DocumentListService()

    Instanziiert ein DocumentListService- Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein DocumentListService -Objekt instanziiert wird. Siehe auch Systemdokumentliste.

    var s = new sn_doc_services.DocumentListService();

    DocumentListService – createDocumentList(SystemDocumentList doc)

    Erstellt eine Dokumentliste in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Das Plugin Dokumentverwaltung unterstützt auch das Erstellen von Listen mit Dokumentvorlagen, die Ihrem Dokument zugeordnet werden können. Zum Beispiel eine Stellenbewerbung, die mehrere Dokumente erfordert, z. B. Abschlussdiplom, Ausweis oder Reisepass. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

    Verwenden Sie die Methode createDocumentsFromList(), um Dokumente aus der Liste der Dokumentvorlagen zu erstellen.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    doc Systemdokumentliste Eine oder mehrere Eigenschaften, die Felder eines neuen Datensatzes darstellen. Die Eigenschaft „name“ ist erforderlich und kann mit dem Konstruktor „SystemDocumentList“ oder der Methode „name()“ festgelegt werden.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Objekt Sys_id des neuen Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists] mit einer Erfolgsmeldung. Andernfalls Fehlermeldung.
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg – Der Vorgang war erfolgreich.
    • Fehler – Der Vorgang war nicht erfolgreich. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine Dokumentliste erstellt wird. Siehe auch Systemdokumentliste.

    var dL = new sn_doc_services.SystemDocumentList('My document list');

// Define the document list field
dL.description('description');

var docList = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docList.createDocumentList(dL), null, 2));
    Ausgabe:
    {
  "message": "Create List for the given name : My document list, List sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService - createDocumentsFromList(Zeichenfolge listSysId, Zeichenfolge tableName, Zeichenfolge tableSysId)

    Erstellt Dokumente aus einer Liste von Dokumentvorlagen.

    Hinweis:
    Erstellen Sie vor der Verwendung dieser Methode eine Dokumentvorlagenliste mit der Methode createDocumentList().
    Tabelle : 4. Parameter
    Name Typ Beschreibung
    listSysId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    tableName Zeichenfolge Name der Tabelle mit dem Datensatz, für den eine Liste von Dokumentvorlagenreferenzen hinzugefügt wird.
    tableSysId Zeichenfolge Sys_id des Datensatzes, der den Inhalt enthält, aus dem eine Liste von Dokumentvorlagenreferenzen hinzugefügt werden soll.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message

    Nachricht, die die Anzahl der Dokumentvorlagen in der Dokumentliste enthält.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg – Der Vorgang war erfolgreich.
    • Fehler – Der Vorgang war nicht erfolgreich. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie einem Datensatz eine Liste von Dokumentvorlagenreferenzen hinzufügen. Die Dokumentation wird einem Datensatz in der Tabelle „Incidents“ [incident] hinzugefügt.

    var result = new sn_doc_services.DocumentListService().createDocumentsFromList('21afddea2460fc10f877a6fed1c2b0dd', 'incident', 'd7158da0c0a8016700eef46c8d1f3661');
gs.info(JSON.stringify(result, null, 2));
    Ausgabe:
    {
  "message": "Created 1 document references for the given table name: incident, table sysId : d7158da0c0a8016700eef46c8d1f3661 with list SysId 21afddea2460fc10f877a6fed1c2b0dd",
  "request_id": "21afddea2460fc10f877a6fed1c2b0dd",
  "status": "success"
}

    DocumentListService – deleteDocumentList(Zeichenfolge listSysId)

    Entfernt einen Dokumentdatensatz aus der Tabelle „Dokumentlisten“ [ds_document_lists].

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    listSysId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    Tabelle : 7. Ausgabe
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg – Der Vorgang war erfolgreich.
    • Fehler – Der Vorgang war nicht erfolgreich. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie ein Dokumentlistendatensatz gelöscht wird. Siehe auch Systemdokumentliste.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.deleteDocumentList(docListID), null, 2));
    Ausgabe:
    {
  "message": "Delete List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}

    DocumentListService – updateDocumentList(String docSysId, SystemDocumentList doc)

    Aktualisiert die Feldwerte einer vorhandenen Dokumentliste.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    listSysId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].
    doc Systemdokument Eine oder mehrere Eigenschaften, die zu aktualisierende Dokumentlistenfelder darstellen.
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Tabelle „Dokumentlisten“ [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg – Der Vorgang war erfolgreich.
    • Fehler – Der Vorgang war nicht erfolgreich. message enthält Details.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie den Namen und die Beschreibung einer Dokumentliste aktualisieren. Siehe auch Systemdokumentliste.

    var docListID = 'b2c021a924683c10f877a6fed1c2b0b1';

var docListUpdate = new sn_doc_services.SystemDocumentList();
docListUpdate.name('name change');
docListUpdate.description('description update');

var docListSvc = new sn_doc_services.DocumentListService();
gs.info(JSON.stringify(docListSvc.updateDocumentList(docListID , docListUpdate), null, 2));
    Ausgabe:
    {
  "message": "Update List for the given sysId : b2c021a924683c10f877a6fed1c2b0b1 is successful.",
  "request_id": "b2c021a924683c10f877a6fed1c2b0b1",
  "status": "success"
}