PdfMergeSignRequestor – Scoped, Global

Die PdfMergeSignRequestor- API fügt einem PDF-Dokument ein Bild hinzu, das eine Signatur darstellt.

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 Methode erstellt ein Signaturobjekt, das mithilfe der PDFGenerationAPIin eine PDF-Datei implementiert werden kann.

PdfMergeSignRequestor – PdfMergeSignRequestor()

Instanziiert ein neues PdfMergeSignRequestor- Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Die folgenden Beispiele zeigen, wie ein PdfMergeSignRequestor- Objekt erstellt wird.

var v = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

PdfMergeSignRequestor – addSignatureMapping(Number pageNumber, Number leftMargin, Number topMargin, Number BoxWidth, Number BoxHeight, String sysId)

Weist Anforderungen für Signaturgröße und -position in der PDF-Datei zu.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
pageNumber	Nummer	Nummer der Seite, auf der die Signatur eingefügt werden soll.
leftMargin	Nummer	Wert in Punkten, der den linken Randbereich der Seite darstellt, an dem die Signatur eingefügt werden soll.
topMargin	Nummer	Wert in Punkten, der den oberen Randbereich der Seite darstellt, an dem das Signaturbild eingefügt werden soll.
BoxWidth	Nummer	Wert in Punkten, der die Breite des Felds für die Signatur angibt.
BoxHeight	Nummer	Wert in Punkten, der die Höhe des Felds angibt, das das Signaturbild enthalten soll.
sysId	Zeichenfolge	Sys_id des Signaturbilds in der Tabelle „Anhänge“ [sys_attachment].

Tabelle : 3. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie die Signaturzuordnung hinzugefügt wird. Ein vollständiges Beispiel finden Sie unter processRequest().

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

// For the purpose of this example, set signature sizes and page number for signature placement
var page = 2;
var leftMargin = 48;
var topMargin = 60;
var signatureWidth = 96;
var signatureHeight = 36; 

requestor.addSignatureMapping(page, leftMargin, topMargin, signatureWidth, signatureHeight, "<signatureSysId>");

PdfMergeSignRequestor – createRequest(String targetSysId, String targetTable, String tableSysId, String targetFileName)

Erstellt eine Signaturanforderung mit Quell- und Zieleingaben.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
targetSysId	Zeichenfolge	Sys_id einer PDF-Datei in der Tabelle „Anhänge“ [sys_attachment]. Verwenden Sie diesen Wert als Ziel-PDF, der eine Signatur hinzugefügt werden soll.
targetTable	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.
targetFileName	Zeichenfolge	Name der Ziel-PDF-Datei ohne Erweiterung.

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie eine Signaturanforderung erstellt wird. Ein vollständiges Beispiel finden Sie unter processRequest().

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", "pdfFileName");

PdfMergeSignRequestor – processRequest()

Verarbeitet Anforderungen und fügt die Signaturen hinzu.

Tabelle : 6. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 7. Ergebnisse

Typ	Beschreibung
Objekt	Objekt, das bei Erfolg die Größe jeder Seite enthält, andernfalls Fehlermeldung. { "attachment_id": "String", "message": "String", "status": "String" }
<Object>.attachment_id	Wenn die Anforderung erfolgreich ist, sys_id der signierten und angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt. Datentyp: Zeichenfolge
<Object>.Nachricht	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. Keine Signaturzuordnung angegeben. Diese Anforderung kann nicht verarbeitet werden – Signaturzuordnung mit der addSignatureMapping() -Methode bereitstellen. Anforderung erfolgreich abgeschlossen. Anforderungsfehler. Ausnahmen beim Versuch, dem Dokument Signaturen hinzuzufügen. Versuchen Sie es erneut. Diese Anforderung kann nicht abgeschlossen werden, da die angeforderte Seite nicht vorhanden ist. Seite Nr.:<page number> 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 Signaturanforderung verarbeitet wird.

var requestor = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

requestor.createRequest("<sys_id>", "tableName", "<tableSysId>", pdfFileName);

// For the purpose of this example, set signature sizes and page number for signature placement
var page = 6;
var leftMargin = 40;
var topMargin = 50;
var signatureWidth = 188;
var signatureHeight = 44; 

requestor.addSignatureMapping(page, leftMargin, topMargin, signatureWidth, signatureHeight, "<signatureSysId>");

var result = requestor.processRequest();
gs.info(JSON.stringify(result));