Cisco Unity Express 7.0 スクリプト作成ガイド

ステップのプロパティ

ほとんどのステップには、スクリプトの必要に応じて変更可能なプロパティがあります。プロパティは、ステップに応じて複数のタブにグループ化されることがあります。ステップのプロパティ ウィンドウを表示するには、図 4 に示す Label ステップの [Properties] ダイアログボックスのように、[Design] ペインでステップを右クリックし、ポップアップ メニューの [Properties] をクリックします。

図 4 [Properties] ポップアップ メニュー：Label ステップ

変数

変数は、ユーザ定義のデータ、またはステップや式が完了した結果のデータを格納します。スクリプト内のステップは、定義済みの変数を使用できます。データにはさまざまな形式があるため、使用する前に変数の型も定義する必要があります。変数は、次の組み込み基本変数の型にグループ化されています（「組み込み基本変数の型」を参照してください）。

• Boolean

• Character

• Float

• Integer

• String

• Date

• Time

• BigDecimal

• BigInteger

• Double

• Long

変数の定義

データにはさまざまな形式があるため、使用する前に変数も定義する必要があります。次のように操作します。

1. 新しい変数を定義するには、[Variable] ペインの左上隅にある [New Variable] アイコンをクリックします。

[Edit Variable] ウィンドウが表示されます。[Edit Variable] ウィンドウを使用して変数を定義した後、変数が [Variable] ペインに表示されます。

2. 選択した変数を削除するには、[Delete Variable] をクリックします。

3. 変数を選択した変数に変更するには [Modify Variable] をクリックします。

図 5 [Variable] ペインと [Edit Variable] ウィンドウ

表 3 に、[Edit Variable] ウィンドウのフィールドを示します。

組み込み基本変数の型

定義する変数ごとに型を設定する必要があります。変数の型は、変数に含まれる情報の種類を示しており、Cisco Unity Express Script Editor は変数の型に応じてその情報を適切に処理できます。たとえば、スクリプトは、文字列「Tuesday」を含む変数を、数字 25 を含む変数とは別の方法で使用します。

表 4 に、組み込み基本変数の型を示します。

パラメータを使用した変数のエクスポート

変数をパラメータとして宣言するには、[Edit Variables] ダイアログボックスの [Parameter] をクリックします。パラメータ設定機能によって、パラメータの値を自動受付（AA）Web インターフェイスに設定できます。値は、値を使用するスクリプトの設定時に初期化されるため、Cisco Unity Express Script Editor でスクリプトを編集することなく、値を変更できます。このような変数を エクスポートされた変数 または パラメータ と呼びます。

たとえば、新しい自動受付を AA ウィザードを使用して追加する場合、AA ウィザードの 2 番目のウィンドウ（[Script Parameters] ウィンドウ）に、パラメータがデフォルト値または現在の値と共にリストで示されます。このリストの値は変更できます。

Cisco Unity Express がパラメータをサポートする変数の型には、Number、Character、String、Boolean、および Prompt があります。

Contact 変数

Contact 変数には、通話呼を示す連絡先が含まれます。Contact 変数はパラメータとしてサブフローに渡すことができます。

Prompt 変数

Prompt 変数には、発信者に対して再生するプロンプトを作成するためにスクリプトで使用する情報が含まれます。Prompt 変数は、1 つのプロンプトのように単純な場合、または連結された複数のプロンプトのように複雑な場合があります。

User 変数

User 変数には、ユーザ認証に役立つ情報が含まれます。User 変数を値として手動で入力することはできません。User 変数を返すことができるのは、 Media パレットの Name To User ステップだけです。User 変数はパラメータとしてサブフローに渡すことができます。

検証

[Tools] メニューからアクセスされるスクリプトの検証機能で、初期の基本的なスクリプト チェックを行います。 に、誤って名前が付けられた Label ステップの結果生成されたエラー メッセージを示します。Label ステップの MainMenu1 は、正しくは MainMenu という名前を付ける必要があります。エラー メッセージ「Dangling GoTo」は、MainMenu ラベルの到達先がないことを示します。エラー メッセージ「MainMenu not exist」も同様です。エラー メッセージ「Dangling GoTo」が 4 つあるということは、Goto ステップが間違った名前のラベルまたは存在しないラベルをスクリプト内で 4 回参照したことを示しています。エラー メッセージをダブルクリックすると、エラー メッセージが指すスクリプト内の行（この場合は各 Dangling GoTo ステップ）が強調表示されます。

図 6 [Debug] ペイン：検証エラー メッセージ

スクリプトのデバッグ

[Debug] メニューから使用可能なデバッグ機能によって、Cisco Unity Express Script Editor を使用してスクリプトをデバッグできます。次の操作を選択できます。

• デバッグする

• ブレークポイントを使用する

• スクリプトをステップごとに実行する

• スクリプトが実行されたときの変数値の変更を確認する

デバッグ機能

デバッグ機能には [Debug] メニューまたはツールバーからアクセスできます。 に、ツールバーを示します。 表 5 に、図の各番号の説明を示します。

図 7 デバッグ ツールバー

表 5 はデバッグ機能について説明しています。

（注） システム スクリプトには、Cisco Unity Express Editor で表示されず、デバッグ不可能なステップが含まれます。

デバッグ モード

使用可能なデバッグ モードには、リアクティブ デバッグとノンリアクティブ デバッグの 2 種類のデバッグモードがあります。どちらのモードでも、ステップにブレークポイントを挿入してスクリプトをそのポイントまで実行させ、その後、そのステップからデバッグを開始できます。デバッグ セッションの間、実際のスクリプトは Editor が稼動しているローカル PC ではなく、モジュール上で実行されるため、Editor は継続的に Cisco Unity Express モジュールと通信します。この通信は、ポート 1099 の Java Remote Method Invocation（Java RMI）接続を介して行われます。デバッグを正常に実行するには、Editor PC と Cisco Unity Express モジュールのネットワーク接続が必要です。また、ポート 1099 ACL やその他の手段でブロックすることはできません。

（注） ポート 1099 以外に、TCP 32xxx の範囲内のポートを使用できます。これらのポート番号は実行時に動的に決定されます。

Editor と Cisco Unity Express モジュールとの通信を可能にするには、 および に示すように、Editor の [Tools] > [Options] メニューを選択して、Cisco Unity Express のホスト名または IP アドレスを設定します。この時点ではネットワーク接続は検証されず、デバッグ セッションの開始時に検証されます。

図 8 [Tools] メニュー

図 9 Cisco Unity Express のホスト

に [Debug] メニューを示します。

図 10 [Debug] メニュー

リアクティブ デバッグ

リアクティブ デバッグ モードでは、Cisco Unity Express システムでスクリプトを実行中にスクリプトをデバッグできます。このデバッグ モードを使用して、外部イベントによってトリガーされるスクリプトをデバッグできます。Cisco Unity Express 上のスクリプトをトリガーできる外部イベントは、着信通話だけです。スクリプトは必ず、Cisco Unity Express スクリプト リポジトリにロードされ、着信通話によってトリガーされます。スクリプトは、デバッグ中にローカル PC 上で変更および保存できますが、変更をデバッグするには再び Cisco Unity Express システムにアップロードする必要があります。

リアクティブ デバッグ セッションを開始するには、Editor の [Debug] > [Reactive Script] メニューを選択して、スクリプトをデバッグします。Editor は、Cisco Unity Express とやり取りし、Cisco Unity Express 上のすべてのカスタム スクリプトのリストを取得します。Editor は、Cisco Unity Express との接続を確立できない場合（ネットワークに問題があるか、またはポート 1099 がブロックされている）、エラー メッセージを表示します。

このリストを正常に取得できた場合は、ダイアログボックスにリストが表示されます。 の [Reactive Script Information for Debugging] ウィンドウに示すように、このダイアログボックスのドロップダウン リストからデバッグするスクリプトの名前を選択できます。

図 11 スクリプトと待ち時間の選択

待ち時間は、着信通話が、Cisco Unity Express 上の選択されたスクリプトの実行をトリガーするまで、Script Editor が待機する期間です。[OK] をクリックした後、この指定された間隔以内に、着信通話がスクリプトをトリガーする必要があります。スクリプトがこの間隔以内にトリガーされないと、エラー メッセージが表示されます。

[OK] をクリックすると、Editor は Cisco Unity Express に登録され、選択したスクリプトのイベントを受信できるようになります。通話が着信すると、図 12 および図 13 に示すように、Editor の [Design] ペインにスクリプトが自動的に表示されます。

図 12 リアクティブ デバッグのためのスクリプトの選択

図 13 進行中のリアクティブ デバッグ

Editor はスクリプトの実行を制御します。スクリプトは、ツールバーの [Play]（F5）または [Step]（F10）をクリックするまで実行を開始しません。スクリプトの実行が開始され通話に応答するまで、発信者には呼び出しトーンが聞こえます。

[Play] をクリックすると、スクリプトは、ブレークポイントに到達するか、発信者からの何らかの入力が必要になるか、または、スクリプトの最後に到達するまで実行されます。[Step] をクリックするたびに、スクリプトの次のステップが実行され、実行が停止します。

スクリプトの任意のステップをクリックして、ツールバーの [Breakpoint] ボタンをクリックすると、そのステップにブレークポイントを挿入できます。ブレークポイントは、[Debug] > [Insert Breakpoint] メニュー項目を選択して挿入することもできます。 および にブレークポイントの例を示します。

図 14 ブレークポイントの挿入

スクリプトの実行が進むにつれ、現在実行中のステップが強調表示されます。[Variable] ペインには常に、スクリプトの実行に伴い、変数の現在のランタイム値が表示されます。

デバッグ セッションの進行中に通話が中断されると、エラー メッセージが表示されます。

Script Editor を使用してデバッグしているスクリプトは、Editor が稼動しているローカル PC のディスクに保存することもできます（[File] > [Save] メニュー）。これが、Cisco Unity Express からスクリプトをダウンロードする方法になります。

図 15 ブレークポイントを挿入したスクリプト

ノンリアクティブ デバッグ

このデバッグ モードは、実行をトリガーするために外部イベントを必要としないスクリプトの場合にのみ使用します。これらのスクリプトには、トリガーするコンタクトを持つステップは含まれていません。ノンリアクティブ デバッグは、スクリプトのセグメントまたはサブフローをデバッグする際に役立ちます。このデバッグ モードではスクリプトに関連付けられた着信通話がないため、メディア ストリームは確立できません。つまり、PlayPrompt や GetDigitString などのメディア ストリームを使用するステップは、効果的にデバッグできません。

ただし、Media ステップと Call Control ステップを使用するスクリプトとサブフローは、ノンリアクティブ デバッグを使用してデバッグできます。一部の計算を実行するスクリプトをデバッグする場合に役立ちます。スクリプト セグメントは、デバッグ後に、より大きいスクリプトに組み込むことができます。

ノンリアクティブ デバッグ セッションを開始するには、[File] > [Open] メニューを選択してスクリプトを開きます。

スクリプトを開いた後、ツールバーの [Play]（F5）または [Step]（F10）をクリックしてデバッグ プロセスを開始します。その他のデバッグ オプションと機能は、「リアクティブ デバッグ」でリアクティブ デバッグについて説明したものと同じです。

このモードでも、スクリプトは、Script Editor PC ではなく、Cisco Unity Express システム上で実行されます。ただし、この場合、スクリプトはデバッグ セッションの開始時に RMI 接続を介して Script Editor から Cisco Unity Express に送信されます。そのため、このモードでも、ポート 1099 で Script Editor を Cisco Unity Express に接続する必要があります。Editor が Cisco Unity Express との接続を確立できない場合は、[Play] または [Step] をクリックしたときにエラー メッセージが表示されます。

制限事項

スクリプトのデバッグ時には、次の制限事項を考慮する必要があります。

• リアクティブ デバッグ モードとノンリアクティブ デバッグ モードでは、メイン スクリプトからサブフローに入ることはできません。Cisco Unity Express は、デバッグを制御せずにサブフローを実行します。これは、CallSubflow ステップにステップを進めるのと同様です。

• 場合によっては、構文エラーのあるスクリプトが正常にアップロード（警告付き）されることがあります。ただし、このようなスクリプトは、呼び出しに失敗しトリガーされることがないため、デバッグできません。

• 一度にデバッグできるスクリプトは 1 つだけです。別のユーザがデバッグ セッションを開始しようとすると、エラー メッセージが表示されます。

Continue on Prompt Errors ステップ

[Continue on Prompt Errors] オプションを使用すると、スクリプトが無効な入力を受け取ったときに（Invalid Audio Format や File Not Found など）、スクリプトを継続して実行できます。

Cisco Unity Express Script Editor には、Media パレットにあるステップのカスタマイザ ウィンドウに [Continue on Prompt Errors] オプションがあります （「Media ステップ」を参照してください）。たとえば、図 17 は [Get Digit String] カスタマイザ ウィンドウの [Prompt] タブを示しています。

図 17 [Continue on Prompt Errors] オプション：[Get Digit String] カスタマイザ ウィンドウの [Prompt] タブ

有効な場合、ステップは再生されるプロンプトのリストにある次のプロンプトを続行します。リストにある最後のステップであれば、発信者の入力を待ちます。

[Continue on Prompt Errors] を有効にした場合は、プロンプト エラーを無視し、このプロンプトの再生が成功したものとして処理を続行するようにスクリプトに指示します。たとえば、一連のプロンプト 1 + 2 + 3 でプロンプト 1 番が失敗した場合、ステップはプロンプト 2 番を続行します。プロンプト 3 番が失敗すると、ステップはプロンプト 3 番が正しく再生されたものとして発信者の入力を待ち、処理を続行します。

[Continue on Prompt Errors] を無効にした場合は、Media ステップは例外を生成します。この例外はスクリプトで処理できます。

使用可能なプロンプトの例外は次のとおりです。

• InvalidPromptArgumentException

• PromptException

• UndefinedPromptException

• UndefinedPromptGenerator

• UnsupportedPromptExpression

エラー出力ブランチ

エラー出力ブランチは、一般的なエラーが発生したときの操作について指示するスクリプトの一部です。

図 18 に、スクリプトの Call Redirect ステップの下にあるエラー出力ブランチを示します。

（注） スクリプトでは、予期されるエラー条件についてだけ、エラー出力ブランチを提供します。システム エラーについては提供しません。

図 18 エラー出力ブランチ：Call Redirect ステップ

この図の Call Redirect ステップには、無効な内線用と使用不能な内線用の両方のロジックが含まれています。

On Exception Goto ステップ

General パレットの On Exception Goto ステップ（「On Exception Goto」を参照）は、例外が生成されたときにスクリプト内の指定された場所でスクリプトの実行を継続します。

スクリプトで特定の例外に対して On Exception Goto ステップを使用することにより、特定の例外用に新しいハンドラを登録するか、または既存のハンドラを上書きすることができます。

登録処理はスクリプト全体に影響を与えます。割り当てられたハンドラは、その例外が発生する場所（指定ステップの前、中、または後）に関係なく、スクリプトをアクティブにします。ステップの実行後、新しいハンドラが再登録されるか、 On Exception Clear ステップで例外が消去されるまで、このハンドラは登録されています。

サブフローの原因となる例外の場合、スクリプトは最初にサブフローの例外ハンドラを調べます。指定された例外に何も定義されていない場合は、例外によってサブフローが中止され、Cisco Unity Express アプリケーションが親スクリプト内の例外ハンドラを検索します。この処理は、スクリプトが例外ハンドラを見つけるか、スクリプトの最上位に達するまで続行されます。

例外ハンドラが登録されていない場合、スクリプトは中止され、エラー処理は、エラー処理の最終レベル、つまりデフォルト スクリプトに戻ります。

デフォルト スクリプトの使用方法

デフォルト スクリプトは、Cisco Unity Express Script Editor がデフォルトのシステム処理をアクティブなすべての連絡先に適用する前の、ユーザ定義エラー処理の最終レベルです。

Cisco Unity Express Script Editor からこのデフォルト スクリプトが起動されるのは、次の条件の場合です。

• メイン スクリプトが中止される。これは、次のいずれかの理由で発生します。

– 検出されていない例外が発生する。

– 正しく検証されていないため、Cisco Unity Express アプリケーション ソフトウェアがプライマリ スクリプトを起動できない。

• Cisco Unity Express アプリケーション ソフトウェアがアプリケーションで同時に実行できるセッション数の制限に到達したため、着信を中止する必要がある。

どちらの場合も、デフォルト スクリプトが実行される前に Cisco Unity Express Script Editor によってアクティブなすべての連絡先に中止のマークが付けられます。これらの連絡先は、デフォルト スクリプトの実行の結果、転送またはリダイレクトされた場合でも、最後の状態が Aborted となります。

プライマリ スクリプトが正常に終了する場合、デフォルト スクリプトは実行されません。プライマリ スクリプトの終了時にまだ連絡先がアクティブになっている場合、処理済みのマークが付いていないアクティブな連絡先はすべて中止され、処理済みのマークが付いたアクティブな連絡先はすべてそのまま終了します。この場合、設計上の問題がないかどうかプライマリ スクリプトを確認してください。

（注） デフォルト スクリプトはシステム上の問題について連絡先に最終的なフィードバックを示すだけで、サービスの継続やサービスの再開は行いません。

連絡先がまだアクティブであれば、デフォルト スクリプトがある場合はその実行後に、システムによって CallContact スクリプトが適用されます。CallContact スクリプトは通知として「We are currently experiencing system problems, please call back later」というプロンプトを再生し、その後に高速の通話中信号が続きます。

スクリプト割り込み

スクリプト割り込みは、スクリプトの別の部分に戻るために、またはスクリプトの実行を停止するために、スクリプトの現在の処理に外部イベントが割り込むことができる機能です。

スクリプト割り込みは、通常、連絡先の 1 つがリモートで終了したことをスクリプトに通知する必要があるときに使用します。たとえば、発信者が電話を切った場合などです。

（注） どの場合でも、必要なスクリプト割り込みをトリガーするイベントは、スクリプトが他のステップを実行中にいつでも発生する可能性があります。

スクリプトはデフォルトで、任意のステップが実行される前に自動的に割り込み可能になります。外部イベント（上で説明したようなイベント）がスクリプトに割り込む場合、スクリプトは次のステップの実行を開始する前に、特定のイベントに対する適切な処理に基づいて実行を継続します。

2 つの連続するステップを割り込みの可能性がない状態で実行するには、この 2 つのステップをサブフローに移し、そのサブフローをスクリプトが処理する間は割り込みをすべて無効にする必要があります。

Cisco Unity Express Script Editor では、外部イベントが発生した場合にスクリプトが内部のステップに割り込むことができるかどうかを指定できる [interruptible] オプションが、一部のステップに用意されています。

連絡先がリモートで終了するときに、スクリプトは次のいずれかの操作を実行します。

• 発信者が電話を切ると、スクリプトは（可能であれば）割り込まれて、ContactInactiveException が生成される。この例外は、 General パレットの OnExceptionGoto ステップで処理されます。

• 発信者が電話を切り、使用可能な例外処理ロジックがない場合、スクリプトはただちに中止される。

• 複数の連絡先を管理している場合、 OnExceptionGoto ステップはリモートで終了した連絡先を識別できない。その代わり、既知のすべての連絡先変数でループできるように Label を指定し、 General パレットの Get Contact Info ステップを使用して Active フラグを検索する必要があります。

スクリプトが割り込み可能ではないときに割り込みイベントが発生した場合、スクリプトは再度割り込み可能になったときに自動的に割り込まれます。たとえば、割り込み不可のマークが付いたサブフローを実行しているときは、スクリプトは割り込み可能ではありませんが、そのサブフローが終了して制御が親に戻ると、スクリプトはすぐに割り込みを処理します（そのプライマリ スクリプトが割り込み可能な場合）。