🧩
実行パラメータを設定する
この記事では、レシピの中で使える変数「実行パラメータ」の設定方法を説明します。
実行パラメータを使うと、実行のたびに変わる値（対象日など）を、レシピの設定を書き換えずに切り替えられます。
レシピの設定項目に の形で書いておくと、実行時にその値へ置き換えられます。
Step 1 実行パラメータタブを開く
Step 2 組み込みパラメータを確認する
Step 3 カスタムパラメータを追加する ・STRING 型の場合 ・DATE 型の場合
Step 4 保存する
Step 5 レシピの設定でパラメータを使う
実行のたびに値を上書きする
Step 2 組み込みパラメータを確認する
Step 3 カスタムパラメータを追加する ・STRING 型の場合 ・DATE 型の場合
Step 4 保存する
Step 5 レシピの設定でパラメータを使う
実行のたびに値を上書きする
Step 3 カスタムパラメータを追加する
- 「カスタムパラメータ」見出しの右の「編集」をクリック
- 「パラメータを追加」をクリック
- 「パラメータ名」と「型」を入力・選択
| 項目 | 説明 |
|---|---|
| パラメータ名 必須 | レシピの設定で として参照する名前 例） |
| 型 必須 | （文字列）または （日付）を選択 |
| 既定値 | 値を指定せずに実行したときに使われる値 入力欄は型によって変わります |
追加したパラメータを取り消す場合は、その行の右の「×」をクリックしてください。編集そのものを取りやめる場合は「キャンセル」をクリックします。
STRING 型の場合
- 「既定値」に、そのまま埋め込みたい文字列を入力
DATE 型の場合
実行日を基準に、日付を自動で計算します。
| 項目 | 説明 |
|---|---|
| 日付オフセット（日） | 実行日から何日ずらすかを整数で入力 は実行日、 は前日、 は翌日 初期値は |
| フォーマット 必須 | 日付の書式 初期値は 例） と指定すると の形になります |
保存後の一覧では、「既定値」列に のように表示されます。
以下の場合は「保存」をクリックしたときにエラーが表示され、保存できません。
・パラメータ名が空欄のとき：「パラメータ名を入力してください。」
・同じパラメータ名が複数あるとき：「パラメータ名「○○」が重複しています。」
・DATE 型のフォーマットが空欄のとき：「DATE 型のフォーマットを入力してください。」
Step 5 レシピの設定でパラメータを使う
定義したパラメータは、以下の項目に の形で埋め込めます。組み込みパラメータも同じように使えます。
| レシピの種類 | タブ | 項目 |
|---|---|---|
| インポート | ソース（HTTP API） | 「パス」「クエリパラメータ」の値、「リクエストボディ」 |
| インポート | ターゲット（通常インポート） | 「変更予定への表示名」「変更日」 |
| エクスポート | ソース（アセット） | 「クエリ」の「基準日」 |
| エクスポート | ターゲット（CSV ファイル出力） | 「ファイル名パターン」 |
| エクスポート | ターゲット（HTTP API） | 「パス」 |
| 共通 | 変換 | 「日付計算」ルールの （ が「可変」のとき） |
変換の「カスタム式（CEL）」の中では使えません
が展開されるのは、上の表に挙げた場所だけです。変換ルールのカスタム式（CEL）に書いても展開されず、 という文字列のまま扱われます。
この場合、実行パラメータ側には「使用されていない実行パラメータがあります」という確認事項が表示されます。
変換の中で実行パラメータを使えるのは、「日付計算」ルールの基準日に「変数」を指定した場合だけです。
例）前日分だけ取得する
- 実行パラメータタブで、DATE 型のカスタムパラメータ を追加する 日付オフセットは -1、フォーマットは接続先の API に合わせて指定します。
- ソースタブの「クエリパラメータ」に、名前 、値 の行を追加する
- 実行すると、（前日の日付）を付けて API を呼び出します
日付の形式が でよければ、カスタムパラメータを作らずに をそのまま書いても同じことができます。
定義していないパラメータをレシピの設定で使っていると、デプロイできません。
「実行パラメータ — ○○: 宣言されていない実行パラメータが使用されています」と表示されます（○○ はパラメータ名）。（デプロイできないときの対応（整合性エラー））
逆に、定義したパラメータをどこでも使っていない場合は「実行パラメータ — ○○: 使用されていない実行パラメータがあります」と表示されますが、これは警告のみでデプロイはできます。
実行のたびに値を上書きする
カスタムパラメータを定義していると、以下のダイアログに「実行パラメータ」欄が表示され、その回だけ値を上書きできます。
- 「ドライラン」（ドライランで動作を確認する）
- 「今すぐ実行」（レシピを今すぐ実行する）
- ソースタブの「サンプルを取得」（ソーススキーマを設定する）
いずれも「既定値は実行パラメータタブで設定されたもの。今回のみ上書きできます。」と表示されます。
- 型は、設定した既定値が入力済みの状態で表示されます
- 型は空欄で表示され、入力欄には のように既定の動きが薄い文字で表示されます
- 空欄のままにすると、既定値が使われます
ここで入力した値が使われるのはその 1 回だけです。実行パラメータタブの設定は変わりません。
組み込みパラメータはこの欄に表示されず、上書きできません。
「今すぐ実行」ではアクティブリビジョンが実行されるため、この欄にはアクティブリビジョンのパラメータ定義が表示されます。
パラメータを追加・変更した直後は、デプロイするまで反映されません。