4.4.2 ActiveXコンポーネントの作成
(1) ユーザ認証メソッド(hs5um_OutSideAuthenticate)
(a) 機能
指定したモードに従い,ユーザ情報を取得します。指摘できるモードを次に示します。
モード種別 | ユーザ情報の取得方法 |
---|
2 | 引数sLcaseUsrIDで渡したユーザIDと,引数sPasswdで渡したパスワードでユーザ認証をして,プロパティにユーザ情報を設定します。プロパティに設定されたユーザの権限でHITSENSER5 Webを実行します。 |
(b) 形式
hs5um_OutSideAuthenticate(iMode,sLcaseUsrID,sPasswd)〔Long〕
(c) 引数
- iMode〔Long〕
ユーザ認証モードの動作モードを指定します。
動作モード | 説明 |
---|
2 | レジストリに登録したユーザ認証モードが「OutSideMode=IDOUT(HITSENSER5 WebユーザID取得,外部ユーザ認証の場合)」のときに指定します。 |
- sLcaseUsrID〔String〕
認証用ユーザIDを指定します。ユーザIDの英字では,全角と半角が区別されません。また,大文字,小文字の指定にかかわらず,すべて小文字に変換したものを外部に渡します。引数sLcaseUsrIDは,引数iModeに「2」が設定されている場合だけ有効です。
- sPasswd〔String〕
認証用パスワードを指定します。パスワードは,大文字と小文字を区別して外部に渡します。ユーザ認証のときにパスワードの大文字と小文字をどのように扱うかは任意です。引数sPasswdは,引数iModeに「2」が設定されている場合だけ有効です。
(d) 戻り値
0以上の戻り値は実装する必要があります。エラーは例外として実装してもかまいません。戻り値1~3が返された場合は,HITSENSER5 Web側で対応するメッセージが出力されます。
戻り値 | 説明 |
---|
-1 | エラー(詳細エラー情報を参照のこと)。 |
0 | 正常終了。 ユーザ情報(ユーザID,パスワード,ユーザ名,ユーザが持つ権限,ユーザが所属するグループ数,ユーザが所属するグループの一覧)を返します。 |
1 | 指定したユーザIDが存在しません。 |
2 | 指定したパスワードが不正です。 |
3 | 指定したユーザID又はパスワードが不正です。 戻り値1と2を区別しない場合に使用します。 |
(e) 固有のプロパティ
- hs5m_sUserIDプロパティ
- 機能
- 認証対象のユーザを識別するユニークなID(ユーザID)を設定します。
- ユーザIDに指定できる文字列の長さは1~20バイトまでです。全角文字及び半角文字を使用できます。ただし,タブ記号,改行文字などの制御記号,及び次に示す半角文字は使用できません。
- [ ] + = , / * ? " < > | ¥ :
- また,ピリオド(.)と空白だけで構成される文字列は指定できません。ユーザIDを英大文字で指定した場合は,ユーザIDは小文字に変換されるため,大文字と小文字が区別されません。HITSENSER5 Webでは,ユーザIDでユーザを区別します。
- 形式
- hs5m_sUserID
- データ型
- String
- hs5m_sUserNameプロパティ
- 機能
- ユーザIDに対応する任意の名称(ユーザ名)を設定します。
- ユーザ名に設定できる文字列の長さは1~255バイトまでです。全角文字及び半角文字を使用できます。ただし,タブ記号,改行文字などの制御記号,及び半角のコンマ(,)は使用できません。
- なお,ユーザ名を決める必要がなければ,ユーザIDを設定してください。
- 形式
- hs5m_sUserName
- データ型
- String
- hs5m_iAttrプロパティ
- 機能
- ユーザが持つ権限を次に示す値で設定します。
- 0x10:一般ユーザ
- 0x20:分析情報ファイル作成者
- 0x40:システム管理者
- 形式
- hs5m_iAttr
- データ型
- Long
- hs5m_iGroupsCntプロパティ
- 機能
- ユーザが所属するグループ数を1以上の整数で設定します。ユーザは,一つ以上のグループに所属している必要があります。
- 形式
- hs5m_iGroupsCnt
- データ型
- Long
- hs5m_sGroupsプロパティ
- 機能
- ユーザが所属するグループの一覧を,0~(hs5m_iGroupsCnt -1)の添え字を持つ文字列型の配列で設定します。ユーザは,一つ以上のグループに所属している必要があります。グループを作成しない場合は,HITSENSER5 Webが用意している管理者グループ(グループID:system)に所属させてください。
- 一つのグループにしか所属していない場合でも配列として定義してください。
- 定義例
- hs5m_sGroups(0 to (hs5m_iGroupsCnt -1)) as string
- 形式
- hs5m_sGroups
- データ型
- String( )
(2) グループ一覧取得メソッド(hs5um_OutSideGetGroupList)
(a) 機能
グループの一覧を取得します。管理しているユーザが所属しているすべてのグループの一覧を取得してください。取得したグループの一覧は,分析情報ファイルを公開する対象グループを選択するときに使用されます。
グループ一覧取得メソッドは,レジストリに登録したユーザ認証モードが「OutSideMode=IDOUT(HITSENSER5 WebユーザID取得,外部ユーザ認証の場合)」ときに使用します。グループ一覧取得メソッドを使用する場合,ユーザ認証メソッドが正常に終了している必要があります。
- 注意
- グループを作成しない場合は,グループ一覧取得メソッドを実装しないでください。
(b) 形式
hs5um_OutSideGetGroupList(iMode)〔Long〕
(c) 引数
- iMode〔Long〕
- ユーザ認証モードの動作モードとして「0(通常モード)」を指定します。
(d) 戻り値
戻り値 | 説明 |
---|
-1 | エラー(詳細エラー情報を参照のこと)。 |
0 | ダミーメソッドとして使用されています。 |
0以上 | グループ数を返します。 |
(e) 固有のプロパティ
- hs5um_OutSideGetGroupListEnableプロパティ
- 機能
- グループ一覧取得メソッドのサポートフラグを参照します。
- 0:グループ一覧取得メソッドをサポートしません。
- 1:グループ一覧取得メソッドをサポートします。
- 形式
- hs5um_OutSideGetGroupListEnable
- データ型
- Long
- hs5um_OutSideGroupListEnableプロパティ
- 機能
- グループ情報のサポートレベルを参照します。
サポートレベル | 説明 |
---|
0 | グループIDだけ。グループ名にはグループIDを使用します。階層グループは使用できません。 |
&H20 | グループID,親グループID。グループ名にはグループIDを使用します。 |
&H40 | グループID,グループ名。 階層グループは使用できません。 |
&H40 + &H20 | グループID,親グループID,グループ名。 すべてのグループ情報をサポートします。 |
- 形式
- hs5um_OutSideGroupListEnable
- データ型
- Long
- hs5um_OutSideGroupListプロパティ
- 機能
- 指定したインデックスを持つグループ情報を参照して,グループ情報リストを設定します。インデックスは0~(hs5um_OutSideGroupListCnt-1)の範囲とします。
- ユーザ定義型メンバ情報は,次のとおりです。
メンバ情報 | 説明 |
---|
sGroupId | グループを識別するユニークなID(グループID)を設定します。グループIDに指定できる文字列の長さは1~20バイトまでです。全角文字及び半角文字を使用できます。ただし,タブ記号,改行文字などの制御記号,及び次に示す半角文字は使用できません。 [ ] + = , / * ? " < > | ¥ : また,ピリオド(.)と空白だけで構成される文字列は指定できません。グループIDを英大文字で指定した場合は,グループIDは小文字に変換されるため,ます。大文字と小文字が区別されません。HITSENSER5 Webでは,グループIDでグループを区別します。 |
sGroupName | グループIDに対応する任意の名称(グループ名)を設定します。 グループ名に設定できる文字列の長さは1~255バイトまでです。全角文字及び半角文字を使用できます。ただし,タブ記号,改行文字などの制御記号,及び半角のコンマ(,)は使用できません。 |
sPGroupID | 自グループの親となるグループのグループID(親グループID)を設定します。親グループIDに指定できる文字列の長さは1~20バイトまでです。親グループがない場合は,0バイト長の文字列として「" "」を設定してください。 |
- グループの階層は最大で4階層です。4階層を超える階層構造にした場合は,動作を保証しません。例えば,「支店A-総務部-総務1課-第3ユニット-土木対応」のような5階層の階層構造は設定できません。
- また,自分の子グループを親にするような循環グループは構成できません。この場合も動作を保証しません。例えば,「システム1-第2グループ-ユニットA-システム1」のような循環グループは設定できません。
- 一つの親グループには,複数の子グループを設定できます。
- 形式
- hs5um_OutSideGroupList
- データ型
- ユーザ定義型
- hs5um_OutSideGroupListCntプロパティ
- 機能
- グループの数(グループ一覧取得メソッドの戻り値と同じ値)を設定します。
- 形式
- hs5um_OutSideGroupListCnt
- データ型
- Long