🧭
データブリッジの用語集
この記事では、YESOD データブリッジのヘルプ記事や画面に出てくる用語を、分類ごとにまとめています。
この記事は用語の索引です
それぞれの用語の設定方法や操作手順は、表の「詳しくは」列からリンクしている記事をご覧ください。
レシピの構成に関する用語
データの向きに関する用語
接続とデータの参照先に関する用語
デプロイとリビジョンに関する用語 実行に関する用語
権限に関する用語
間違えやすい用語の使い分け ・「保存」と「デプロイ」 ・「レシピの無効化」と「定期実行の無効化」 ・「ドライラン」と「実行」 ・「アセット」（アカウントコントロール）と「インポート設定」（ディレクトリサービス） ・「接続設定」はデータの向きを持たない共通リソース
データの向きに関する用語
接続とデータの参照先に関する用語
デプロイとリビジョンに関する用語 実行に関する用語
権限に関する用語
間違えやすい用語の使い分け ・「保存」と「デプロイ」 ・「レシピの無効化」と「定期実行の無効化」 ・「ドライラン」と「実行」 ・「アセット」（アカウントコントロール）と「インポート設定」（ディレクトリサービス） ・「接続設定」はデータの向きを持たない共通リソース
レシピの構成に関する用語
データ連携の中身は「ソース → 変換 → ターゲット」の順に設定します。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| レシピ | データの取り込み・書き出しの設定をひとまとめにしたもの 「ソース」「変換」「ターゲット」の3つで構成されます | レシピ作成からデプロイまでの流れ |
| ソース | データの取得元の設定 インポートでは外部システム（HTTP API・CSV ファイル）、エクスポートでは YESOD のアセットを指定します | ソースを設定する（HTTP API） ソースを設定する（CSV ファイル） ソースを設定する（アセット） |
| ソーススキーマ | ソースから取り込む列の定義 ここで定義した列が、変換で参照できる項目になります | ソーススキーマを設定する |
| 変換 | ソースで取得した値を加工し、ターゲットの項目に対応付ける設定 | 変換を設定する（マッピングの基本） |
| マッピング | 変換の中で「どのソース列を、どのターゲット項目にするか」を1件ずつ定義したもの 整合性エラーの表示では「マッピング #2」のように番号で示されます | 変換を設定する（マッピングの基本） |
| 変換ルール | マッピングの中で、値の加工方法を指定するもの 文字種の変換・値の置き換え・日付計算などが用意されています | 変換ルールの種類と使い方 |
| ターゲット | データの書き出し先の設定 インポートでは YESOD のインポート設定、エクスポートでは CSV ファイルや外部システムの API を指定します | ターゲットを設定する（通常インポート） ターゲットを設定する（CSV ファイル出力） ターゲットを設定する（HTTP API） |
データの向きに関する用語
レシピは「インポート」と「エクスポート」の2種類があり、どちらも「ソース → 変換 → ターゲット」という同じ流れで設定します。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| インポート | 外部システムから YESOD へデータを取り込むこと レシピの種別の1つです | YESOD データブリッジについて |
| エクスポート | YESOD から外部システムへデータを書き出すこと レシピの種別の1つです | YESOD データブリッジについて |
| 種別 | レシピがインポートかエクスポートかを表す区分 レシピの新規作成時に決め、あとから変更できません | レシピを新規作成する |
種別によって、選べるソース・ターゲットの種類が変わります。
取り込みと書き出しの両方を行う場合は、インポートのレシピとエクスポートのレシピをそれぞれ作成してください。
接続とデータの参照先に関する用語
外部システムへの接続情報は、レシピの外側にある「接続設定」として登録します。YESOD 側のデータの参照先は「アセット」「インポート設定」で指定します。参照先はそれぞれ別の製品の設定で、アセットはアカウントコントロール、インポート設定はディレクトリサービスに登録されているものを選びます。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| 接続設定 | 外部システムへの接続情報（URL・認証情報）を登録したもの レシピの外側で管理され、複数のレシピから共有して使えます | 接続設定を新規作成する |
| 接続先 | 接続設定を作るときに選ぶ、接続する外部システムの種類 | 接続先一覧 |
| アセット | アカウントコントロールの「業務アセット」 エクスポートのレシピのソースで選択します | ソースを設定する（アセット） |
| インポート設定 | ディレクトリサービスの「インポート」設定 インポートのレシピのターゲットで選択します | ターゲットを設定する（通常インポート） |
アセットとインポート設定は、データブリッジでは作成・編集できません。
「アセット」はアカウントコントロールの「業務アセット」、「インポート設定」はディレクトリサービスの「インポート」設定です。データブリッジでは、登録済みのものを選ぶだけです。
選びたいものが一覧に見つからない場合は、アセットはアカウントコントロール、インポート設定はディレクトリサービスで登録されているかを確認してください。
デプロイとリビジョンに関する用語
データブリッジでは、編集と本番の実行が分かれています。編集した内容は、デプロイして初めて実行に反映されます。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| 保存 | 編集した内容を、レシピの編集中の内容として残す操作 保存しただけでは、実行される内容は変わりません | レシピ作成からデプロイまでの流れ |
| デプロイ | 保存済みの内容を新しいリビジョンとして確定し、実行できる状態にする操作 | レシピをデプロイする |
| リビジョン | デプロイのたびに作られる、レシピの内容の記録 リビジョンID は 8 文字の英数字で、連番ではありません。新旧はデプロイ日時で判断します | レシピをデプロイする |
| アクティブリビジョン | 実際の実行に使われるリビジョン デプロイすると、そのときのリビジョンがアクティブになります | レシピをデプロイする |
| 運用ステータス | レシピのデプロイの状態を表す区分 「未デプロイ」「デプロイ済み」「未デプロイの変更あり」の3つがあります | YESOD データブリッジについて |
| 未デプロイ | 作成直後で、まだ一度もデプロイしていない状態。実行できません | レシピ作成からデプロイまでの流れ |
| デプロイ済み | デプロイした内容と編集中の内容が一致している状態。実行できます | レシピ作成からデプロイまでの流れ |
| 未デプロイの変更あり | デプロイ後に編集を加えた状態 実行できますが、動くのはデプロイ済みの内容です | レシピを編集して再デプロイする |
| 有効／無効 | レシピを実行できる状態かどうかを表すもの 運用ステータスとは別の軸で、無効化しても運用ステータスは変わりません | レシピを無効化・有効化する |
| 整合性エラー | レシピの設定に矛盾があるときに検出される問題 1件でもあるとデプロイできません | デプロイできないときの対応（整合性エラー） |
| 確認事項 | 整合性のチェックで検出される注意喚起 そのままデプロイできます | デプロイできないときの対応（整合性エラー） |
リビジョンとして管理されるのは「データ処理」タブの変更だけです。
「概要」タブの名称・コード・メモの変更や、レシピの有効化・無効化は、デプロイをしなくてもすぐに反映されます。
実行に関する用語
レシピを動かす方法は「ドライラン」「今すぐ実行」「定期実行」の3つです。実行の結果は実行履歴で確認できます。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| ドライラン | ターゲットに書き込まずにレシピを試験実行し、変換後のデータを確認できる機能 編集中（未デプロイ）の内容に対して実行でき、結果は実行履歴に残りません | ドライランで動作を確認する |
| 実行 | デプロイ済みのレシピを動かし、実際にデータを連携すること 動くのはアクティブリビジョンの内容です | レシピを今すぐ実行する |
| 今すぐ実行 | レシピをその場で1回だけ実行する操作 レシピが「有効」かつ「デプロイ済み」のときだけクリックできます | レシピを今すぐ実行する |
| 定期実行 | 指定した頻度・時刻でレシピを自動実行する設定 「データ処理」タブの「スケジュール」タブで設定します | 定期実行を設定する |
| 実行パラメータ | レシピの中で の形で使える変数 実行やドライランのたびに値を差し替えられます | 実行パラメータを設定する |
| 実行履歴 | 実行の記録 いつ・どのレシピが・どのリビジョンで・何件処理したかが残ります | 実行履歴を確認する |
| 抽出行数 | ソースから取得した行数 | 実行の詳細を調査する |
| 読込行数 | ターゲットへの書き込みが完了した行数 | 実行の詳細を調査する |
| エラー行数 | 処理中にエラーになった行数 | 実行の詳細を調査する |
| 実行結果ファイル | エクスポートの実行で生成されたファイル 実行履歴からダウンロードできます | 実行結果ファイルをダウンロードする |
| 通知 | 実行結果をメールや Webhook で知らせる設定 | 通知を設定する |
権限に関する用語
データブリッジの権限は、「ロールの機能制限設定」による機能単位の権限と、「アクセス権限」によるレシピ単位の権限の2段構えです。
| 用語 | 意味 | 詳しくは |
|---|---|---|
| データブリッジ管理者 | ロールの機能制限設定の権限 すべてのデータブリッジ機能へのアクセスと、レシピの作成・編集・実行ができます | YESOD データブリッジについて |
| データブリッジユーザー | ロールの機能制限設定の権限 権限が付与されたレシピの操作に限り、データブリッジ機能へアクセスできます | YESOD データブリッジについて |
| アクセス権限 | レシピごとに、操作できるメンバーを設定するもの 「実行権限」と「編集権限」の2種類があります | レシピのアクセス権限を管理する |
| 実行権限 | レシピの実行・閲覧ができるアクセス権限 | レシピのアクセス権限を管理する |
| 編集権限 | 実行に加えて、レシピの編集・デプロイができるアクセス権限 | レシピのアクセス権限を管理する |
接続設定の作成・編集・削除は、データブリッジ管理者のみが行えます。
接続設定は複数のレシピから共有される設定のため、データブリッジユーザーの権限では操作できません。
間違えやすい用語の使い分け
名前が似ていて混同しやすい用語を、ここでまとめて整理します。
「保存」と「デプロイ」
「保存」は編集中の内容を残すだけの操作で、実行される内容は変わりません。実行に反映するには「デプロイ」が必要です。
| 項目 | 保存 | デプロイ |
|---|---|---|
| 変わるもの | 編集中の内容 | 実行される内容（アクティブリビジョン） |
| 操作したあとの運用ステータス | 「未デプロイの変更あり」になります | 「デプロイ済み」になります |
| 稼働中の実行への影響 | ありません | 次回の実行から反映されます |
「編集した内容が実行に反映されない」というお問い合わせは、保存だけでデプロイをしていない場合がほとんどです。
運用ステータスが「未デプロイの変更あり」になっていないかを確認してください。（レシピを編集して再デプロイする）
「レシピの無効化」と「定期実行の無効化」
どちらも実行を止める操作ですが、止まる範囲と反映のタイミングが異なります。
| 項目 | レシピの無効化 | 定期実行の無効化 |
|---|---|---|
| 定期実行 | 実行されません | 実行されません |
| 「今すぐ実行」 | できません | できます |
| 操作する場所 | レシピ詳細の「その他のアクション」＞「無効化する」 | 「データ処理」タブ＞「スケジュール」タブの「定期実行を有効にする」をオフにして「保存」 |
| 反映のタイミング | 操作した時点 | 保存してデプロイしたあと |
一時的に自動実行だけを止めたい場合は、レシピの無効化ではなく定期実行の無効化を使ってください。
レシピを無効化すると、手動での実行もできなくなります。（レシピを無効化・有効化する／定期実行を設定する）
「ドライラン」と「実行」
ドライランはターゲットに書き込まない試験実行です。実行履歴に残らないため、記録を残したい確認には使えません。
| 項目 | ドライラン | 実行 |
|---|---|---|
| ターゲットへの書き込み | 行いません | 行います |
| 対象になる内容 | 編集中（未デプロイ）の内容 | デプロイ済み（アクティブリビジョン）の内容 |
| デプロイ前でも使えるか | 使えます | 使えません |
| 実行履歴への記録 | 残りません | 残ります |
「アセット」（アカウントコントロール）と「インポート設定」（ディレクトリサービス）
どちらも「YESOD 側のデータの参照先」ですが、定義されている場所が異なります。「アセット」はアカウントコントロールの「業務アセット」、「インポート設定」はディレクトリサービスの「インポート」設定です。データブリッジでは、どちらも登録済みのものを選ぶだけで、作成・編集はできません。
| 項目 | アセット | インポート設定 |
|---|---|---|
| 実体 | アカウントコントロールの「業務アセット」 | ディレクトリサービスの「インポート」設定 |
| 使う場所 | エクスポートのレシピの「ソース」 | インポートのレシピの「ターゲット」 |
| 役割 | YESOD のどのデータを書き出すかを決めます 書き出せる項目は、業務アセットの属性マッピングで決まります | YESOD へどのように取り込むかを決めます |
| 作成・編集 | アカウントコントロールで行います | ディレクトリサービスで行います |
アカウントコントロールで業務アセットを、またはディレクトリサービスでインポート設定を削除すると、それを参照していたレシピは「アセットが見つかりません」「インポート設定が見つかりません」の状態になります。
この状態ではデプロイに失敗するため、「編集」から選び直してください。（デプロイできないときの対応（整合性エラー））
アカウントコントロールを利用していない場合、エクスポートのレシピは組めません。
アセットの一覧には、アカウントコントロールに登録されている業務アセットがそのまま表示されます。利用していない場合は選べるアセットがなく、ソースを設定できません。
インポート（外部システム→YESOD）はディレクトリサービスのインポート設定を使うため、アカウントコントロールを利用していない場合でも利用できます。（ソースを設定する（アセット））
「接続設定」はデータの向きを持たない共通リソース
接続設定は、レシピの外側で管理される共通の設定です。インポート用・エクスポート用という区別はなく、同じ接続設定を複数のレシピのソース・ターゲットの両方から参照できます。