このガイドでは、アクションスクリプトの概要から、実際のスクリプト作成、テスト方法までを詳しく解説します。 SmartStage自身のAPI操作による自動化や、外部システムとの連携など、アクションスクリプトを活用して業務効率を向上させましょう。
アクションスクリプトとは
アクションスクリプトとは、特定のアクションが実行されたタイミングで、自動的にスクリプト（Node.js）を実行する機能です。
SmartStage自身のAPI（アイテムの登録・更新など）を呼び出して複雑なデータ処理を自動化したり、「タスクのステータスを承認済みに変更した時に、外部チャットツールへ通知を送る」といった外部連携を実現したりすることができます。
事前準備
SmartStageのAPIを利用する場合や、外部連携を行う場合は、下記事前準備を実施してください。
＜SmartStageのAPI仕様確認＞
利用可能なエンドポイントは下記よりご確認ください。
SmartStage APIリファレンス（Swagger UI）
＜APIトークンの発行と共通定数の設定＞
SmartStageのAPIトークンの発行
SmartStage APIを呼び出すには、認証用のAPIトークンの発行が必要です。
APIトークンの発行については、以下の記事を参照してください。
また、APIトークンは共通定数に設定することをおすすめします。
共通定数の設定については、以下の記事を参照してください。
生成AIのエンドポイントとAPIキー（※SmartStageに生成AIを組み付ける場合のみ）
生成AIを起動させるには、認証用のエンドポイントとAPIキーの発行が必要です。
生成AIのエンドポイントとAPIキーの発行については、弊社にお問い合わせください。（※お客様自身の生成AI環境をご利用の場合はお客様自身でご確認いただきますようお願いいたします。）
また、生成AIのAPIキーは共通定数に設定することをおすすめします。
共通定数の設定については、以下の記事を参照してください。
※APIキーなどの認証情報は、直接スクリプトに記述せず「共通定数」に設定することを推奨します。
＜API実行に必要な各種ID（パラメータ）情報の取得＞
ワークスペースIDの取得
サンプルスクリプトのワークスペースIDをお客様自身の値に置き換えるため、SmartStageの管理メニューからIDを取得します。
確認箇所：
- SmartStageの管理者ページであることを確認します。
- 右上にある歯車アイコン > ワークスペース設定の順にクリックします。
ここで確認できるワークスペースIDがお客様のワークスペースIDです。
データストアIDの取得
サンプルスクリプトのデータストアIDをお客様自身の値に置き換えるため、SmartStageの管理メニューからIDを取得します。
確認箇所：
SmartStageの管理者ページであることを確認し、「プロセス設定」>対象プロセス>「基本設定」の順にクリックしてください。
ここで確認できるデータストアIDがお客様のデータストアIDです。
アクションIDの取得
サンプルスクリプトのアクションIDをお客様自身の値に置き換えるため、SmartStageの管理メニューからIDを取得します。
確認箇所：
SmartStageの管理者ページであることを確認し、「プロセス設定」>対象プロセス>「アクション設定」、または「データ操作設定」の順にクリックしてください。
画面項目IDの取得
サンプルスクリプトの登録対象画面項目IDをお客様自身の値に置き換えるため、SmartStageの管理メニューからIDを取得します。
確認箇所：
SmartStageの管理者ページであることを確認し、「プロセス設定」>対象プロセス>「項目設定」>「項目リスト」の対象画面項目名の順にクリックしてください。
ここで確認できる項目IDが登録対象画面項目IDです。
アクションスクリプト実行手順
サンプルスクリプトの修正と配置
まずは、目的に合わせたサンプルスクリプトを用意し、環境に合わせて項目IDなどを修正します。
サンプルスクリプトの修正
サンプルスクリプトを、お好みのテキストエディタ（例：VSCode）にペーストしてください。
各種パラメータを上記で取得したパラメータ情報に置き換えます。
※<>は不要です。
＜スクリプトの配置＞
アクションスクリプト設定画面から対象のアクションを選択し、プレスクリプト、またはポストスクリプトに修正したスクリプトを記述します。
動作確認とデバッグ
スクリプトを配置したら、必ず「テスト実行」をクリックして動作を確認してください。
テスト実行時の注意事項
- 実データへの影響: スクリプトの内容によっては、実際にデータの作成・更新・削除が発生します。テストデータを使用するか、内容を十分に確認してください。
-
デバッグ方法: スクリプト内に
logger.log(変数);を記述すると、テスト実行画面の「実行ログ」に変数の内容が出力されます。
プレスクリプトとポストスクリプトの使い分け
アクションの実行前後どちらに記述するかにより、役割が異なります。
- プレスクリプト（アクション実行前）: 入力値のバリデーションなどに適しています。エラー時に「アクションを実行しない」設定にすることで、不適切なデータの保存を阻止できます。
- ポストスクリプト（アクション実行後）: アクション完了後の後続処理に適しています。自身のAPIを用いた関連レコードの作成や、外部システムへの通知などに利用します。
何かお困りのことはございますか？まずはヘルプセンターを検索してみましょう！
その他ご不明な点があれば、サポートチームにお問い合わせください。
コメント
0件のコメント
サインインしてコメントを残してください。