名前付きデータソースを使用したCSV統合の作成方法
概要
CSV連携は、最もシンプルで便利な連携方法のひとつです。他の連携方法と異なり、この連携ではトリガーファイル内に含まれるCSVデータベースを変数に分解し、それをラベルファイルに渡すことができます。BarTenderのバージョンによってUIが異なる場合があるため、画面上部のバージョン選択ドロップダウンを必ずご利用ください。
同様の連携方法をお探しの場合は、以下のチュートリアルもご参照ください:
- 印刷コマンドスクリプトを使ったドキュメント印刷(動画 - 9:40) - スクリプトヘッダーでプリンターやラベル情報を設定し、CSVデータベースを含む連携方法です。
- 基本的なCSV連携の作成方法 - データベースの上書きを使ってデータをラベルに送信するCSV連携です。
- データベース連携の構築(動画 - 33:42) - このCSV連携と非常に似た動作をし、ラベル上で名前付きデータソースを使用する連携方法です。
対象バージョン
BarTender 2022以降
情報
ラベルの設定
このタイプのラベルはデータベースを使用せず、すべてのデータを名前付きデータソースで管理します。ここでは、このラベルの基本的な設定方法を説明します。詳細はヘルプファイルの名前付きデータソースをご覧ください。
- 新しいラベルを作成します。
- ラベルデザインエリアにテキストオブジェクトを作成します。
- ラベルを右クリックし、「プロパティ」を選択します。
- リストからデータソースを選択します。「サンプルテキスト」と表示されています。
- 「名前」フィールドの横にあるボックスをクリックします。
- ダイアログで一意の名前を入力し、「OK」をクリックします。この例では「ProductName」とします。
- 「タイプ」が「埋め込みデータ」になっていることを確認します。
- さらにテキストオブジェクトを作成する場合、名前付きデータソースのダイアログが異なって表示されます。「名前」フィールドの横のボックスをクリックし、最初のオプションを選択して新しい名前を作成します。例として「ProductType」とします。
- 必要な数だけ名前付きデータソースを作成したら、ラベルを保存します。
連携の作成
連携にはトリガーファイルが必要です。CSVのフィールド名は名前付きデータソース名と一致している必要はありません。ここでフィールドと名前付きデータソースを紐付けるためです。CSVのフィールド名は自動的に連携内の変数となります。フィールド名にスペースを含めないようにしてください。
この例ではプリンター情報も含まれています。ご自身の連携でテストする前に、ラベル名とプリンター名を変更してください。例は以下の通りです:
Name,Food,ID,btw,printer
Seagull Seed Rings,bird food,1236468,Test.btw,Zebra 105
- Integration Builderを開き、「新しい連携の作成」を選択します。
- 新しい連携ダイアログで「ファイル連携」を選択し、「OK」をクリックします。
- まず、連携がファイルを検出する方法を設定します。スキャンフォルダーを設定してください。ここにトリガーファイルを配置すると、連携がそれを検出します。例ではCドライブ上のフォルダーを使用しています。マイドキュメントやデスクトップなど、アクセス権が必要な場所は避けてください。
- 「場所」横のドロップダウンをクリックし、「コンピューター/ネットワーク」を選択します。
- フォルダー名を入力するか、「参照」ボタンで場所を指定します。
- ファイルパターンを、ご自身のファイルに合わせて変更します。ここではデフォルトの.datを使用していますが、.txtや.csvなど任意の拡張子を指定できます。
- このセクションの一番下までスクロールします。*.txtファイルパターンを使用している場合は、「検出後」のオプションで別の拡張子に変更してください。同じファイルが繰り返し検出されるのを防ぎます。
- 左側のメニューで「アクション」の横にある+ボタンをクリックします。
- ダイアログで「変換」カテゴリをクリックし、「テキストをレコードセットに変換」を選択して「OK」をクリックします。
- 「データベース接続の設定」ボタンをクリックし、ウィザードの手順に従って印刷時に使用するデータベースフィールドを含むCSV形式のファイルに接続します。
- 「テキストソース」を「変数」に変更し、変数が「%EventData%」になっていることを確認します。
- 「データベース接続の設定」ボタンをクリックし、ウィザードの手順に従って印刷時に使用するデータベースフィールドを含むCSV形式のファイルに接続します。
- 再度アクションの+ボタンをクリックします。
- 「データベース」カテゴリをクリックし、「各データベースレコードごとに」を選択して「OK」をクリックします。
- アクションリストの「ドキュメントを印刷」アクションを、「各データベースレコードごとに」アクションの下にドラッグしてインデントさせます。これで「ドキュメントを印刷」アクションが子アクションになります。
- 「ドキュメント」セクションで、前のセクションで作成したドキュメントを選択します。後ほど変数名を使用します。
- 「場所」を「コンピューター/ネットワーク」に変更します。
- フォルダー名を入力するか、「参照」ボタンで場所を指定します。
- [ドキュメント設定のインポート...]ボタンをクリックします。
- ダイアログで「OK」をクリックします。
- 「名前付きデータソース」タブをクリックし、インポートされ自動入力された情報を確認します。
「値」フィールドに入力する変数名は、CSVのフィールド名です。変数は名前を%で囲んで表します。たとえばフィールド名が「Name」の場合、変数は%Name%となります。
- 該当する列に変数を入力します。例のデータベースを使う場合、値は以下のようになります:
- プリンターやラベル情報を上書きしたい場合も、ここで変数を使用できます。
- 「印刷オプション」タブをクリックします。
- 「プリンター」欄に%printer%と入力します。これはcsvトリガーファイルのプリンターフィールドに対応します。
- 「ドキュメント」タブをクリックします。
- 「ドキュメント」欄でbtwファイル名を削除し、パスはそのまま残します。ドキュメント名の部分を%btw%に置き換えます。これはトリガーファイルのフィールド名に対応します。ドキュメント欄は以下のようにパスと変数を含みます:
パスに変数が含まれている場合、プレビューが生成できなくなりますが、これは正常な動作です。
- 連携を保存します。
- ツールバー上部の「連携のテスト」ボタンをクリックします。
- 右上の緑色の「開始」ボタンをクリックします。
- エクスプローラーでCSVトリガーファイルをスキャンフォルダーにドラッグします。連携がトリガーされ、ラベルが印刷されます。
連携のデプロイ
連携のテストが完了したら、本番環境にデプロイします。
- 「デプロイ」タブをクリックし、上部ツールバーの「デプロイ」ボタンをクリックします。変更がある場合は、続行前に連携ファイルの保存を求められます。
- ドロップダウンリストから「このコンピューター」を選択し、ローカルにデプロイします。「次へ」をクリックします。
- 「今すぐデプロイ」が選択されていることを確認し、「完了」をクリックします。
- しばらくすると、管理コンソールが開き、連携がデプロイされて稼働中であることが表示されます。
対象製品
BarTender 2019 および BarTender 2021
情報
ラベルの設定方法
このタイプのラベルはデータベースを使用せず、すべてのデータを「名前付きデータソース」で管理します。ここでは、このラベルの基本的な設定方法について説明します。詳細については、ヘルプファイルの「名前付きデータソース」をご覧ください。
- 新しいラベルを作成します。
- ラベルのデザインエリアにテキストオブジェクトを作成します。
- ラベルを右クリックして「プロパティ」を選択します。
- リストからデータソースを選択します。「サンプルテキスト」と表示されます。
- 「名前」フィールドの横にあるボックスをクリックします。
- ダイアログで一意の名前を入力し、「OK」をクリックします。この例では「ProductName」とします。
- 「タイプ」が「埋め込みデータ」になっていることを確認します。
- さらにテキストオブジェクトを作成する場合、「名前付きデータソース」ダイアログの見た目が異なります。「名前」フィールドの横のボックスをクリックし、最初のオプションを選択して新しい名前を作成します。例:「ProductType」など。
- 必要な数だけ名前付きデータソースを作成したら、ラベルを保存します。
インテグレーションの作成
インテグレーションにはトリガーファイルが必要です。CSVのフィールド名は、名前付きデータソース名と一致している必要はありません。ここでフィールドと名前付きデータソースを紐付けるためです。これらのCSVフィールド名は自動的にインテグレーション内の変数になります。フィールド名にスペースを含めないようにしてください。
この例ではプリンター情報も含まれています。ご自身のインテグレーションでテストする前に、ラベル名とプリンター名を変更してください。例は以下の通りです:
Name,Food,ID,btw,printer
Seagull Seed Rings,bird food,1236468,Test.btw,Zebra 105
- Integration Builder を開き、「新しいインテグレーションの作成」を選択します。
- 新しいインテグレーションのダイアログで「ファイルインテグレーション」を選択し、「OK」をクリックします。
- まず、インテグレーションがファイルを検出する方法を設定します。スキャンフォルダーを指定してください。ここにトリガーファイルを配置すると、インテグレーションが自動で検出します。この例ではCドライブ上のフォルダーを使用しています。フォルダー名を入力するか、「参照」ボタンで場所を指定してください。「マイドキュメント」や「デスクトップ」などは追加の権限が必要になるため避けてください。
- ファイルパターンを、使用するファイルに合わせて変更します。デフォルトは .dat ですが、.txt や .csv など任意の拡張子を使用できます。
- このセクションの一番下までスクロールします。*.txt ファイルパターンを使用している場合は、「検出後」のオプションで別の拡張子に変更してください。同じファイルが繰り返し検出されるのを防ぎます。
- 左側のメニューで「アクション」の横にある + ボタンをクリックします。
- ダイアログで「変換」カテゴリをクリックし、「テキストをレコードセットに変換」を選択して「OK」をクリックします。
- 「データベース接続の設定」ボタンをクリックし、ウィザードの手順に従って印刷時に使用するデータベースフィールドを含むCSV形式のファイルに接続します。
- 「テキストソース」を「変数」に変更し、変数が「%EventData%」になっていることを確認します。
- 「データベース接続の設定」ボタンをクリックし、ウィザードの手順に従って印刷時に使用するデータベースフィールドを含むCSV形式のファイルに接続します。
- 再度、アクションの横にある + ボタンをクリックします。
- 「データベース」カテゴリをクリックし、「各データベースレコードごとに」を選択して「OK」をクリックします。
- アクションリストの「ドキュメントを印刷」アクションをクリックし、「各データベースレコードごとに」アクションの下にドラッグしてインデントさせます。これで「ドキュメントを印刷」アクションが子アクションになります。
- 「ドキュメント」セクションで、前のセクションで作成したドキュメントを選択します。後で変数名を使う設定にします。
- [ドキュメント設定のインポート...] ボタンをクリックします。
- ダイアログで「OK」をクリックします。
- 「名前付きデータソース」タブをクリックし、インポートされ自動入力された情報を確認します。
「値」フィールドに入力する変数名は、CSVのフィールド名です。変数は名前を % で囲んで表します。たとえばフィールド名が「Name」の場合、変数は %Name% となります。
- 対応する列に変数を入力します。例のデータベースを使う場合、値は以下のようになります:
- プリンターやラベル情報を上書きしたい場合も、ここで変数を使用できます。
- 「印刷オプション」タブをクリックします。
- 「プリンター」欄に、csvトリガーファイルのプリンターフィールドに合わせて %printer% と入力します。
- 「ドキュメント」タブをクリックします。
- 「ドキュメント」欄で、btwファイル名を削除しパスはそのまま残します。ドキュメント名の部分を %btw% に置き換えます。これでトリガーファイルのフィールド名と一致します。ドキュメント欄は、次のようにパスと変数を組み合わせた形になります:
パスに変数が含まれている場合、プレビューが生成できなくなりますが、これは正常な動作です。
- インテグレーションを保存します。
- 上部ツールバーの「インテグレーションのテスト」ボタンをクリックします。
- 右上の緑色の「開始」ボタンをクリックします。
- エクスプローラーでCSVトリガーファイルをスキャンフォルダーにドラッグします。インテグレーションがトリガーされ、ラベルが印刷されます。
インテグレーションの展開
インテグレーションのテストが完了したら、本番環境に展開します。
- 「展開」タブをクリックし、上部ツールバーの「展開」ボタンをクリックします。変更がある場合は、続行前にインテグレーションファイルの保存を求められます。
- ドロップダウンリストから「このコンピューター」を選択し、ローカルに展開します。「次へ」をクリックします。
- 「今すぐ展開」が選択されていることを確認し、「完了」をクリックします。
- しばらくすると、管理コンソールが開き、インテグレーションが展開され稼働中であることが表示されます。