BarTender Cloud REST APIでデータベースオーバーライドを使用する方法
概要
ラベルのデータベースフィールドの情報を、印刷ジョブ用に新しい情報に置き換えたい場合があります。この操作は「データベースオーバーライド」と呼ばれます。BarTender Cloud REST API にリクエストを送る際、送信プログラムやクライアントアプリケーションでどのように記述すればよいか分かりにくいことがあります。
この記事では、BarTender Cloud REST API に送信できる印刷アクション(データベースオーバーライドを含む)の例を紹介します。
対象
BarTender Cloud
情報
ドキュメントの準備
例を紹介する前に、印刷アクションに使用するドキュメントを準備しましょう。
- BarTender Cloud Designerで新しいドキュメントを作成します。
- 画面左上のデータベース設定アイコンをクリックして、データベース設定ウィザードを開きます。
- テキストファイルを選択し、次へをクリックします。
- 埋め込みサンプルデータを選択し、次へをクリックします。
- 以下のサンプルデータを貼り付けて、次へをクリックします。
- 残りのデータベース設定ウィザードの手順に従い、データベース接続を完了させます。
ペイロード例
以下はデータベースオーバーライドを含むペイロードの例です。この例は JSON 形式ですが、YAML も使用できます。右側のスクロールバーで全体を確認できます。
データベースオーバーライドのペイロードは、上記で設定したドキュメントのデータベースと同じ形式(フィールドの数と順番)である必要があります。そうしないと、この例は正しく動作しません。
[
{
"SetVariableAction": {
"VariableName": "EventData",
"VariableValue": "Id,name,year\r\n1,7325856667720,KS2451-Test1,2020\r\n2,7325856667721,KS2451-Test2,2024\r\n3,1234,test3,22"
}
},
{
"PrintBTWAction": {
"DocumentFile": "librarian://main/test.btw",
"Name": "Print Document",
"Printer": "PDF",
"SaveAfterPrint": false,
"Copies": 1,
"ReturnPrintData": "true",
"ReturnPrintSummary": "true",
"PrintToFileFileName": "myOutput.PDF",
"PrintToFileFolder": "librarian://main/pdf/",
"PrintToFileNameVariable": "myPdfOutput",
"MakeUniqueOutputFile": "true",
"DatabaseOverrides": [
{
"Name": "Text",
"Type": "VariableName",
"DataSourceVariableName": "EventData"
}
]
}
}
詳細については、以下のリソースをご覧ください。
追加リソース
BarTender Cloud オンラインヘルプ - データベースオーバーライドの YAML リファレンス