SVGToPDFConversionAPI: Bereichsbezogen, global

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 5 Minuten Lesedauer

    • Die SVGToPDFConversionAPI bietet Methoden, die das Hinzufügen einer SVG-Datei zu einer PDF-Datei und die Konvertierung einer SVG-Datei in eine PDF-Datei ermöglichen.

    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.

    Siehe auch PDFGenerationAPI.

    SVGToPDFConversionAPI: SVGToPDFConversionAPI()

    Instanziiert ein neues SVGToPDFConversionAPI- Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

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

    var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

    SVGToPDFConversionAPI - addSVGToPDF(Zeichenfolge „svg“, Zeichenfolge „inputPdfSysId“, „Zeichenfolge targetTable“, „Zeichenfolge targetSysId“, „Zeichenfolge nameForPdf“, „Nummer pageNo“, „Nummer x“, „Nummer y“, „Nummer SVGImgWidth“, „Nummer SVGImgHeight“)

    Fügt einer PDF-Datei auf einer angegebenen Seite ein SVG-Bild mit Bildgröße und Standortkoordinaten hinzu.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    SVG Zeichenfolge SVG zum Konvertieren in ein PDF-Dokument.
    inputPdfSysId Zeichenfolge Sys_id der Ziel-PDF, in der eine Kopie von mit einer SVG-Datei erstellt werden soll. Die Ziel-PDF befindet sich in der Tabelle „Anhänge“ [sys_attachment].
    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].
    targetTableSysId 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].
    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].
    pageNo Nummer Seitenzahl in der angehängten PDF-Datei, auf der die SVG-Datei platziert werden soll.
    x Nummer Horizontale Position der SVG-Datei auf der Seite. Der Wert wird in Punkten angegeben.
    y Nummer Vertikale Position der SVG-Datei auf der Seite. Der Wert wird in Punkten angegeben.
    SVGImgWidth Nummer Breite des SVG-Bilds in Pixel.
    SVGImgHeight Nummer Höhe des SVG-Bilds in Pixel.
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Objekt Objekt mit der sys_id eines neuen PDF-Anhangs mit eingefügter SVG-Datei bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn die SVG-Konvertierung erfolgreich ist, sys_id der angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Hinzufügen von SVG-Inhalten zu PDF.
    • Das Hinzufügen von SVG-Dateien zu PDFs und das Erstellen einer neuen PDF-Datei war erfolgreich.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Sys-ID des eingegebenen PDF-Anhangs zum Hinzufügen des SVG-Inhalts ist null
    • Der eingegebene SVG-Inhalt ist leer oder null
    • PdfReader ist nicht mit Besitzerpasswort geöffnet
    • Der Name der Zieltabelle zum Anhängen der geänderten PDF-Datei:<targetTable> ist leer oder null
    • Der Name der Zieltabelle zum Anhängen der geänderten PDF-Datei:<targetTable> ist ungültig

    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 Sie SVG-Dateien aus dem Beschreibungsfeld eines incident-Datensatzes abrufen und auf Seite 5 eines PDF-Anhangs hinzufügen. Die neue PDF-Datei mit SVG-Datei befindet sich in der Tabelle „Anhänge“ [sys_attachment].

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var result = new sn_pdfgeneratorutils.SVGToPDFConversionAPI().addSVGToPDF(svg, "<inputPdfSysId>", "incident", "<tableSysId>", "AddSVGToPDF", 5, 30, 30, 300, 100);
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<sys_id>","message":"Adding SVG to PDF and creating new PDF is successful.","status":"success"}

    SVGToPDFConversionAPI - konvertierenSVGToPDF(String „svg“, „String pdfName“, „String targetTable“, „String targetTableSysId“)

    Konvertiert eine als Zeichenfolge bereitgestellte SVG-Datei in eine PDF-Datei.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    SVG Zeichenfolge SVG zum Konvertieren in ein PDF-Dokument.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    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.
    Tabelle : 5. Ausgabe
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aus SVG konvertierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn die SVG-Konvertierung erfolgreich ist, sys_id der angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Konvertieren des SVG-Bilds in ein PDF-Dokument.
    • Ausnahme beim Lesen des Quelldokumentinhalts.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Konvertierung von SVG in PDF erfolgreich.
    • Der Name der Zieltabelle –<tableName> zum Anhängen der konvertierten SVG-Datei ist ungültig
    • Der Name der Zieltabelle –<tableName> zum Anhängen der konvertierten SVG-Datei ist leer oder null

    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 Sie die SVG-Datei aus dem Beschreibungsfeld eines Incident-Datensatzes abrufen, um die SVG-Datei in eine PDF-Datei zu konvertieren und an einen Datensatz anzuhängen.

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

var result = v.convertSVGToPDF(svg, "ConvertSVGToPDF", "incident", "<targetTableSysId>");
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<pdf_attachment_sys_id>","message":"SVG to PDF conversion is successful.","status":"success"}

    SVGToPDFConversionAPI - konvertierenSVGToPDFWithSize(Zeichenfolge SVG, Zeichenfolge nameForPDF, Zeichenfolge targetTable, Zeichenfolge targetTableSysId, Anzahl SVGImgWidth, Anzahl SVGImgHeight)

    Konvertiert eine als Zeichenfolge bereitgestellte SVG-Datei in eine PDF-Datei mit Werten für Bildbreite und -höhe.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    SVG Zeichenfolge SVG zum Konvertieren in ein PDF-Dokument.
    pdfName Zeichenfolge Name für die PDF-Datei.

    Standard: Sys_id der PDF-Datei in der Tabelle „Anhänge“ [sys_attachment].
    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.
    SVGImgWidth Nummer Breite des SVG-Bilds in Pixel.
    SVGImgHeight Nummer Höhe des SVG-Bilds in Pixel.
    Tabelle : 7. Ergebnisse
    Typ Beschreibung
    Objekt Objekt mit der sys_id des aus SVG konvertierten PDF-Anhangs bei Erfolg, andernfalls Fehlermeldung.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Wenn die SVG-Konvertierung erfolgreich ist, sys_id der angehängten PDF-Datei. Die Datei wird in der Tabelle „Anhänge“ [sys_attachment] aufgeführt.

    Datentyp: Zeichenfolge
    <Object>.message Meldung, die den Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Konvertieren des SVG-Bilds in ein PDF-Dokument.
    • Ausnahme beim Lesen des Quelldokumentinhalts.
    • Angegebener Zieldatensatz [<tableName> -<targetTableSysId> ] ist nicht vorhanden. – sys_id der Zieltabelle befindet sich nicht in der angegebenen Tabelle. Stellen Sie sicher, dass Sie den richtigen Tabellennamen für den Datensatz angeben.
    • Der Name der Zieltabelle –<tableName> zum Anhängen der konvertierten SVG-Datei ist ungültig
    • Der Name der Zieltabelle –<tableName> zum Anhängen der konvertierten SVG-Datei ist leer oder null
    • Konvertierung von SVG in PDF erfolgreich.

    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 Sie die SVG-Datei aus dem Beschreibungsfeld eines Incident-Datensatzes abrufen, um die SVG-Datei in eine PDF-Datei zu konvertieren und an einen Datensatz anzuhängen.

    var gr = new GlideRecord("incident");

var svg;

if (gr.get("<tableSysId>")) {
 svg = gr.description.toString();
}

var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

var result = v.convertSVGToPDFWithSize(svg, "ConvertSVGToPDF", "incident", "<targetTableSysId>", 600, 150);
gs.info(JSON.stringify(result));

    Ausgabe:

    {"attachment_id":"<pdf_attachment_sys_id>","message":"SVG to PDF conversion is successful.","status":"success"}