Cisco Unified JTAPI 開発者ガイド for Cisco Unified Communications Manager リリース 7.1(2)
Cisco Unified JTAPI のインストール
Cisco Unified JTAPI のインストール
発行日;2012/02/04 | 英語版ドキュメント(2010/04/06 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 10MB) | フィードバック

目次

Cisco Unified JTAPI のインストール

概要

現在の JTAPI バージョンの確認

Cisco Unified JTAPI ソフトウェアのインストール

サイレント インストール呼び出し

コマンドライン呼び出し

エンド ユーザ インストール

インストール手順

Linux および Solaris プラットフォーム

Linux および Solaris でのインストールの検証

Windows プラットフォーム

Windows でのインストールの検証

アップグレードの自動インストール

Cisco Unified JTAPI Preferences の設定

[JTAPI トレース] タブ

[ログ先] タブ

[CallManagers] タブ

[詳細設定] タブ

[セキュリティ] タブ

[言語] タブ

JTAPI アプリケーションのユーザ情報の管理

jtapi.ini ファイルのフィールド

デフォルト値を使用する場合の jtapi.ini ファイルの例

Cisco Unified JTAPI のインストール

この章では、Cisco Unified Communications Manager 6.0 以降のリリース用の Cisco Unified Java Telephony API(JTAPI)クライアント ソフトウェアのインストール方法と設定方法について説明します。

この章は次のトピックで構成されています。

「概要」

「Cisco Unified JTAPI ソフトウェアのインストール」

「アップグレードの自動インストール」

「Cisco Unified JTAPI Preferences の設定」

「JTAPI アプリケーションのユーザ情報の管理」

「jtapi.ini ファイルのフィールド」

概要

Cisco Java Telephony API(JTAPI)実装は、JTAPI アプリケーションを実行するすべてのクライアント マシン上に存在する Java クラスによって構成されています。これらのアプリケーションが正しく動作するためには、事前に Cisco Unified JTAPI 実装をインストールする必要があります。JTAPI アプリケーションを Cisco Unified Communications Manager マシンで実行するか、別のマシンで実行するか、両方で実行するかにかかわらず、JTAPI アプリケーションを実行するすべてのマシンに必ず Cisco Unified JTAPI のクラスをインストールしてください。

これまで JTAPI クライアントのインストールは Windows プラットフォームだけでサポートされていました。5.0 リリースから、 表 4-1 に示す Linux、Windows、および Solaris プラットフォームでの JTAPI クライアントのインストールおよびアンインストール プロセスを統一するために、JTAPIInstaller が提供されています。InstallShield MultiPlatform(ISMP)インストーラを実行すると、インストールに必要なファイル セットが取得された後、Linux 版および Solaris 版の場合はバイナリ(.bin)ファイルが生成され、Windows 版の場合は実行可能ファイル(.exe)が生成されます。

 

表 4-1 でサポートされている JVM のバージョンCisco Unified Communications Manager

プラットフォーム
リリース
CiscoUnified Communications Manager リリース 4.x
CiscoUnified Communications Manager 5.x、6.x、7.x

Linux

AS 3.0

IBM JVM 1.3.1

IBM JVM 1.4.2

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2

Red Hat 7.3

IBM JVM 1.3.1

IBM JVM 1.4.2

Sun JVM 1.3.1

Sun JVM 1.4.2

SunJVM 1.5.0.4

Sun JVM 1.4

Solaris

6.2(SPARC)

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2

Windows

9x

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.4.2

2000
NT 4.0+
XP(32 ビット)
2003

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0_13

Sun JVM 1.5.0.4

Sun JVM 1.4.2

Vista(32 ビット)

Sun JVM 1.3.1

Sun JVM 1.4.2

Sun JVM 1.5.0.4

Sun JVM 1.4.2


) Cisco Unified Communications Manager 5.0 にアップグレードした場合は、JTAPI アプリケーションがインストールされているアプリケーション サーバまたはクライアント ワークステーション上の JTAPI クライアント ソフトウェアをアップグレードする必要があります。JTAPI クライアントをアップグレードしないと、アプリケーションの初期化に失敗します。アップグレードする必要がある場合は、「Cisco Unified JTAPI ソフトウェアのインストール」の説明に従って適切なクライアントをダウンロードしてください。

アップグレード後の JTAPI クライアント ソフトウェアを以前のリリースの Cisco Unified Communications Manager とともに使用できません。


現在の JTAPI バージョンの確認

インストーラから JTAPI のバージョン番号を確認するには、次のコマンドのうちのいずれかを使用します。

CiscoJtapiVersion.exe - silent -W newversion.check="1" -goto showversion

CiscoJtapiClient-linux.bin -silent -W newversion.check=="1" -goto showversion

CiscoJtapiClient-solarisSparc.bin -silent -W newversion.check=="1" -goto showversion

CiscoJtapiClient-solarisX86.bin -silent -W newversion.check=="1" -goto showversion

これらのコマンドにより、コマンドを実行したフォルダに「jtapiversion.txt」というファイルが作成されます。このファイル内に A.B(C.D) の形式で JTAPI のバージョンが記述されます。

警告 リリース 4.X またはそれよりも前のリリースの JTAPI SDK が存在する場合、最初にそれらを手動でアンインストールしないと、新しいソフトウェアのインストールが失敗します。

以前のバージョンの JTAPI がシステムに存在している状態で現行バージョンにアップグレードしようとすると、以前のリリースのアンインストーラが起動します。Windows システムで以前のリリースのアンインストーラをサイレント モードで起動するには、次のコマンドを使用します。

CiscoJtapiClient.exe -silent -W newversion.silent=”1”
 

JTAPI Preferences のユーザ インターフェイス ユーティリティ ツールがインストールされている場合は、このツールを使用して現在インストールされている JTAPI のバージョンを確認することもできます。


ステップ 1 [スタート] > [プログラム] > [CiscoJTAPI] > [JTAPI Preferences] の順に選択します。次のメニューが表示されます。

 

ステップ 2 「ReadMe」ファイルを選択します。このファイルに、現在インストールされている Cisco Unified JTAPI のバージョンが記載されています。


 

Cisco Unified JTAPI ソフトウェアのインストール

Cisco Unified JTAPI ソフトウェアのインストール モードには次の種類があります。

サイレント インストール呼び出し

コマンドライン呼び出し

エンド ユーザ インストール

ISMP インストーラを実行すると、インストール操作のために Java Runtime Environment(JRE; Java ランタイム環境)バージョンが一時的にインストールされます。この JRE はアンインストール操作時に削除されます。


) Cisco Unified JTAPIInstaller での JRE の配布は、Sun Microsystems, Inc. と Cisco Systems, Inc. の間の契約に基づいて行われます。


警告 リリース 4.X またはそれよりも前のリリースの JTAPI SDK が存在する場合、最初にそれらを手動でアンインストールしないと、新しいソフトウェアのインストールが失敗します。

サイレント インストール呼び出し

JTAPIInstaller のサイレント インストール呼び出しを使用すると、アプリケーションのインストーラに JTAPIInstaller を組み込むことができます。

JTAPIInstaller をサイレント モードで起動するアプリケーションでは、次のいずれかのコマンドを使用できます。

Linux プラットフォーム: CiscoJTAPIClient-linux -silent

Solaris(Sparc)プラットフォーム: CiscoJTAPIClient-solarisSparc.bin -silent

Solaris(X86)プラットフォーム: CiscoJTAPIClient-solarisX86.bin -silent

Windows(Win9X、Win ME、Win2K、WinXP)プラットフォーム: CiscoJTAPIClient.exe -silent

JTAPIInstaller で新規インストールまたはアップグレード/ダウングレードを実行すると、インストール先フォルダが自動的に検出されて、サイレント インストールが実行されます。ユーザがインストール時に指定した適切なフォルダ、またはデフォルト フォルダ(サイレント インストールの場合)に、JTAPI サンプル アプリケーションと JAR ファイルが格納されます。ただし、以前のバージョンが存在する場合は、JTAPIInstaller がアプリケーションのパスを判断できないため、デフォルト フォルダ、Lib、および JTAPITools が作成されて、それらのフォルダにアプリケーションがインストールされます。

Windows クライアントの場合は、インストール時にレジストリが更新されて新しいインストール情報が書き込まれます。Linux 版の場合は、ユーザのホーム ディレクトリに jtapiver.ini というファイルが作成されます。

コマンドライン呼び出し

コマンドラインから対話形式で JTAPIInstaller を実行するには、コマンド プロンプトから次のいずれかのコマンドを入力します。

Linux プラットフォーム: CiscoJTAPIClient-linux.bin -console

Solaris(Sparc)プラットフォーム: CiscoJTAPIClient-solarisSparc.bin -console

Solaris(X86)プラットフォーム: CiscoJTAPIClient-solarisX86.bin -console

Windows(Win9X、WinME、Win2K、WinXP)プラットフォーム: CiscoJTAPIClient.exe -console

コマンドライン モードは、Linux システムなど、GUI をサポートしていないシステムに JTAPI をインストールする場合に便利です。すべてのインストール手順が文字ベースのメニューで示され、ユーザはインストール時の条件に基づいて一連の入力を行うように求められます。このモードでは GUI ベースのインストーラで提供されているその他のオプションもすべて使用できます。

エンド ユーザ インストール

JTAPI Installer では、エンド ユーザ インターフェイスとして Java Foundation Classes(JFC)Swing インターフェイスが使用されます。インストール手順を開始すると、ユーザは一連の情報の入力と確認を行うように求められます。

インストーラにより、ターゲット システムの「_uninst」フォルダへのアンインストーラの作成とインストールが行われます。このフォルダは JTAPI アプリケーションのパス(通常、Windows の場合は C:¥Program Files¥JTAPITools、Linux の場合は $HOME/.jtapi/bin)内に配置されます。ユーザはこのパスを使用してアンインストーラを起動できます。

インストーラまたはアンインストーラを実行したフォルダには ismpInstall.txt(または ismpUninstall.txt)というログ ファイルが作成され、このファイルにインストール手順についての詳細情報がすべて保存されます。このファイルには製品インストール中に発生した各種イベントのトレースの完全なリストが含まれるため、エラーの確認にも使用できます。

インストール手順

以降のセクションでは、Linux、Solaris、および Windows プラットフォームでのインストール手順について説明します。

Linux および Solaris プラットフォーム

Cisco Unified JTAPI のインストールと JTAPI Preferences のユーザ インターフェイスでは、複数の言語がサポートされています。

Cisco Unified JTAPIInstaller は次の項目をローカル ディスク ドライブにインストールします。

JTAPI Java クラス($HOME/.jtapi/lib ディレクトリ)

JTAPI Preferences($HOME/.jtapi/bin ディレクトリ)

JTAPI サンプル アプリケーション makecall、jtrace($HOME/.jtapi/bin ディレクトリ)

JTAPI ドキュメント($HOME/.jtapi/bin/doc ディレクトリ)

Linux または Solaris プラットフォームに Cisco Unified JTAPI ソフトウェアをインストールするには、次の手順に従います。


ステップ 1 Cisco Unified JTAPI クライアント ソフトウェアをインストールするコンピュータにログインします。

ステップ 2 適切な ISMP インストーラを探して起動します。

CiscoJTAPIClient-linux.bin(Linux OS の場合)

CiscoJTAPIClient-solarisSparc.bin(Solaris Sparc OS の場合)

CiscoJTAPIClient-solarisX86.bin(Solaris X86 OS の場合)

ステップ 3 Cisco Unified JTAPI Installer の指示に従います。


) Cisco Unified JTAPI ソフトウェアはデフォルト ドライブにインストールされます。
たとえば Linux の場合、デフォルト ディレクトリは $HOME/.jtapi/lib です。



 

Linux および Solaris でのインストールの検証

JTAPI が正常にインストールされたことを確認するには、次の手順に従います。


ステップ 1 $HOME ディレクトリに .jtapiver.ini ファイルが作成されていることを確認します。

ステップ 2 $HOME/.jtapi/bin フォルダに JTAPI プログラム ファイルとドキュメントが存在することを確認します。
makecall、jtrace、Locale_files、および doc フォルダを探します。

ステップ 3 $HOME/.jtapi/lib に JTAPI ライブラリが存在することを確認します。
jtapi.jar、jtracing.jar、および updater.jar ファイルを探します。

ステップ 4 クラスパスに jtapi.jar が存在することを確認した後、$HOME/.jtapi/bin ./_jvm/bin/java のコマンドライン プロンプトから次のコマンドを実行します。

com.cisco.services.jtprefs.jtprefsFrame
 

これにより、[JTAPI Preferences] ダイアログボックスが表示されます。


) JTPrefs アプリケーションが存在しない場合は、次のコマンドを入力して jtapi.ini ファイルを生成できます。
< jview | java > CiscoJtapiVersion -parms
このコマンドにより、現在のディレクトリに jtapi.ini ファイルが生成されます。



 

ユーザはインストール時に $HOME 以外のフォルダを選択して JTAPI をインストールできます。その場合は、指定したフォルダ内に .jtapi というフォルダが作成され、そのフォルダの中に bin フォルダと lib フォルダが作成されて対応するファイルがコピーされます。たとえば /home/jtapiuser というフォルダを選択した場合のフォルダ構造は次のようになります。

/home/jtapiuser/.jtapi/bin:このフォルダには makecall、jtrace、Locale_files、および doc フォルダが含まれます。

/home/jtapiuser/.jtapi/lib:このフォルダには jtapi.jar、jtracing.jar、および updater.jar ファイルが含まれます。

この場合、ステップ 4 のコマンドは /home/jtapiuser/.jtapi/bin フォルダから実行します。

Windows プラットフォーム

Cisco Unified JTAPI のインストールと JTAPI Preferences のユーザ インターフェイスでは、複数の言語がサポートされています。Cisco Unified JTAPI Installer は次の項目をローカル ディスク ドライブにインストールします。

JTAPI Java クラス(%SystemRoot%¥java¥lib ディレクトリ)

JTAPI Preferences(Program Files¥JTAPITools ディレクトリ)

JTAPI サンプル アプリケーション makecall、jtrace(Program Files¥JTAPITools ディレクトリ)

JTAPI ドキュメント(Program Files¥JTAPITools¥doc ディレクトリ)

Windows プラットフォームに Cisco Unified JTAPI ソフトウェアをインストールするには、次の手順に従います。


ステップ 1 Cisco Unified JTAPI クライアント ソフトウェアをインストールするコンピュータにログインします。

ステップ 2 すべての Windows プログラムを終了します。

ステップ 3 ISMP インストーラ(CiscoJTAPIClient.exe)を探して起動します。

ステップ 4 インストーラの指示に従います。


 


) Cisco Unified JTAPI ソフトウェアはデフォルト ドライブにインストールされます。
たとえば Windows NT の場合、デフォルト ディレクトリは C:¥WINNT¥Java¥lib です。


Windows でのインストールの検証

JTAPI を利用して発呼する makecall アプリケーションを使用すると、Windows に JTAPI が適切にインストールされているかどうかを検証できます。makecall アプリケーションを使用するには、次の手順に従います。


ステップ 1 Windows NT のコマンドラインから、Cisco Unified JTAPI ツールがインストールされているディレクトリに移動します。デフォルトでは、このディレクトリは C:¥Program Files¥JTAPITools です。

ステップ 2 次のコマンドを実行します。

java CiscoJtapiVersion

ステップ 3 次のコマンドを実行します。

java makecall < server name > < login > < password > 1000 < phone1 > < phone2 >


server name には、Cisco Unified Communications Manager のホスト名または IP アドレス(たとえば CTISERVER)を指定します。


phone1 変数と phone2 変数には、ユーザ設定に従って制御される IP フォンまたは仮想電話のディレクトリ番号を指定します。詳細については、『 Cisco Unified Communications Manager Administration Guide 』を参照してください。

login 変数と password 変数には、Cisco Unified Communications Manager の [ユーザの設定] ウィンドウで設定したユーザ ID とパスワードを指定します。


 

アップグレードの自動インストール

自動インストール機能には、アプリケーションの起動時に HTTP 要求を使用して Cisco Unified Communications Manager Web サーバにそのアプリケーションの API のバージョンを提示し、必要な JTAPI API のバージョンに関する応答を受信する機能があります。アプリケーションのクラスパスにあるローカルのバージョンと、サーバから取得できるバージョンが比較され、アップグレードが必要かどうかが確認されます。

更新後の API をインスタンス化するように初期化プロセスが変更され、サーバにインストールされているコンポーネントが確認されて、必要に応じてそれらのコンポーネントがダウンロードされます。

この機能を使用すると、Cisco Unified Communications Manager に合わせてアプリケーションが jtapi.jar コンポーネントをリフレッシュでき、アプリケーションで自動アップデート可能な jtapi.jar を一元的に展開できます。

この機能の実行に必要な API は、updater.jar 形式でパッケージ化されています。jtapi.jar および updater.jar のパッケージには、バージョンの比較に使用できる標準マニフェストが含まれています。これにより API 書き込みがアップデートから保護されるため、アプリケーションでバージョン クラスをインスタンス化する必要がなくなります。

場所とコンポーネントを指定してこの機能を実行すると、jtapi.jar がサーバからダウンロードされてローカル ディレクトリにコピーされます。アプリケーションでは、ダウンロードした jtapi.jar を既存のバージョンに上書きするか、新しい jtapi.jar にアクセスするようにクラスパスを変更することができます。


) 自動インストールでは、JTAPI Preferences、TAPITestTools、updater.jar、javadoc コンポーネントはアップデートされません。アプリケーションにこれらのコンポーネントが必要な場合は、Cisco Unified Communications Manager プラグイン ウィンドウから JTAPI をインストールしてください。


Cisco Unified JTAPI Preferences の設定

トレース レベル、トレースの保存先、およびその他のシステム パラメータを設定するには、Cisco Unified JTAPI Preferences アプリケーション(JTPREFS)を使用します。デフォルトでは、Cisco Unified JTAPI Preferences は Program Files¥JTAPITools ディレクトリにインストールされます。Cisco Unified JTAPI Preferences ユーティリティを開くには、[スタート] > [プログラム] > [Cisco Unified JTAPI] > [JTAPI Preferences] の順に選択してください。

このセクションでは、Cisco Unified JTAPI Preferences アプリケーションの使用方法について説明します。このセクションの内容は次のとおりです。

「[JTAPI トレース] タブ」

「[ログ先] タブ」

「[CallManagers] タブ」

「[詳細設定] タブ」

「[セキュリティ] タブ」

「[言語] タブ」

[JTAPI トレース] タブ

[JTAPI トレース] タブでは JTAPI レイヤのトレース設定だけを変更できます。[セキュリティ] タブ でセキュリティ インストールのトレース レベルを有効にできます。図 4-1 に、Cisco Unified JTAPI Preferences アプリケーションの [JTAPI トレース] タブを示します。ウィンドウ タイトルには JTAPI のバージョン番号が表示されます。

図 4-1 [JTAPI トレース] タブ

 

[JTAPI トレース] タブでは、 表 4-2 に示す JTAPI トレース レベルを有効または無効にできます。

 

表 4-2 JTAPI トレース レベル

jtapi.ini のフィールド
デフォルト
最小値
最大値
説明
トレース レベル

警告

WARNING

なし

該当なし

該当なし

低レベルの警告イベント。

情報

INFORMATIONAL

なし

該当なし

該当なし

ステータス イベント。

デバック

DEBUG

なし

該当なし

該当なし

最高レベルのデバッグ イベント。

デバッグ レベル

JTAPI_DEBUGGING

なし

該当なし

該当なし

JTAPI のメソッドおよびイベントのトレース。

JTAPIIMPL_DEBUGGING

なし

該当なし

該当なし

内部 JTAPI 実装トレース。

CTI_DEBUGGING

なし

該当なし

該当なし

JTAPI に送信された Cisco Unified Communications Manager イベントのトレース。

CTIIMPL_DEBUGGING

なし

該当なし

該当なし

内部 CTICLIENT 実装トレース。

PROTOCOL_DEBUGGING

なし

該当なし

該当なし

CTI プロトコルの完全なデコード。

MISC_DEBUGGING

なし

該当なし

該当なし

各種の低レベル デバッグ トレース。

[ログ先] タブ

[ログ先] タブでは、JTAPI によるトレースの作成方法とトレースの保存方法を設定できます。図 4-2 に、Cisco Unified JTAPI Preferences アプリケーションの [ログ先] タブを示します。 表 4-3 に、ログ先のフィールドに関する説明を示します。

図 4-2 [ログ先] タブ

 

 

表 4-3 [ログ先] フィールド

jtapi.ini のフィールド
デフォルト
最小値
最大値
説明

アラームサービスの有効化

Enable Alarm Service
(UseAlarmService)

0

NA

NA

このオプションを有効にすると、指定したマシンで実行されているアラーム サービスに JTAPI アラームが送信されます。このオプションを有効にする場合は、ホスト名とポート番号を指定する必要があります。

Syslogを使用する

Use Syslog
(UseSyslog)

FALSE

NA

NA

このオプションを有効にすると、[コレクタ(Collector)] フィールドと [ポート番号(Port Number)] フィールドで指定された UDP ポートにトレースが送信されます。トレースは syslog コレクタ サービスによって収集され、CiscoWorks2000 サーバに送信されます。

アラームサービスの設定(Alarm Service Settings)

ホスト名

Host Name

NA

NA

このフィールドを使用して、アラーム サービス サーバのホスト名を指定します。

ホストポート

Host Port

NA

NA

このフィールドを使用して、アラーム サービス サーバのホスト ポートを指定します。

Syslogの設定(Syslog Settings)

コレクタ

Collector

0

NA

NA

このフィールドを使用して、トレースを収集する Syslog コレクタ サービスを指定します。

ポート番号

Port Number

514

NA

NA

このフィールドを使用して、コレクタの UDP ポートを指定します。

回転ログファイルを使用

Use Rotating Log Files
(SyslogCollector)

FALSE

NA

NA

このフィールドを使用して特定のパスおよびフォルダにトレースを送信できます。作成できるログ ファイルの数は 2 ~ 99 個です。ログ ファイルは番号順に書き込まれ、最後のファイルがいっぱいになると最初のファイルに戻ります。ログ ファイルのサイズは 1 MB ずつ増加します。

Javaコンソールを使用

Use Java Console
(UseSystemDotOut)

FALSE

NA

NA

このオプションを有効にすると、標準出力またはコンソール(コマンド)ウィンドウにトレースが送信されます。

Log File Settings

ログファイルの最大数

Maximum Number of Log Files
(NumTraceFiles)

10

2

1000

書き込むログ ファイルの最大数を指定します。

ログファイルの最大サイズ(MB)

Maximum Log File Size
(TraceFileSize)

1048576

1048576

NP

書き込むログ ファイルの最大サイズを指定します。

同じディレクトリを使用する

Use the Same Directory
(UseSameDirectory)

1

NA

NA

アプリケーションの各インスタンスで同じフォルダ名を使用するかどうかを指定します。

このオプションを有効にすると、同じディレクトリにログ ファイルがトレースされます。この場合は、JTAPI アプリケーションのインスタンスが順次に起動されるたびに、インデックス 01 から始まるログ ファイルが再作成されます。

このオプションを無効にすると、アプリケーションのインスタンスが(順次か同時かにかかわらず)起動されるたびに、最後に書き込まれたフォルダの後に続く新しいフォルダにトレース ファイルが保存されます。Cisco Unified JTAPI がトレース パスに存在する最後のフォルダを検出して、インデックスの値を自動的に増やします。

パス

Trace Path(TracePath)

.

NA

NA

トレース ファイルを書き込むパスを指定します。このパスを指定しない場合は、デフォルトでアプリケーションのパスが使用されます。

ディレクトリ名ベース

Directory Name Base(Directory)

.

NA

NA

トレース ファイルを格納するフォルダの名前を指定します。

ファイル名ベース

File Name Base
(FileNameBase)

Cisco
Jtapi

NA

NA

この値はトレース ファイルの名前を作成するときに使用します。

ファイル名の拡張子

File Name Extension
(FileNameExtension)

log

NA

NA

トレース ファイルの作成順を示す、ファイル ベース名の末尾に付加される数値インデックスを指定します。

[ファイル名ベース] フィールドに「jtapiTrace」と入力し、[ファイル名の拡張子] フィールドに「log」と入力した場合、トレース ファイルの名前は jtapiTrace01.log、jtapiTrace02.log のようになります。[ファイル名ベース] フィールドと [ファイル名の拡張子] フィールドを空のままにした場合、トレース ファイルの名前は CiscoJtapi01.log、CiscoJtapi02.log のようになります。

[CallManagers] タブ

このタブでは、オプションの Cisco Unified Communications Manager と接続するために JTAPI アプリケーションがユーザに提示する Cisco Unified Communications Manager のリストを定義できます。図 4-3 に、初期設定アプリケーションの [CallManagers] タブを示します。

図 4-3 [CallManagers] タブ

 

[詳細設定] タブ

JTPrefs アプリケーションの [詳細設定] タブでは、 表 4-4 のパラメータを設定できます。これらの低レベル パラメータの設定が必要になるのは、トラブルシューティングやデバッグを行う場合だけです。図 4-4 に、初期設定アプリケーションの [詳細設定] タブを示します。

図 4-4 [詳細設定] タブ

 


表 4-4 のパラメータは、Cisco Technical Assistance Center(TAC)から指示された場合を除き、変更しないことを強くお勧めします。


 

表 4-4 [詳細設定] タブの設定フィールド

jtapi.ini のフィールド
デフォルト
最小値
最大値
説明

定期ウェイクアップを有効にする

Enable Periodic Wakeup
(PeriodicWakeupEnabled)

FALSE

(無効)

NA

NA

JTAPI が使用する内部メッセージ キューのハートビートを有効(または無効)にします。定期ウェイクアップインターバルで定義された時間内に JTAPI がメッセージを受信しなかった場合は、スレッドがアクティブになり、ログ イベントが作成されます。

定期ウェイクアップインターバル(秒)

Periodic Wakeup Interval
(PeriodicWakeupInterval)

50

NP

NP

JTAPI 内部メッセージ スレッドを非アクティブにする時間を秒数で定義します。この時間内に JTAPI がメッセージを受信しなかった場合は、スレッドがアクティブになり、イベントがログに記録されます。

キューの統計を有効にする

Enable Queue Stats
(QueueStatsEnabled)

FALSE

(無効)

NA

NA

指定した数のメッセージが JTAPI メイン イベント スレッドにキューイングされるたびに最大のキュー項目数がログに記録されます。

x 個のメッセージが処理されるたびに、その期間における最大のキュー項目数を報告する DEBUGGING レベル トレースがログに記録されます(x は Queue Size Threshold で指定したメッセージの数を表します)。

キューサイズしきい値

Queue Size Threshold
(QueueSizeThreshold)

25

10

NP

何個のメッセージを処理するたびに最大のキュー項目数を報告するかを指定します。

CTI要求のタイムアウト(秒)

CTI Request Timeout
(CtiRequestTimeout)

15

10

NP

CTI 要求からの応答を待つ秒数を指定します。

プロバイダオープン要求タイムアウト(秒)

Provider Open Request Timeout
(ProviderOpenRequestTimeout)

200

10

NP

プロバイダー オープン要求に対する応答を待つ秒数を指定します。

プロバイダ再試行インターバル(秒)

Provider Retry Interval
(ProviderRetryInterval)

30

5

NP

システム障害が発生したときに Cisco Unified Communications Manager クラスタへの接続を再試行する秒数を指定します。

サーバハートビートインターバル(秒)

Server Heartbeat Interval
(DesiredServerHeartbeatInterval)

30

>0

NP

JTAPI と Cisco Unified Communications Manager クラスタが接続されていることを確認する間隔を秒単位で指定します。

この時間内にハートビートを受信しなかった場合、JTAPI はプロバイダー オープン要求で指定されている 2 番目の CTIManager を通じて接続を確立します。

ルート三択タイムアウト(ミリ秒)

Route Select Timeout
(RouteSelectTimeout)

5000

0

NP

ルート イベントに対するアプリケーションの応答を待つ時間をミリ秒単位で指定します。この時間内にアプリケーションが応答しなかった場合、JTAPI はそのルートを終了して、対応する RouteEnd イベントを送信します。

ポストコンディションタイムアウト

Post Condition Timeout

15

0

NP

タイムアウトを指定します。

UseProgressAsDisconnectedDuringErrorEnabled

0

NA

NA

ゲートウェイから Progress を受け取った際に、Disconnect とみなす場合のコード。カンマ区切りのリストで記載します。たとえば、17(USERBUSY)と25(EXCHANGEROUTINGERROR)の場合は、17, 15と記載します。

[セキュリティ] タブ

図 4-5 に、初期設定アプリケーションの [セキュリティ] タブを示します。

図 4-5 [セキュリティ] タブ

 

アプリケーション ユーザは、JTAPI API または JTAPI Preferences を起動してアプリケーション サーバから証明書をダウンロードしてインストールする前に、JTAPI Preferences アプリケーションでユーザ名、インスタンス ID、許可コード、TFTP サーバの IP アドレス、CAPF サーバの IP アドレスの各パラメータを設定する必要があります。

JTAPI Preferences では、ユーザ名とインスタンス ID の 1 つ以上のペアに対してセキュリティ プロファイルを設定できます。ユーザ名とインスタンス ID のペアに対してすでにセキュリティ プロファイルが設定されている場合、アプリケーション ユーザがユーザ名とインスタンス ID を入力して他の編集ボックスをクリックすると、セキュリティ プロファイルが自動的に編集ボックスに入力されます。

JTAPI Preferences の GUI を使用せずに、CiscoJtapiProperties で提供されているインターフェイスをアプリケーションから呼び出してクライアント証明書をインストールすることもできます。UpdateCertificate() インターフェイスが呼び出されると、JTAPI クライアントは TFTP サーバに接続して CTL ファイルをダウンロードし、指定された証明書パスに証明書を抽出します。その後、CAPF サーバに接続してクライアント証明書をダウンロードし、指定された証明書パスにクライアント証明書をインストールします。

ユーザ セキュリティ レコードは Comma Separated Value(CSV; カンマ区切り形式)で jtapi.ini ファイルに保存されます。各レコードはセミコロンで区切られます。ユーザ セキュリティ レコードの例を次に示します。

SecurityProperty=user,123,12345,172.19.242.37,3804,172.19.242.37,69,.¥¥,true,false;<次のレコード>; ...

[セキュリティ] タブでは、次のパラメータを設定できます。

 

表 4-5 JTAPI のセキュリティ設定のフィールド

jtapi.ini のフィールド
デフォルト
最小値
最大値
説明

セキュリティトレースを有効にする

Enable Security Tracing
(SecurityTraceEnabled)

FALSE

NA

NA

このチェックボックスをオンにしてトレース レベルを選択すると、証明書のインストール処理のトレースが有効(または無効)になります。

トレースレベルの選択

Select Trace Level
(SecurityTraceLevel)

0

0

2

次の 3 つからトレース レベルを選択できます。

Error = 0:エラー イベントをログに記録します。

Debug = 1:デバッグ イベントをログに記録します。

Detailed = 2:すべてのイベントをログに記録します。

ユーザ名

User Name
(Username)

NA

NA

NA

ユーザ名とインスタンス ID のペアに対してすでにセキュリティ プロファイルが設定されている場合、アプリケーション ユーザがユーザ名とインスタンス ID を入力して他の編集ボックスをクリックすると、セキュリティ プロファイルが自動的に編集ボックスに入力されます。

インスタンスID

Instance ID
(instanceID)

NA

NA

NA

このフィールドでアプリケーション インスタンスの ID を指定します。同じユーザ名を使用して CTIManager に接続するアプリケーションの場合は、インスタンスごとにインスタンス ID を定義して証明書の AuthorizationString をダウンロードする必要があります。

認証文字列

Authentication String
(authcode)

NA

NA

NA

このフィールドで証明書のダウンロードに使用される 1 回限りの文字列を指定します。

TFTP サーバの IP アドレス

TFTP Server IP Address

NA

NA

NA

このフィールドで TFTP サーバの IP アドレス(通常は Cisco Unified Communications Manager の IP アドレス)を指定します。

TFTP サーバのポート

TFTP Server Port

69

NP

NP

TFTP サーバのポートはデフォルトで 69 です。システム管理者からの指示が限り、この値は変更しないでください。

CAPF サーバの IP アドレス

CAPF Server IP Address

NA

NA

NA

このフィールドで CAPF サーバの IP アドレスをドット付き 10 進数で指定します。

CAPF サーバのポート

CAPF Server Port

3804

NP

NP

CAPF サーバのポート番号はデフォルトで 3804 に設定されますが、この番号は Cisco Unified Communications Manager Administration で設定することもできます。JTAPI Preferences からこの値を入力する場合は、Cisco Unified Communications Manager Administration で設定した値と同じにする必要があります。

証明書のパス

Certificate Path

JTAPI.jar
location

NA

NA

このフィールドでアプリケーションがサーバ証明書とクライアント証明書をインストールするパスを指定します。このフィールドが空の場合、証明書は JTAPI.jar のクラスパスにインストールされます。

証明書のパスフレーズ

Certificate Passphrase

このフィールドで証明書のパスフレーズを指定します。

セキュア接続を有効にする

Enable Secure Connection

FALSE

NA

NA

このオプションをオンにすると、Cisco Unified Communications Manager へのセキュア TLS 接続が有効になります。このオプションをオフにした場合は、証明書が更新またはインストールされていても、JTAPI と CTI の接続は暗号化されません。

証明書更新ステータス

Certificate Update Status

NA

NA

NA

このフィールドには、証明書の更新状態に関する情報が表示されます。

証明書を削除する

Delete Certificate

NA

NA

NA

このボタンを使用すると、既存の証明書が削除されます。

証明書を更新する

Update Certificate

NA

NA

NA

このボタンを使用すると、変更されたパラメータで既存の証明書が更新されます。

[言語] タブ

図 4-6 に、初期設定アプリケーションの [言語] タブを示します。

図 4-6 [言語] タブ

 

[言語] タブでは、システムにインストールされている言語の中から、設定の表示に使用する言語を 1 つ選択できます。選択可能な言語は次のとおりです。

 

Arabic(アラビア語)

Brazilian Portuguese(ブラジルポルトガル語)

Chinese Taiwan(繁体字中国語)

Croatian(クロアチア語)

Czech(チェコ語)

Danish(デンマーク語)

Dutch(オランダ語)

English(英語)

Finnish(フィンランド語)

French(フランス語)

German(ドイツ語)

Greek(ギリシャ語)

Hebrew(ヘブライ語)

Hungarian(ハンガリー語)

Italian(イタリア語)

Japanese(日本語)

Nederlands(オランダ語)

Norwegian(ノルウェー語)

Polish(ポーランド語)

Portuguese(ポルトガル語)

Russian(ロシア語)

Simplified Chinese(簡体字中国語)

Slovak(スロバキア語)

Spanish(スペイン語)

Swedish(スウェーデン語)

言語を選択すると、タブ内のテキストがその言語で表示されます。

JTAPI アプリケーションのユーザ情報の管理

JTAPI アプリケーションのユーザには、1 つ以上のデバイスを制御する特権が与えられている必要があります。JTAPI アプリケーションを使用する前に、「新規ユーザの追加」セクションの手順に従ってユーザを追加し、ユーザにデバイスを割り当ててください。ユーザに割り当てられているデバイスのリストには、ユーザがアプリケーションから制御(発呼や応答など)する必要がある電話機が表示されます。

jtapi.ini ファイルのフィールド

JTPrefs を起動できない非 GUI ベースのプラットフォームで実行されるアプリケーションの場合は、ここに示す値に基づく固有の jtapi.ini ファイルを作成して jtapi.jar とともに配置できます。これらの値は JTAPI の設定に使用されます。

各アプリケーションは 表 4-6 で説明されている有効なデータを提供する必要があります。jtapi.ini ファイルの値が不適切であるために JTAPI の動作で発生するエラーは、アプリケーション側に原因があります。

NA:適用なし
NP:なし

 

表 4-6 jtapi.ini ファイルのフィールド

jtapi.ini のフィールド
デフォルト
最小値
最大値
説明

INFORMATIONAL

0

NA

NA

ステータス イベントを指定します。

DEBUG

0

NA

NA

最高レベルのデバッグ イベントを指定します。

WARNING

0

NA

NA

低レベルの警告イベントを指定します。

JTAPI_DEBUGGING

0

NA

NA

JTAPI のメソッドおよびイベントのトレースを指定します。

JTAPIIMPL_DEBUGGING

0

NA

NA

内部 JTAPI 実装トレースを指定します。

CTI_DEBUGGING

0

NA

NA

JTAPI 実装に送信される Cisco Unified Communications Manager イベントのトレースを指定します。

CTIIMPL_DEBUGGING

0

NA

NA

内部 CTICLIENT 実装トレースを指定します。

PROTOCOL_DEBUGGING

0

NA

NA

CTI プロトコルの完全なデコードを指定します。

MISC_DEBUGGING

0

NA

NA

各種の低レベル デバッグ トレースを指定します。

DesiredServerHeartbeatInterval

30

>0

NP

このフィールドで JTAPI と Cisco Unified Communications Manager クラスタが接続されていることを確認する間隔を秒単位で指定します。この時間内にハートビートを受信しなかった場合、JTAPI はプロバイダー オープン要求で指定されている 2 番目の CTIManager を通じて接続を確立します。

TracePath

.

NA

NA

トレース ファイルを書き込むパス名を指定します。このパスを指定しない場合は、デフォルトでアプリケーションのパスが使用されます。

FileNameExtension

log

NA

NA

このフィールドで、トレース ファイルの作成順を示すファイル ベース名の末尾に付加される数値インデックスを指定します。たとえば、[File Name Base] フィールドに「jtapiTrace」と入力し、[File Name Extension] フィールドに「log」と入力した場合、トレース ファイルの名前は jtapiTrace01.log、jtapiTrace02.log のようになり、jtapiTrace10.log まで達すると再び jtapiTrace01.log に書き込まれます。[File Name Base] フィールドと [File Name Extension] フィールドを空のままにした場合、トレース ファイルの名前は CiscoJtapi01.log、CiscoJtapi02.log のようになります。

SyslogCollector

FALSE

NA

NA

このフィールドで、システム上の特定のパスおよびフォルダにトレースを送信するように指定します。作成できるログ ファイルの数は 2 ~ 99 個です。ログ ファイルは番号順に書き込まれ、最後のファイルがいっぱいになると最初のファイルに戻ります。ログ ファイルのサイズは 1 MB ずつ増加します。

TraceFileSize

1048576

1048576

NP

このフィールドで、書き込むログ ファイルの最大サイズを指定します。

UseAlarmService

0

NA

NA

このオプションを有効にすると、指定したマシンで実行されているアラーム サービスに JTAPI アラームが送信されます。このオプションを有効にする場合は、ホスト名とポート番号を指定する必要があります。

ProviderOpenRequestTimeout

200

10

NP

このフィールドで、プロバイダー オープン要求に対する応答を待つ秒数を指定します。デフォルトは 10 秒です。

JtapiPostConditionTimeout

15

10

20

JTAPI にはイベントの事後条件があり、タイムアウト時間内に事後条件が満たされない場合は例外がスローされます。このフィールドでは、そのような条件のタイムアウト値を設定します。

ApplicationPriority

2

NA

NA

このフィールドは、複数のプロバイダー オープン要求の優先順位を設定するために使用します。現在のところ、JTAPI はデフォルト値しか送信しません。

SecurityTraceEnabled

FALSE

NA

NA

このフィールドで、セキュリティ関連メッセージのトレースを有効にします。

このチェックボックスを選択してトレース レベルを選択すると、証明書のインストール処理のトレースが有効(または無効)になります。

AlarmServicePort

1444

NP

NP

このフィールドは、アラームを別のサーバに送信するために使用します。アラーム サーバのホスト名とサービスが実行されているポートを選択すると、指定したサーバおよびポートにアラームが送信されます。

AlarmServiceHostname

null

NA

NA

このフィールドで、アラーム サーバのホスト名を表示します。

RouteSelectTimeout

5000

0

NP

このフィールドで、Route イベントに対するアプリケーションの応答を待つ時間をミリ秒単位で指定します。この時間内にアプリケーションが応答しなかった場合、JTAPI はそのルートを終了して、対応する RouteEnd イベントを送信します。

ProviderRetryInterval

30

5

NP

このフィールドで、システム障害が発生したときに Cisco Unified Communications Manager クラスタへの接続を再試行する秒数を指定します。

QueueStatsEnabled

FALSE

NA

NA

このフィールドで、指定した数のメッセージが JTAPI メイン イベント スレッドにキューイングされるたびに JTAPI が最大のキュー項目数をログに記録するために使用します。つまり、x 個のメッセージが処理されるたびに、その期間における最大のキュー項目数を報告する DEBUGGING レベル トレースがログに記録されます(x は Queue Size Threshold で指定したメッセージの数を表します)。

FileNameBase

CiscoJtapi

NA

NA

このフィールドで、トレース ファイルの名前を作成するときの値を指定します。

PeriodicWakeupEnabled

FALSE

NA

NA

このフィールドで、JTAPI が使用する内部メッセージ キューのハートビートを有効(または無効)にします。PeriodicWakeupInterval で定義された時間内に JTAPI がメッセージを受信しなかった場合は、スレッドがアクティブになり、ログ イベントが作成されます。

JTAPINotificationPort

2789

1

NP

このフィールドで、実行中に JTAPI パラメータの変更を JTAPI アプリケーションに伝達するために使用するポートを指定します。

PeriodicWakeupInterval

50

NP

NP

このフィールドで、JTAPI 内部メッセージ スレッドを非アクティブにする時間を定義します。この時間内に JTAPI がメッセージを受信しなかった場合は、スレッドがアクティブになり、イベントがログに記録されます。

QueueSizeThreshold

25

10

NP

このフィールドで、何個のメッセージを処理するたびに最大のキュー項目数を報告するかを指定します。

UseSystemDotOut

FALSE

NA

NA

このフィールドは、コンソールにトレースを表示するために使用します。

UseSameDirectory

1

NA

NA

このフィールドで、アプリケーションの各インスタンスで同じフォルダ名を使用する必要があるかどうかを指定します。

このオプションを有効にすると、同じディレクトリにログ ファイルがトレースされます。この場合は、JTAPI アプリケーションのインスタンスが順次に起動されるたびに、インデックス 01 から始まるログ ファイルが再作成されます。

このオプションを無効にすると、アプリケーションのインスタンスが(順次か同時かにかかわらず)起動されるたびに、最後に書き込まれたフォルダの後に続く新しいフォルダにトレース ファイルが保存されます。Cisco Unified JTAPI がトレース パスに存在する最後のフォルダを検出して、インデックスの値を自動的に増やします。

NumTraceFiles

10

2

1000

このフィールドで、書き込むログ ファイルの最大数を指定します。

UseSyslog

FALSE

NA

NA

このフィールドを有効にすると、Collector フィールドと Port Number フィールドで指定された UDP ポートにトレースが送信されます。トレースは syslog コレクタ サービスによって収集され、CiscoWorks2000 サーバに送信されます。

SecurityTraceLevel

0

0

2

このフィールドで、セキュリティ メッセージのトレース レベルを指定します。
0 = Error、1 = Debug、2 = Detailed

UseTraceFile

TRUE

NA

NA

このフィールドで、logFile Trace Writer へのログの書き込みを有効にします。

CMAssignedAppID

0

NA

NA

このフィールドで、アプリケーションに割り当てられている機能 ID を指定します。この ID は Cisco Unified Communications Manager によってあらかじめ割り当てられます。

UseProgressAsDisconnectedDuringErrorEnabled

0

NA

NA

ゲートウェイから Progress を受け取った際に、Disconnect とみなす場合のコード。カンマ区切りのリストで記載します。たとえば、17(USERBUSY)と25(EXCHANGEROUTINGERROR)の場合は、17, 15と記載します。

CtiManagers

null

NA

NA

このフィールドで、トレースを収集する CTI Manager のリストを指定します。

Directory

.

NA

NA

このフィールドで、トレース ファイルを格納するフォルダの名前を指定します。

Security Property

SecurityProperty=username, instanceId, authcode,
tftp ip address, tftp port,
capf ip address, capf port, certificate path, security option, certificate status

NA

NA

NA

このフィールドで、ユーザ セキュリティ レコード(username、instanceId、authcode、tftp ip address、tftp port、capf ip address、capf port、certificate path、security option、certificate status)を指定します。このレコードは、jtapi.ini ファイルにカンマ区切りの文字列で保存されます。各レコードはセミコロンで区切られます。

SecurityProperty=user,123,12345,172.19.242.37,3804,172.19.242.37,69,.¥¥,true,false;<次のレコード>; ...

Username

NA

NA

NA

このフィールドには、以前にユーザ名とインスタンス ID のペアが設定され、他の編集ボックスをクリックしたアプリケーション ユーザーのセキュリティ プロファイルが自動的に入力されます。

instanceId

NA

NA

NA

このフィールドでアプリケーション インスタンスの ID を指定します。同じユーザ名を使用して CTIManager に接続するアプリケーションの場合は、インスタンスごとにインスタンス ID を定義して証明書の AuthorizationString をダウンロードする必要があります。

authcode

NA

NA

NA

このフィールドで、Cisco Unified Communications Manager データベースで設定された認証文字列を指定します。これは証明書を取得するために一度だけ使用できます。

Communications Manager TFTP IP address

NA

NA

NA

このフィールドで、Cisco Unified Communications Manager の TFTP アドレス(通常は Cisco Unified Communications Manager の IP アドレス)を指定します。

CallManger TFTP port

69

NP

NP

このフィールドには CallManager TFTP port が表示されます。
システム管理者からの指示がない限り、この値はデフォルトの 69 から変更しないでください。

Communications Manager CAPF IP server address

NA

NA

NA

このフィールドで、CAPF サーバの IP アドレスを指定します。

Communications Manager CAPF server port

3804

NP

NP

このフィールドには、CAPF サーバ ポートのデフォルト値(3804)が表示されます。この値は Cisco Unified Communications Manager Administration のサービス パラメータで設定できることに注意してください。このインターフェイスから値を入力する場合は、Cisco Unified Communications Manager Administration ウィンドウで設定した値と同じであることを確認してください。

Certificate path

JTAPI.jar

の場所

NA

NA

このフィールドで、アプリケーションがサーバ証明書とクライアント証明書をインストールする場所を指定します。このフィールドが空の場合、証明書は JTAPI.jar のクラスパスにインストールされます。

Enable secure connection

TRUE

NA

NA

このフィールドを TRUE に設定した場合は、証明書が更新またはインストールされていても、JTAPI と CTI の接続は暗号化されません。

Certificate Update Status

NA

NA

NA

[JTAPI Preferences] ダイアログボックスは、ユーザ名とインスタンス ID の 1 つ以上のペアに対してセキュリティ プロファイルを設定するために使用します。

デフォルト値を使用する場合の jtapi.ini ファイルの例

#Cisco Unified JTAPI version 7.0(1.1000)-1 Release ini parameters
#Wed Sep 14 16:55:30 PDT 2008
INFORMATIONAL=0
DesiredServerHeartbeatInterval=30
TracePath=.
FileNameExtension=log
SyslogCollector=
TraceFileSize=1048576
UseAlarmService=0
ProviderOpenRequestTimeout=200
JtapiPostConditionTimeout=15
ApplicationPriority=2
SecurityTraceEnabled=0
AlarmServicePort=1444
RouteSelectTimeout=5000
ProviderRetryInterval=30
QueueStatsEnabled=0
FileNameBase=CiscoJtapi
JTAPI_DEBUGGING=0
PeriodicWakeupEnabled=0
CTI_DEBUGGING=0
JTAPINotificationPort=2789
Traces=WARNING;INFORMATIONAL;DEBUG
PeriodicWakeupInterval=50
AlarmServiceHostname=
QueueSizeThreshold=25
Debugging=JTAPI_DEBUGGING;JTAPIIMPL_DEBUGGING;CTI_DEBUGGING;CTIIMPL_DEBUGGING; PROTOCOL_DEBUGGING;MISC_DEBUGGING
PROTOCOL_DEBUGGING=0
UseSystemDotOut=0
MISC_DEBUGGING=0
UseSameDirectory=1
NumTraceFiles=10
UseSyslog=0
DEBUG=0
SecurityTraceLevel=0
UseTraceFile=1
WARNING=0
CMAssignedAppID=0
UseProgressAsDisconnectedDuringErrorEnabled=0
CtiManagers=;;;;;;;;;
Directory=
CTIIMPL_DEBUGGING=0
CtiRequestTimeout=30
JTAPIIMPL_DEBUGGING=0
SyslogCollectorUDPPort=514
SecurityProperty=cisco,123,12345,A.B.C.D,3804,A.B.C.D,69,/C¥:/Program Files/JTAPITools/./,false,false;