SVGToPDFConversionAPI:スコープ対象、グローバル

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

この API は ServiceNow PDF 生成ユーティリティプラグイン (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)

指定したページの PDF に、画像サイズと位置座標を使用して SVG 画像を追加します。

表 : 2. パラメーター

名前	タイプ	説明
svg	文字列	PDF ドキュメントに変換する SVG。
入力 PdfSysID	文字列	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 の水平位置。値はポイント単位です。
年	番号	ページ内の 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	成功またはエラーを確認するメッセージ。 可能な値： PDF への SVG コンテンツの追加に失敗しました。 SVG を PDF に追加し、新しい PDF を作成することに成功しました。 指定されたターゲットレコード [<tableName>- <targetTableSysId>] が存在しません。– ターゲットテーブルsys_idが指定されたテーブルにありません。レコードに正しいテーブル名が含まれていることを確認してください。 SVG コンテンツを追加するための入力 PDF 添付ファイルの Sys ID が null です 入力 SVG コンテンツが空または null です PdfReader がオーナーパスワードで開かれていません 変更された PDF を添付するターゲットテーブル名:<targetTable> が空または null です 変更された PDF を添付するターゲットテーブル名:<targetTable> が有効ではありません データタイプ：文字列
<Object>.status	操作が成功したかどうかを示すステータス。 可能な値： 成功:操作が成功しました。 失敗:操作は成功しませんでした。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	操作が成功したかどうかを示すステータス。 可能な値： 成功:操作が成功しました。 失敗:操作は成功しませんでした。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	操作が成功したかどうかを示すステータス。 可能な値： 成功:操作が成功しました。 失敗:操作は成功しませんでした。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"}