New-CsRgsWorkflow
トピックの最終更新日: 2012-03-23
新しい応答グループ ワークフローを作成します。ワークフローは、応答グループ アプリケーションが電話を受信するときに実行するアクションを決定します。
構文
New-CsRgsWorkflow -Parent <RgsIdentity> -Name <String> -PrimaryUri <Uri> [-Active <$true | $false>] [-Anonymous <$true | $false>] [-BusinessHoursID <Nullable>] [-Confirm [<SwitchParameter>]] [-CustomMusicOnHoldFile <AudioFile>] [-DefaultAction <CallAction>] [-Description <String>] [-DisplayNumber <String>] [-EnabledForFederation <$true | $false>] [-Force <SwitchParameter>] [-HolidayAction <CallAction>] [-HolidaySetIDList <Collection>] [-InMemory <SwitchParameter>] [-Language <String>] [-LineUri <Uri>] [-NonBusinessHoursAction <CallAction>] [-TimeZone <String>] [-WhatIf [<SwitchParameter>]]
解説
ワークフローは応答グループ アプリケーションの主要な要素です。各ワークフローは電話番号と一意に関連付けられています。誰かがこの番号に電話をかけると、ワークフローがその通話の処理方法を決定します。たとえば、一連の対話型音声応答 (IVR) の質問にこの通話を転送し、その質問で発信者に追加情報を入力するように案内します ("ハードウェア サポートについては 1 を、ソフトウェア サポートについては 2 を押してください" など)。あるいは、通話をキューに配置して、エージェントがその通話に応答できるようになるまで発信者を保留します。通話に応答するエージェントが出勤しているかどうかも、ワークフローによって決定されます。つまり、ワークフローを使用して、営業時間 (エージェントが通話に応答できる曜日と時間帯) および休日 (通話に応答できるエージェントがいない日) を設定します。
新しいワークフローは、New-CsRgsWorkflow コマンドレットを使用して作成されます。
このコマンドレットを実行できる人は次のとおりです。既定では、次のグループのメンバーが、New-CsRgsWorkflow コマンドレットの実行を承認されています。RTCUniversalServerAdmins です。このコマンドレットが割り当てられているすべての役割ベースのアクセス制御 (RBAC) の役割の一覧 (自身が作成したカスタムの RBAC の役割を含む) を戻すには、Windows PowerShell プロンプトから次のコマンドを実行します。
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "New-CsRgsWorkflow"}
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Name |
必須 |
文字列 |
ワークフローに割り当てられる一意の名前。Parent プロパティと Name プロパティを一緒に使用すると、ワークフローのグローバル一意識別子 (GUID) を参照することなく、一意にワークフローを識別することができます。 |
Parent |
必須 |
RGS ID |
新しいワークフローがホストされるサービス。次に例を示します。-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com" |
PrimaryUri |
必須 |
SIP アドレス |
ワークフローの SIP アドレス。次に例を示します。-PrimaryUri "sip:helpdesk@litwareinc.com"。PrimaryUri はプレフィックス "sip:" で始まっている必要があります。 |
Active |
省略可能 |
ブール値 |
True は、ワークフローがアクティブであり電話の呼び出しに応答できることを示します。False (既定値) は、ワークフローが電話の呼び出しに応答できないことを示します。 Active プロパティが True に設定されている場合、ワークフローは作成前に検証されます。たとえば、DefaultAction が指定されていないと、ワークフローは作成されません。Active が False (または設定されていない) の場合、検証は行われず、DefaultAction が指定されていなくてもワークフローは作成されます。 |
Anonymous |
省略可能 |
ブール値 |
True に設定した場合、個々の応答グループ エージェントの ID は、エージェントが通話に応答したときに常にマスクされます。False (既定値) に設定した場合、エージェントの ID が発信者にわかるようになります。 |
BusinessHoursID |
省略可能 |
BusinessHours オブジェクト |
ワークフロー エージェントが通話に応答できる曜日および時間帯。営業時間の ID は Get-CsRgsHoursOfBusiness コマンドレットを使用して取得できます。 |
CustomMusicOnHoldFile |
省略可能 |
AudioFile オブジェクト |
通話の保留中に再生されるカスタムの音楽を示します(定義されていない場合、保留中は発信者に対して既定の音楽が流されます)。カスタムの音楽は、Import-CsRgsAudioFile コマンドレットを使用してインポートする必要があります。 |
DefaultAction |
必須 |
CallAction オブジェクト |
営業時間中にワークフローが開かれたときに実行されるアクションを示します。DefaultAction は New-CsRgsCallAction コマンドレットを使用して定義する必要があり、通話はキューまたは質問のいずれかに転送する必要があります。DefaultAction パラメーターはワークフローがアクティブな場合には必須ですが、アクティブではない場合には省略できます。 |
Description |
省略可能 |
文字列 |
管理者が応答グループ ワークフローに関するその他の情報を追加できます。たとえば、Description にはワークフローの所有者への連絡先情報を含めることができます。この説明はワークフローの Microsoft Lync 2010 連絡先カードに表示されます。 |
DisplayNumber |
省略可能 |
文字列 |
Lync 2010 に表示される、このワークフローの電話番号。DisplayNumber は任意の書式に設定できます。次に例を示します。 -DisplayNumber "555-1219" -DisplayNumber "1-(425)-555-1219" -DisplayNumber "1.425.555.1219" |
EnabledForFederation |
省略可能 |
ブール値 |
フェデレーション ドメインからのユーザーがこのワークフローを利用できるかどうかを示します。False に設定した場合、組織内のユーザーのみがこのワークフローにアクセスできます。 |
HolidayAction |
省略可能 |
CallAction オブジェクト |
休日に通話を受信した場合に実行されるアクション。HolidayAction は、New-CsRgsCallAction コマンドレットを使用して定義する必要があります。 |
HolidaySetIdList |
省略可能 |
HolidaySet オブジェクト |
ワークフロー エージェントが通話に応答できない日を示します。休日セットの ID は Get-CsRgsHolidaySet コマンドレットを使用して取得できます。 |
Language |
省略可能 |
文字列 |
音声合成によるワークフロー音声ガイダンスの読み上げに使用される言語。以下に示すサポート言語の一覧のうちのいずれかをオペレーティング システムが使用している限り、Language パラメーターは省略可能です (この音声用のサポート言語は、オペレーティング システムで使用できる言語のサブセットとなっています)。 オペレーティング システムがサポート言語を使用していない場合、Language パラメーターは必須となり、パラメーターにサポート言語の言語コードを指定する必要があります。オペレーティング システムが使用している言語がサポート言語ではない場合、Language パラメーターを指定せずに New-CsRgsWorkflow を実行するとコマンドは失敗します。 たとえば、オペレーティング システムがフェロー語で実行されているとします。この言語は Windows オペレーティング システムではサポートされていますが、応答グループ アプリケーション ではサポートされていません。そのため、新しいワークフローの作成時に、Language パラメーターとサポート言語を指定する必要があります。 言語が指定されていないとワークフローはオペレーティング システムの言語を使用するからです。ただし、応答グループ アプリケーション でサポートされる言語である場合に限り、その言語をワークフローで使用することができます。 言語は、次のいずれかの言語コードを使用して指定する必要があります。 ca-ES – カタルーニャ語 (スペイン) da-DK – デンマーク語 (デンマーク) de-DE – ドイツ語 (ドイツ) en-AU – 英語 (オーストラリア) en-CA – 英語 (カナダ) en-GB – 英語 (英国) en-IN – 英語 (インド) en-US – 英語 (米国) es-ES – スペイン語 (スペイン) es-MX – スペイン語 (メキシコ) fi-FI – フィンランド語 (フィンランド) fr-CA – フランス語 (カナダ) fr-FR – フランス語 (フランス) it-IT – イタリア語 (イタリア) ja-JP – 日本語 (日本) ko-KR – 韓国語 (韓国) nb-NO – ノルウェー語、ブークモール (ノルウェー) nl-NL – オランダ語 (オランダ) pl-PL – ポーランド語 (ポーランド) pt-BR – ポルトガル語 (ブラジル) pt-PT – ポルトガル語 (ポルトガル) ru-RU – ロシア語 (ロシア) sv-SE – スウェーデン語 (スウェーデン) zh-CN – 中国語 (中国) zh-HK – 中国語 (香港特別行政区) zh-TW – 中国語 (台湾) 次に例を示します。-Language "nl-NL" |
LineUri |
省略可能 |
文字列 |
ワークフローの電話番号。次の形式を使用して、回線の Uniform Resource Identifier (URI) を指定する必要があります。TEL: プレフィックス、プラス記号、国および地域番号、市外局番、電話番号の順に記述します (番号では数字のみを使用し、空白スペース、ピリオド、ハイフンは記述しません)。次に例を示します。-LineUri "TEL:+14255551219" |
NonBusinessHoursAction |
省略可能 |
CallAction オブジェクト |
ワークフローの営業時間外に通話を受信した場合に実行されるアクション。NonBusinessHoursAction は、New-CsRgsCallAction コマンドレットを使用して定義する必要があります。 |
TimeZone |
省略可能 |
文字列 |
休日および営業時間を決めるときに使用されるタイム ゾーン情報。次に例を示します。-TimeZone "Pacific Standard Time" |
Force |
省略可能 |
スイッチ パラメーター |
コマンド実行中に発生する可能性のある、致命的ではないすべてのエラー メッセージを表示しないようにします。 |
InMemory |
省略可能 |
スイッチ パラメーター |
永続的な変更としてオブジェクトをコミットせずに、オブジェクト参照を作成します。このパラメーターを指定して呼び出したコマンドレットの出力を変数に割り当てる場合、オブジェクト参照のプロパティを変更し、コマンドレットに対応する Set- コマンドレットを呼び出してそれらの変更をコミットできます。 |
入力の種類
なし。New-CsRgsWorkflow はパイプライン処理された入力を受け入れません。
戻り値の種類
New-CsRgsWorkflow は、Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow オブジェクトの新しいインスタンスを作成します。
例
-------------------------- 例 1 ------------------------
New-CsRgsWorkflow -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com"
上記のコマンドでは、ApplicationServer:atl-cs-001.litwareinc.com サービス上で新しいワークフローを作成しています。このワークフローの Name には Help Desk が設定され、sip:helpdesk@litwareinc.com というプライマリ URI が割り当てられています。
-------------------------- 例 2 ------------------------コード例の追加
$prompt = New-CsRgsPrompt -TextToSpeechPrompt "Welcome to the help desk."
$queue = (Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk").Identity
$callAction = New-CsRgsCallAction -Prompt $prompt -Action TransferToQueue -QueueId $queue
New-CsRgsWorkflow -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com" -DefaultAction $callAction
例 2 のコマンドでは、新しいワークフロー音声ガイダンスおよび通話アクションを作成し、新しい応答グループ ワークフローにこれらの項目を割り当てています。1 つ目のコマンドで New-CsRgsPrompt コマンドレットを使用して、"Welcome to the help desk." という音声合成による音声ガイダンスを作成しています。この新しい音声ガイダンスは、$prompt という名前の変数に格納されます。
2 つ目のコマンドで Get-CsRgsQueue コマンドレットを使用して、Help Desk という名前の既存の応答グループ キューの ID を取得しています。戻された ID は、$queue という名前の変数に格納されます。
その後 3 つ目のコマンドで、新しい通話アクション ($callAction という名前の変数に格納) を作成しています。この通話アクションは、新しい音声ガイダンス ($prompt) と取得したキュー ($queue) の両方を参照しています。最後に、この例の最後のコマンドで Help Desk という名前の新しいワークフローを作成しています。このコマンドは PrimaryUri に sip:helpdesk@litwareinc.com を設定し、DefaultAction プロパティの値を前の手順で作成した通話アクションに設定しています。