このガイドでは、アクションスクリプトの概要から、実際のスクリプト作成、テスト方法までを詳しく解説します。
外部システムとの連携を自動化するなど、アクションスクリプトを活用して業務効率を向上させましょう。
目次
アクションスクリプトとは
アクションスクリプトとは、特定のアクションが実行されたタイミングで、自動的にスクリプト(Node.js)を実行する機能です。 例えば、「タスクのステータスを承認済みに変更した時に、別のシステムへ通知を送る」といった、外部連携や業務の自動化に役立ちます。
事前準備
SmartStageのAPIを利用する場合は、下記事前準備を実施してください。
<SmartStageのAPI>
SmartStage公開APIの仕様は以下のドキュメントをご確認ください。
https://api.smart-stage.io/swagger/index.html
<アクションスクリプトで実行するAPIのトークン発行>
SmartStageのAPIトークンの発行
SmartStage APIを呼び出すには、認証用のAPIトークンの発行が必要です。
APIトークンの発行については、以下の記事を参照してください。
また、APIトークンは共通定数に設定することをおすすめします。
共通定数の設定については、以下の記事を参照してください。
生成AIのエンドポイントとAPIキー(※SmartStageに生成AIを組み付ける場合のみ)
生成AIを起動させるには、認証用のエンドポイントとAPIキーの発行が必要です。
生成AIのエンドポイントとAPIキーの発行については、弊社にお問い合わせください。(※お客様自身の生成AI環境をご利用の場合はお客様自身でご確認いただきますようお願いいたします。)
また、生成AIの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です。
アクションスクリプト実行手順
1. サンプルスクリプトの修正
サンプルスクリプトの修正
サンプルスクリプトを、お好みのテキストエディタ(例:VSCode)にペーストしてください。
各種パラメータを上記で取得したパラメータ情報に置き換えます。
※<>
は不要です。
2. 動作確認
<サンプルスクリプトの配置>
アクションスクリプト設定画面からアクションスクリプトを適用するアクションを選択し、プレスクリプト、またはポストスクリプトに修正したサンプルスクリプトを配置します。
<テスト実行>
サンプルスクリプトを配置したら、「テスト実行」をクリックしてください。設定したプレスクリプト、またはポストスクリプトのJavaScriptが実行されます。
テスト実行時の注意事項
- テストデータについて: 「アクション実行時に渡されるデータ」に表示されているタスクがテスト対象です。
- 重要: スクリプトの内容によっては、実際にデータの作成・読み取り・更新・削除(CRUD)操作が発生します。テストデータで実行するか、内容を十分に確認してください。
補足. プレスクリプトとポストスクリプトの違い
ここでは、プレスクリプトとポストスクリプトの違いについて説明します。
- プレスクリプト: アクション実行前に実行されるスクリプトです。
- ポストスクリプト: アクション実行後に実行されるスクリプトです。
プレスクリプトの便利な機能
「エラー時にアクションの実行をしない」チェックボックスを有効にすることで、プレスクリプトでエラーが発生した場合にアクションの実行を停止できます。 これにより、誤ったアクション実行を防ぐことが可能です。
何かお困りのことはございますか?まずはヘルプセンターを検索してみましょう!
その他ご不明な点があれば、サポートチームにお問い合わせください。
コメント
0件のコメント
サインインしてコメントを残してください。