SVGToPDFConversionAPI – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 5 Minuten Lesedauer
  • Die SVGToPDFConversionAPI ermöglicht das Hinzufügen einer SVG-Datei zu einer PDF-Datei und die Konvertierung einer SVG-Datei in eine PDF-Datei.

    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.

    Siehe auch PDFGenerationAPI.

    SVGToPDFConversionAPI – SVGToPDFConversionAPI()

    Instantiiert 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(String svg, String inputPdfSysId, String targetTable, String targetSysId, String nameForPdf, Number pageNo, Number x, Number y, Number svgImgWidth, Number svgImgHeight)

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

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    SVG Zeichenfolge SVG zur Konvertierung in ein PDF-Dokument.
    inputPdfSysId Zeichenfolge Sys_id der Ziel-PDF-Datei, in der eine Kopie von mit einer SVG-Datei erstellt werden soll. Die Ziel-PDF-Datei 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 derselben Zeile wie den Anhang, der in der Tabelle „Anhänge“ [sys_attachment] aufgeführt ist.
    targetTableSysId 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.
    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].

    Seitennr 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.
    J 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ügtem SVG, falls erfolgreich, 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] aufgelistet.

    Datentyp: Zeichenfolge

    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Hinzufügen von SVG-Inhalten zu PDF.
    • Das Hinzufügen von SVG zu PDF und das Erstellen einer neuen PDF-Datei ist erfolgreich.
    • 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.
    • Sys-ID des Eingabe-PDF-Anhangs zum Hinzufügen des SVG-Inhalts ist null
    • Eingegebener SVG-Inhalt ist leer oder null
    • PdfReader wird nicht mit dem Besitzerpasswort geöffnet
    • Der Name der Zieltabelle, an die die geänderte PDF-Datei angehängt werden soll:<targetTable> ist leer oder null
    • Der Name der Zieltabelle, an die die geänderte PDF-Datei angehängt werden soll:<targetTable> ist ungültig

    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 SVG aus dem Beschreibungsfeld eines Incident-Datensatzes abgerufen und auf Seite 5 eines PDF-Anhangs hinzugefügt wird. Die neue PDF-Datei mit SVG 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 – convertSVGToPDF(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 zur Konvertierung 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, falls erfolgreich, 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] aufgelistet.

    Datentyp: Zeichenfolge

    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Konvertieren des SVG-Bilds in ein PDF-Dokument.
    • Ausnahme beim Lesen des Inhalts des Quelldokuments.
    • 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.
    • Die Konvertierung von SVG in PDF ist erfolgreich.
    • Der Name der Zieltabelle –<tableName> zum Anfügen der konvertierten SVG-Datei ist nicht gültig
    • Der Name der Zieltabelle –<tableName> zum Anfügen der konvertierten SVG-Datei ist leer oder null

    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 SVG aus dem Beschreibungsfeld eines Incident-Datensatzes abrufen, um das SVG in PDF 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 – convertSVGToPDFWithSize(Stringsvg, String nameForPDF, String targetTable, String targetTableSysId, NumbersvgImgWidth, NumbersvgImgHeight)

    Konvertiert eine als Zeichenfolge bereitgestellte SVG-Datei mit Bildbreiten- und -höhenwerten in eine PDF-Datei.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    SVG Zeichenfolge SVG zur Konvertierung 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, falls erfolgreich, 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] aufgelistet.

    Datentyp: Zeichenfolge

    <Object>.Nachricht Nachricht, die Erfolg oder Fehler bestätigt.
    Mögliche Werte:
    • Fehler beim Konvertieren des SVG-Bilds in ein PDF-Dokument.
    • Ausnahme beim Lesen des Inhalts des Quelldokuments.
    • 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.
    • Der Name der Zieltabelle –<tableName> zum Anfügen der konvertierten SVG-Datei ist nicht gültig
    • Der Name der Zieltabelle –<tableName> zum Anfügen der konvertierten SVG-Datei ist leer oder null
    • Die Konvertierung von SVG in PDF ist erfolgreich.

    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 SVG aus dem Beschreibungsfeld eines Incident-Datensatzes abrufen, um das SVG in PDF 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"}