PdfMergeSignRequestor: Bereichsbezogen, Global

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

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.

Diese API erstellt ein Signaturobjekt, das mit in einer PDF-Datei implementiert werden kann PDFGenerationAPI .

PdfMergeSignRequestor: PdfMergeSignRequestor()

Instanziiert eine neue PdfMergeSignRequestor Objekt.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Die folgenden Beispiele zeigen, wie Sie einen erstellen PdfMergeSignRequestor Objekt.

var v = new sn_pdfgeneratorutils.PdfMergeSignRequestor;

PdfMergeSignRequestor – addSignatureMapping(Number pageNumber, Number leftMargin, Number topMargin, Number boxWidth, Number boxHeight, SYS-ID der Zeichenfolge)

Weist Signaturgröße und Positionsanforderungen in der PDF-Datei zu.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
pageNumber	Anzahl	Nummer der Seite, auf die die Signatur eingefügt werden soll.
Linker Rand	Anzahl	Wert in Punkten, der den linken Randbereich der Seite darstellt, an dem die Signatur eingefügt werden soll.
Oberer Rand	Anzahl	Wert in Punkten, der den oberen Randbereich der Seite darstellt, an der das Signaturbild eingefügt werden soll.
Boxbreite	Anzahl	Wert in Punkten, der die Breite des Felds darstellt, das die Signatur enthalten soll.
BoxHeight	Anzahl	Wert in Punkten, der die Höhe des Felds darstellt, das das Signaturbild enthalten soll.
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 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(Zeichenfolge 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, 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 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.
Zieldateiname	Zeichenfolge	Name der Ziel-PDF ohne Erweiterung.

Tabelle : 5. Rückgaben

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 die Größe jeder Seite enthält, falls erfolgreich, 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. 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 den Virenschutz-Scan nicht bestanden. Keine Signaturzuordnung angegeben. Diese Anforderung kann nicht verarbeitet werden. Stellen Sie die Signaturzuordnung mit bereit AddSignatureMapping() Methode. Anforderung erfolgreich abgeschlossen. Anforderungsfehler. Ausnahmen beim Versuch, Signaturen zum Dokument hinzuzufügen. Überprüfen Sie es erneut. Diese Anforderung kann nicht abgeschlossen werden, da die angeforderte Seite nicht vorhanden ist. Seitennummer: <page number> 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 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));