DocumentListService – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer

    • Die DocumentListService -API stellt Methoden zum Erstellen, Löschen und Aktualisieren einer Dokumentliste 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.

    Das Plugin Document Management unterstützt auch das Erstellen von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente erfordert, z. B. ein Diplom, einen Personalausweis oder einen 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 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].
    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 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].

    Siehe auch SystemDocumentList.

    DocumentListService – createDocumentList(SystemDocumentList doc)

    Erstellt eine Dokumentliste in der Dokumentlistentabelle [ds_document_lists].

    Das Plugin Document Management unterstützt auch das Erstellen von Listen von Dokumentvorlagen, die Ihrem Dokument zugeordnet werden sollen. Zum Beispiel eine Bewerbung, die mehrere Dokumente erfordert, z. B. ein Diplom, einen Personalausweis oder einen Reisepass. Nachdem Sie Ihre Dokumentliste hinzugefügt haben, können Sie Dokumentvorlagen hinzufügen:

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

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    doc Systemdokumentliste Eine oder mehrere Eigenschaften, die Felder eines neuen Datensatzes darstellen. Die name-Eigenschaft ist erforderlich und kann mit dem SystemDocumentList- Konstruktor oder der name()- Methode festgelegt werden.
    Tabelle : 2. Ergebnisse
    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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Dokumentlistentabelle [ds_document_lists].

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

    Datentyp: Zeichenfolge

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

    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(String listSysId, String tableName, String tableSysId)

    Erstellt Dokumente aus einer Liste von Dokumentvorlagen.

    Hinweis:
    Erstellen Sie vor der Verwendung dieser Methode eine Dokumentvorlagenliste mit der Methode createDocumentList().
    Tabelle : 3. Parameter
    Name Typ Beschreibung
    listSysId Zeichenfolge Sys_id eines Dokumentlistendatensatzes in der Dokumentlistentabelle [ds_document_lists].
    tableName Zeichenfolge Name der Tabelle, die den Datensatz enthält, zu dem 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 : 4. Ergebnisse
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht

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

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Dokumentlistentabelle [ds_document_lists].

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • success: Der Vorgang war erfolgreich.
    • failure – 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(String listSysId)

    Entfernt einen Dokumentdatensatz aus der Dokumentlistentabelle [ds_document_lists].

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

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Dokumentlistentabelle [ds_document_lists].

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

    Datentyp: Zeichenfolge

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

    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 – DocumentListService()

    Instanziiert ein DocumentListService -Objekt.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine

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

    var s = new sn_doc_services.DocumentListService();

    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 Dokumentlistentabelle [ds_document_lists].
    doc Systemdokument Eine oder mehrere Eigenschaften, die zu aktualisierende Dokumentlistenfelder darstellen.
    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    Objekt Erfolgs- oder Fehlermeldung. 
    {
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Datensatzes in der Dokumentlistentabelle [ds_document_lists].

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie der Name und die Beschreibung einer Dokumentliste aktualisiert werden. Siehe auch SystemDocumentList.

    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"
}