カスタム処理に利用できるトリガと変数の一覧
カスタム処理を使用して、特定の処理の途中で独自の処理の実行ができます。
例えば、「トリガー」フィールドに「コンテンツの追加後」を選択し、対象のコンテンツ定義を選択することで、特定のコンテンツ定義IDのコンテンツが追加された場合に処理を実行できます。
利用できる変数はテンプレートにあらかじめ変数がアサインされていることを指し、返り値はテンプレートにアサインされている場合にシステムが処理の結果として認識する変数であることを指します。
選択したトリガーにより利用できる変数が異なります。トリガー毎の利用できる変数をまとめましたので下記ご参照ください。
コンテンツ
コンテンツの表示（管理画面）
注意：このトリガーは「スーパーユーザー」でログインしている場合も実行されますが、$filters・$disable_columns・$default_columns は「スーパーユーザー」には適用されません（$errors・$form_data は適用されます）。
コンテンツ一覧画面、コンテンツ編集画面表示時に呼び出されます。
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの表示（管理画面）」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $topics_id | Integer | コンテンツID（新規作成時は空、既存コンテンツ編集時はIDが入る） |
返り値
| 変数名 | 型 | 説明 | サンプル |
|---|---|---|---|
| $filters | Object | フィルター条件 | {"filter":"subject contain SomeText","order:"subject=ASC"}詳細はFilter検索のパラメータを参照ください。 |
| $disable_columns | Array | 非表示にしたい項目キー | ["ymd", ... ] |
| $default_columns | Array | デフォルト表示にしたい項目のキー名、表示名、ソートの有無 | [[{"key_name":"topics_id","disp_name":"TOPICS ID","sortable":true}, ...]] |
| $form_data | Object | コンテンツ編集画面を開いた際の初期値 | コンテンツの新規作成時に初期値を設定する |
| $errors | String Array Object | 表示エラー | "エラーメッセージ" [ "エラーメッセージ", ... ] { "項目名": "エラーメッセージ", ... } |
コンテンツの表示(API)
注意：このトリガーによるフィルターは「スーパーユーザー」でのAPIリクエスト時には適用されません。 APIでコンテンツを取得する際に呼び出されます。コンテンツ一覧・詳細のAPIエンドポイントに加え、コンテンツに紐づくファイルへのアクセス（IMG_URL / API_URL経由）時にも呼び出されるため、ファイルダウンロードのアクセス制御にも利用できます。 コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの表示(API)」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $filter | String | フィルター条件 詳細はFilter検索のパラメータを参照ください。 |
| $errors | String Array Object | エラーメッセージ |
| $http_code | Integer | HTTPステータスコード（400, 401, 404） |
APIリクエストパラメータのfilterとの違い
$filter はAPIリクエストパラメータの filter と同じ書式ですが、以下の点が異なります。
- 追加条件として適用: リクエストパラメータの
filterを上書きするのではなく、別のWHERE句として追加（AND）されます。API呼び出し側が指定したfilterと、このトリガーの$filterの両方が同時に適用されます。 - 全カラムでフィルター可能: リクエストパラメータの
filterはエンドポイント設定の許可カラムに制限されますが、トリガーの$filterは全カラムを対象にフィルターできます。 - スーパーユーザーの自動バイパス: このトリガーのフィルターはスーパーユーザーのAPIリクエスト時には自動的にスキップされます。
- ファイルアクセスにも適用: コンテンツに紐づくファイルへのアクセス時にも呼び出されるため、ファイルのアクセス制御が可能です。
- アクセス拒否:
$http_codeに 400/401/404 を返すことで、フィルターではなくアクセス自体をブロックできます。
使用例
ログインメンバーが自分の投稿したコンテンツのみAPI経由で取得できるようにする例：
{if $smarty.session.member_id}
{assign var="filter" value="member_id = `$smarty.session.member_id`"}
{else}
{assign var="filter" value="member_id = 0"}
{/if}
この例では、ログイン中のメンバーは自分が作成したコンテンツのみ取得でき、未ログイン時は member_id = 0 により該当コンテンツが存在しないため、コンテンツは返されません。
承認待ちコンテンツの表示（管理画面）
注意：このトリガーは「スーパーユーザー」でログインしている場合も実行されますが、絞り込みに関する返り値（$filters・$trigger_filter_group_ids・$approvalflow_id・$authorized_status・$can_approve・$my_applications）は「スーパーユーザー」には適用されません（$errors は適用されます）。
管理画面の承認待ちコンテンツ一覧画面（/management/topics/topics_waiting_for_approval_list/）の表示時に呼び出されます。また、コンテンツ一覧画面の承認待ちボックスも同じ画面のデータを取得しているため、その件数・一覧にもこのトリガーの結果が適用されます。API経由で承認待ちコンテンツを取得する場合には呼び出されません。
承認待ちコンテンツ一覧画面はコンテンツ定義を指定せずに複数のコンテンツ定義をまたいで表示することもできるため、このトリガーはコンテンツ定義IDを指定して設定することはできません（「共通」としてのみ設定できます）。表示対象のコンテンツ定義IDは $topics_group_ids で取得できるため、コンテンツ定義ごとに処理を分けたい場合はカスタム処理内で $topics_group_ids を判定してください。
コンポーネントの指定方法
- トリガー : 「承認待ちコンテンツの表示（管理画面）」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_group_ids | Array | 表示対象のコンテンツ定義ID |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
返り値
| 変数名 | 型 | 説明 | サンプル |
|---|---|---|---|
| $filters | Object | フィルター条件order には一覧画面の詳細検索の並び順で選択できる項目を指定できます（topics_id、slug、ymd、subject、inst_ymdhi、update_ymdhi、および並び替えに対応した拡張項目）。 | {"filter":"subject contains \"テスト\"","order":"subject=ASC"}詳細はFilter検索のパラメータを参照ください。 |
| $trigger_filter_group_ids | Array | 表示対象とするコンテンツ定義ID ログインユーザーが権限を持つコンテンツ定義IDのみが適用されます。権限のあるIDが1件もない場合は無視されます。 | [1, 2] |
| $approvalflow_id | Integer Array | 絞り込む承認フローID | 3 [3, 4] |
| $authorized_status | Integer Array | 絞り込む承認ステータス（0: 承認待ち、10: 承認完了） | [0] |
| $can_approve | Boolean | true の場合、ログインユーザーが承認できるコンテンツのみを表示します。 | true |
| $my_applications | Boolean | true の場合、ログインユーザーが申請したコンテンツのみを表示します。 | true |
| $errors | String Array Object | 表示エラー | "エラーメッセージ" [ "エラーメッセージ", ... ] { "項目名": "エラーメッセージ", ... } |
注記
$trigger_filter_group_ids、$approvalflow_id、$authorized_status、$can_approve、$my_applications、および $filters.filter を返した場合、画面で指定された検索条件よりもトリガーの返り値が優先されます。$filters.order は、画面やエンドポイント設定で明示的な並び順が指定されていない場合にのみデフォルトの並び順として適用されます（明示的な指定がある場合はそちらが優先されます）。
使用例
ログインユーザーが承認できる承認待ちコンテンツのみを表示する例：
{assign var="can_approve" value=true}
タイトルに特定の文字列を含む承認待ちコンテンツのみを表示する例：
{assign_array var="filters" values=""}
{assign var="filters.filter" value="subject contains \"テスト\""}
コンテンツ定義ID 1 の承認待ちコンテンツ一覧を表示している場合のみ、自分の申請のみに絞り込む例：
{assign var="target_group_id" value=1}
{if $target_group_id|in_array:$topics_group_ids}
{assign var="my_applications" value=true}
{/if}
コンテンツ定義の表示（管理画面）
注意：このトリガーは「スーパーユーザー」でログインしている場合も実行されますが、$disable_columns は「スーパーユーザー」には適用されません（$errors は適用されます）。
コンポーネントの指定方法
- トリガー : 「コンテンツ定義の表示（管理画面）」を選択
利用できる変数
なし
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $disable_columns | Array | 非表示にしたい項目キー |
コンテンツダウンロードのデータ毎の処理
コンテンツ定義IDごとに設定できます。
コンテンツのデータダウンロード時に、ヘッダ行および各データ行ごとにトリガ処理が実行されます。
コンポーネントの指定方法
- トリガー : 「コンテンツダウンロードのデータ毎の処理」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | String[] | ヘッダ文字の連想配列 ヘッダ行に対応するトリガ処理実行時のみに指定される キーに各行と同一のキー文字列が設定されている（拡張項目は ext_1 形式） |
| $row | String[] | ダウンロードするデータの連想配列 データ行に対応するトリガ処理実行時のみに指定される キーにヘッダ行と同一のキー文字列が設定されている |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | String[] | ヘッダ文字の連想配列、ヘッダ文字列を変更したい場合に返り値に指定する |
| $row | String[] | データの連想配列、出力内容を変更したい場合に返り値に指定する |
| $errors | String Array Object | 表示エラー "エラーメッセージ" [ "エラーメッセージ", ... ] { "項目名": "エラーメッセージ", ... } |
コンテンツの追加前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの追加前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの追加後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの追加後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $ext_config | Object | 拡張設定情報 |
コンテンツの更新前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの更新前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの更新後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの更新後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツの削除前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの削除後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの削除後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツの途中保存前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの途中保存後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $draftId | Int | 途中保存データID |
| $topicsData | Object | 記事データ |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
コンテンツの途中保存削除前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object { topics_id:Int, draftId:Int, ...} | フォームのデータ |
コンテンツの途中保存削除後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存削除後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $draftId | Int | 途中保存データID |
コンテンツの途中保存更新前
コンテンツ定義IDごとに設定できます。
既存の途中保存データを更新する前に呼び出されます。
注記
このトリガーは、コンテンツAPIのdraft_update（途中保存の更新）を実行した場合に呼び出されます。管理画面上で新しく途中保存を行う操作（draft_save）や、コンテンツの公開時には呼び出されません。
draft_updateの詳細はエンドポイント 設定項目一覧を参照してください。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存更新前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
注記
このトリガーの返り値は途中保存データには反映されません。
コンテンツの途中保存更新後 提供版: β版
コンテンツ定義IDごとに設定できます。
既存の途中保存データの更新が完了した後に呼び出されます。
注記
このトリガーは、コンテンツAPIのdraft_update（途中保存の更新）を実行した場合に呼び出されます。管理画面上で新しく途中保存を行う操作（draft_save）や、コンテンツの公開時には呼び出されません。
draft_updateの詳細はエンドポイント 設定項目一覧を参照してください。
コンポーネントの指定方法
- トリガー : 「コンテンツの途中保存更新後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツをコピーする場合
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツをコピーする場合」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $copy_topics_id | Int | コピー元コンテンツID |
| $copy_topics_data | Object | コピー対象データ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $data | Object | コピー項目から変更するデータ |
使用例
{*変更したいデータのみdataにassignする*}
{assign_array var=data values=''}
{assign var=data.subject value='copy data'}
{assign var=data.ext_1 value='new text'}{*テストデータ*}
{assign_array var=check values=''}{*チェックボックス*}
{assign var=check. value='2'}
{assign var=check. value='3'}
{assign var=data.ext_2 value=$check}
{assign var=data.ext_3 value='2025-01-02 10:13'}{*日付+時間*}
コンテンツの差し戻し前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの差し戻し前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの差し戻し後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの差し戻し後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツの取り下げ前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの取り下げ前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの取り下げ後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの取り下げ後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $topics_group_id | Int | コンテンツ定義ID |
コンテンツの申請前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの申請前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの申請後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの申請後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツの承認前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの承認前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
| $original_operation_mode | String | 承認がコンテンツに対してどの動作になるか (INSERT,UPDATE,DELETE,ACCEPT) |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | フォームのデータ |
コンテンツの承認後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの承認後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツの公開・非公開バッチ後
- トリガー : 「コンテンツの公開・非公開バッチ後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $open_flg | Int | 1: 公開、0: 非公開 |
コンテンツのバリデーション前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツのバリデーション前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $uploaded_row | Object | CSVアップロード時の行データ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | Object {項目名: エラーメッセージ, ...} | 入力エラー |
コンテンツのアップロード前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツの追加前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $update_topics_ids | Int[] | 更新対象とするコンテンツIDの配列 |
コンテンツのアップロード後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツのアップロード後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $update_topics_ids | Int[] | 更新したコンテンツIDの配列 |
| $insert_topics_ids | Int[] | 追加したコンテンツIDの配列 |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
コンテンツのファイルをダウンロードした後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツのファイルをダウンロードした後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
コンテンツ カテゴリを追加した後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツカテゴリの追加後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_category_id | Int | コンテンツカテゴリID |
| $topics_category_data | Object | 追加したカテゴリ情報 |
コンテンツ カテゴリの更新後
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツカテゴリの更新後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_category_id | Int | コンテンツカテゴリID |
| $topics_category_data | Object | 更新後のカテゴリ情報 |
コンテンツのCDNキャッシュ削除前
コンテンツ定義IDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「コンテンツのCDNキャッシュ削除前」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_group_id | Int | コンテンツ定義ID |
| $MODE | String | 処理モード |
| $topics_id | Int | コンテンツID |
| $lang | String | 言語 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $cancel_cdn_cache_purge | Bool | true: CDNキャッシュ削除をキャンセル false: CDNキャッシュ削除を実行 |
プレビューサイトに送った後
コンテンツ定義IDごとに設定できます。 コンテンツをプレビューサイト（ステージサイト）へ送信する処理が完了した後に呼び出されます。
コンポーネントの指定方法
- トリガー : 「プレビューサイトに送った後」を選択
- テキストフィールド : トリガーの対象とするコンテンツ定義IDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $topics_id | Int | コンテンツID |
| $topics_group_id | Int | コンテンツ定義ID |
| $topicsData | Object | コンテンツの詳細データ |
| $ext_config | Object (ext_config) | コンテンツ拡張設定 |
| $stage_site_id | Int | 送信先のプレビューサイト（ステージサイト）のサイトID |
マスタ
マスタの追加後
コンポーネントの指定方法
- トリガー : 「マスタの追加後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $csvtable_id | Int | マスタID |
マスタの更新後
コンポーネントの指定方法
- トリガー : 「マスタの更新後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $csvtable_id | Int | マスタID |
マスタの削除後
コンポーネントの指定方法
- トリガー : 「マスタの削除後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $csvtable_id | Int | マスタID |
メンバー
メンバーの登録前
コンポーネントの指定方法
- トリガー : 「メンバーの登録前」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
注記
$row.group_idによる所属グループの書き換えは、登録を実行している操作者にグループの更新権限がある場合に限り反映されます。権限がない場合はメンバー設定のデフォルトグループが使用されます。
メンバーの登録前(管理画面招待)
コンポーネントの指定方法
- トリガー : 「メンバーの登録前(管理画面招待)」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
注記
$row.emailは書き換えできません（招待時に確定したメールアドレスで固定されます）。$row.group_idによる所属グループの書き換えはできません。招待時に設定されたデフォルトグループが使用されます。
メンバーの登録前(連携時)
コンポーネントの指定方法
- トリガー : 「メンバーの登録前(連携時)」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
| $register_type | String | 連携タイプ（例：'saml'） |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
注記
$row.emailおよび$row.login_idは、連携元から受け取った認証識別子で固定されるため、書き換えできない場合があります（連携方式や設定により、いずれか一方または両方が固定されます）。$row.group_idによる所属グループの書き換えはできません。連携登録処理に渡されたグループIDが使用されます。
メンバーの編集前
コンポーネントの指定方法
- トリガー : 「メンバーの編集前」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
メンバーの登録後
コンポーネントの指定方法
- トリガー : 「メンバーの登録後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
メンバーの登録後(管理画面招待)
コンポーネントの指定方法
- トリガー : 「メンバーの登録後(管理画面招待)」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
メンバーの登録後(連携時)
コンポーネントの指定方法
- トリガー : 「メンバーの登録後(連携時)」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
| $register_type | String | 連携タイプ（例：'saml'） |
メンバーの更新後(連携時)
連携ログイン時に既存メンバーの情報が更新された後に呼び出されます。自動ユーザ登録で既存メンバーの更新を行う設定の場合が対象です。
コンポーネントの指定方法
- トリガー : 「メンバーの更新後(連携時)」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
| $update_flg | Boolean | 更新処理であることを示すフラグ（常に true） |
| $register_type | String | 連携タイプ（例：'saml'） |
メンバーの編集後
コンポーネントの指定方法
- トリガー : 「メンバーの編集後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
メンバーのバリデーション前
コンポーネントの指定方法
- トリガー : 「メンバーのバリデーション前」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
| $formData | Object {member_id: Int, name1: String, ...} | メンバー入力情報 |
| $memberExtensionColumns | Object[] [{ disp_name: String, key_name: String, type: String, ...}, ...] | メンバー入力項目 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | Object {項目名: エラーメッセージ, ...} | 入力エラー |
メンバーの一括アップロードのデータ毎の前処理
注記
メンバーのCSV一括アップロードでは、メンバーの個別追加・編集で発火するトリガー（「メンバーのバリデーション前」「メンバーの登録前」「メンバーの編集後」など）は発火しません。CSV一括アップロード時に各行のデータの取得・書き換え・検証を行いたい場合は、このトリガーを使用してください。
コンポーネントの指定方法
- トリガー : 「メンバーの一括アップロードのデータ毎の前処理」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object {member_id: Int, name1: String, ...} | メンバー情報 |
| $errors | String[] | エラー文字列の配列 |
メンバーの一括アップロード後
注記
メンバーのCSV一括アップロードでは、メンバーの個別追加・編集で発火するトリガー（「メンバーの編集後」「メンバーの登録後」など）は発火しません。CSV一括アップロードの完了後に処理を実行したい場合は、このトリガーを使用してください。
コンポーネントの指定方法
- トリガー : 「メンバーの一括アップロード後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_ids | Int[] | 更新したメンバーIDの一覧 |
タグ
タグの追加後
コンポーネントの指定方法
- トリガー : 「タグの追加後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $tag_id | Int | タグID |
| $tagData | Object {tag_id: Int, tag_nm: String, ...} | タグ情報 |
タグの更新後
コンポーネントの指定方法
- トリガー : 「タグの更新後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $tag_id | Int | タグID |
| $tagData | Object {tag_id: Int, tag_nm: String, ...} | タグ情報 |
タグのバリデーション前
コンポーネントの指定方法
- トリガー : 「タグのバリデーション前」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $tag_id | Int | タグID |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | Object {項目名: エラーメッセージ, ...} | 入力エラー |
アクティビティ
アクティビティのバリデーション前
コメントヘッダーIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「アクティビティのバリデーション前」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $comment_header_id | Int | コメントヘッダーID |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | Array [エラーメッセージ, ...] | 入力エラー |
アクティビティの追加後
API経由でアクティビティ（コメント）が追加された際に呼び出されます。
コンポーネントの指定方法
- トリガー : 「アクティビティの追加後」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $comment_header_id | Int | コメントヘッダーID |
| $comment_id | Int | コメントID |
アクティビティの更新後
API経由でアクティビティ（コメント）が更新された、 もしくは管理画面からアクティビティ（コメント）を更新した再に呼び出されます。
コンポーネントの指定方法
- トリガー : 「アクティビティの更新後」を選択
- テキストフィールド : トリガーの対象とするコメントヘッダーIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $comment_header_id | Int | コメントヘッダーID |
| $comment_id | Int | コメントID |
EC
ECの在庫チェックロジック実行後
コンポーネントの指定方法
- トリガー : 「ECの在庫チェックロジック実行後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $cart_items | Object {製品ID: { product_name: String, topics_name:String, ...}, ...} | カート内の商品 |
| $products | Object { topics_name: String, ...} | 商品情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | Object {項目名: エラーメッセージ, ...} | 入力エラー |
ECの支払処理完了後
決済が完了したタイミングで呼び出される。 支払い無し（0円）での購入、クレジットカード決済の場合は購入時に決済処理が行われるので「ECの注文処理完了後」ではなくこちらのトリガー処理を利用すること。
コンポーネントの指定方法
- トリガー : 「ECの支払処理完了後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $order_id | Int | 注文番号 |
| $customerId | Int | 注文者のメンバーID |
| $name1 | String | 注文者の姓 |
| $name2 | String | 注文者の名 |
| $group_list | Object { topics_name:String, ...} | 注文者のグループ情報 |
| $member_data | Object { name1: String, name2: String, email: String, ...} | 注文者のメンバーデータ |
| $order_info | Object{ ec_order_id:Int, payment_method:Int, payment_total:Number, total:Number, subtotal:Number, deliv_fee:Number, trade_number:String, approval_number:String, ...} | 注文情報 |
| $payment_type_options | Object{支払方法ID: 支払方法, ....} | キーにIDを持つ支払い方法の一覧 |
| $products | Object{ product_name:String, product_id:Int, topics_name:String, topics_id:Int, price:Number, quantity:Int, ...} | 購入商品情報 |
| $product_ids | Array | 商品IDの配列 |
| $is_exists_download_product | Int | 1: ダウンロード商品あり 0: ダウンロード商品無し |
| ※他にも利用可能な変数はありますがよく使うもののみ記載しております |
返り値
なし。
ECの注文処理完了後
注文が完了したタイミングで呼び出される。
コンポーネントの指定方法
- トリガー : 「ECの注文処理完了後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $order_id | Int | 注文番号 |
| $customerId | Int | 注文者のメンバーID |
| $name1 | String | 注文者の姓 |
| $name2 | String | 注文者の名 |
| $group_list | Object { topics_name:String, ...} | 注文者のグループ情報 |
| $member_data | Object { name1: String, name2: String, email: String, ...} | 注文者のメンバーデータ |
| $order_info | Object{ ec_order_id:Int, payment_method:Int, payment_total:Number, total:Number, subtotal:Number, deliv_fee:Number, trade_number:String, approval_number:String, ...} | 注文情報 |
| $payment_type_options | Object{支払方法ID: 支払方法, ....} | キーにIDを持つ支払い方法の一覧 |
| $products | Object{ product_name:String, product_id:Int, topics_name:String, topics_id:Int, price:Number, quantity:Int, ...} | 購入商品情報 |
| $product_ids | Array | 商品IDの配列 |
| $is_exists_download_product | Int | 1: ダウンロード商品あり 0: ダウンロード商品無し |
| ※他にも利用可能な変数はありますがよく使うもののみ記載しております |
返り値
なし。
認証
ログインロジックの追加
このトリガーは、標準の認証処理（ID/パスワード認証、SAML、SSO等）とは別に、カスタム処理テンプレートによる独自の認証ロジックを追加するためのものです。
ログイン時、システムは複数の認証方式を順番に試行します。標準の認証方式（ID/パスワード、SAML、SSO等）がすべて失敗した場合に、このトリガーで設定したカスタム処理が実行されます。カスタム処理テンプレート内で返り値の変数をアサインすることで、ログインの可否やログイン対象のユーザーを制御できます。
このトリガーは管理画面のログインとAPIのログインの両方で発火します。
コンポーネントの指定方法
- トリガー : 「ログインロジックの追加」を選択
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $login_email | String | メールアドレスまたはログインID。ログイン対象のメンバーを特定するために使用します。 |
| $login_member_id | Int | メンバーID。$login_emailの代わりにメンバーIDで直接指定することもできます。 |
| $login_save | Bool | ログイン状態を維持する |
| $is_login | Bool | ログインを許可する。trueにするとログインが許可されます。falseまたは未設定の場合、ログインは失敗します。 |
| $custom_search_ids | Int[] | セッションにセットするカスタムメンバーフィルターのID配列（オプション）。通常、ログイン時にはメンバーの情報をもとに「そのメンバーが条件に合致するカスタムメンバーフィルター」のIDリストが自動算出されます。この変数を指定すると、自動算出の代わりに指定したIDリストがそのままセッションにセットされます。これにより、本来はフィルタ条件に合致しないカスタムメンバーフィルターのIDを強制的に付与でき、そのフィルターで制限されたAPIエンドポイントへのアクセスを許可できます。未指定の場合は通常通り自動算出されます。 |
APIのログイン前処理
コンポーネントの指定方法
- トリガー : 「APIのログイン前処理」を選択
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | String[] | エラーメッセージ、設定された場合はログイン失敗となる。 |
| $is_login | Bool | true: ログイン済み、false: 未ログイン falseの場合、その後の処理でオートログインが行われる。 |
ログイン後処理
コンポーネントの指定方法
- トリガー : 「ログイン後処理」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $is_login | Bool | ログインを許可する |
| $auto_login | Bool | ログインを保存する |
| $custom_search_ids | Int[] | ログインするユーザーの権限 |
| $member_id | Int | メンバーID |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $is_login | Bool | ログインを許可する |
| $auto_login | Bool | ログインを保存する |
| $custom_search_ids | Int[] | ログインするユーザーの権限 |
SSOを使用してログインした後
コンポーネントの指定
- トリガー: 「SSOを使用してログインした後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $external_login_type | String | IDAAS、SAML、OAUTH のいずれかの値がアサインされます。 |
| $external_login_id | Int | 設定された外部SSOサービスプロバイダーのID |
| $member_id | Int | メンバーID |
| $is_register | Bool | 現在のログインが新規登録かどうか |
リマインダーでのパスワード変更後
コンポーネントの指定方法
- トリガー : 「リマインダーでのパスワード変更後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_id | Int | メンバーID |
承認ワークフロー
承認ワークフローの申請後
承認ワークフローIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローの申請後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
承認ワークフローの承認後
承認ワークフローIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローの承認後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
| $approvalflow_apply | Object {approvalflow_id: Int, draft_id: Int, ...} | 申請情報 |
| $nextApply | Object {approvalflow_id: Int, approvalflow_apply_id: Int, ...} | 次の承認申請依頼情報 |
承認ワークフローの差し戻し後
承認ワークフローIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローの差し戻し後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
承認ワークフローのフェーズへの差し戻し後
承認ワークフローIDごとに設定できます。
同一の承認ワークフロー内の指定したフェーズへ差し戻した後に呼び出されます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローのフェーズへの差し戻し後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
承認ワークフローの別フローへの差し戻し後
承認ワークフローIDごとに設定できます。
別の承認ワークフローへ差し戻した後に呼び出されます。対象の承認ワークフローIDは、差し戻し先（移動先）の承認ワークフローIDで判定されます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローの別フローへの差し戻し後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
承認ワークフローの取り下げ後
承認ワークフローIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「承認ワークフローの取り下げ後」を選択
- テキストフィールド : トリガーの対象とする承認ワークフローIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $module_nm | String | モジュール名 |
| $module_id | Int | モジュールID |
| $apply_language | String | 申請データの言語 |
配信
配信の宛先追加
マガジンIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「配信の宛先追加」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $magazine_data | Object {magazine_id: Int, magazine_name: String, ...} | 配信情報 |
| $destination | Int[] | 送信対象者メンバー検索条件ID |
| $search_condition_list | String[] | 送信対象者メンバー検索条件 |
| $preview_flg | Bool | 管理画面からの事前確認時にはtrue |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $additional_member_ids | Int[] | 追加する送信対象者メンバーID |
配信の送信前
マガジンIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「配信の送信前」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $mail_header | String | メールヘッダ |
| $subject | String | 題名 |
| $body | String | 本文(HTML) |
| $body_plain | String | 本文(テキスト) |
| $can_send | Bool | 送信許可 |
| $member_id | Int | メンバーID |
| $magazine_data | Object {magazine_id: Int, magazine_name: String, ...} | 配信情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $mail_header | String | メールヘッダ |
| $subject | String | 題名 |
| $body | String | 本文(HTML) |
| $body_plain | String | 本文(テキスト) |
| $can_send | Bool | 送信許可 |
| $member | Object {email: String, ...} | メンバー情報 |
配信の差し込み
マガジンIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「配信の差し込み」を選択
- テキストフィールド : トリガーの対象とするマガジンIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $member_info | Object {member_id: Int, name1: String, ...} | 送信対象者情報 |
| $magazine_info | Object {magazine_id: Int, magazine_name: String, ...} | 配信情報 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $substitutions | Object {置き換えられる文字列: 置き換える文字列, ...} | 置換する文字列 |
フォーム
回答データの表示（管理画面）
フォームIDごとに設定できます。
回答一覧の表示、回答内容の表示の際にトリガ処理が実行されます。
注意：このトリガーは「スーパーユーザー」でログインしている場合も実行されますが、$filters は「スーパーユーザー」には適用されません（$errors は適用されます）。
コンポーネントの指定方法
- トリガー : 「回答データの表示（管理画面）」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $inquiry_bn_id | Int | 回答データID |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $errors | String Array Object | 表示エラー |
| $filters | Object | フィルター条件 |
回答ダウンロードのデータ毎の処理
フォームIDごとに設定できます
フォームの回答データダウンロード時にヘッダ行、及びそれぞれの回答データ行毎にトリガ処理が実行されます。
コンポーネントの指定方法
- トリガー : 「回答ダウンロードのデータ毎の処理」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | String[] | ヘッダ文字の連想配列 ヘッダ行に対応するトリガ処理実行時のみに指定される キーに各行と同一のキー文字列が設定されている |
| $row | String[] | CSV文字列の連想配列 回答行に対応するトリガ処理実行時のみに指定される キーにヘッダ行と同一のキー文字列が設定されている |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | String[] | ヘッダ文字の連想配列、ヘッダ文字列を変更したい場合に戻り値に指定する |
| $row | String[] | CSV文字列の連想配列、CSVの内容を変更したい場合に戻り値に指定する |
| $errors | String Array Object | 表示エラー "エラーメッセージ" [ "エラーメッセージ", ... ] { "項目名": "エラーメッセージ", ... } |
回答データ更新前
フォームIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「回答データ更新前」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | Object | フォームヘッダー情報 |
| $inquiry_bn_id | Int | 回答データID |
| $row | Object | 回答データ |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $row | Object | 回答データ |
回答データ更新後
フォームIDごとに設定できます。
コンポーネントの指定方法
- トリガー : 「回答データ更新後」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $header | Object | フォームヘッダー情報 |
| $inquiry_bn_id | Int | 回答データID |
メッセージひな形
デフォルトのメール送信方法（SendGrid）を代替
メール送信時に呼び出され、メールの送信をデフォルト(SendGrid)以外のメール配信サービスに置き換える用途で使用します。
コンポーネントの指定方法
- トリガー: "デフォルトのメール送信方法（SendGrid）を代替" を選択します
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $payload | String | メールの内容とパラメータを含むJSON文字列 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $is_mail_sent | Bool | true: 標準のメール送信を行わない false: 標準のメール送信を行う |
メールテンプレート利用メール送信時
メールテンプレート（メッセージひな形）ごとに設定できます
コンポーネントの指定方法
- トリガー : 「メールテンプレート利用メール送信時」を選択
- テキストフィールド : トリガーの対象とするメッセージひな形のIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $body | String | 送信メール文面 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $body | String | 送信メール文面 |
| $avoid_sending | Bool | true: 標準のメール送信を行わない false: 標準のメール送信を行う |
お問い合わせサンクスメール送信時
フォームIDごとに設定できます
コンポーネントの指定方法
- トリガー : 「お問い合わせサンクスメール送信時」を選択
- テキストフィールド : トリガーの対象とするフォームIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $body | String | 送信メール文面 |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $body | String | 送信メール文面 |
| $avoid_sending | Bool | true: 標準のメール送信を行わない false: 標準のメール送信を行う |
メールテンプレートの更新前
コンポーネントの指定方法
- トリガー : 「メールテンプレートの更新前」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $mailtemplateedit_id | Int | メールテンプレートID |
メールテンプレートの更新後
コンポーネントの指定方法
- トリガー : 「メールテンプレートの更新後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $mailtemplateedit_id | Int | メールテンプレートID |
API
キャッシュクリアするボタンをクリックした時
APIごとに設定できます
APIにキャッシュを設定している場合に、API一覧に表示される[キャッシュクリアする]ボタン押下時に呼び出されます。
コンポーネントの指定方法
- トリガー : 「キャッシュクリアするボタンをクリックした時」を選択
- テキストフィールド : トリガーの対象とするAPIのIDを入力
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $api_uri_id | Int | APIのID |
GitHub
Githubのデプロイリクエスト時
コンポーネントの指定方法
- トリガー : 「Githubのデプロイリクエスト時」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $re_run | Bool | 過去に実行したビルドを指定しての再実行か |
| $original_github_params | Array | GitHubに渡すパラメータ github_owner github_repo github_installation_id workflow_id (re_runがfalseの場合のみ) branch (re_runがfalseの場合のみ) |
| $ext_params | Array | 拡張情報 case、topics_group_idなど |
返り値
| 変数名 | 型 | 説明 |
|---|---|---|
| $github_params | Array | $original_github_params で渡された情報を置き換えたい場合に設定、未設定の場合は $original_github_params の情報を使用する |
| $cancel_github_deploy_request | Bool | true: 標準のGitHubActionsのワークフローを動作させない false: 標準のGitHubActionsのワークフローを動作させる |
Githubのデプロイリクエストが完了した後
コンポーネントの指定方法
- トリガー : 「Githubのデプロイリクエストが完了した後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $artifact_hash | String | GitHubActionsに対応したハッシュ値 |
Githubのデプロイが完了した後
コンポーネントの指定方法
- トリガー : 「Githubのデプロイが完了した後」を選択
利用できる変数
| 変数名 | 型 | 説明 |
|---|---|---|
| $kuroco_front_meta | Object | KurocoFrontのメタ情報 |
関連ドキュメント
サポート
お探しのページは見つかりましたか？解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。