🧭
🐘YESOD ヘルプ/💡機能別/🐍YESOD データブリッジ/🧭データブリッジの利用開始までの流れ

データブリッジの利用開始までの流れ

この記事では、データブリッジを初めて使うときに、最初の1本のレシピが動きだすまでの流れを説明します。 各ステップの詳しい操作は、それぞれの記事をご覧ください。
💡
データブリッジの基本的な考え方（レシピ、インポート／エクスポート、デプロイ）は、先に「YESOD データブリッジについて」をご覧ください。
Step 1　権限を有効化する
Step 2　接続設定を登録する
Step 3　レシピを作成する
Step 4　ドライランで確認する Step 5　デプロイする Step 6　実行して結果を確認する アクセス権限について

Step 1　権限を有効化する

データブリッジは、ロールの機能制限設定で有効化してからご利用可能になります。
  • 左メニューの「設定」→「ロール」をクリック
  • 対象のロールを開き、「機能制限設定」タブをクリック
  • 「データブリッジ」の以下のいずれかを ON に変更
項目許可される範囲
データブリッジユーザー権限が付与されたレシピの操作に限り、データブリッジ機能へのアクセスを許可します
データブリッジ管理者すべてのデータブリッジ機能へのアクセスと、レシピの作成・編集・実行を許可します
  • 画面左端のアプリ切り替えから「データブリッジ」を選択 サイドメニューに「レシピ」「実行履歴」「接続設定」が表示されます。
⚠️
機能制限の設定画面にデータブリッジの項目が表示されない場合は、 YESODサポート担当までお問い合わせください。
⚠️
「データブリッジユーザー」と「データブリッジ管理者」が、どちらも OFF のままだと、画面左端のアプリ切り替えに「データブリッジ」が表示されません。 データブリッジの画面が見当たらない場合は、まずこの設定をご確認ください。
💡
ロールの機能制限設定は「データブリッジを使えるかどうか」の設定です。 実際にどのレシピを操作できるかは、レシピごとのアクセス権限で決まります。（レシピのアクセス権限を管理する） 機能制限設定そのものの操作方法は「ロール毎の機能制限設定」をご覧ください。

Step 2　接続設定を登録する

外部システムのAPIと連携する場合は、先に接続設定を登録します。接続設定には、接続先のベース URL と認証情報を登録します。（接続設定を新規作成する）
💡
CSV ファイルを取り込むだけのレシピ、または CSV ファイルとして書き出すだけのレシピであれば、接続設定は必要ありません。Step3（レシピ作成）に進んでください。

Step 3　レシピを作成する

レシピの作成は2段階です。
  • レシピ一覧の「新規作成」から、ウィザードで種別・名称・ソースの種類・ターゲットの種類を決めて骨組みを作ります
  • 作成後の「データ処理」タブで、ソース・変換・ターゲットの中身を作り込みます
⚠️
種別（インポート／エクスポート）はあとから変更できません。 種別を変えたい場合は、レシピを作り直してください。
📋
作成からデプロイまでの手順は、以下の記事をご覧ください。 → 🧩 レシピ作成からデプロイまでの流れ → 🧩 レシピを新規作成する

Step 4　ドライランで確認する

ドライランは、実際の書き込みを行わずにレシピを試験実行し、変換後のデータを確認できる機能です。デプロイの前に実施することをおすすめします。（ドライランで動作を確認する）
💡
ドライランはターゲットに一切書き込まないため、何度でも試せます。 ドライランの結果は実行履歴には残りません。

Step 5　デプロイする

「データ処理」タブの「デプロイ」で、その時点の内容をリビジョンとして確定します。デプロイすると、レシピを実行できる状態になります。（レシピをデプロイする）
⚠️
レシピに整合性エラーがあるとデプロイできません。この場合「デプロイ」はクリックできず、画面上部に「レシピに整合性エラーがあります（デプロイできません）」と表示されます。（デプロイできないときの対応（整合性エラー））
⚠️
「保存」と「デプロイ」は別の操作です
レシピを編集して保存しても、実行される内容は変わりません。変更を反映するには「デプロイ」が必要です。 稼働中のレシピを止めずに次の設定を作り込めるようにするための仕組みです。

Step 6　実行して結果を確認する

レシピ詳細の「今すぐ実行」から実行します。実行が終わったら、実行履歴で結果を確認します。（レシピを今すぐ実行する／実行履歴を確認する）
⚠️
「今すぐ実行」は、レシピが「有効」かつ「デプロイ済み」のときだけクリックできます。
💡
決まったタイミングで自動的に動かす場合は、「データ処理」タブの「スケジュール」で定期実行を設定します。（定期実行を設定する）

アクセス権限について

レシピを操作できる範囲は、レシピごとのアクセス権限で決まります。権限は2種類です。
権限できること想定する担当者
編集権限レシピの実行・閲覧に加えて、レシピの編集とデプロイができますデータ連携を設計・保守する情報システム部門の担当者
実行権限レシピの実行・閲覧ができます決まったタイミングで連携を動かす業務部門の担当者
💡
アクセス権限の付与は、レシピ詳細の「アクセス権限」タブから行います。 （レシピのアクセス権限を管理する）
🐘YESOD ヘルプ/💡機能別/🐍YESOD データブリッジ/🧭データブリッジの利用開始までの流れ