PDFGenerationAPI: Bereichsbezogen, global

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

    • Die PDFGenerationAPI bietet Unterstützung für die PDF-Konvertierung und die Verarbeitung von PDF-Feldern.

    Diese API ist Teil des Plugins ServiceNow PDF Generierung Utilities (com.snc.apppdfgenerator) und wird im Namespace sn_pdfgeneratorutils bereitgestellt. Das Plugin ist standardmäßig aktiviert.

    Verwenden Sie die Eigenschaft glide.pdf.url.whitelist, um eine zusätzliche Validierungsebene hinzuzufügen, um sicherzustellen, dass eine eingeführte externe URL in die generierte PDF-Datei aufgenommen werden soll. Wenn die Systemeigenschaft glide.pdf.url.whitelisting.enabled auf „wahr“ festgelegt ist, verarbeitet die PDF-Datei keine URL-Inhalte, es sei denn, sie sind im Feld „Wert“ der Systemeigenschaft „com.snc.pdf.whitelisted_urls“ aufgeführt. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt. Weitere Informationen finden Sie unter Available system properties.

    Die Methoden in dieser Klasse ermöglichen die folgenden Aufgaben:
    Hinweis:
    Diese Methoden können auch für Dokumente verwendet werden, die von Nicht-Katalogelementen erstellt wurden.
    Zugehörige APIs:

    PDFGenerationAPI – PDFGenerationAPI()

    Instanziiert ein neues PDFGenerationAPI- Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Beispiel zeigt, wie ein PDFGenerationAPI- Objekt erstellt wird.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

    PDFGenerationAPI – konvertierenZuPDF(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Zeichenfolge SchriftartFamilySysId, Objekt documentConfiguration)

    Konvertiert eine HTML-Zeichenfolge in ein PDF-Dokument.

    Mit dieser Methode wird eine PDF-Datei mit der Seitengröße A4 – 595 x 842 Punkte erstellt. Inhalt wird gekürzt, wenn er diese Größe überschreitet.

    Um eine PDF-Datei mit zusätzlichen Einstellungen wie Seitengröße, Ausrichtung und Seitenzahlen zu generieren, verwenden Sie konvertierenzuPDFMitHeaderFooter().

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML, das in ein PDF-Dokument konvertiert werden soll.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF-Datei angehängt werden soll.
    targetTableSysId Zeichenfolge Sys_id des Datensatzes, an den die konvertierte PDF-Datei angehängt werden soll.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    „SchriftartFamilieSysId“ Zeichenfolge Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftartfamilie für PDF-Generierung“ [sys_pdf_generation_font_family].

    Standard: keiner
    documentConfiguration Objekt Optional. Objekt, das eine Inhaltsverzeichniskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    documentConfiguration.accessibilityEnabled Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind in der PDF-Tag-Struktur Barrierefreiheits-Tags verfügbar, um Anwendern zu helfen, die Sprachausgabeprogramme verwenden, um in den generierten PDF-Dokumenten zu navigieren, sie zu verstehen und mit ihnen zu interagieren.
    Gültige Werte:
    • „wahr“: Die generierte PDF-Datei wird für Barrierefreiheit formatiert.
    • „falsch“: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    documentConfiguration.toc_config Zeichenfolge Optional. Sys_id der Inhaltsverzeichniskonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Konfiguration des Inhaltsverzeichnisses“ [doc_toc_config].

    Standard: keiner
    documentConfiguration.page_number_config Zeichenfolge Optional. Sys_id der Seitenzahlkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Seitenzahlkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 3. Ausgabe
    Typ Beschreibung
    Objekt Objekt, das die sys_id des PDF-Anhangs enthält, wenn die Konvertierung erfolgreich ist, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn die HTML-Konvertierung erfolgreich ist, sys_id der konvertierten und angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind.
    • Konvertierung war erfolgreich. – Der HTML-Code wurde erfolgreich in eine PDF-Datei konvertiert.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.
    • <URL>ist nicht in der URL auf der weißen Liste aufgeführt. Überprüfen Sie die Eigenschaft für die weiße Liste der URL: „glide.pdf.url.whitelisting.enabled“ und „com.snc.pdf.whitelisted_urls“ – Wenn die Systemeigenschaft glide.pdf.url.whitelisting.enabled auf „wahr“ festgelegt ist, verarbeitet die PDF-Datei keine URL-Inhalte, es sei denn, sie sind im Feld „Wert“ der Systemeigenschaft „com.snc.pdf.whitelisted_urls“ aufgeführt. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Change-Ersteller-Anforderungsdatensatzes.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie HTML in eine PDF-Datei konvertiert und an einen Datensatz in der Incident-Tabelle [incident] angehängt wird.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var result = v.convertToPDF(html, "incident", "<target_sys_id>", "myPDF");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<sys_id>","message":"Conversion is successful.","request_id":"<change_sys_id>","status":"success"}

    PDFGenerationAPI – konvertierenZuPDFAsync(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Zeichenfolge SchriftartFamilySysId, Objekt documentConfiguration)

    Stellt einen Auftrag bereit, der eine HTML-Zeichenfolge asynchron in ein PDF-Dokument konvertiert. Durch die asynchrone Verarbeitung können Sie in der Instanz arbeiten, während die PDF-Konvertierung ausgeführt wird. Dies ist besonders hilfreich für größere PDF-Exporte.

    Diese API erstellt eine PDF-Datei mit der Seitengröße A4 – 595 x 842 Punkte. Inhalt wird gekürzt, wenn er diese Größe überschreitet.

    Um eine PDF-Datei mit zusätzlichen Einstellungen wie Seitengröße, Ausrichtung und Seitenzahlen zu generieren, verwenden Sie konvertieren zu PDFWithHeaderFooterAsync().

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML, das in ein PDF-Dokument konvertiert werden soll.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF-Datei angehängt werden soll.
    targetTableSysId Zeichenfolge Sys_id des Datensatzes, an den die konvertierte PDF-Datei angehängt werden soll.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    „SchriftartFamilieSysId“ Zeichenfolge Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftartfamilie für PDF-Generierung“ [sys_pdf_generation_font_family].

    Standard: keiner
    documentConfiguration Objekt Optional. Objekt, das eine Inhaltsverzeichniskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    documentConfiguration.accessibilityEnabled Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind in der PDF-Tag-Struktur Barrierefreiheits-Tags verfügbar, um Anwendern zu helfen, die Sprachausgabeprogramme verwenden, um in den generierten PDF-Dokumenten zu navigieren, sie zu verstehen und mit ihnen zu interagieren.
    Gültige Werte:
    • „wahr“: Die generierte PDF-Datei wird für Barrierefreiheit formatiert.
    • „falsch“: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    documentConfiguration.toc_config Zeichenfolge Optional. Sys_id der Inhaltsverzeichniskonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Konfiguration des Inhaltsverzeichnisses“ [doc_toc_config].

    Standard: keiner
    documentConfiguration.page_number_config Zeichenfolge Optional. Sys_id der Seitenzahlkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Seitenzahlkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 5. Ausgabe
    Typ Beschreibung
    Objekt Objekt, das angibt, ob die PDF-Konvertierung ausgeführt wird. Sie können den Konvertierungsstatus in der Tabelle „PDF-Generierungsstatus“ [sys_pdf_generation_status] überprüfen.
    {
  "message": "String",
  "request_id": "String"
}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • HTML-zu-PDF-Konvertierung wird ausgeführt. – Anforderung zum Konvertieren von HTML in ein PDF-Dokument ist erfolgreich.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.
    • <URL>ist nicht in der URL auf der weißen Liste aufgeführt. Überprüfen Sie die Eigenschaft für die weiße Liste der URL: „glide.pdf.url.whitelisting.enabled“ und „com.snc.pdf.whitelisted_urls“ – Wenn die Systemeigenschaft glide.pdf.url.whitelisting.enabled auf „wahr“ festgelegt ist, verarbeitet die PDF-Datei keine URL-Inhalte, es sei denn, sie sind im Feld „Wert“ der Systemeigenschaft „com.snc.pdf.whitelisted_urls“ aufgeführt. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Change-Ersteller-Anforderungsdatensatzes.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine Aufgabe, die HTML in eine PDF-Datei konvertiert, in die Warteschlange gestellt wird. Wenn die Konvertierung abgeschlossen ist, wird die PDF-Datei mit dem Namen „myPDF“ an den Zieldatensatz in der Incident-Tabelle [incident] angehängt.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var result = v.convertToPDFAsync(html, "incident", "<target_sys_id>", "myPDF");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"message":"HTML to PDF Conversion is in progress.","request_id":"<sys_id>"}

    PDFGenerationAPI – konvertieren von PDFWithHeaderFooter(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Objekt headerFooterInfo, Zeichenfolge SchriftartFamilySysId, Objekt documentConfiguration)

    Konvertiert eine HTML-Zeichenfolge in eine PDF-Datei mit Header- und Footer-Inhalt.

    Diese Methode verwenden, um PDFs mit Seiteneinstellungen zu generieren:
    • Header- und Footerinformationen
    • Randgrößen
    • Ausrichtung
    • Aufzählung
    • Seitengröße
    Tabelle : 6. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML, das in ein PDF-Dokument konvertiert werden soll.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF-Datei angehängt werden soll.
    targetTableSysId Zeichenfolge Sys_id des Datensatzes, an den die konvertierte PDF-Datei angehängt werden soll.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    headerFooterInfo Objekt Definiert Header- und Footerdetails für PDFs.
    {
  "FooterImageAlignment": "String",
  "FooterImageAttachmentId": "String",
  "FooterImageHeight": "String",
  "FooterText": "String",
  "FooterTextAlignment": "String",
  "GeneratePageNumber": "String",
  "HeaderImageAlignment": "String",
  "HeaderImageAttachmentId": "String",
  "HeaderImageHeight": "String",
  "LeftOrRightMargin": "String",
  "PageOrientation": "String",
  "PageSize": "String",
  "TopOrBottomMargin": "String"
}
    headerFooterInfo.FooterImageAlignment Zeichenfolge Legt die Bildposition in der Fußzeile fest.
    Gültige Werte:
    • BOTTOM_CENTER: Positioniert das Bild unten in der Mitte der Fußzeile.
    • BOTTOM_LEFT: Positionieren Sie das Bild im unteren linken Bereich der Fußzeile.
    • BOTTOM_Rright: Positioniert das Bild im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positioniert das Bild oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positioniert das Bild im oberen linken Bereich der Fußzeile.
    • TOP_Rright: Positioniert das Bild im oberen rechten Bereich der Fußzeile.
    headerFooterInfo.​FooterImageAttachmentId Zeichenfolge Sys_id des Fußzeilenbilds in der Tabelle „Anhänge“ [sys_attachment] Um zu ermitteln, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften, Sicherheit, und überprüfen Sie, ob er im Feld Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können aufgeführt ist.
    headerFooterInfo.FooterImageHeight Zeichenfolge Höhe des Fußzeilenbilds.

    Standard: 50 Punkte
    headerFooterInfo.​FooterText Zeichenfolge Fußzeilentext, der am unteren Rand jeder PDF-Seite platziert werden soll.
    headerFooterInfo.​FooterTextAlignment Zeichenfolge Legt die Textposition in der Fußzeile fest. Stellen Sie sicher, dass dieser Wert nicht mit dem in headerFooterInfo.FooterImageAlignmentangegebenen Gebiet übereinstimmt oder mit diesem in Konflikt steht.
    Gültige Werte:
    • BOTTOM_CENTER: Positionieren Sie den Text unten in der Mitte der Fußzeile.
    • BOTTOM_LEFT: Positionieren Sie den Text im unteren linken Bereich der Fußzeile.
    • BOTTOM_Rright: Positionieren Sie den Text im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positionieren Sie den Text oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positionieren Sie den Text im oberen linken Bereich der Fußzeile.
    • TOP_Rright: Positionieren Sie den Text im oberen rechten Bereich der Fußzeile.
    headerFooterInfo.​GeneratePageNumber Zeichenfolge Kennzeichnung, die angibt, ob eine PDF-Seitenzahl generiert werden soll.
    Gültige Werte:
    • „wahr“: Seitenzahlen generieren.
    • „falsch“: Seitenzahlen werden nicht generiert.

    Standardwert: wahr
    headerFooterInfo.HeaderImageAlignment Zeichenfolge Legt die Bildposition im Header fest.
    Gültige Werte:
    • Mitte: Positioniert das Bild in der Mitte des Headers.
    • links: Positionieren Sie das Bild auf der linken Seite des Headers.
    • rechts: Positionieren Sie das Bild auf der rechten Seite des Headers.
    headerFooterInfo.​HeaderImageAttachmentId Zeichenfolge Sys_id des Headerbilds in der Tabelle „Anhänge“ [sys_attachment]. Um zu ermitteln, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften, Sicherheit, und überprüfen Sie, ob er im Feld Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können aufgeführt ist.
    headerFooterInfo.​HeaderImageHeight Zeichenfolge Höhe des Headerbilds.

    Standard: 50 Punkte
    headerFooterInfo.​LeftOrRechterRand Zeichenfolge Größe des linken und rechten Rands. Bei Positionierung auf der linken oder rechten Seite werden die Header-/Footer-Details in diesem Bereich platziert.

    Standard: 36 Punkte
    headerFooterInfo.​Seitenausrichtung Zeichenfolge Seitenausrichtung.
    Gültige Werte:
    • PORTRÄT
    • LANDSCAP

    Standard: Hochformat
    headerFooterInfo.​Seitengröße Zeichenfolge Seitengröße des Dokuments.
    Gültige Werte:
    • A4: 595 x 842 Punkte
    • BRIEF – 612 x 792 Punkte
    • Hauptbuch – 792 x 1224 Punkte

    Inhalt wird gekürzt, wenn er die Seitengröße überschreitet.
    headerFooterInfo.​TopOrBidentumMargin Zeichenfolge Größe der oberen und unteren Ränder. Header- und Footer-Details werden innerhalb dieses Bereichs platziert.

    Standard: 72 Punkte
    „SchriftartFamilieSysId“ Zeichenfolge Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftartfamilie für PDF-Generierung“ [sys_pdf_generation_font_family].

    Standard: keiner
    documentConfiguration Objekt Optional. Objekt, das eine Inhaltsverzeichniskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    documentConfiguration.accessibilityEnabled Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind in der PDF-Tag-Struktur Barrierefreiheits-Tags verfügbar, um Anwendern zu helfen, die Sprachausgabeprogramme verwenden, um in den generierten PDF-Dokumenten zu navigieren, sie zu verstehen und mit ihnen zu interagieren.
    Gültige Werte:
    • „wahr“: Die generierte PDF-Datei wird für Barrierefreiheit formatiert.
    • „falsch“: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    documentConfiguration.toc_config Zeichenfolge Optional. Sys_id der Inhaltsverzeichniskonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Konfiguration des Inhaltsverzeichnisses“ [doc_toc_config].

    Standard: keiner
    documentConfiguration.page_number_config Zeichenfolge Optional. Sys_id der Seitenzahlkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Seitenzahlkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Objekt Objekt, das die sys_id des PDF-Anhangs enthält, wenn die Konvertierung erfolgreich ist, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "request_id": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn die HTML-Konvertierung erfolgreich ist, sys_id der konvertierten und angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.​Nachricht Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind.
    • Konvertierung war erfolgreich. – Der HTML-Code wurde erfolgreich in eine PDF-Datei konvertiert.
    • Fußzeilenbildausrichtung und Textausrichtung dürfen sich nicht im selben Bereich mit derselben Ausrichtung befinden:<footerImageAlignment value> – Stellen Sie sicher, dass sich die Werte headerFooterInfo.​FooterImageAlignment und headerFooterInfo.​FooterTextAlignment nicht im selben Bereich befinden.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Ungültige Ausrichtung des Fußzeilenbilds:<invalid_option> wird bereitgestellt. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​FooterImageAlignment an.
    • Ungültige Ausrichtung des Fußzeilentexts: „+“.<invalid_option> + " wird angegeben. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​footerTextAlignment an.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Fußzeilenbild kann nicht abgerufen werden. sysId: +<value provided> – Stellen Sie sicher, dass die für headerFooterInfo.​footerImageId angegebene sys_id korrekt ist.
    • Das Headerbild kann nicht abgerufen werden. sysId: +<value provided> – Stellen Sie sicher, dass die für headerFooterInfo.​headerImageId angegebene sys_id korrekt ist.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.
    • <URL>ist nicht in der URL auf der weißen Liste aufgeführt. Überprüfen Sie die Eigenschaft für die weiße Liste der URL: „glide.pdf.url.whitelisting.enabled“ und „com.snc.pdf.whitelisted_urls“ – Wenn die Systemeigenschaft glide.pdf.url.whitelisting.enabled auf „wahr“ festgelegt ist, verarbeitet die PDF-Datei keine URL-Inhalte, es sei denn, sie sind im Feld „Wert“ der Systemeigenschaft „com.snc.pdf.whitelisted_urls“ aufgeführt. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Change-Ersteller-Anforderungsdatensatzes.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie HTML in eine PDF-Datei mit dem Namen „myPDF“ konvertiert und die PDF-Datei als Anhang zu einem Datensatz in der Incident-Tabelle [incident] hinzugefügt wird. Die PDF-Datei enthält einen Header und einen Footer, die als Anhang bereitgestellt werden.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var hfInfo = new Object();
hfInfo["HeaderImageAttachmentId"] = "<hdrImgAttSysId>";
hfInfo["HeaderImageAlignment"] = "left";
hfInfo["FooterImageAttachmentId"] = "<ftrImgAttSysId>";
hfInfo["FooterImageAlignment"] = "TOP_CENTER";
hfInfo["FooterText"] = "Sample Footer Message";
hfInfo["PageSize"] = "A4";
hfInfo["GeneratePageNumber"] = "false";
hfInfo["TopOrBottomMargin"] = "36";
hfInfo["LeftOrRightMargin"] = "24";

var result = v.convertToPDFWithHeaderFooter(html, "incident", "<targetTbl_sys_id>", "myPDF", hfInfo);
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<sys_id>","message":"Conversion is successful.","request_id":"<change_sys_id>","status":"success"}

    PDFGenerationAPI – konvertieren von PDFWithHeaderFooterAsync(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Objekt headerFooterInfo, Zeichenfolge SchriftartFamilySysId, Objekt documentConfiguration)

    Stellt einen Auftrag bereit, der eine HTML-Zeichenfolge asynchron in eine PDF-Datei mit Header- und Footer-Inhalt konvertiert. Durch die asynchrone Verarbeitung können Sie in der Instanz arbeiten, während die PDF-Konvertierung ausgeführt wird. Dies ist besonders hilfreich für größere PDF-Exporte.

    Diese Methode verwenden, um PDFs mit Seiteneinstellungen zu generieren:
    • Header- und Footerinformationen
    • Randgrößen
    • Ausrichtung
    • Aufzählung
    • Seitengröße
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML, das in ein PDF-Dokument konvertiert werden soll.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF-Datei angehängt werden soll.
    targetTableSysId Zeichenfolge Sys_id des Datensatzes, an den die konvertierte PDF-Datei angehängt werden soll.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    headerFooterInfo Objekt Definiert Header- und Footerdetails für PDFs.
    {
  "FooterImageAlignment": "String",
  "FooterImageAttachmentId": "String",
  "FooterImageHeight": "String",
  "FooterText": "String",
  "FooterTextAlignment": "String",
  "GeneratePageNumber": "String",
  "HeaderImageAlignment": "String",
  "HeaderImageAttachmentId": "String",
  "HeaderImageHeight": "String",
  "LeftOrRightMargin": "String",
  "PageOrientation": "String",
  "PageSize": "String",
  "TopOrBottomMargin": "String"
}
    headerFooterInfo.FooterImageAlignment Zeichenfolge Legt die Bildposition in der Fußzeile fest.
    Gültige Werte:
    • BOTTOM_CENTER: Positioniert das Bild unten in der Mitte der Fußzeile.
    • BOTTOM_LEFT: Positionieren Sie das Bild im unteren linken Bereich der Fußzeile.
    • BOTTOM_Rright: Positioniert das Bild im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positioniert das Bild oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positioniert das Bild im oberen linken Bereich der Fußzeile.
    • TOP_Rright: Positioniert das Bild im oberen rechten Bereich der Fußzeile.
    headerFooterInfo.​FooterImageAttachmentId Zeichenfolge Sys_id des Fußzeilenbilds in der Tabelle „Anhänge“ [sys_attachment] Um zu ermitteln, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften, Sicherheit, und überprüfen Sie, ob er im Feld Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können aufgeführt ist.
    headerFooterInfo.FooterImageHeight Zeichenfolge Höhe des Fußzeilenbilds.

    Standard: 50 Punkte
    headerFooterInfo.​FooterText Zeichenfolge Fußzeilentext, der am unteren Rand jeder PDF-Seite platziert werden soll.
    headerFooterInfo.​FooterTextAlignment Zeichenfolge Legt die Textposition in der Fußzeile fest. Stellen Sie sicher, dass dieser Wert nicht mit dem in headerFooterInfo.FooterImageAlignmentangegebenen Gebiet übereinstimmt oder mit diesem in Konflikt steht.
    Gültige Werte:
    • BOTTOM_CENTER: Positionieren Sie den Text unten in der Mitte der Fußzeile.
    • BOTTOM_LEFT: Positionieren Sie den Text im unteren linken Bereich der Fußzeile.
    • BOTTOM_Rright: Positionieren Sie den Text im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positionieren Sie den Text oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positionieren Sie den Text im oberen linken Bereich der Fußzeile.
    • TOP_Rright: Positionieren Sie den Text im oberen rechten Bereich der Fußzeile.
    headerFooterInfo.​GeneratePageNumber Zeichenfolge Kennzeichnung, die angibt, ob eine PDF-Seitenzahl generiert werden soll.
    Gültige Werte:
    • „wahr“: Seitenzahlen generieren.
    • „falsch“: Seitenzahlen werden nicht generiert.

    Standardwert: wahr
    headerFooterInfo.HeaderImageAlignment Zeichenfolge Legt die Bildposition im Header fest.
    Gültige Werte:
    • Mitte: Positioniert das Bild in der Mitte des Headers.
    • links: Positionieren Sie das Bild auf der linken Seite des Headers.
    • rechts: Positionieren Sie das Bild auf der rechten Seite des Headers.
    headerFooterInfo.​HeaderImageAttachmentId Zeichenfolge Sys_id des Headerbilds in der Tabelle „Anhänge“ [sys_attachment]. Um zu ermitteln, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften, Sicherheit, und überprüfen Sie, ob er im Feld Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können aufgeführt ist.
    headerFooterInfo.​HeaderImageHeight Zeichenfolge Höhe des Headerbilds.

    Standard: 50 Punkte
    headerFooterInfo.​LeftOrRechterRand Zeichenfolge Größe des linken und rechten Rands. Bei Positionierung auf der linken oder rechten Seite werden die Header-/Footer-Details in diesem Bereich platziert.

    Standard: 36 Punkte
    headerFooterInfo.​Seitenausrichtung Zeichenfolge Seitenausrichtung.
    Gültige Werte:
    • PORTRÄT
    • LANDSCAP

    Standard: Hochformat
    headerFooterInfo.​Seitengröße Zeichenfolge Seitengröße des Dokuments.
    Gültige Werte:
    • A4: 595 x 842 Punkte
    • BRIEF – 612 x 792 Punkte
    • Hauptbuch – 792 x 1224 Punkte

    Inhalt wird gekürzt, wenn er die Seitengröße überschreitet.
    headerFooterInfo.​TopOrBidentumMargin Zeichenfolge Größe der oberen und unteren Ränder. Header- und Footer-Details werden innerhalb dieses Bereichs platziert.

    Standard: 72 Punkte
    „SchriftartFamilieSysId“ Zeichenfolge Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftartfamilie für PDF-Generierung“ [sys_pdf_generation_font_family].

    Standard: keiner
    documentConfiguration Objekt Optional. Objekt, das eine Inhaltsverzeichniskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    documentConfiguration.accessibilityEnabled Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind in der PDF-Tag-Struktur Barrierefreiheits-Tags verfügbar, um Anwendern zu helfen, die Sprachausgabeprogramme verwenden, um in den generierten PDF-Dokumenten zu navigieren, sie zu verstehen und mit ihnen zu interagieren.
    Gültige Werte:
    • „wahr“: Die generierte PDF-Datei wird für Barrierefreiheit formatiert.
    • „falsch“: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    documentConfiguration.toc_config Zeichenfolge Optional. Sys_id der Inhaltsverzeichniskonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Konfiguration des Inhaltsverzeichnisses“ [doc_toc_config].

    Standard: keiner
    documentConfiguration.page_number_config Zeichenfolge Optional. Sys_id der Seitenzahlkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Seitenzahlkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Objekt
    <Object>.​Nachricht Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • HTML-zu-PDF-Konvertierung wird ausgeführt. – Anforderung zum Konvertieren von HTML in ein PDF-Dokument ist erfolgreich.
    • Fußzeilenbildausrichtung und Textausrichtung dürfen sich nicht im selben Bereich mit derselben Ausrichtung befinden:<footerImageAlignment value> – Stellen Sie sicher, dass sich die Werte headerFooterInfo.​FooterImageAlignment und headerFooterInfo.​FooterTextAlignment nicht im selben Bereich befinden.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Ungültige Ausrichtung des Fußzeilenbilds:<invalid_option> wird bereitgestellt. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​FooterImageAlignment an.
    • Ungültige Ausrichtung des Fußzeilentexts: „+“.<invalid_option> + " wird angegeben. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​footerTextAlignment an.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Fußzeilenbild kann nicht abgerufen werden. sysId: +<value provided> – Stellen Sie sicher, dass die für headerFooterInfo.​footerImageId angegebene sys_id korrekt ist.
    • Das Headerbild kann nicht abgerufen werden. sysId: +<value provided> – Stellen Sie sicher, dass die für headerFooterInfo.​headerImageId angegebene sys_id korrekt ist.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.
    • <URL>ist nicht in der URL auf der weißen Liste aufgeführt. Überprüfen Sie die Eigenschaft für die weiße Liste der URL: „glide.pdf.url.whitelisting.enabled“ und „com.snc.pdf.whitelisted_urls“ – Wenn die Systemeigenschaft glide.pdf.url.whitelisting.enabled auf „wahr“ festgelegt ist, verarbeitet die PDF-Datei keine URL-Inhalte, es sei denn, sie sind im Feld „Wert“ der Systemeigenschaft „com.snc.pdf.whitelisted_urls“ aufgeführt. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.request_id Sys_id des Change-Ersteller-Anforderungsdatensatzes.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie eine Aufgabe, die HTML in eine PDF-Datei konvertiert, in die Warteschlange gestellt wird. Die PDF-Datei enthält einen Header und einen Footer, die als Anhang bereitgestellt werden. Wenn die Konvertierung abgeschlossen ist, wird die PDF-Datei mit dem Namen „myPDF“ an den Zieldatensatz in der Incident-Tabelle [incident] angehängt.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

//  (Option) get HTML from the description field of an incident record
var gr = new GlideRecord("incident");
var html;

if (gr.get("<tableSysId>")) {
 html = gr.description.toString();
}

var hfInfo = new Object();
hfInfo["HeaderImageAttachmentId"] = "<hdrImgAttSysId>";
hfInfo["HeaderImageAlignment"] = "left";
hfInfo["FooterImageAttachmentId"] = "<ftrImgAttSysId>";
hfInfo["FooterImageAlignment"] = "TOP_CENTER";
hfInfo["FooterText"] = "Sample Footer Message";
hfInfo["PageSize"] = "A4";
hfInfo["GeneratePageNumber"] = "false";
hfInfo["TopOrBottomMargin"] = "36";
hfInfo["LeftOrRightMargin"] = "24";

var result = v.convertToPDFWithHeaderFooterAsync(html, "incident", "<targetTbl_sys_id>", "myPDF", hfInfo);
gs.info(JSON.stringify(result));

    Ausgabe:

    {"message":"HTML to PDF Conversion is in progress.","request_id":"<sys_id>"}

    PDFGenerationAPI –fillDocumentFields(ObjektfieldsMap, Zeichenfolge sysId, Zeichenfolge tableName, Zeichenfolge tableSysId, Zeichenfolge pdfName)

    Füllt Felder in einer bearbeitbaren PDF-Datei aus und hängt sie an den angegebenen Datensatz an.

    Verwenden Sie die folgenden Methoden, um zu bestimmen, ob die PDF-Datei ausfüllbar ist, und um Feldinformationen abzurufen:
    PDFGenerationAPI bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    • fillDocumentFieldsAndFlatten() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.
    • fillFieldsAndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt es an den bereitgestellten Datensatz an.
    • getFilledDocumentWithSignatureAsBase64() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    felderzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die getDocumentFields() -Methode, um die Liste der verfügbaren Felder abzurufen.
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    tableName Zeichenfolge Name der Tabelle, die den Datensatz enthält, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    tableSysId Zeichenfolge Sys_id des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Tabelle : 11. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aktualisierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn der Vorgang erfolgreich ist, sys_id der ausgefüllten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Felder in einer bearbeitbaren PDF-Datei ausgefüllt werden.

    var fieldMap = new Object();
fieldMap["Address"] = "Address value here";
fieldMap["State"] = "State value here";

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillDocumentFields(fieldMap, "<attachmentSysId>", "<tableName>", "<tableSysId>", "pdfName");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<sys_id>","message":"Request completed successfully.","status":"success"}

    PDFGenerationAPI –fillDocumentFieldsAndFlatten(Objekt „fieldsMap“, Zeichenfolge „sysId“, Zeichenfolge „tableName“, Zeichenfolge „tableSysId“, Zeichenfolge „pdfName“, „Objekt reduzieren“)

    Füllt Felder in einer bearbeitbaren PDF-Datei aus, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.

    Verwenden Sie die folgenden Methoden, um zu bestimmen, ob die PDF-Datei ausfüllbar ist, und um Feldinformationen abzurufen:
    PDFGenerationAPI bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    • fillDocumentFields() – Füllt Felder in einer bearbeitbaren PDF-Datei aus und hängt sie an den angegebenen Datensatz an.
    • fillFieldsAndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt es an den bereitgestellten Datensatz an.
    • getFilledDocumentWithSignatureAsBase64() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.
    Tabelle : 12. Parameter
    Name Typ Beschreibung
    felderzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die getDocumentFields() -Methode, um die Liste der verfügbaren Felder abzurufen.
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    tableName Zeichenfolge Name der Tabelle, die den Datensatz enthält, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    tableSysId Zeichenfolge Sys_id des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    abflachen Objekt Optional. Durch das Reduzieren von Feldern können Sie die Felder sperren, damit andere Benutzer die Informationen nicht ändern können. Geben Sie den Schlüssel als „FlattenType“ an, und geben Sie eine Reduzierungsoption als Zeichenfolge an.
    Gültige Werte:
    • donot_platten: Keine Felder reduzieren.
    • Partielles Flatten: Nur die Felder reduzieren, die geändert werden.
    • vollwertig_platten: Verringert alle Felder.

    Standard: vollwertig_platten

    {
  "FlattenType": "String" 
}
    Tabelle : 13. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aktualisierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn der Vorgang erfolgreich ist, sys_id der ausgefüllten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Felder ausgefüllt und eine bearbeitbare PDF-Datei reduziert werden.

    var fieldMap = new Object();
fieldMap["Last Name First Name Middle Initial"] = "Tuter Abel E.";
fieldMap["Date of Birth"] = "08101952";
fieldMap["US SSN"] = "111-22-9999";
fieldMap["Address"] = "PO Box 344";
fieldMap["City"] = "Jerome";
fieldMap["State"] = "AZ";
fieldMap["Zip"] = "86331";

var flatten = new Object();
flatten["FlattenType"] = "partially_flatten";

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillDocumentFieldsAndFlatten(fieldMap, "<attachmentSysId>", "<tableName>", "<tableSysId>", "pdfName", flatten);
gs.info(JSON.stringify(result));

    Ausgabe:

    "attachment_id":"<sys_id>","message":"Request completed successfully.","status":"success"

    PDFGenerationAPI –fillFieldsAndMergeSignature(Objekt fieldMap, Zeichenfolge sysId, Zeichenfolge tableName, Zeichenfolge tableSysId, Zeichenfolge pdfName, PdfMergeSignRequestor Anforderer, Objekt reduzieren)

    Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt es an den bereitgestellten Datensatz an.

    Verwenden Sie die folgenden Methoden, um zu bestimmen, ob die PDF-Datei ausfüllbar ist, und um Feldinformationen abzurufen:
    PDFGenerationAPI bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    • fillDocumentFields() – Füllt Felder in einer bearbeitbaren PDF-Datei aus und hängt sie an den angegebenen Datensatz an.
    • fillDocumentFieldsAndFlatten() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.
    • getFilledDocumentWithSignatureAsBase64() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.
    Tabelle : 14. Parameter
    Name Typ Beschreibung
    felderzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die getDocumentFields() -Methode, um die Liste der verfügbaren Felder abzurufen.
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    tableName Zeichenfolge Name der Tabelle, die den Datensatz enthält, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    tableSysId Zeichenfolge Sys_id des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    requestor PdfMergeSign​Anfordernde Person Von pdfMergeSignRequestorzurückgegebene Signatureingabe.
    abflachen Objekt Optional. Durch das Reduzieren von Feldern können Sie die Felder sperren, damit andere Benutzer die Informationen nicht ändern können. Geben Sie den Schlüssel als „FlattenType“ an, und geben Sie eine Reduzierungsoption als Zeichenfolge an.
    Gültige Werte:
    • donot_platten: Keine Felder reduzieren.
    • Partielles Flatten: Nur die Felder reduzieren, die geändert werden.
    • vollwertig_platten: Verringert alle Felder.

    Standard: vollwertig_platten

    {
  "FlattenType": "String" 
}
    Tabelle : 15. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aktualisierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn der Vorgang erfolgreich ist, sys_id der ausgefüllten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie Signaturfelder mit Standardeinstellungen ausfüllen, um die Felder vollständig zu reduzieren.

    var fieldMap = new Object();
fieldMap["Address_Salutation"] = "Address value here";

var paramMap = new Object();
paramMap["FlattenType"] = "partially_flatten";

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;
requestor.createRequest("<attachmentSysId>", "incident", "<tableSysId>", "filledPdf");
requestor.addSignatureMapping(6, 40, 50, 188, 44, "<signatureSysId>");

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.fillFieldsAndMergeSignature(fieldMap, "<attachmentSysId>", "incident", "<tableSysId>", requestor, "filledPdf", paramMap);
gs.info(JSON.stringify(result));
    Ausgabe:
    {"attachment_id":"5440d993dbed3010d66be1191396194e","message":"Request completed successfully.","status":"success"}

    PDFGenerationAPI – getDocumentFields(String sysId)

    Ruft eine Liste bearbeitbarer Felder in einem PDF-Dokument ab. Aktiviert das Auflisten bearbeitbarer PDF-Felder, ohne die Datei manuell zum Überprüfen zu öffnen.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Tabelle : 17. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der ID der signierten PDF-Datei, andernfalls Fehlermeldung. 
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.fields Wenn die Anforderung erfolgreich ist, Liste mit dem Namen jedes Felds in der PDF-Datei.

    Datentyp: Array von Zeichenfolgen

    "fields": ["field_name"]
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Felder in einem PDF-Anhang abgerufen werden.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getDocumentFields("attachmentSysId");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"message":"Request completed successfully.","fields":["NP_formFillable","reset","print","1SSN","Signature.1","5sigDate","Check Box21"],"status":"success"}

    PDFGenerationAPI – getDocumentFieldsType(String sysId)

    Ruft den Feldtyp eines Satzes bearbeitbarer Felder aus einem PDF-Dokument ab.

    Tabelle : 18. Parameter
    Name Typ Beschreibung
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Tabelle : 19. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit jedem PDF-Feldtyp bei Erfolg, andernfalls Fehlermeldung. 
    {
  "fields_type": {Object},
  "message": "String",
  "status": "String"
}
    <Object>.fields_type Objekt, das jedes Feld in der angegebenen PDF-Datei auflistet, wenn erfolgreich, andernfalls Fehlermeldung.

    Datentyp: Objekt

    "fields_type": {
  "<field type>": {Object},
}
    <Object>.fields_type.​<field> Objekt, das die Seitenzahl jedes Felds enthält. Die<field> Name stellt die Feldbezeichnung dar, z. B. „SSN“ oder eine automatisierte Bezeichnung, die den Typ darstellt.

    Datentyp: Objekt

    "<field>": { 
  "fieldsDetails": [Array], // Check boxes, radio buttons, choice boxes only
  "pageNumber": "String",
  "type": "String"
}
    <Object>.fields_type.​<field> .fieldsDetails Liste von Objekten, die den Feldnamen und den entsprechenden Wert für jede Option für Auswahlfeldtypen enthalten.
    Anwendbare Typen:
    • Checkbox
    • Auswahlfeld
    • Kombinationsfeld
    • Auswahlfeld für Mehrfachauswahl

    Datentyp: Array

    "fieldsDetails": [ 
  "fieldName": "String",
  "value": "String"
]
    <Object>.fields_type.​<field> .fieldsDetails.fieldName Name eines Auswahlfelds.

    Datentyp: Zeichenfolge
    <Object>.fields_type.​<field> .fieldsDetails.Wert Wert eines Auswahlfelds.

    Datentyp: Zeichenfolge
    <Object>.fields_type.​<field> .Seitennummer PDF-Seitenzahl, die diesem Feld entspricht.

    Datentyp: Zeichenfolge
    <Object>.fields_type.​<field> .type PDF-Feldtyp.
    Mögliche Werte:
    • check_box
    • „choice_box“
    • „combo_box“
    • multi_select_choice_box
    • push_button
    • text_button
    • signature
    • text

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Feldtypen in einem PDF-Anhang abgerufen werden. Die Ergebnisse enthalten manuelle Rückgaben für die Lesbarkeit und werden der Kürze wegen gekürzt.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getDocumentFieldsType("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"fields_type":{"1ADDLINE2.25":{"pageNumber":2,"type":"text"},"1ADDLINE2.24":{"pageNumber":2,"type":"text"},
"1ADDLINE2.23":{"pageNumber":2,"type":"text"},"1ADDLINE2.22":{"pageNumber":2,"type":"text"},
"1ADDLINE2.11":{"pageNumber":2,"type":"text"},
"Check Box1":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":2,"type":"check_box"},
"4consentDate.6":{"pageNumber":4,"type":"text"},"4consentDate.7":{"pageNumber":4,"type":"text"},
"3SSN.9":{"pageNumber":3,"type":"text"},"3SSN.8":{"pageNumber":3,"type":"text"},"3SSN.7":{"pageNumber":3,"type":"text"},
"pageNumber":2,"type":"check_box"},"Check Box8":{"fieldsDetails":[{"fieldName":"Off"},{"fieldName":"yes"}],
"4planAdminDate.8":{"pageNumber":4,"type":"text"},"4planAdminDate.7":{"pageNumber":4,"type":"text"},
"1FirstName_ID.7":{"pageNumber":2,"type":"text"},
"Check Box9":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.1":{"pageNumber":2,"type":"text"},"1LN.2":{"pageNumber":2,"type":"text"},
"Check Box11":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.9":{"pageNumber":2,"type":"text"},
"Check Box17":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"Check Box16":{"fieldsDetails":[{"fieldName":"Yes"}],"pageNumber":3,"type":"check_box"},
"1LN.7":{"pageNumber":2,"type":"text"},"Check Box19":{"fieldsDetails":[{"fieldName":"Yes"}],
"1LN.8":{"pageNumber":2,"type":"text"},"Check Box18":{"fieldsDetails":[{"fieldName":"Yes"}],
"print":{"pageNumber":2,"type":"push_button"},"4planAdministrator.1":{"pageNumber":4,"type":"text"},
"1TaxID.9":{"pageNumber":2,"type":"text"},"4SSN.1":{"pageNumber":3,"type":"text"},"4SSN.2":{"pageNumber":3,"type":"text"},
"Signature.1":{"pageNumber":4,"type":"text"},"1ZIP.2":{"pageNumber":2,"type":"text"},"1ZIP.3":{"pageNumber":2,"type":"text"},
"message":"Request completed successfully.","status":"success"}

    PDFGenerationAPI – getFilledDocumentWithSignatureAsBase64(Object FieldsMap, String sysId, PdfMergeSignRequestor Requestor, Object Flatten)

    Füllt Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.

    Mit der Base64-Codierung können Sie eine PDF-Datei als Zeichenfolge in einem Textdokument wie HTML oder JSON ausgeben, ohne die Syntax der binären Zeichen zu beschädigen.

    Verwenden Sie die folgenden Methoden, um zu bestimmen, ob die PDF-Datei ausfüllbar ist, und um Feldinformationen abzurufen:
    PDFGenerationAPI bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    • fillDocumentFields() – Füllt Felder in einer bearbeitbaren PDF-Datei aus und hängt sie an den angegebenen Datensatz an.
    • fillDocumentFieldsAndFlatten() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.
    • fillFieldsAndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt es an den bereitgestellten Datensatz an.
    Tabelle : 20. Parameter
    Name Typ Beschreibung
    felderzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die getDocumentFields() -Methode, um die Liste der verfügbaren Felder abzurufen.
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    requestor PdfMergeSign​Anfordernde Person Von pdfMergeSignRequestorzurückgegebene Signatureingabe.
    abflachen Objekt Optional. Durch das Reduzieren von Feldern können Sie die Felder sperren, damit andere Benutzer die Informationen nicht ändern können. Geben Sie den Schlüssel als „FlattenType“ an, und geben Sie eine Reduzierungsoption als Zeichenfolge an.
    Gültige Werte:
    • donot_platten: Keine Felder reduzieren.
    • Partielles Flatten: Nur die Felder reduzieren, die geändert werden.
    • vollwertig_platten: Verringert alle Felder.

    Standard: vollwertig_platten

    {
  "FlattenType": "String" 
}
    Tabelle : 21. Ausgabe
    Typ Beschreibung
    Zeichenfolge Bei Erfolg wird die in das Base64-Format konvertierte PDF-Datei der Tabelle „Anhänge“ [sys_attachment] hinzugefügt. Der Inhalt spiegelt den bereitgestellten PDF-Anhang mit ausgefüllten Feldern und Signatur wider. Die Felder können nicht bearbeitet werden, es sei denn, eine alternative Reduzierungsoption wurde mit dem Parameter flatten angegeben.
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Kein Formular mit PDF zum Ausfüllen verknüpft. Sys-ID des Anhangs:<sys_id>
    • Es sind keine bearbeitbaren Felder mit den angegebenen Namen vorhanden. Überprüfen Sie dies, und versuchen Sie es erneut. Feldnamen:<field names>
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie zwei Felder in einem PDF-Anhang laden, die Felder reduzieren und die PDF-Datei in das Base64-Format konvertieren.

    var mymap = new Object();
mymap["City"] = "City value here";
mymap["State"] = "XX";

// create a requestor
var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;
requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", "pdfName");
requestor.addSignatureMapping(6, 40, 50, 188, 44, "<signImgSysId>");
var processedRequestObj = requestor.processRequest();

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

var result = v.getFilledDocumentWithSignatureAsBase64(mymap, "<attachmentSysId>", processedRequestObj);
gs.info (JSON.stringify(result));

    PDFGenerationAPI – getPdfPageSizes(String sysId)

    Ruft die Seitengröße eines PDF-Dokuments ab.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Tabelle : 23. Ausgabe
    Typ Beschreibung
    Objekt Objekt, das bei Erfolg die Größe jeder Seite enthält, andernfalls Fehlermeldung. 
    {
  "pages_size": {Object},
  "message": "String",
  "status": "String"
}
    <Object>.pages_size Wenn der Vorgang erfolgreich ist, Breite und Höhe jeder PDF-Seite in Punkt. Die Seitenzahl wird als Zeichenfolge zurückgegeben, und die Messwerte werden als Zahlendatentypen zurückgegeben.

    Datentyp: Objekt

    "pages_size": {"<page number>":[<width>,<height>]}
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie die Breite und Höhe jeder Seite in einem PDF-Anhang angezeigt wird.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.getPdfPageSizes ("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"pages_size":{"1":[612,792],"2":[612,792],"3":[612,792],"4":[612,792],"5":[612,792]},"message":"Request completed successfully.","status":"success"}

    PDFGenerationAPI – isDocumentFillable(String sysId)

    Überprüft, ob das PDF-Dokument bearbeitbare Felder enthält.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Tabelle : 25. Ausgabe
    Typ Beschreibung
    Objekt Objekt, das bei Erfolg die Größe jeder Seite enthält, andernfalls Fehlermeldung. 
    {
  "document_editable": "String",
  "message": "String",
  "status": "String"
}
    <Object>. document_edierbar Wenn der Vorgang erfolgreich ist, gibt die Kennzeichnung an, ob das Dokument bearbeitet werden kann.
    Gültige Werte:
    • „wahr“: PDF-Dokument hat bearbeitbare Felder.
    • „falsch“: PDF-Dokument hat keine bearbeitbaren Felder.

    Datentyp: Boolescher Wert, bereitgestellt als Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie ermittelt wird, ob PDF-Dokumentfelder bearbeitbar sind.

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = v.isDocumentFillable("<attachmentSysId>");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"message":"Request completed successfully.","document_editable":"true","status":"success"}

    PDFGenerationAPI – redact(Object inputJson)

    Wendet eine Schwärzung auf ein PDF-Dokument basierend auf den angegebenen Rechteckkoordinaten und/oder Suchbegriffen an. In der Tabelle „Anhänge“ [sys_attachment] wird eine geschwärzte Kopie der ursprünglichen PDF-Datei generiert.

    Hinweis:
    • Schwärzungsergebnisse enthalten möglicherweise einen unerwarteten weißen geschwärzten Textblock, der Text überschreibt, der nicht geschwärzt werden soll. Wenn dieses Ereignis auftritt, können Sie den Inhalt für die Schwärzung manuell mit der Eigenschaft highlightedSections oder dem Plugin „Dienstprogramme zur PDF-Generierung“ auswählen. Weitere Informationen finden Sie unter Redact data from documents.
    • Diese Methode unterstützt keine Schwärzung in PDFs, die JBIG2-Bilder enthalten.
    Tabelle : 26. Parameter
    Name Typ Beschreibung
    inputJson Objekt Gibt die PDF-Datei und deren Inhalt an, die geschwärzt werden soll.
    {
  "sysId": "String",
  "highlightedSections": [Array],
  "searchedKeywords": [Array]
}
    inputJson.sysId Zeichenfolge Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    inputJson hervorgehobeneAbschnitte Array von Objekten Liste der Rechteckkoordinaten, die als Objekt bereitgestellt werden. Jede Koordinate stellt die Position des Inhalts dar, der auf jeder Seite geschwärzt werden soll.
    Optional, wenn die Eigenschaft searchedKeywords enthalten ist.
    [
   {
     "pageNumber": Number,
     "x": Number,
     "y": Number,
     "width": Number,
     "height": Number
   }
]
    inputJson hervorgehobeneAbschnitte pageNumber Nummer PDF-Seitenzahl, die den für die Schwärzung auszuwählenden Inhalt enthält.
    inputJson hervorgehobeneAbschnitte x Nummer Die X-Achse (horizontale Position) des Schwärzungsrechtecks in der PDF-Datei in Punkten. Der Wert in der linken unteren Ecke der PDF-Seite ist 0. Beispiel: Ein Wert von 306 platziert das Rechteck ungefähr in der horizontalen Mitte einer PDF-Seite im Briefformat.
    inputJson hervorgehobeneAbschnitte J Nummer Die Y-Achse (vertikale Position) des Schwärzungsrechtecks auf der PDF-Datei in Punkten. Der Wert in der linken unteren Ecke der PDF-Seite ist 0. Beispiel: Ein Wert von 396 platziert das Rechteck ungefähr in der vertikalen Mitte einer PDF-Seite im Briefformat.
    inputJson hervorgehobeneAbschnitte Breite Nummer Die Breite des Schwärzungsrechtecks wird in Punkten angegeben. Dieser Wert erhöht die Größe des Rechtecks horizontal ab dem Punkt unten links, an dem sich die x- und y-Achsen treffen.
    inputJson hervorgehobeneAbschnitte Höhe Nummer Höhe des Schwärzungsrechtecks in Punkten. Dieser Wert erhöht die Größe des Rechtecks in der Vertikalen ab dem unteren linken Punkt, an dem sich die x- und y-Achsen treffen.
    inputJson durchsuchteStichwörter Array Liste mit einer oder mehreren Zeichenfolgen, die zum Suchen von Text zur Schwärzung verwendet werden. Die Größe des Schwärzungsrechtecks entspricht der Höhe und Breite des Texts, der dadurch ausgeblendet wird.
    Optional, wenn die Eigenschaft highlightedSections enthalten ist.
    Hinweis:
    In einigen Fällen Textzeichenfolgen, die Sonderzeichen oder Interpunktion enthalten, z. B. „items:“ und „PDF“. werden nicht geschwärzt. Alternativ können Sie das Zeichen aus der Zeichenfolge entfernen oder den Bereich markieren, um den Text zu entfernen.
    Tabelle : 27. Rückgaben
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aktualisierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn der Vorgang erfolgreich ist, sys_id der ausgefüllten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Dieses Format kann nicht analysiert werden – Ein in die PDF-Datei eingebettetes Bild kann nicht verarbeitet werden. Die PDF-Datei enthält ein oder mehrere Bilder in einem nicht unterstützten Format, z. B. ein JBIG2-Bild.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Der angegebene Eingabeanhang ist keine gültige PDF-Datei. Geben Sie die richtige sys_id des Anhangs an.
    • Die Anforderung kann nicht fortgesetzt werden, da der Anhang mit der Sys_id [{0}] die Sicherheitsprüfung nicht bestanden hat – die PDF-Datei hat die Antivirenprüfung nicht bestanden.
    • Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] die Sicherheitsprüfung aussteht – Die PDF-Datei erfordert eine Virenprüfung.
    • Anforderung erfolgreich abgeschlossen – Vorgang erfolgreich.
    • Nicht definiert: Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang.

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

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie anhand von Rechteck und Stichwort geschwärzt wird. In der geschwärzten PDF-Datei sind die auf Seite 2 ausgewählten Bereiche blockiert. Die Zeichenfolge „23“ wird auf jeder Seite geschwärzt, auf der sie gefunden wird.

    var pdfRequest = {
  sysId: 'e4b3ae35fc128210f877789781ea59f3',
  highlightedSections: [
    {
      "pageNumber": 2,
      "x": 261.75,
      "y": 480,
      "width": 21,
      "height": 14.25
    },
    {
      "pageNumber": 2,
      "x": 249,
      "y": 390.75,
      "width": 63.75,
      "height": 15.75
    }
    // Add more coordinates as needed
  ],
  searchedKeywords: ['23']
};

// Convert the JSON object to a string
var jsonRequest = JSON.stringify(pdfRequest);
gs.info('JSON Request: ' + jsonRequest + '\n');

var PDFRedaction = new sn_pdfgeneratorutils.PDFGenerationAPI;
var result = PDFRedaction.redact(jsonRequest);
gs.info(JSON.stringify(result));

    Ausgabe:

    JSON Request: {"sysId":"e4b3ae35fc128210f877789781ea59f3","highlightedSections":[{"pageNumber":2,"x":261.75,"y":480,"width":21,"height":14.25},{"pageNumber":2,"x":249,"y":390.75,"width":63.75,"height":15.75}],"searchedKeywords":[23]}

{"attachment_id":"1744ae35fc128210f877789781ea59fc","message":"Request completed successfully.","status":"success"}