SVGToPDFConversionAPI : champ d’application, global

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 6 minutes de lecture

    • L’API SVGToPDFConversionAPI fournit des méthodes qui permettent d’ajouter un SVG à un PDF et de convertir un SVG en PDF.

    Cette API fait partie du module d’extension ServiceNow PDF Generation Utilities (com.snc.apppdfgenerator) et est fournie dans l’espace de noms sn_pdfgeneratorutils . Le module d’extension est activé par défaut.

    Voir aussi PDFGenerationAPI.

    SVGToPDFConversionAPI : SVGToPDFConversionAPI()

    Instancie un nouvel objet SVGToPDFConversionAPI .

    Tableau 1. Paramètres
    Nom Type Description
    Néant

    Les exemples suivants montrent comment créer un objet SVGToPDFConversionAPI .

    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)

    Ajoute une image SVG à un fichier PDF sur une page spécifiée avec la taille de l’image et les coordonnées d’emplacement.

    Tableau 2. Paramètres
    Nom Type Description
    svg Chaîne SVG pour convertir en document PDF.
    inputPdfSysId Chaîne Sys_id du PDF cible dans lequel créer une copie avec un SVG. Le PDF cible se trouve dans la table Pièces jointes [sys_attachment].
    targetTable Chaîne Nom de la table contenant l’enregistrement auquel le PDF est joint. Vous pouvez trouver cette valeur dans la même ligne que la pièce jointe répertoriée dans le tableau Pièces jointes [sys_attachment].
    targetTableSysId Chaîne Sys_id de l’enregistrement auquel le PDF est joint. Vous pouvez trouver cette valeur dans la même ligne que la pièce jointe répertoriée dans le tableau Pièces jointes [sys_attachment].
    targetTable Chaîne Nom de la table à laquelle joindre le PDF converti.
    targetTableSysId Chaîne Sys_id de l’enregistrement auquel joindre le PDF converti.
    Nom pdf Chaîne Nom à donner au PDF.

    Par défaut : Sys_id du PDF dans la table Pièces jointes [sys_attachment].
    pageNo Numéro Numéro de page dans le PDF joint sur lequel placer le SVG.
    x Numéro Position horizontale du SVG dans la page. La valeur est en points.
    o Numéro Position verticale du SVG dans la page. La valeur est en points.
    svgImgWidth Numéro Largeur de l’image SVG en pixels.
    svgImgHeight Numéro Hauteur de l’image SVG en pixels.
    Tableau 3. Renvoie
    Type Description
    Objet Objet contenant sys_id d’une nouvelle pièce jointe PDF avec SVG inséré en cas de réussite, message d’erreur dans le cas contraire.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Si la conversion SVG réussit, sys_id du PDF joint. Le fichier est répertorié dans la table Pièces jointes [sys_attachment].

    Type de données : chaîne
    <Object>.Message Message confirmant la réussite ou l’erreur.
    Valeurs possibles :
    • Échec de l’ajout de contenu SVG au PDF.
    • L’ajout de SVG au PDF et la création d’un nouveau PDF sont réussis.
    • L’enregistrement cible indiqué [<tableName> <targetTableSysId>] n’existe pas. : la table cible sys_id n’est pas dans la table fournie. Assurez-vous d’inclure le nom de table correct pour l’enregistrement.
    • L’ID système de la pièce jointe PDF d’entrée pour ajouter le contenu SVG est nul
    • Le contenu SVG d’entrée est vide ou nul
    • Le lecteur PDF n’est pas ouvert avec le mot de passe du propriétaire
    • Nom de la table cible à laquelle joindre le fichier PDF modifié : <targetTable> est vide ou nul
    • Nom de la table cible à laquelle joindre le fichier PDF modifié : <targetTable> n’est pas valide

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération n’a pas réussi. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment obtenir SVG à partir du champ de description d’un enregistrement d’incident et l’ajouter à la page 5 d’une pièce jointe PDF. Le nouveau PDF avec SVG se trouve dans le tableau Pièces jointes [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));

    Sortie :

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

    SVGToPDFConversionAPI : convertSVGToPDF(Chaîne svg, Chaîne pdfName, Chaîne targetTable, Chaîne targetTableSysId)

    Convertit un SVG fourni en tant que chaîne en PDF.

    Tableau 4. Paramètres
    Nom Type Description
    svg Chaîne SVG pour convertir en document PDF.
    Nom pdf Chaîne Nom à donner au PDF.

    Par défaut : Sys_id du PDF dans la table Pièces jointes [sys_attachment].
    targetTable Chaîne Nom de la table à laquelle joindre le PDF converti.
    targetTableSysId Chaîne Sys_id de l’enregistrement auquel joindre le PDF converti.
    Tableau 5. Renvoie
    Type Description
    Objet Objet contenant sys_id de la pièce jointe PDF convertie à partir de SVG en cas de réussite, message d’erreur dans le cas contraire.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Si la conversion SVG réussit, sys_id du PDF joint. Le fichier est répertorié dans la table Pièces jointes [sys_attachment].

    Type de données : chaîne
    <Object>.Message Message confirmant la réussite ou l’erreur.
    Valeurs possibles :
    • Échec de la conversion de l’image SVG en document PDF.
    • Exception lors de la lecture du contenu du document source.
    • L’enregistrement cible indiqué [<tableName> <targetTableSysId>] n’existe pas. : la table cible sys_id n’est pas dans la table fournie. Assurez-vous d’inclure le nom de table correct pour l’enregistrement.
    • La conversion SVG en PDF est réussie.
    • Le nom de la table cible <tableName> pour joindre le SVG converti n’est pas valide
    • Le nom de la table cible <tableName> pour joindre le SVG converti est vide ou nul

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération n’a pas réussi. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment obtenir SVG à partir du champ Description d’un enregistrement d’incident pour convertir le SVG en PDF et le joindre à un enregistrement.

    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));

    Sortie :

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

    SVGToPDFConversionAPI : convertSVGToPDFWithSize(String svg, String nameForPDF, String targetTable, String targetTableSysId, Number svgImgWidth, Number svgImgHeight)

    Convertit un SVG fourni en tant que chaîne en PDF avec les valeurs de largeur et de hauteur de l’image.

    Tableau 6. Paramètres
    Nom Type Description
    svg Chaîne SVG pour convertir en document PDF.
    Nom pdf Chaîne Nom à donner au PDF.

    Par défaut : Sys_id du PDF dans la table Pièces jointes [sys_attachment].
    targetTable Chaîne Nom de la table à laquelle joindre le PDF converti.
    targetTableSysId Chaîne Sys_id de l’enregistrement auquel joindre le PDF converti.
    svgImgWidth Numéro Largeur de l’image SVG en pixels.
    svgImgHeight Numéro Hauteur de l’image SVG en pixels.
    Tableau 7. Renvoie
    Type Description
    Objet Objet contenant sys_id de la pièce jointe PDF convertie à partir de SVG en cas de réussite, message d’erreur dans le cas contraire.
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id Si la conversion SVG réussit, sys_id du PDF joint. Le fichier est répertorié dans la table Pièces jointes [sys_attachment].

    Type de données : chaîne
    <Object>.Message Message confirmant la réussite ou l’erreur.
    Valeurs possibles :
    • Échec de la conversion de l’image SVG en document PDF.
    • Exception lors de la lecture du contenu du document source.
    • L’enregistrement cible indiqué [<tableName> <targetTableSysId>] n’existe pas. : la table cible sys_id n’est pas dans la table fournie. Assurez-vous d’inclure le nom de table correct pour l’enregistrement.
    • Le nom de la table cible <tableName> pour joindre le SVG converti n’est pas valide
    • Le nom de la table cible <tableName> pour joindre le SVG converti est vide ou nul
    • La conversion SVG en PDF est réussie.

    Type de données : chaîne
    <Object>.statut État indiquant si l’opération a réussi.
    Valeurs possibles :
    • réussite : l’opération a réussi.
    • échec : l’opération n’a pas réussi. Le message fournit des détails.

    Type de données : chaîne

    L’exemple suivant montre comment obtenir SVG à partir du champ de description d’un enregistrement d’incident, convertir le SVG en PDF et le joindre à un enregistrement.

    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));

    Sortie :

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