PDFGenerationAPI – Scoped, Global

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

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

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

• Generieren Sie dynamisch eine PDF-Datei aus einer HTML-Zeichenfolge, und hängen Sie sie an einen Datensatz an
• Füllen Sie Felder in einer PDF-Datei aus
• Signieren Sie eine PDF-Datei
• Nicht reduziert, reduziert oder teilweise reduziert
• PDF-Felddaten werden abgerufen

Zugehörige APIs:

• PdfMergeSignRequestor
• SVGToPDFConversionAPI

PDFGenerationAPI – convertToPDF(String html, String targetTable, String targetTableSysId, String pdfName, String FontFamilySysId, Object documentConfiguration)

Konvertiert eine HTML-Zeichenfolge in ein PDF-Dokument.

Um eine PDF-Datei mit Kopf- und Fußzeileninformationen wie Seitenzahlen zu generieren, verwenden Sie convertToPDFWithHeaderFooter().

Tabelle : 1. 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].
SchriftartFamilySysId	Zeichenfolge	Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftfamilie der PDF-Generierung“ [sys_pdf_generation_font_family]. Standard: keiner
Dokumentkonfiguration	Objekt	Optional. Objekt mit einer Inhaltsverzeichniskonfiguration und einer Seitenzahlkonfiguration. {​ "toc_config" : "String",​ "page_number_config": "String"​ }​
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 „Inhaltsverzeichniskonfiguration“ [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 : 2. Ausgabe

Typ	Beschreibung
Objekt	Objekt mit der 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-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: Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind. Die Konvertierung ist erfolgreich. – Der HTML-Code wurde erfolgreich in PDF konvertiert. Ausnahme beim Lesen des Inhalts des Quelldokuments. 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich. Nicht definiert – Die angegebene Sys_id ist nicht vorhanden oder kein PDF-Anhang. 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: success: Vorgang war erfolgreich. failure – 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 – convertToPDFWithHeaderFooter(String html, String targetTable, String targetTableSysId, String pdfName, Object headerFooterInfo, String FontFamilySysId, Object documentConfiguration)

Konvertiert eine HTML-Zeichenfolge in eine PDF-Datei mit Kopf- und Fußzeileninhalten.

Verwenden Sie diese Methode, um PDFs mit Seiteneinstellungen zu generieren:

• Kopf- und Fußzeileninformationen
• Randgrößen
• Ausrichtung
• Aufzählung
• Seitengröße

Tabelle : 3. 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 Kopf- und Fußzeilendetails 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: Positionieren Sie das Bild unten in der Mitte der Fußzeile. BOTTOM_LEFT: Positionieren Sie das Bild im unteren linken Bereich der Fußzeile. BOTTOM_Right: Positionieren Sie das Bild rechts unten in der Fußzeile. TOP_CENTER: Positionieren Sie das Bild oben in der Mitte der Fußzeile. TOP_LEFT: Positionieren Sie das Bild oben links in der Fußzeile. TOP_Right: Positionieren Sie das Bild oben rechts in der Fußzeile.
headerFooterInfo.​FooterImageAttachmentId	Zeichenfolge	Sys_id des Fußzeilenbilds in der Tabelle „Anhänge“ [sys_attachment]. Um festzustellen, 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 Ende 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 Bereich übereinstimmt oder 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_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 oben links in der Fußzeile. TOP_Right: Positionieren Sie den Text oben rechts in der Fußzeile.
headerFooterInfo.​GeneratePageNumber	Zeichenfolge	Kennzeichnung, die angibt, ob eine PDF-Seitenzahl generiert werden soll. Gültige Werte: true: Seitenzahlen werden generiert. false: Seitenzahlen werden nicht generiert. Standardwert: true
headerFooterInfo.​HeaderImageAlignment	Zeichenfolge	Legt die Bildposition im Header fest. Gültige Werte: Mitte: Positionieren Sie das Bild in der Mitte der Kopfzeile. left: Positioniert das Bild auf der linken Seite der Kopfzeile. rechts: Positionieren Sie das Bild auf der rechten Seite der Kopfzeile.
headerFooterInfo.​HeaderImageAttachmentId	Zeichenfolge	Sys_id des Headerbilds in der Tabelle „Anhänge“ [sys_attachment]. Um festzustellen, 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 Header-Bildes. Standard: 50 Punkte
headerFooterInfo.​LinksOderRechtsMargin	Zeichenfolge	Größe der linken und rechten Ränder. Bei Positionierung auf der linken oder rechten Seite der Seite werden Kopf-/Fußzeilendetails in diesem Bereich platziert. Standard: 36 Punkte
headerFooterInfo.​PageOrientation	Zeichenfolge	Seitenausrichtung. Gültige Werte: HOCHformat LANDSCAP Standard: Hochformat
headerFooterInfo.​Seitengröße	Zeichenfolge	Dokumentseitengröße. Gültige Werte: A4 – 595 x 842 Punkte LETTER – 612 x 792 Punkte LEDGER – 792 x 1224 Punkte
headerFooterInfo.​TopOrBottomMargin	Zeichenfolge	Größe der oberen und unteren Ränder. Kopf- und Fußzeilendetails werden in diesem Bereich platziert. Standard: 72 Punkte
SchriftartFamilySysId	Zeichenfolge	Optional. Sys_id der Schriftartfamilie, die für die PDF-Datei verwendet werden soll. Diese sys_id stammt aus der Tabelle „Schriftfamilie der PDF-Generierung“ [sys_pdf_generation_font_family]. Standard: keiner
Dokumentkonfiguration	Objekt	Optional. Objekt mit einer Inhaltsverzeichniskonfiguration und einer Seitenzahlkonfiguration. {​ "toc_config" : "String",​ "page_number_config": "String"​ }​
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 „Inhaltsverzeichniskonfiguration“ [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 : 4. Ergebnisse

Typ	Beschreibung
Objekt	Objekt mit der 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-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: Konvertierung fehlgeschlagen. – Keine PDF-Datei erstellt. Stellen Sie sicher, dass die angegebenen Werte korrekt sind. Die Konvertierung ist erfolgreich. – Der HTML-Code wurde erfolgreich in PDF konvertiert. Fußzeilenbildausrichtung und Textausrichtung dürfen nicht im selben Bereich mit derselben Ausrichtung liegen:<footerImageAlignment value> – Stellen Sie sicher, dass sich die Werte headerFooterInfo.​FooterImageAlignment und headerFooterInfo.​FooterTextAlignment nicht im selben Bereich befinden. Ausnahme beim Lesen des Inhalts des Quelldokuments. 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 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> wird bereitgestellt. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​FooterImageAlignment an. Ungültige Fußzeilentextausrichtung: " +<invalid_option> + " ist angegeben. – Geben Sie eine gültige Option in der Eigenschaft headerFooterInfo.​footerTextAlignment an. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist erfolgreich. Fußzeilenbild kann nicht abgerufen werden. sysId: +<value provided> – Stellen Sie sicher, dass die für headerFooterInfo.​footerImageId angegebene sys_id korrekt ist. Header-Bild 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. 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: success: Vorgang war erfolgreich. failure – 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 eine Kopf- und Fußzeile, die als Anhang bereitgestellt 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 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 –fillDocumentFieldsAndFlatten(Object fieldsMap, String sysId, String tableName, String tableSysId, String pdfName, Object reduzieren)

Füllt Felder in einer bearbeitbaren PDF-Datei aus, reduziert die Datenfelder 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 Feldinformationen abzurufen:

• isDocumentFillable ()
• getDocumentFields()
• getDocumentFieldsType()

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 sie an den angegebenen Datensatz an.
• getFilledDocumentWithSignatureAsBase64() – Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
FieldsMap	Objekt	Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die Methode getDocumentFields(), 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 derselben Zeile wie den 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 den 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 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_latten: Keine Felder reduzieren. teilweise_platten – Nur die Felder reduzieren, die geändert wurden. vollständig_platten – Macht alle Felder platt. Standard: vollständig_platten { "FlattenType": "String" }

Tabelle : 6. Ausgabe

Typ	Beschreibung
Objekt	Objekt mit der sys_id des aktualisierten PDF-Anhangs, wenn 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 Inhalts des Quelldokuments. 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – 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 –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 Feldinformationen abzurufen:

• isDocumentFillable ()
• getDocumentFields()
• getDocumentFieldsType()

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 angegebenen Datensatz an.
• fillFieldsAndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt sie an den angegebenen Datensatz an.
• getFilledDocumentWithSignatureAsBase64() – Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
FieldsMap	Objekt	Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die Methode getDocumentFields(), 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 derselben Zeile wie den 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 den 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 : 8. Ausgabe

Typ	Beschreibung
Objekt	Objekt mit der sys_id des aktualisierten PDF-Anhangs, wenn 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 Inhalts des Quelldokuments. 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – 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 –fillFieldsAndMergeSignature(Object fieldsMap, String sysId, String tableName, String tableSysId, String pdfName, PdfMergeSignRequestor requestor, Object reduzieren)

Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder 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 Feldinformationen abzurufen:

• isDocumentFillable ()
• getDocumentFields()
• getDocumentFieldsType()

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 angegebenen Datensatz an.
• getFilledDocumentWithSignatureAsBase64() – Felder in einer bearbeitbaren PDF-Datei aus, erstellt ein Bild und konvertiert es in eine Base64-codierte PDF-Datei.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
FieldsMap	Objekt	Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die Methode getDocumentFields(), 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 derselben Zeile wie den 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 den 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​Anforderer	Signatureingabe, die von pdfMergeSignRequestorzurückgegeben wird.
reduzieren	Objekt	Optional. Durch das Reduzieren von Feldern können die Felder gesperrt werden, 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_latten: Keine Felder reduzieren. teilweise_platten – Nur die Felder reduzieren, die geändert wurden. vollständig_platten – Macht alle Felder platt. Standard: vollständig_platten { "FlattenType": "String" }

Tabelle : 10. Ausgabe

Typ	Beschreibung
Objekt	Objekt mit der sys_id des aktualisierten PDF-Anhangs, wenn 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 Inhalts des Quelldokuments. 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – Vorgang war nicht erfolgreich. message enthält Details. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie Felder mit Signaturen mit Standardeinstellungen gefü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 der bearbeitbaren Felder in einem PDF-Dokument ab. Ermöglicht das Auflisten bearbeitbarer PDF-Felder, ohne die zu überprüfende Datei manuell zu öffnen.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].

Tabelle : 12. Ausgabe

Typ	Beschreibung
Objekt	Objekt mit der ID der signierten PDF-Datei, andernfalls Fehlermeldung. { "attachment_id": "String", "message": "String", "status": "String" }
<Object>.Felder	Wenn die Anforderung erfolgreich ist, Liste mit dem Namen jedes Felds in der PDF-Datei. Datentyp: Array von Zeichenfolgen "fields": ["field_name"]
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Mögliche Werte: Ausnahme beim Lesen des Inhalts des Quelldokuments. 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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – 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 : 13. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].

Tabelle : 14. Ausgabe

Typ	Beschreibung
Objekt	Objekt, das bei Erfolg jeden PDF-Feldtyp enthält, andernfalls Fehlermeldung. { "fields_type": {Object}, "message": "String", "status": "String" }
<Object>.fields_type	Objekt, das bei Erfolg jedes Feld in der angegebenen PDF-Datei auflistet, 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 der Objekte, die den Feldnamen und den entsprechenden Wert jeder 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.value	Wert eines Auswahlfelds. Datentyp: Zeichenfolge
<Object>.fields_type​<field> .Seitennummer	PDF-Seitenzahl, die diesem Feld entspricht. Datentyp: Zeichenfolge
<Object>.fields_type​<field> .Typ	PDF-Feldtyp. Mögliche Werte: check_box choice_box Combobox multi_select_choice_box push_button Radio_Schaltfläche Signatur HTML Datentyp: Zeichenfolge
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Mögliche Werte: Ausnahme beim Lesen des Inhalts des Quelldokuments. 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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – 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 zur besseren Lesbarkeit und sind der Kürze halber 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 reduzieren)

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 Feldinformationen abzurufen:

• isDocumentFillable ()
• getDocumentFields()
• getDocumentFieldsType()

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 angegebenen Datensatz an.
• fillFieldsAndMergeSignature() – Füllt Felder in einer bearbeitbaren PDF-Datei aus, fügt ein Signaturbild hinzu, reduziert die Datenfelder und hängt sie an den angegebenen Datensatz an.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
FieldsMap	Objekt	Optional. Schlüsselwertzuordnung nach PDF-Feldname und auszufüllendem Wert. Verwenden Sie die Methode getDocumentFields(), um die Liste der verfügbaren Felder abzurufen.
sysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
requestor	PdfMergeSign​Anforderer	Signatureingabe, die von pdfMergeSignRequestorzurückgegeben wird.
reduzieren	Objekt	Optional. Durch das Reduzieren von Feldern können die Felder gesperrt werden, 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_latten: Keine Felder reduzieren. teilweise_platten – Nur die Felder reduzieren, die geändert wurden. vollständig_platten – Macht alle Felder platt. Standard: vollständig_platten { "FlattenType": "String" }

Tabelle : 16. 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 PDF-Anhang wider, der mit Feldern und ausgefüllter Signatur bereitgestellt wird. Die Felder können nicht bearbeitet werden, es sei denn, es wurde eine alternative Reduzierungsoption mit dem Parameter flatten angegeben.
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Gültige Werte: Ausnahme beim Lesen des Inhalts des Quelldokuments. 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 ist nicht in der angegebenen Tabelle enthalten. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben. Kein Formular zum Ausfüllen mit PDF verknüpft. AnhangSysId:<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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – Vorgang war nicht erfolgreich. message enthält Details. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie zwei Felder in einem 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 : 17. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].

Tabelle : 18. 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 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 die Antivirenprüfung nicht bestanden. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – 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 : 19. Parameter

Name	Typ	Beschreibung
sysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].

Tabelle : 20. 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_edable	Wenn der Vorgang erfolgreich ist, Kennzeichnung, die angibt, ob das Dokument bearbeitet werden kann. Gültige Werte: true: Das PDF-Dokument verfügt über bearbeitbare Felder. false: PDF-Dokument enthält keine bearbeitbaren Felder. Datentyp: Boolescher Wert, der als Zeichenfolge bereitgestellt wird
<Object>.Nachricht	Nachricht, die Erfolg oder Fehler bestätigt. Mögliche Werte: Ausnahme beim Lesen des Inhalts des Quelldokuments. 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. Die Anforderung kann nicht fortgesetzt werden, da für den Anhang mit sys_id [{0}] eine Sicherheitsprüfung aussteht. Die PDF-Datei erfordert eine Virenprüfung. Anforderung erfolgreich abgeschlossen – Vorgang ist 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: success: Vorgang war erfolgreich. failure – Vorgang war nicht erfolgreich. message enthält Details. Datentyp: Zeichenfolge

Das folgende Beispiel zeigt, wie Sie feststellen können, 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 – PDFGenerationAPI()

Instanziiert ein neues PDFGenerationAPI- Objekt.

Tabelle : 21. Parameter

Name	Typ	Beschreibung
Keine

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

var v = new sn_pdfgeneratorutils.PDFGenerationAPI;