スクリプトをスポーンすると、スクリプトを手動で実行できます。 また、他のスクリプトや外部プロセスからスクリプトを起動するためにも使われます。 スクリプトをテストするためにも使用できます。 テストの際は、スクリプトトレースと一緒に使用できます。
スクリプトをテストするには、Studiotrace optionトレース オプションからスクリプトを生成できます。
他のスクリプトやプロセスからスクリプトを起動するには：
- 呼び出し元のスクリプトでSPAWNactionを使用します。
- POST /scripts/start
APIを使用します。 これは、外部プロセスからスクリプトをスポーンするための解決策としてお勧めします。
ビジネスユニットは、特に設定されていない限り、最大15,000のスクリプトを実行できます。 その制限に達すると、1つ以上のスクリプトの実行が停止するまで、このページで説明する方法のいずれかを使用して追加のスクリプトを開始または生成できなくなります。
スクリプトパラメーター
スクリプトパラメーターは、スクリプトにデータを渡すことができます。 データは、システムスクリプトを含む他のスクリプトや、CRM
コンタクト、販売情報、サポートの詳細、ケース履歴などを管理するサードパーティシステム。またはAPIなどの外部ソースから取得されます。 これはpX変数のp1～pNを使ってスクリプトに渡されます。ここで、Nはスポーンメソッドがサポートするパラメーターの最大数です。 スクリプトをスポーンするときにスクリプトに渡すデータは、前のセクションに挙げたオプションのいずれかを使用して指定できます。
パラメーター変数の名前を変更したい場合は、スポーン済みスクリプト内のBeginアクションを新しい名前で設定することができます。 スクリプトがBEGINアクションを処理すると、pX変数は新しい名前に変換されます。 新しい名前を指定しない場合、変数はデフォルトのpXの名前を保持します。
データがスクリプトに渡されると、traceでそれを確認できます。 BEGINアクションを選択すると、トレース出力の変数リストにこれらのパラメーター変数が表示されます。 BEGINアクションを新しい変数名で設定した場合は、スクリプトトレースでBEGINの後のアクションを選択すると、その変数名が表示されます。 パラメータ変数は、値を保持している場合にのみ存在します。
- 最大で以下をサポートしています。
- SPAWNアクションを使ってスポーンされた場合、各値につき32 KB。
- APIからスポーンされた場合、全パラメーターでパイプ区切り文字を含めて合計32 KB。
- 変数の置換をサポートしています。 変数名は中括弧({})で囲んで入力します。
- SPAWNアクションまたは API によって生成するときに、1 ～ 20 個のパラメータをサポートします。
- ダイナミックデータオブジェクトはサポートされません。 オブジェクトはまず、JSON文字列に変換する必要があります。
Studioアクションの比較
現在のスクリプトから新規スクリプトを開始するStudioアクションは3つあります。 ただし、これらには重要な違いがいくつかあります。
- Runscript：が別のスクリプトをトリガーすると、2番目のスクリプトから最初のスクリプトに戻ることはありません。
- Runsub：がサブスクリプトをトリガーすると、サブスクリプトにアクションがある限り、スクリプトは最初のスクリプトに戻ることができます。 アクションは、添え字が終了したときにアクションに値を返します。
- SPAWN：最初のスクリプトと並行して実行される2番目のスクリプトを開始します。 スポーンされたスクリプトにactionを含めない限り、スポーンされたスクリプトは最初のスクリプトにデータを戻すことができません。
SPAWNアクションを使用した別のスクリプトからのスポーン
子スクリプトにパラメーター値を渡す必要がない場合は、親スクリプトにSPAWNアクションを追加して設定するだけで済みます。 パラメーターを渡す必要がある場合は、以下の設定を行わなければなりません。
- 親スクリプトを以下のように変更します。
- SPAWNアクションを、子スクリプトをスポーンしたい場所に配置します。 SPAWNアクションのParametersプロパティに、子スクリプトに渡す必要のある値を設定します。 値は変数p1～p9で渡されます。
- SPAWNアクションのother propertiesを設定します。
-
子スクリプトを以下のように変更します。
- アクションのParametersプロパティを設定して、カスタムパラメーター変数の名前を変更します。 何もしない場合、カスタムパラメーターの値は変数に残ります。
- 親スクリプトや呼び出し元のアプリケーションに値を返す必要がある場合は、actionを追加して設定します。
APIによるスクリプトのスポーン
POST /scripts/start
APIを使用してスクリプトをスポーンします。
このAPIを使用する際は、以下の重要な点に注意してください。
- 以下のパラメーターは必須です。
- skillId：JSONとして送信する場合は整数値が必要ですが、クエリーパラメーターとして送信する場合は該当しません。 スキルには次の条件が課されます：
- アクティブであること。
- スクリプトのメディアタイプに一致すること。 たとえば、電話のスクリプトは、電話のスキルと相関している必要があります。 スキルタイプは、スキルの詳細タブで確認できます。 Genericタイプのスクリプトは、任意のアクティブスキルで機能します。
scriptIdまたはscriptPath：scriptPathの使用が推奨されます。 スクリプトIDは、スクリプトの変更を保存すると変更されるので、パラメーターで更新する必要があります。
- skillId：JSONとして送信する場合は整数値が必要ですが、クエリーパラメーターとして送信する場合は該当しません。 スキルには次の条件が課されます：
- 最大20個のパラメーターを含めることができます。
- パラメーターはパイプ区切りのリストとして送る必要があります。
- APIは、パイプ区切り文字も含め、すべてのパラメーターで最大32 KBまでをサポートしています。
- 区切り文字でない限り、パラメーターにパイプ文字を含めることはできません。
- リクエストをJSONとして送信する場合、予約文字は適切な方法でエスケープする必要があります。
- リクエストをURLクエリーパラメーターで送信する場合、パラメーターはURLエンコードされている必要があります。