PDFGenerationAPI: Bereichsbezogen, Global

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 40 Minuten Lesedauer

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

    Diese API ist Teil von ServiceNow Plugin „PDF-Generierungsdienstprogramme“ (com.snc.apppdfgenerator) und wird in bereitgestellt sn_pdfgeneratorutils Namespace. Das Plugin ist standardmäßig aktiviert.

    Verwenden Sie glide.pdf.url.whitelistEigenschaft zum Hinzufügen einer zusätzlichen Validierungsebene, um sicherzustellen, dass 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 URL-Inhalte nur dann, wenn sie im Feld Wert der Systemeigenschaft „com.snc.pdf.Whitelisted_urls“ aufgeführt ist. 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 eine neue PDFGenerationAPI Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

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

    var v = new sn_pdfgeneratorutils.PDFGenerationAPI;

    PDFGenerationAPI – ConvertToPDF(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Zeichenfolge fontFamilySysId, Objektdokumentkonfiguration)

    Konvertiert eine HTML-Zeichenfolge in ein PDF-Dokument.

    Mit dieser Methode wird eine PDF-Datei im Seitenformat A4 erstellt – 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 KonvertToPDFWithHeaderFooter() .

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML zum Konvertieren in ein PDF-Dokument.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF angehängt werden soll .
    TargetTableSysId Zeichenfolge SYS_ID des Datensatzes, an den die konvertierte PDF 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].
    FontFamilySysId 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
    Dokumentkonfiguration Objekt Optional. Objekt, das eine Inhaltskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    Dokumentkonfiguration.Zugänglichkeitaktiviert Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind Barrierefreiheits-Tags in der PDF-Tag-Struktur verfügbar, damit Anwender, die auf Bildschirmleser angewiesen sind, die generierten PDF-Dokumente navigieren, verstehen und mit ihnen interagieren können.
    Gültige Werte:
    • Wahr: Die generierte PDF-Datei ist zur Barrierefreiheit formatiert.
    • Falsch: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    Dokumentkonfiguration.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 der Inhaltstabelle“ [doc_toc_config].

    Standard: keiner
    DocumentConfiguration.page_number_config Zeichenfolge Optional. SYS_ID der Seitennummernkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_ID stammt aus der Tabelle „Seitennummernkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 3. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit sys_ID des PDF-Anhangs, 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. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind.
    • Konvertierung ist erfolgreich. – HTML erfolgreich in PDF konvertiert.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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 URL-Whitelisting: „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 URL-Inhalte nur dann, wenn sie im Feld Wert der Systemeigenschaft „com.snc.pdf.Whitelisted_urls“ aufgeführt ist. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatz der Change-Erstelleranforderung .

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie HTML in eine PDF-Datei konvertiert und an einen Datensatz in der Tabelle „Incident“ [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 – konvertToPDFAsync(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Zeichenfolge fontFamilySysId, Objektdokumentkonfiguration)

    Stellt einen Auftrag bereit, der eine HTML-Zeichenfolge asynchron in ein PDF-Dokument konvertiert. Mit der asynchronen 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 KonvertToPDFWithHeaderFooterAsync() .

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML zum Konvertieren in ein PDF-Dokument.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF angehängt werden soll .
    TargetTableSysId Zeichenfolge SYS_ID des Datensatzes, an den die konvertierte PDF 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].
    FontFamilySysId 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
    Dokumentkonfiguration Objekt Optional. Objekt, das eine Inhaltskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    Dokumentkonfiguration.Zugänglichkeitaktiviert Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind Barrierefreiheits-Tags in der PDF-Tag-Struktur verfügbar, damit Anwender, die auf Bildschirmleser angewiesen sind, die generierten PDF-Dokumente navigieren, verstehen und mit ihnen interagieren können.
    Gültige Werte:
    • Wahr: Die generierte PDF-Datei ist zur Barrierefreiheit formatiert.
    • Falsch: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    Dokumentkonfiguration.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 der Inhaltstabelle“ [doc_toc_config].

    Standard: keiner
    DocumentConfiguration.page_number_config Zeichenfolge Optional. SYS_ID der Seitennummernkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_ID stammt aus der Tabelle „Seitennummernkonfiguration“ [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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • HTML-in-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. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Nicht definiert – 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 URL-Whitelisting: „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 URL-Inhalte nur dann, wenn sie im Feld Wert der Systemeigenschaft „com.snc.pdf.Whitelisted_urls“ aufgeführt ist. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatz der Change-Erstelleranforderung .

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie eine Aufgabe in die Warteschlange stellen, die HTML in eine PDF-Datei konvertiert. Wenn die Konvertierung abgeschlossen ist, wird die PDF-Datei mit dem Namen „myPDF“ an den Zieldatensatz in der Tabelle „Incident“ [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 – ConvertToPDFWithHeaderFooter(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Object headerFooterInfo, ZeichenfolgenschriftFamilySysId, Objektdokumentkonfiguration)

    Konvertiert eine HTML-Zeichenfolge in eine PDF-Datei mit Header- und Fußzeileninhalt.

    Verwenden Sie diese Methode, um PDFs mit Seiteneinstellungen zu generieren:
    • Header- und Fußzeileninformationen
    • Margengrößen
    • Ausrichtung
    • Aufzählung
    • Seitengröße
    Tabelle : 6. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML zum Konvertieren in ein PDF-Dokument.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF angehängt werden soll .
    TargetTableSysId Zeichenfolge SYS_ID des Datensatzes, an den die konvertierte PDF 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 PDF-Header- und Fußzeilendetails.
    {
  "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: Positionieren Sie das Bild unten in der Mitte der Fußzeile.
    • UNTEN_LINKS: Positionieren Sie das Bild im unteren linken Bereich der Fußzeile.
    • UNTEN_RECHTS: Positionieren Sie das Bild im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positionieren Sie das Bild oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positionieren Sie das Bild im oberen linken Bereich der Fußzeile.
    • TOP_RIGHT: Positionieren Sie 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 bestimmen, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften , Sicherheit , Und überprüfen Sie, ob es in aufgeführt ist Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können Feld.
    HeaderFooterInfo. ​FooterImageHeight Zeichenfolge Höhe des Fußzeilenbilds.

    Standard: 50 Punkte
    HeaderFooterInfo. ​Fußzeilentext Zeichenfolge Fußzeilentext, der am unteren Rand jeder PDF-Seite platziert werden soll.
    HeaderFooterInfo. ​Fußzeilenausrichtung Zeichenfolge Legt die Textposition in der Fußzeile fest. Stellen Sie sicher, dass dieser Wert nicht mit dem in angegebenen Bereich übereinstimmt oder in Konflikt steht headerFooterInfo.FooterImageAlignment.
    Gültige Werte:
    • BOTTOM_CENTER: Positionieren Sie den Text unten in der Mitte der Fußzeile.
    • UNTEN_LINKS: Positionieren Sie den Text im unteren linken Bereich der Fußzeile.
    • BOTTOM_RIGHT: 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_RIGHT: 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: Generieren Sie keine Seitenzahlen.

    Standardwert: wahr
    HeaderFooterInfo. ​HeaderImageAlignment Zeichenfolge Legt die Bildposition im Header fest.
    Gültige Werte:
    • Mitte: Positionieren Sie 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 bestimmen, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften , Sicherheit , Und überprüfen Sie, ob es in aufgeführt ist Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können Feld.
    HeaderFooterInfo. ​HeaderImageHeight Zeichenfolge Höhe des Headerbilds.

    Standard: 50 Punkte
    HeaderFooterInfo. ​LeftOrRightMargin Zeichenfolge Größe des linken und rechten Rands. Bei Position links oder rechts auf der Seite werden Header-/Fußzeilendetails in in diesem Bereich platziert.

    Standard: 36 Punkte
    HeaderFooterInfo. ​Seitenausrichtung Zeichenfolge Seitenausrichtung.
    Gültige Werte:
    • HOCHFORMAT
    • QUERFORMAT

    Standard: Hochformat
    HeaderFooterInfo. ​Seitengröße ändern Zeichenfolge Größe der Dokumentseite.
    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. ​TopOrBottomMargin Zeichenfolge Größe des oberen und unteren Rands. Header- und Fußzeilendetails werden in in in diesem Bereich platziert.

    Standard: 72 Punkte
    FontFamilySysId 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
    Dokumentkonfiguration Objekt Optional. Objekt, das eine Inhaltskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    Dokumentkonfiguration.Zugänglichkeitaktiviert Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind Barrierefreiheits-Tags in der PDF-Tag-Struktur verfügbar, damit Anwender, die auf Bildschirmleser angewiesen sind, die generierten PDF-Dokumente navigieren, verstehen und mit ihnen interagieren können.
    Gültige Werte:
    • Wahr: Die generierte PDF-Datei ist zur Barrierefreiheit formatiert.
    • Falsch: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    Dokumentkonfiguration.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 der Inhaltstabelle“ [doc_toc_config].

    Standard: keiner
    DocumentConfiguration.page_number_config Zeichenfolge Optional. SYS_ID der Seitennummernkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_ID stammt aus der Tabelle „Seitennummernkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Objekt Objekt mit sys_ID des PDF-Anhangs, 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. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>. ​Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind.
    • Konvertierung ist erfolgreich. – HTML erfolgreich in PDF konvertiert.
    • Bildausrichtung und Textausrichtung der Fußzeile dürfen sich nicht in derselben Region mit derselben Ausrichtung befinden: <footerImageAlignment value> – Stellen Sie sicher headerFooterInfo.​FooterImageAlignmentUnd headerFooterInfo.​FooterTextAlignmentWerte befinden sich nicht im selben Bereich.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Ungültige Ausrichtung des Fußzeilenbilds: <invalid_option> ist angegeben. – Geben Sie eine gültige Option in an headerFooterInfo.​FooterImageAlignmentEigenschaft.
    • Ungültige Ausrichtung des Fußzeilentexts: „ + <invalid_option> + “ ist angegeben. – Geben Sie eine gültige Option in an headerFooterInfo.​footerTextAlignmentEigenschaft.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Das Fußzeilenbild kann nicht abgerufen werden. SysId: + <value provided>: Stellen Sie sicher, dass die sys_ID für angegeben wurde headerFooterInfo.​footerImageIdIst genau.
    • Headerbild kann nicht abgerufen werden. SysId: + <value provided>: Stellen Sie sicher, dass die sys_ID für angegeben wurde headerFooterInfo.​headerImageIdIst genau.
    • Nicht definiert – 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 URL-Whitelisting: „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 URL-Inhalte nur dann, wenn sie im Feld Wert der Systemeigenschaft „com.snc.pdf.Whitelisted_urls“ aufgeführt ist. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatz der Change-Erstelleranforderung .

    Datentyp: Zeichenfolge
    <Object>.Status Status, der angibt, ob der Vorgang erfolgreich ist.
    Mögliche Werte:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    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 Tabelle „Incident“ [Incident] hinzugefügt wird. Die PDF-Datei enthält Header und Fußzeile, die über den 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 – ConvertToPDFWithHeaderFooterAsync(Zeichenfolge html, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Zeichenfolge pdfName, Object headerFooterInfo, ZeichenfolgenschriftFamilySysId, Objektdokumentkonfiguration)

    Stellt einen Auftrag bereit, der eine HTML-Zeichenfolge asynchron in eine PDF-Datei mit Header- und Fußzeileninhalt konvertiert. Mit der asynchronen 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.

    Verwenden Sie diese Methode, um PDFs mit Seiteneinstellungen zu generieren:
    • Header- und Fußzeileninformationen
    • Margengrößen
    • Ausrichtung
    • Aufzählung
    • Seitengröße
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    HTML Zeichenfolge HTML zum Konvertieren in ein PDF-Dokument.
    targetTable Zeichenfolge Name der Tabelle, an die die konvertierte PDF angehängt werden soll .
    TargetTableSysId Zeichenfolge SYS_ID des Datensatzes, an den die konvertierte PDF 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 PDF-Header- und Fußzeilendetails.
    {
  "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: Positionieren Sie das Bild unten in der Mitte der Fußzeile.
    • UNTEN_LINKS: Positionieren Sie das Bild im unteren linken Bereich der Fußzeile.
    • UNTEN_RECHTS: Positionieren Sie das Bild im unteren rechten Bereich der Fußzeile.
    • TOP_CENTER: Positionieren Sie das Bild oben in der Mitte der Fußzeile.
    • TOP_LEFT: Positionieren Sie das Bild im oberen linken Bereich der Fußzeile.
    • TOP_RIGHT: Positionieren Sie 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 bestimmen, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften , Sicherheit , Und überprüfen Sie, ob es in aufgeführt ist Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können Feld.
    HeaderFooterInfo. ​FooterImageHeight Zeichenfolge Höhe des Fußzeilenbilds.

    Standard: 50 Punkte
    HeaderFooterInfo. ​Fußzeilentext Zeichenfolge Fußzeilentext, der am unteren Rand jeder PDF-Seite platziert werden soll.
    HeaderFooterInfo. ​Fußzeilenausrichtung Zeichenfolge Legt die Textposition in der Fußzeile fest. Stellen Sie sicher, dass dieser Wert nicht mit dem in angegebenen Bereich übereinstimmt oder in Konflikt steht headerFooterInfo.FooterImageAlignment.
    Gültige Werte:
    • BOTTOM_CENTER: Positionieren Sie den Text unten in der Mitte der Fußzeile.
    • UNTEN_LINKS: Positionieren Sie den Text im unteren linken Bereich der Fußzeile.
    • BOTTOM_RIGHT: 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_RIGHT: 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: Generieren Sie keine Seitenzahlen.

    Standardwert: wahr
    HeaderFooterInfo. ​HeaderImageAlignment Zeichenfolge Legt die Bildposition im Header fest.
    Gültige Werte:
    • Mitte: Positionieren Sie 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 bestimmen, ob der Dateityp in Ihrer Instanz unterstützt wird, navigieren Sie zu Systemeigenschaften , Sicherheit , Und überprüfen Sie, ob es in aufgeführt ist Liste der Dateierweiterungen (kommagetrennt), die angehängt werden können Feld.
    HeaderFooterInfo. ​HeaderImageHeight Zeichenfolge Höhe des Headerbilds.

    Standard: 50 Punkte
    HeaderFooterInfo. ​LeftOrRightMargin Zeichenfolge Größe des linken und rechten Rands. Bei Position links oder rechts auf der Seite werden Header-/Fußzeilendetails in in diesem Bereich platziert.

    Standard: 36 Punkte
    HeaderFooterInfo. ​Seitenausrichtung Zeichenfolge Seitenausrichtung.
    Gültige Werte:
    • HOCHFORMAT
    • QUERFORMAT

    Standard: Hochformat
    HeaderFooterInfo. ​Seitengröße ändern Zeichenfolge Größe der Dokumentseite.
    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. ​TopOrBottomMargin Zeichenfolge Größe des oberen und unteren Rands. Header- und Fußzeilendetails werden in in in diesem Bereich platziert.

    Standard: 72 Punkte
    FontFamilySysId 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
    Dokumentkonfiguration Objekt Optional. Objekt, das eine Inhaltskonfiguration und eine Seitenzahlkonfiguration enthält.
    {​
   "accessibilityEnabled" : Boolean,
   "toc_config" : "String",​
   "page_number_config": "String"​
}​
    Dokumentkonfiguration.Zugänglichkeitaktiviert Boolean Optional. Kennzeichnung, die angibt, ob die generierte PDF-Datei formatiert werden soll, um Barrierefreiheit zu unterstützen. Wenn diese Funktion aktiviert ist, sind Barrierefreiheits-Tags in der PDF-Tag-Struktur verfügbar, damit Anwender, die auf Bildschirmleser angewiesen sind, die generierten PDF-Dokumente navigieren, verstehen und mit ihnen interagieren können.
    Gültige Werte:
    • Wahr: Die generierte PDF-Datei ist zur Barrierefreiheit formatiert.
    • Falsch: Die generierte PDF-Datei ist nicht für Barrierefreiheit formatiert.

    Standardwert: False
    Dokumentkonfiguration.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 der Inhaltstabelle“ [doc_toc_config].

    Standard: keiner
    DocumentConfiguration.page_number_config Zeichenfolge Optional. SYS_ID der Seitennummernkonfiguration, die für die PDF-Datei verwendet werden soll. Diese sys_ID stammt aus der Tabelle „Seitennummernkonfiguration“ [doc_page_number_config].

    Standard: keiner
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Objekt
    <Object>. ​Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • HTML-in-PDF-Konvertierung wird ausgeführt. – Anforderung zum Konvertieren von HTML in ein PDF-Dokument ist erfolgreich.
    • Bildausrichtung und Textausrichtung der Fußzeile dürfen sich nicht in derselben Region mit derselben Ausrichtung befinden: <footerImageAlignment value> – Stellen Sie sicher headerFooterInfo.​FooterImageAlignmentUnd headerFooterInfo.​FooterTextAlignmentWerte befinden sich nicht im selben Bereich.
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Ungültige Ausrichtung des Fußzeilenbilds: <invalid_option> ist angegeben. – Geben Sie eine gültige Option in an headerFooterInfo.​FooterImageAlignmentEigenschaft.
    • Ungültige Ausrichtung des Fußzeilentexts: „ + <invalid_option> + “ ist angegeben. – Geben Sie eine gültige Option in an headerFooterInfo.​footerTextAlignmentEigenschaft.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Das Fußzeilenbild kann nicht abgerufen werden. SysId: + <value provided>: Stellen Sie sicher, dass die sys_ID für angegeben wurde headerFooterInfo.​footerImageIdIst genau.
    • Headerbild kann nicht abgerufen werden. SysId: + <value provided>: Stellen Sie sicher, dass die sys_ID für angegeben wurde headerFooterInfo.​headerImageIdIst genau.
    • Nicht definiert – 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 URL-Whitelisting: „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 URL-Inhalte nur dann, wenn sie im Feld Wert der Systemeigenschaft „com.snc.pdf.Whitelisted_urls“ aufgeführt ist. Diese Eigenschaften sind in der Tabelle „Systemeigenschaften“ [sys_properties] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.Request_ID SYS_ID des Datensatz der Change-Erstelleranforderung .

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie eine Aufgabe in die Warteschlange stellen, die HTML in eine PDF-Datei konvertiert. Die PDF-Datei enthält Header und Fußzeile, die über den Anhang bereitgestellt werden. Wenn die Konvertierung abgeschlossen ist, wird die PDF-Datei mit dem Namen „myPDF“ an den Zieldatensatz in der Tabelle „Incident“ [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 (Object fieldsMap, String sysId, String tableName, String tableSysId, String 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 rufen Sie Feldinformationen ab:
    PDFGenerationAPI Bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Feldzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie GetDocumentFields() Methode zum Abrufen der Liste der verfügbaren Felder.
    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 derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    tableSysId Zeichenfolge SYS_ID des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    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 sys_ID des aktualisierten PDF-Anhangs, falls erfolgreich, 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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    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(Object fieldsMap, String sysId, String tableName, String tableSysId, String pdfName, Objekt reduzieren)

    Füllt Felder in einer bearbeitbaren PDF 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 rufen Sie Feldinformationen ab:
    PDFGenerationAPI Bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Feldzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie GetDocumentFields() Methode zum Abrufen der Liste der verfügbaren Felder.
    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 derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    tableSysId Zeichenfolge SYS_ID des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    PdfName Zeichenfolge Name für die PDF-Datei.

    Standard: SYS_ID der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    Reduzieren Objekt Optional. Durch das Reduzieren von Feldern können die Felder gesperrt werden, damit andere Anwender 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_Flatten: Reduzieren Sie keine Felder.
    • Partially_FLATEN: Reduzieren Sie nur die Felder, die geändert wurden.
    • Fully_Flatten: Reduziert alle Felder.

    Standard: Fully_Flatten

    {
  "FlattenType": "String" 
}
    Tabelle : 13. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit sys_ID des aktualisierten PDF-Anhangs, falls erfolgreich, 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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie Felder ausfüllen und eine bearbeitbare PDF-Datei reduzieren.

    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(Object fieldsMap, String sysId, String tableName, String tableSysId, String pdfName, PdfMergeSignAnforderer, Objekt reduzieren)

    Füllt Felder in einer bearbeitbaren PDF aus, fügt ein Signaturbild hinzu, 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 rufen Sie Feldinformationen ab:
    PDFGenerationAPI Bietet zusätzliche Füllmethoden mit verschiedenen Optionen:
    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Feldzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie GetDocumentFields() Methode zum Abrufen der Liste der verfügbaren Felder.
    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 derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    tableSysId Zeichenfolge SYS_ID des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in derselben Zeile wie der Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    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 Signatureingabe von zurückgegeben PdfMergeSignRequestor .
    Reduzieren Objekt Optional. Durch das Reduzieren von Feldern können die Felder gesperrt werden, damit andere Anwender 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_Flatten: Reduzieren Sie keine Felder.
    • Partially_FLATEN: Reduzieren Sie nur die Felder, die geändert wurden.
    • Fully_Flatten: Reduziert alle Felder.

    Standard: Fully_Flatten

    {
  "FlattenType": "String" 
}
    Tabelle : 15. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit sys_ID des aktualisierten PDF-Anhangs, falls erfolgreich, 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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Felder mit Signatur mit Standardeinstellungen ausgefüllt werden, 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 von bearbeitbaren Feldern in einem PDF-Dokument ab. Ermöglicht das Auflisten bearbeitbarer PDF-Felder, ohne die zu überprüfende Datei manuell 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 ID der signierten PDF-Datei, andernfalls Fehlermeldung. 
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.Felder Wenn die Anforderung erfolgreich ist, wird eine Liste mit den Namen jedes Felds in der PDF-Datei angezeigt.

    Datentyp: Array von Zeichenfolgen

    "fields": ["field_name"]
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    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, das jeden PDF-Feldtyp enthält, falls erfolgreich, andernfalls Fehlermeldung. 
    {
  "fields_type": {Object},
  "message": "String",
  "status": "String"
}
    <Object>.Fields_type Objekt, das jedes Feld in der angegebenen PDF auflistet, falls erfolgreich, andernfalls Fehlermeldung.

    Datentyp: Objekt

    "fields_type": {
  "<field type>": {Object},
}
    <Object>.Fields_type. ​<field> Objekt, das die Seitennummer jedes Felds enthält. Der <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>.Felddetails Liste von Objekten mit dem Feldnamen und dem entsprechenden Wert jeder Option für Auswahlfeldtypen.
    Anwendbare Typen:
    • Checkbox
    • Auswahlfeld
    • Kombinationsfeld
    • Auswahlfeld für Mehrfachauswahl

    Datentyp: Array

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

    Datentyp: Zeichenfolge
    <Object>.Fields_type. ​<field>.Felddetails.Wert Wert eines Auswahlfelds.

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

    Datentyp: Zeichenfolge
    <Object>.Fields_type. ​<field>.Typ PDF-Feldtyp.
    Mögliche Werte:
    • check_box
    • Choice_Box
    • Combo_Box
    • Multi_select_choice_Box
    • Push_button
    • Radio_button
    • signature
    • text

    Datentyp: Zeichenfolge
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Feldtypen in einem PDF-Anhang abgerufen werden. Ergebnisse enthalten manuelle Rückgaben zur Lesbarkeit und werden aus Kürze 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, Objekt reduzieren)

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

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

    Verwenden Sie die folgenden Methoden, um zu bestimmen, ob die PDF-Datei ausfüllbar ist, und rufen Sie Feldinformationen ab:
    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 aus, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.
    • Ausgefüllte Felder AndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt sie an den bereitgestellten Datensatz an.
    Tabelle : 20. Parameter
    Name Typ Beschreibung
    Feldzuordnung Objekt Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie GetDocumentFields() Methode zum Abrufen der Liste der verfügbaren Felder.
    sysId Zeichenfolge SYS_ID einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    requestor PdfMergeSign-​anfordernde Person Signatureingabe von zurückgegeben PdfMergeSignRequestor .
    Reduzieren Objekt Optional. Durch das Reduzieren von Feldern können die Felder gesperrt werden, damit andere Anwender 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_Flatten: Reduzieren Sie keine Felder.
    • Partially_FLATEN: Reduzieren Sie nur die Felder, die geändert wurden.
    • Fully_Flatten: Reduziert alle Felder.

    Standard: Fully_Flatten

    {
  "FlattenType": "String" 
}
    Tabelle : 21. Ausgabe
    Typ Beschreibung
    Zeichenfolge Wenn erfolgreich, wird die PDF-Datei, die im Base64-Format konvertiert wurde, der Tabelle „Anhänge“ [sys_attachment] hinzugefügt. Inhalte spiegeln den PDF-Anhang wider, der mit Feldern und ausgefüllter Signatur bereitgestellt wird. Die Felder können nicht bearbeitet werden, es sei denn, mit wurde eine alternative Reduzierungsoption bereitgestellt flattenParameter.
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Gültige Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Dem PDF-Dokument ist kein Formular zum Ausfüllen zugeordnet. AttachmentSysId: <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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie zwei Felder in einen PDF-Anhang geladen, die Felder reduziert und die PDF-Datei in das Base64-Format konvertiert werden.

    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 die Größe jeder Seite enthält, falls erfolgreich, 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 Punkten. Die Seitenzahl wird als Zeichenfolge zurückgegeben, und die Messwerte werden als Zahlendatentypen zurückgegeben.

    Datentyp: Objekt

    "pages_size": {"<page number>":[<width>,<height>]}
    <Object>.Nachricht Nachricht, die 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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    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 die Größe jeder Seite enthält, falls erfolgreich, andernfalls Fehlermeldung. 
    {
  "document_editable": "String",
  "message": "String",
  "status": "String"
}
    <Object>. ​Document_editable Wenn der Vorgang erfolgreich ist, Kennzeichnung, die angibt, ob das Dokument bearbeitet werden kann.
    Gültige Werte:
    • Wahr: Das PDF-Dokument hat bearbeitbare Felder.
    • Falsch: Das PDF-Dokument hat keine bearbeitbaren Felder.

    Datentyp: Boolescher Wert als Zeichenfolge angegeben
    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Ausnahme beim Lesen des Quelldokumentinhalts. PDF-Header nicht gefunden. – Angegebener 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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie bestimmt wird, ob PDF-Dokumentfelder bearbeitet werden können.

    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 die Schwärzung auf ein PDF-Dokument basierend auf den angegebenen Rechteckkoordinaten, Suchstichwörtern oder beidem an. Eine geschwärzte Kopie der ursprünglichen PDF wird in der Tabelle „Anhänge“ [sys_attachment] generiert.

    Hinweis:
    • Schwärzungsergebnisse können einen unerwarteten weiß geschwärzten Textblock enthalten, der Text überschreibt, der nicht geschwärzt werden soll. Wenn dieses Ereignis auftritt, können Sie den Inhalt manuell für die Schwärzung mit auswählen highlightedSectionsEigenschaft oder das Plugin „PDF-Generierungsdienstprogramme“. Weitere Informationen finden Sie unter Redact data from documents.
    • Diese Methode unterstützt keine Schwärzung in PDFs, die JBIG2-Images enthalten.
    Tabelle : 26. Parameter
    Name Typ Beschreibung
    inputJson Objekt Gibt die PDF-Datei und ihren Inhalt an, die geschwärzt werden soll.
    {
  "sysId": "String",
  "highlightedSections": [Array],
  "searchedKeywords": [Array]
}
    EingabeJson.sysId Zeichenfolge SYS_ID einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    EingabeJSON. HighlightedSections Array von Objekten Liste der als Objekt bereitgestellten Rechteckkoordinaten. Jede Koordinate stellt die Position des Inhalts dar, der auf jeder Seite geschwärzt werden soll.
    Optional, wenn enthalten ist searchedKeywordsEigenschaft.
    [
   {
     "pageNumber": Number,
     "x": Number,
     "y": Number,
     "width": Number,
     "height": Number
   }
]
    EingabeJSON. HighlightedSections. Pagennummeriert Anzahl PDF-Seitenzahl mit dem Inhalt, der zur Schwärzung ausgewählt werden soll.
    EingabeJSON. HighlightedSections. X Anzahl 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 Format Letter.
    EingabeJSON. HighlightedSections. y Anzahl Die Y-Achse (vertikale 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 396 Platziert das Rechteck ungefähr in der vertikalen Mitte einer PDF-Seite im Format Letter.
    EingabeJSON. HighlightedSections. Breite Anzahl Die Breite des Schwärzungsrechtecks ist in Punkten angegeben. Dieser Wert erhöht die Größe des Rechtecks horizontal vom unteren linken Punkt, an dem sich die x- und y-Achsen schneiden.
    EingabeJSON. HighlightedSections. Höhe Anzahl Höhe des Schwärzungsrechtecks in Punkten. Dieser Wert erhöht die Größe des Rechtecks vertikal vom unteren linken Punkt, an dem sich die x- und y-Achsen schneiden.
    EingabeJSON. SearchedKeywords Array Liste von einer oder mehreren Zeichenfolgen, die zum Suchen von Text für die Schwärzung verwendet werden. Die Größe des Schwärzungsrechtecks entspricht der Höhe und Breite des Texts, der als Ergebnis blockiert wird.
    Optional, wenn enthalten ist highlightedSectionsEigenschaft.
    Hinweis:
    In einigen Fällen Textzeichenfolgen mit Sonderzeichen oder Interpunktion, z. B. „Elemente:“ Und „PDF.“ Sind nicht geschwärzt. Alternativ können Sie das Zeichen aus der Zeichenfolge entfernen oder den Bereich hervorheben, um den Text zu entfernen.
    Tabelle : 27. Rückgaben
    Typ Beschreibung
    Objekt Objekt mit sys_ID des aktualisierten PDF-Anhangs, falls erfolgreich, 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>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Dieses Format kann nicht analysiert werden – ein in die PDF 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. – Angegebener 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 den Virenschutz-Scan nicht bestanden.
    • Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit der sys_ID [{0}] eine Sicherheitsüberprüfung aussteht. Die PDF-Datei erfordert einen Virenschutz.
    • Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich.
    • Nicht definiert – 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:
    • Erfolg: Vorgang war erfolgreich.
    • Fehler: Vorgang war nicht erfolgreich. Die messageStellt Details bereit.

    Datentyp: Zeichenfolge

    Das folgende Beispiel zeigt, wie Sie nach Rechteck und Stichwort schwärzen. In der geschwärzten PDF-Datei werden 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"}