SVGToPDFConversionAPI - スコープ付き、グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：11分

    • SVGToPDFConversionAPI は、SVG を PDF に追加したり、SVG を PDF に変換したりできるメソッドを提供します。

    この API は、 ServiceNow PDF Generation Utilities プラグイン (com.snc.apppdfgenerator) の一部であり、 sn_pdfgeneratorutils 名前空間内で提供されます。このプラグインはデフォルトでは有効になっています。

    「PDFGenerationAPI」も参照してください。

    SVGToPDFConversionAPI - SVGToPDFConversionAPI()

    新しい SVGToPDFConversionAPI オブジェクトをインスタンス化します。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし

    次の例では、SVGToPDFConversionAPI オブジェクトを作成する方法を示します。

    var v = new sn_pdfgeneratorutils.SVGToPDFConversionAPI();

    SVGToPDFConversionAPI - addSVGToPDF(文字列 svg, 文字列 inputPdfSysId, 文字列 targetTable, 文字列 targetSysId, 文字列 nameForPdf, 数字 pageNo, 数字 x, 数字 y, 数字 svgImgWidth, 数字 svgImgHeight)

    SVG 画像を、画像サイズおよび位置座標と一緒に PDF の指定されたページに追加します。

    表 : 2. パラメーター
    名前 タイプ 説明
    svg 文字列 PDF ドキュメントに変換する SVG。
    inputPdfSysId 文字列 SVG を使用したコピー作成対象の PDF の sys_id。対象の PDF は添付ファイル [sys_attachment] テーブルにあります。
    targetTable 文字列 PDF が添付されるレコードを含むテーブルの名前。この値は、添付ファイル [sys_attachment] テーブルにリストされている添付ファイルと同じ行にあります。
    targetTableSysId 文字列 PDF が添付されるレコードの sys_id。この値は、添付ファイル [sys_attachment] テーブルにリストされている添付ファイルと同じ行にあります。
    targetTable 文字列 変換された PDF を添付するテーブルの名前。
    targetTableSysId 文字列 変換された PDF を添付するレコードの sys_id。
    pdfName 文字列 PDF に付ける名前。

    デフォルト：添付ファイル [sys_attachment] テーブル内の PDF の sys_id。
    pageNo 数字 SVG を配置する添付の PDF のページ番号。
    x 数字 ページ内での SVG の水平位置。値はポイント単位です。
    y 数字 ページ内での SVG の垂直位置。値はポイント単位です。
    svgImgWidth 数字 SVG 画像の幅 (ピクセル単位)。
    svgImgHeight 数字 SVG 画像の高さ (ピクセル単位)。
    表 : 3. 返される内容
    タイプ 説明
    オブジェクト 成功した場合は SVG が挿入された新しい PDF 添付ファイルの sys_id を含むオブジェクト、失敗した場合はエラーメッセージ。
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id SVG 変換に成功した場合は、添付された PDF の sys_id。ファイルは、添付ファイル [sys_attachment] テーブルにリストされます。

    データタイプ：文字列
    <Object>.message 成功またはエラーを確認するメッセージ。
    可能な値：
    • SVG の内容を PDF に追加できませんでした。(Adding SVG content to PDF failed.)
    • PDF への SVG の追加と新しい PDF の作成に成功しました。(Adding SVG to PDF and creating new PDF is successful.)
    • 指定されたターゲットレコード [<tableName> -<targetTableSysId>] は存在しません。ターゲットテーブル sys_id が指定されたテーブルにありません。レコードの正しいテーブル名が含まれていることを確認してください。
    • SVG の内容を追加するために入力された PDF 添付ファイルのSys ID が null です (Input PDF attachment sys id to add the SVG content is null)
    • 入力された SVG の内容が空または null です (Input SVG content is empty or null)
    • PdfReader がオーナーパスワードで開かれていません (PdfReader is not opened with owner password)
    • 変更された PDF を添付する対象のテーブル名 <targetTable> が空または null です (The target table name to attach the modified PDF : <targetTable> is empty or null)
    • 変更された PDF を添付する対象のテーブル名 <targetTable> が無効です (The target table name to attach the modified PDF : <targetTable> is not valid)

    データタイプ：文字列
    <Object>.status 操作が成功したかどうかを示すステータス。
    可能な値：
    • success - 操作は成功しました。
    • failure – 操作は成功しませんでした。message は詳細を示します。

    データタイプ：文字列

    次の例は、インシデントレコードの説明フィールドから SVG を取得し、PDF 添付ファイルの 5 ページ目に追加する方法を示しています。SVG が入った新しい PDF は、添付ファイル [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));

    出力:

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

    SVGToPDFConversionAPI - convertSVGToPDF(文字列 svg, 文字列 pdfName, 文字列 targetTable, 文字列 targetTableSysId)

    文字列として提供された SVG を PDF に変換します。

    表 : 4. パラメーター
    名前 タイプ 説明
    svg 文字列 PDF ドキュメントに変換する SVG。
    pdfName 文字列 PDF に付ける名前。

    デフォルト：添付ファイル [sys_attachment] テーブル内の PDF の sys_id。
    targetTable 文字列 変換された PDF を添付するテーブルの名前。
    targetTableSysId 文字列 変換された PDF を添付するレコードの sys_id。
    表 : 5. 返される内容
    タイプ 説明
    オブジェクト 成功した場合は SVG から変換された PDF 添付ファイルの sys_id を含むオブジェクト、それ以外の場合はエラーメッセージ。
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id SVG 変換に成功した場合は、添付された PDF の sys_id。ファイルは、添付ファイル [sys_attachment] テーブルにリストされます。

    データタイプ：文字列
    <Object>.message 成功またはエラーを確認するメッセージ。
    可能な値：
    • SVG 画像の PDF ドキュメントへの変換に失敗しました。
    • ソースドキュメントコンテンツの読み取り中に例外が発生しました。
    • 指定されたターゲットレコード [<tableName> -<targetTableSysId>] は存在しません。ターゲットテーブル sys_id が指定されたテーブルにありません。レコードの正しいテーブル名が含まれていることを確認してください。
    • SVG から PDF への変換に成功しました。
    • ターゲットテーブル名 - 変換された SVG を添付する <tableName> が無効です。
    • ターゲットテーブル名 - 変換された SVG を添付する <tableName> が空または null です。

    データタイプ：文字列
    <Object>.status 操作が成功したかどうかを示すステータス。
    可能な値：
    • success - 操作は成功しました。
    • failure – 操作は成功しませんでした。message は詳細を示します。

    データタイプ：文字列

    次の例は、インシデントレコードの説明フィールドから SVG を取得し、その SVG を PDF に変換してレコードに添付する方法を示しています。

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

    出力:

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

    SVGToPDFConversionAPI - convertSVGToPDFWithSize(文字列 svg, 文字列 nameForPDF, 文字列 targetTable, 文字列 targetTableSysId, 数字 svgImgWidth, 数字 svgImgHeight)

    文字列として提供された SVG を、画像の幅と高さの値を含めて PDF に変換します。

    表 : 6. パラメーター
    名前 タイプ 説明
    svg 文字列 PDF ドキュメントに変換する SVG。
    pdfName 文字列 PDF に付ける名前。

    デフォルト：添付ファイル [sys_attachment] テーブル内の PDF の sys_id。
    targetTable 文字列 変換された PDF を添付するテーブルの名前。
    targetTableSysId 文字列 変換された PDF を添付するレコードの sys_id。
    svgImgWidth 数字 SVG 画像の幅 (ピクセル単位)。
    svgImgHeight 数字 SVG 画像の高さ (ピクセル単位)。
    表 : 7. 返される内容
    タイプ 説明
    オブジェクト 成功した場合は SVG から変換された PDF 添付ファイルの sys_id を含むオブジェクト、それ以外の場合はエラーメッセージ。
    {
  "attachment_id": "String",
  "message": "String",
  "status": "String"
}
    <Object>.​attachment_id SVG 変換に成功した場合は、添付された PDF の sys_id。ファイルは、添付ファイル [sys_attachment] テーブルにリストされます。

    データタイプ：文字列
    <Object>.message 成功またはエラーを確認するメッセージ。
    可能な値：
    • SVG 画像の PDF ドキュメントへの変換に失敗しました。
    • ソースドキュメントコンテンツの読み取り中に例外が発生しました。
    • 指定されたターゲットレコード [<tableName> -<targetTableSysId>] は存在しません。ターゲットテーブル sys_id が指定されたテーブルにありません。レコードの正しいテーブル名が含まれていることを確認してください。
    • ターゲットテーブル名 - 変換された SVG を添付する <tableName> が無効です。
    • ターゲットテーブル名 - 変換された SVG を添付する <tableName> が空または null です。
    • SVG から PDF への変換に成功しました。

    データタイプ：文字列
    <Object>.status 操作が成功したかどうかを示すステータス。
    可能な値：
    • success - 操作は成功しました。
    • failure – 操作は成功しませんでした。message は詳細を示します。

    データタイプ：文字列

    次の例は、インシデントレコードの説明フィールドから SVG を取得し、その SVG を PDF に変換してレコードに添付する方法を示しています。

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

    出力：

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