カスタムプログラム
最終更新日:2024年05月14日
概要
カスタムプログラムに設定したPHPプログラムから、スパイラルのデータベースや外部のデータソースにアクセスすることができます。
また、スパイラルAPIを経由してスパイラルのメール配信機能の呼び出しや、外部からのデータ操作が行えます。
PHPプログラムの利用については、カスタムプログラムでのPHP利用をご覧ください。
設定方法
カスタムプログラムの設定をします。
画面の「開発」＞「カスタムプログラム」をクリックします。
カスタムプログラムの一覧が表示されます。
１．新規作成
新しいカスタムプログラムを作成します。「新規作成」を押すと、作成ポップアップを表示します。
２．名前 (タイトル)
カスタムプログラムの名前とタイトルを表示します。
３．実行バージョン
PHPのバージョンを表示します。
４．定期実行
定期実行を行う場合は「有効」と表示します。
５．オープンAPI
スパライラルAPIでpasskeyとsignatureを省略できる場合は「許可」と表示します。
６．最終更新日時
カスタムプログラムの更新元と更新日時を表示します。
７．最終実行日時
カスタムプログラムの実行元と実行日時を表示します。
８．メニュー
（１）編集
カスタムプログラムの情報を表示・編集します。
（２）ログ
定期実行の結果を表示します。
（３）実行
カスタムプログラムの実行ポップアップを表示します。
（４）削除
カスタムプログラムを削除します。
カスタムプログラムの新規作成
「新規作成」のボタンをクリックします。
名前、タイトル、実行バージョン、PHPスクリプトのテンプレートを入力し「作成」ボタンをクリックするとカスタムプログラムが新規作成されます。
カスタムプログラムの編集
カスタムプログラム一覧から「編集」ボタンをクリックします。
カスタムプログラムの基本情報が表示されます。
基本設定
カスタムプログラムの基本設定を編集できます。
１．名前
カスタムプログラムの名前を設定します。他のカスタムプログラムと重複する名前は設定できません。
２．タイトル
カスタムプログラムのタイトルを設定します。他のカスタムプログラムと重複するタイトルは設定できません。
３．実行バージョン
PHPのバージョンを選択できます。
４．コメント
カスタムプログラムに関するコメントを設定します。
５．PHPスクリプト
実行するPHPスクリプトを記入します。
６．引数
PHPスクリプトに渡す引数を入力します。
複数の引数を渡す場合は半角スペースで区切ってください。
例) 引数1 引数2 引数3
引数に半角スペースを含める場合はダブルクォートかシングルｰクォートで囲んでください。
例) "空白 を 含む 引数"
７．実行
新しい画面を表示してPHPスクリプトを実行します。
８．オープンAPI
スパライラルAPIで実行する際に、passkeyとsignatureを省略できるようになります。
プログラムにAPIトークンシークレットを含める必要がなくなるため、JavaScriptでも安心してご利用頂けます。
定期実行
定期実行の設定を編集します。
１．定期実行
「利用する」を設定すると、カスタムプログラムを指定したタイミングで自動実行します。
２．実行タイミング
実行するタイミングは「月」「日 / 曜日」「時」「分」を組み合わせて設定します。 カスタムプログラムはすべての条件を満たす時間に実行されます。
（１）編集UIを表示
「＋」を押すと編集UIが表示されます。
（２）設定値を編集
チェックボックスの中から実行したい日付・時間を選択します。
３．設定例
| 実行したいタイミング | 選択する月 | 選択する日 / 曜日 | 選択する時 | 選択する分 |
| 毎日、0時に | すべて | すべて (日) | 0時 | 0分 |
| 毎月、10日の12時に | すべて | 10日 (日) | 12時 | 0分 |
| 30分に1回 | すべて | すべて (日) | すべて | 0、30分 |
| 月水木の18時に | すべて | 月、水、木 (曜日) | 18時 | 0分 |
| クリスマスに | 12月 | 25日 (日) | 0時 | 0分 |
４．定期実行の通知
有効にすると、定期実行完了時にメールで通知します。メールは「通知メール受信設定」のアドレスに送信します。
実行ログ
定期実行の結果を表示します。
※「実行」ボタンを押下した場合の手動実行ログは残りませんのでご注意ください。
１．実行日時 (処理時間)
カスタムプログラムの処理日時と掛かった時間を表示します。
２．実行者
実行元を表示します。
３．実行バージョン
PHPのバージョンを表示します。
４．出力
実行時に出力した内容を表示します。マウスオーバーで全文を確認できます。
５．エラーメッセージ
実行時に発生したエラーを表示します。マウスオーバーで全文を確認できます。
※出力される実行ログが長い場合、全文が表示されないことがございます。
その場合、定期実行の通知メールを受信して内容をご確認ください。
カスタムプログラム定期実行に関する通知
カスタムプログラムの定期実行が完了した際やエラーになった際にはメールで通知します。
文面につきましては下記をご参照ください。
スパイラル カスタムプログラム定期実行通知
件名 ：[SPIRAL:アカウント名]カスタムプログラム定期実行通知
送信先：担当者ID、アカウントのご利用管理者様、連絡先1、連絡先2に登録されているメールアドレス
文面 ：
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
スパイラル カスタムプログラム定期実行通知
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
スパイラルでご利用のカスタムプログラムが定期実行されました。
結果は以下となります。
■アカウント
==================================================
XXXXX
■カスタムプログラム名称
==================================================
XXXXXX
■出力
==================================================
XXXXXX
■実行開始時間
==================================================
XXX XXX XX XX:XX:XX XXXX
■処理時間
==================================================
XX(ms)スパイラル カスタムプログラム 定期実行エラー通知
件名 ：[SPIRAL:アカウント名]カスタムプログラム定期実行エラー通知
送信先：担当者ID、アカウントのご利用管理者様、連絡先1、連絡先2に登録されているメールアドレス
文面 ：
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
スパイラル カスタムプログラム 定期実行エラー通知
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
スパイラルでご利用のカスタムプログラムが定期実行され、
エラーが発生しました。エラー内容をご確認ください。
■アカウント
==================================================
XXXXX
■カスタムプログラム名称
==================================================
XXXXXX
■エラーメッセージ
==================================================
XXXXXX
■実行開始時間
==================================================
XXX XXX XX XX:XX:XX XXXX
■処理時間
==================================================
XX (ms)