PdfMergeSignRequestor: Bereichsbezogen, global

Die PdfMergeSignRequestor -API bietet Methoden zum Hinzufügen eines Bilds, das eine Signatur darstellt, zu einem PDF-Dokument.

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

Diese API 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, NummerleftMargin, Nummer topMargin, NummernboxWidth, NummernboxHeight, Zeichenfolgen-sysId)

Weist Anforderungen für Größe und Position der Signatur 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 darstellt.
Feldhöhe	Nummer	Wert in Punkt, der die Höhe des Felds für das Signaturbild darstellt.
sysId	Zeichenfolge	Sys_id des Signaturbilds in der Tabelle „Anhänge“ [sys_attachment]

Tabelle : 3. Rückgaben

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie Sie die Signaturzuordnung hinzufügen. 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, Zeichenfolge targetTable, Zeichenfolge tableSysId, Zeichenfolge 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, dem 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 der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
tableSysId	Zeichenfolge	Sys_id des Datensatzes, an den die PDF-Datei angehängt ist. Sie finden diesen Wert in der gleichen Zeile wie den Anhang in der Tabelle „Anhänge“ [sys_attachment].
targetFileName	Zeichenfolge	Name der Ziel-PDF ohne Erweiterung.

Tabelle : 5. Rückgaben

Typ	Beschreibung
Keine

Das folgende Beispiel zeigt, wie Sie eine Signaturanforderung erstellen. 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>.message	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 – Stellen Sie die Signaturzuordnung mit der Methode „addSignatureMapping()“ bereit. 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: erfolgreich: Vorgang war erfolgreich. Fehler: 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));