WSMGR for Web V9 使用手引書

32.3 WsmgrConnectInfoリファレンス

WsmgrConnectInfoオブジェクトで使用可能なメソッドとプロパティの一覧を示します。

メソッド名	機能
Init	スクリプトの動作環境の初期化 関連プロパティ: url, user, pw, icon, scope
Uninit	スクリプトの動作環境の解放
GetIcon	接続アイコンの一覧情報の取得
SetIcon	使用する接続アイコンの指定
ShowIconList	WSMGR for Webの認証と接続先一覧ページの表示
ShowLogonPage	認証するためにWSMGR for Webのログオンページを表示

プロパティ名	設定	参照	機能
url	○	○	WSMGR for Webの仮想ディレクトリのURL（絶対パス指定）
user	○	○	WSMGR for Webのユーザ名
pw	○	○	WSMGR for Webのパスワード
icon	○	○	接続アイコン名
scope	○	○	対象とする接続アイコン(ユーザかグループか)
IconCount	－	○	接続アイコンの個数
IconName	－	○	接続アイコン名
backUrl	○	○	エミュレータ終了時に遷移するURL
emulatorWindowName	－	○	スクリプトから起動するエミュレータがユーザスクリプトをロードできるようにするための値(ウィンドウ名)

■Initメソッド

スクリプトの動作環境の初期化

スクリプトを動作させるための初期化処理を行います。ここでは、次の初期化処理を行います。

• WSMGR for Webの認証

  
  

●呼び出し形式

Init()

●パラメータ

パラメータはありませんが、次の関連プロパティをあらかじめ設定してください。

プロパティ	説明	省略時の初期値
url	WSMGR for Webの仮想ディレクトリのURL	省略できません
user	WSMGR for Webのユーザ名	簡易シングルサインオンユーザ名または自動ログオンユーザ名
pw	WSMGR for Webのパスワード	空白
icon	使用する接続アイコン名	1番目の接続アイコン
scope	対象とする接続アイコン   ユーザ定義の接続アイコン：“user”   グループ定義の接続アイコン：“group”	user

注意

iconプロパティに設定する接続アイコンの表示モードが「フレームウィンドウでエミュレータを表示」になっている場合、スクリプトによるエミュレータの制御ができないためinitメソッドでエラーを返します。管理ツールを使用して接続アイコンの表示モードを「ブラウザの中でエミュレータを表示する」に設定を変更してください。

●リターン値

正常の場合は0、エラーの場合は次の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
24	表示モードがフレームウィンドウになっている接続アイコンは指定できません。
25	すでに同じ接続アイコンが起動しています。
26	ActiveXモードの接続アイコンは指定できません。
28	すでに別のユーザが認証しています。新しいセッションでブラウザを起動してください。

■Uninit メソッド

スクリプトの動作環境の解放

WSMGR for Webサーバよりログオフを行い、スクリプトの動作環境の解放処理を行います。同じWebブラウザを使用してWSMGR for Webへ認証を行う場合に、本メソッドを呼び出して動作環境を解放してください。

●呼び出し形式

Uninit()

●パラメータ

パラメータはありませんが、次の関連プロパティをあらかじめ設定してください。

プロパティ	説明	省略時の初期値
url	WSMGR for Webの仮想ディレクトリのURL	省略できません

●リターン値

正常の場合は0、エラーの場合は次の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
29	initメソッドによる認証が完了していません。

■GetIcon メソッド

接続アイコンの取得

接続アイコンの取得を行います。ここでは、次の条件に基づいた接続アイコンを取得対象とします。

• scopeプロパティにuserが指定された場合は、userプロパティに指定されているユーザの接続アイコンの一覧を取得します。

• scopeプロパティにgroupが指定された場合は、userプロパティに指定されているユーザが所属するグループの接続アイコンの一覧を取得します。

本メソッドの実行にはWSMGR for Webの認証が完了している必要があります。

●呼び出し形式

GetIcon()

●パラメータ

ありません

●リターン値

正常の場合は0、エラーの場合は次の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
29	initメソッドによる認証が完了していません。

■SetIcon メソッド

使用する接続アイコンの指定

ホストへの接続で使用する接続アイコンの指定を行います。initメソッドでiconプロパティに設定される接続アイコンと異なる接続アイコンを指定する場合は、本メソッドを利用して明示的に目的の接続アイコンを指定してください。
本メソッドが正常に完了すると、指定した接続アイコンがiconプロパティに設定されます。

本メソッドの実行にはWSMGR for Webの認証が完了している必要があります。

●呼び出し形式

SetIcon(icon)

●パラメータ

パラメータ	説明	省略時の初期値
icon	使用する接続アイコン名	省略できません

●リターン値

正常の場合は0、エラーの場合は次の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
24	表示モードがフレームウィンドウになっている接続アイコンは指定できません。
25	すでに同じ接続アイコンが起動しています。
26	ActiveXモードの接続アイコンは指定できません。
29	initメソッドによる認証が完了していません。

参考

指定する接続アイコン名を固定化したくない場合、GetIconメソッドを利用して取得した接続アイコンの一覧を使ってスクリプトに判定処理を記述することで、用途に応じた接続アイコンを動的に指定することも可能です。

■ShowIconList メソッド

WSMGR for Webの接続先一覧ページの表示

WSMGR for Webの認証後に接続先一覧のページを表示します。

●呼び出し形式

ShowIconList()

●パラメータ

パラメータはありませんが、以下の関連プロパティを設定してください。

プロパティ	説明	省略時の初期値
url	WSMGR for Webの仮想ディレクトリのURL	省略できません
user	WSMGR for Webのユーザ名	簡易シングルサインオンユーザ名または自動ログオンユーザ名
pw	WSMGR for Webのパスワード	空白

●リターン値

正常の場合は0、エラーの場合は以下の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
28	すでに別のユーザが認証しています。新しいセッションでブラウザを起動してください。

注意

• 本メソッドは接続先一覧をブラウザ上に表示するためのメソッドです。表示された接続先一覧をスクリプトで制御することはできません。このため、WSMGR for Webの認証のみ自動化したい場合に利用してください。

• スクリプトで、接続先一覧からのエミュレータ起動と制御までを一連の流れで行う場合は、GetIconメソッドを利用してください。

■ShowLogonPage メソッド

認証するためにWSMGR for Webのログオンページを表示

WSMGR for Webのログオンページを使って認証します。

●呼び出し形式

ShowLogonPage()

●パラメータ

パラメータはありませんが、以下の関連プロパティを設定してください。

プロパティ	説明	省略時の初期値
url	WSMGR for Webの仮想ディレクトリのURL	省略できません

●リターン値

認証が完了している場合は、リターン値0を返します。認証が完了していない場合は、WSMGR for Webのログオンページを表示するためにリターン値29を返します。ログオンページで認証に成功すると呼び出し元のページに戻ります。

エラーが発生した場合は以下の値になります。

値	説明
1	パラメータが不正です。ユーザ名、パスワード、接続アイコン名などを確認してください。
2	メモリ不足が発生しました。
12	エラーにより処理が異常終了しました。
24	表示モードがフレームウィンドウになっている接続アイコンは指定できません。
25	すでに同じ接続アイコンが起動しています。
26	ActiveXモードの接続アイコンは指定できません。
28	すでに別のユーザが認証しています。新しいセッションでブラウザを起動してください。
29	認証が完了していません。 ※WSMGR for Webのログオンページへ遷移するために返すリターン値です

注意

• 事前に自動ログオンが設定されている場合は、自動ログオンユーザによる認証が優先されます。

●JavaScriptの記述例

// WsmgrConnectInfoオブジェクトの生成
var EmuInfo = new WsmgrConnectInfo();

// プロパティの設定
EmuInfo.url = 'http://exsample.com/wsmgrweb/'; // WSMGR for WebのURL
EmuInfo.icon = '接続1'; // 認証後に起動する接続アイコン
EmuInfo.backUrl = ''; // エミュレータ終了時にウィンドウを閉じます

// WSMGR for Webのログオンページを表示
var ret = EmuInfo.ShowLogonPage();

if (ret != 0 && ret != 29) {
    // エラー処理
    alert('初期化エラーです');
} else if (ret == 0) {
    // エミュレータ起動処理
    window.name = EmuInfo.emulatorWindowName; // ユーザスクリプトのロード
    document.forms['WSMGR_Emulator'].target = '_self';
    document.forms['WSMGR_Emulator'].submit();
}

■IconCountプロパティ

ユーザで利用可能な接続アイコンの個数を示します。initメソッドを使用して初期化が完了した後に参照できます。

■IconNameプロパティ

指定インデックスの接続アイコン名を示します。initメソッドを使用して初期化が完了した後に参照できます。

●JavaScriptの記述例

// WsmgrConnectInfoオブジェクトの生成
var EmuInfo = new WsmgrConnectInfo();

// プロパティの設定
EmuInfo.url = "http://exsample.com/wsmgrweb/"; // WSMGR for WebのURL
EmuInfo.user = "user1";          // ユーザ名
EmuInfo.pw = "password";         // パスワード

// 初期化
EmuInfo.Init();

// 接続アイコンの個数を取得
EmuInfo.GetIcon();
count = EmuInfo.IconCount;

// 接続アイコン名を表示
for(i = 0; i < count; i++)
{
    alert(EmuInfo.IconName(i)); 
}

■backUrlプロパティ

エミュレータ終了時の遷移先URLを指定します。空文字を指定した場合は、ブラウザを終了します。

●JavaScriptの記述例

ShowLogonPageメソッドを参照してください。

■emulatorWindowNameプロパティ

スクリプトから起動するエミュレータがユーザスクリプトをロードできるようにするための値(ウィンドウ名)です。
エミュレータを表示するJavaScriptのwindowオブジェクトのnameプロパティ(ウィンドウ名)に指定することで、あらかじめ管理ツールで接続アイコンに設定したユーザスクリプトをロードしてエミュレータを起動することができます。

●JavaScriptの記述例

ShowLogonPageメソッドを参照してください。