SystemDocument – Scoped, Global

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

    • Die SystemDocument- API stellt Methoden zum Festlegen von Feldern eines Datensatzes in der Dokumenttabelle [ds_document] 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.

    Verwenden Sie zum Erstellen eines Dokuments die DocumentService-API.

    SystemDocument – SystemDocument(String docName)

    Instantiiert ein SystemDocument- Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    docName Zeichenfolge Name des Dokuments.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein SystemDocument- Objekt instanziiert und mehrere Felder für einen Dokumentdatensatz festgelegt werden. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');

// Define the document fields
var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.description('description');
d.classification('restricted');
d.state('review');
d.department('93b25282c0a8000b0b55c8ab34e2f1e6');
d.template(false);
d.type('policy');
d.reviewers(reviewers);
d.audience('external');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 1040420224503410f877a6fed1c2b031 is successful.",
  "request_id": "1040420224503410f877a6fed1c2b031",
  "status": "success"
}

    SystemDocument – audienz(String audience)

    Legt das Feld Zielgruppe eines Dokumentdatensatzes fest, um die externe oder interne Verfügbarkeit anzugeben. Stellt das Feld Zielgruppe in einem Document Management -Formular dar.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    audience Zeichenfolge Zeichenfolge, die die beabsichtigte Zielgruppe des Dokuments darstellt.
    Mögliche Werte:
    • external
    • Intern
    Standard: intern
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Feld Zielgruppe in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService – Scoped, Global.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.audience('external');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 1193fd4624103410f877a6fed1c2b016 is successful.",
  "request_id": "1193fd4624103410f877a6fed1c2b016",
  "status": "success"
}

    SystemDocument – Klassifizierung(String Klassifizierung)

    Legt das Klassifizierungsfeld eines Dokumentdatensatzes fest, um den Grad der Informationsvertraulichkeit zu identifizieren. Stellt das Klassifizierungsfeld in einem Document Management -Formular dar.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Klassifizierung Zeichenfolge Klassifizierung des Dokuments.
    Mögliche Werte:
    • confidential
    • Öffentlich
    • restricted
    Standard: öffentlich
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Der Wert der Klassifizierungseigenschaft eines SystemDocument- Objekts.

    Das folgende Beispiel zeigt, wie das Klassifizierungsfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My restricted document');
var s = new sn_doc_services.DocumentService();

d.classification('restricted');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : d80435c624103410f877a6fed1c2b0d0 is successful.",
  "request_id": "d80435c624103410f877a6fed1c2b0d0",
  "status": "success"
}

    SystemDocument – createdFromTemplate(String docTemplate)

    Legt die Vorlage fest, aus der ein Dokument generiert werden soll. Wenn das Dokument generiert wird, wird die angegebene Vorlage im Feld Aus Vorlage erstellt in der Tabelle „Dokumente“ [ds_document_list] aufgelistet.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    docTemplate Zeichenfolge Sys_id eines Dokuments, das in der Tabelle „Dokumente“ [ds_document_list] aufgeführt ist. Für das Dokument muss das Kontrollkästchen Vorlage aktiviert sein (wahr). Siehe auch DocumentVersionService-API.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein neuer Dokumentdatensatz aus einer vorhandenen Vorlage erstellt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('New doc from template');
var s = new sn_doc_services.DocumentService();

d.createdFromTemplate('<doc_template_sys_id>');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : deaef1ce24103410f877a6fed1c2b085 is successful.",
  "request_id": "deaef1ce24103410f877a6fed1c2b085",
  "status": "success"
}

    SystemDocument –department(String docDept)

    Legt das Feld „Abteilung“ eines Dokumentdatensatzes fest.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    docDept Zeichenfolge Sys_id einer Abteilung, die in der Tabelle „Abteilungen“ [cmn_department] aufgeführt ist.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Feld „department“ in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');

// Assign the doc to the human resources department
d.department('<dept_sys_id>');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 491efbee24187410f877a6fed1c2b0a9 is successful.",
  "request_id": "491efbee24187410f877a6fed1c2b0a9",
  "status": "success"
}

    SystemDocument – description(String description)

    Legt das Beschreibungsfeld eines Dokumentdatensatzes fest.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    description Zeichenfolge Beschreibung des Dokuments.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Beschreibungsfeld in einem Dokumentdatensatz festgelegt wird. Siehe auch: DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');

d.description('Information describing the doc.');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 9acd7fea24587410f877a6fed1c2b060 is successful.",
  "request_id": "9acd7fea24587410f877a6fed1c2b060",
  "status": "success"
}

    SystemDocument – name(String docName)

    Legt das Feld Name eines Dokumentdatensatzes fest.

    Hinweis:
    Sie können den Namen auch als Parameter im SystemDocument()- Konstruktor festlegen.
    Tabelle : 13. Parameter
    Name Typ Beschreibung
    docName Zeichenfolge Name des Dokuments.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Feld Name in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument();

d.name('Document named using method instead of constructor');

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : c19d7f2624587410f877a6fed1c2b0eb is successful.",
  "request_id": "c19d7f2624587410f877a6fed1c2b0eb",
  "status": "success"
}

    SystemDocument – Owner(String Owner)

    Legt das Besitzerfeld eines Dokumentdatensatzes fest.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Eigentümer Zeichenfolge Sys_id eines Benutzers, der in der Benutzertabelle [sys_user] aufgeführt ist.

    Erforderliche Rolle: admin

    Standard: Aktueller Benutzer
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Besitzerfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.owner('aa826bf03710200044e0bfc8bcbe5dd6');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 4235318a24103410f877a6fed1c2b0ff is successful.",
  "request_id": "4235318a24103410f877a6fed1c2b0ff",
  "status": "success"
}

    SystemDocument – reviewers(String reviewers)

    Legt das Feld Prüfer eines Dokumentdatensatzes fest.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Überprüfer Zeichenfolge Liste von einem oder mehreren Dokumentüberprüfern nach sys_id. Der Prüfer muss ein Benutzer sein, der in der Benutzertabelle [sys_user] aufgeführt ist.
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Prüferfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');

var reviewers = '62826bf03710200044e0bfc8bcbe5df1,a8f98bb0eb32010045e1a5115206fe3a';
d.reviewers(reviewers);

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 8d19f9ca24103410f877a6fed1c2b0aa is successful.",
  "request_id": "8d19f9ca24103410f877a6fed1c2b0aa",
  "status": "success"
}

    SystemDocument – state(String state)

    Legt das Statusfeld eines Dokumentdatensatzes fest.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    state Zeichenfolge Status des Dokuments, der angibt, wo sich das Dokument im Workflow befindet.
    Gültige Werte:
    • Entwurf
    • absenden
    • Prüfung
    • Abschließen
    Standard: Entwurf
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Statusfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');
var s = new sn_doc_services.DocumentService();

d.state('submit');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 19aab54e24103410f877a6fed1c2b03d is successful.",
  "request_id": "19aab54e24103410f877a6fed1c2b03d",
  "status": "success"
}

    SystemDocument – template(Boolean template)

    Gibt an, ob ein Dokumentdatensatz eine Vorlage ist.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Vorlage Boolean

    Kennzeichnung, die angibt, ob ein Dokumentdatensatz eine Vorlage ist.

    Gültige Werte:
    • true: Die Standardversion dieses Dokuments ist eine Vorlage.
    • false: Dieses Dokument ist keine Vorlage.

    Standardwert: false
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie Sie angeben, dass ein Dokumentdatensatz eine Vorlage ist. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('My document');

d.template(true);

var s = new sn_doc_services.DocumentService();
gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : f7f006ce24103410f877a6fed1c2b053 is successful.",
  "request_id": "f7f006ce24103410f877a6fed1c2b053",
  "status": "success"
}

    SystemDocument – type(String docType)

    Legt das Feld Typ eines Dokumentdatensatzes fest.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    docType Zeichenfolge Typ des Dokuments.
    Gültige Werte:
    • contract
    • guideline
    • policy
    • procedure
    Standard: Keine
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie das Typfeld in einem neuen Dokumentdatensatz festgelegt wird. Siehe auch DocumentService-API.

    var d = new sn_doc_services.SystemDocument('How to use the document mgmt API');
var s = new sn_doc_services.DocumentService();

d.type('guideline');

gs.info(JSON.stringify(s.createDocument(d), null, 2));
    Ausgabe:
    {
  "message": "Create document sysId : 8adfb10224503410f877a6fed1c2b0e4 is successful.",
  "request_id": "8adfb10224503410f877a6fed1c2b0e4",
  "status": "success"
}