HABエクスポートツール¶
HABエクスポートツールは、階層型アドレス帳(HAB)のデータをエクスポートする際に利用するツールです。
エクスポートしたデータをAddressLookにインポートする手順については「出力したCSVファイルのインポート手順について」をご確認ください。
準備¶
システム条件¶
HABエクスポートツールは以下の環境で動作します。
- Windows 10 / Windows 11
- Windows Server 2019 / Windows Server 2022
ダウンロード¶
HABエクスポートツールは、AddressLook Webサイトからダウンロードすることができます。
https://www.addresslook.net/
「管理者用ツール」ページ内の「HABエクスポートツール(zip)」をダウンロードし、ご利用ください。
初期設定¶
HABエクスポートツール初回利用時のみ実施する作業です。
2回目以降は「HABエクスポートツールの利用方法」をご参照ください。
Microsoft Entraアプリケーションの登録¶
Microsoft Entra管理センターにてMicrosoft Entraアプリケーションの登録を実施します。
・アプリの新規登録
- Microsoft Entra 管理センターに管理者アカウントでサインインし、Microsoft Entra 管理センターを開きます。
https://entra.microsoft.com/ - 「アプリケーション」メニューから、「アプリの登録」をクリックします。
- 「新規登録」をクリックします。
- 「アプリケーションの登録」画面で以下の設定を行い、「登録」ボタンをクリックします。
- 名前:アプリケーションの名称を入力します。(例:AddressLook_HABExport)
- サポートされているアカウントの種類:「この組織ディレクトリのみに含まれるアカウント」を選択します。
・証明書の配置
- Microsoft Entra 管理センターに管理者アカウントでサインインします。
https://entra.microsoft.com/ - 「アプリケーション」メニューから、「アプリの登録」をクリックします。
- 「すべてのアプリケーション」をクリックし、「アプリの新規登録」作業で作成したアプリケーションをクリックします。
- サイドメニューの「証明書とシークレット」をクリックします。
- 「証明書」タブを開き、「証明書のアップロード」をクリックします。
- 「証明書のアップロード」画面で、ダウンロードしたHABエクスポートツールのフォルダに含まれる「AddressLookConsoleCert.cer」ファイルを選択し、アップロードします。
※アップロードする証明書ファイルは、cerファイルを使用します。 - 「追加」ボタンをクリックします。
- ダウンロードしたHABエクスポートツールのフォルダに含まれる「AddressLookConsoleCert.pfx」ファイルを、アプリを使用する環境の任意の場所に配置します。
例:C:\work\AddressLook\AddressLookConsoleCert.pfx
※アプリを使用する環境に配置する証明書ファイルは、pfxファイルを使用します。
・マニフェストの編集
- Microsoft Entra 管理センターに管理者アカウントでサインインします。
https://entra.microsoft.com/ - 「アプリケーション」メニューから、「アプリの登録」をクリックします。
- 「すべてのアプリケーション」をクリックし、「アプリの新規登録」作業で作成したアプリケーションをクリックします。
- サイドメニューの「マニフェスト」をクリックします。
- 「マニフェスト」画面から「requiredResourceAccess」セクションまで下にスクロールし、以下の設定に置き換えます。
{
"resourceAppId": "00000002-0000-0ff1-ce00-000000000000",
"resourceAccess": [
{
"id": "dc50a0fb-09a3-484d-be87-e023b12c6440",
"type": "Role"
}
]
}
6. 「マニフェスト」画面で「保存」をクリックします。
・APIアクセス許可の設定
- Microsoft Entra 管理センターに管理者アカウントでサインインします。
https://entra.microsoft.com/ - 「アプリケーション」メニューから、「アプリの登録」をクリックします。
- 「すべてのアプリケーション」をクリックし、「アプリの新規登録」作業で作成したアプリケーションをクリックします。
- サイドメニューの「APIのアクセス許可」をクリックします。
- 「アクセス許可の追加」をクリックします。
-
「APIアクセス許可の要求」画面で「Microsoft Graph」をクリックし、「委任されたアクセス許可」を選択します。
-
以下のアクセス許可を選択します。
アクセス許可 用途 User:User.Read 認証時に使用します。 -
「アクセス許可の追加」ボタンをクリックします。
- 「APIアクセス許可の要求」画面で「Microsoft Graph」をクリックし、「アプリケーションの許可」を選択します。
-
以下のアクセス許可を選択します。
アクセス許可 用途 Domain:Domain.Read.All 認証時に使用します。 Group:Group.Read.All グループ情報取得時に使用します。 GroupMember:GroupMember.Read.All グループメンバー取得時に使用します。 Organization:Organization.Read.All 組織および関連するリソースの取得時に使用します。 User:User.Read.All 認証時に使用します。 User:User.ReadBasic.All 認証時に使用します。 -
「アクセス許可の追加」ボタンをクリックします。
- 左メニューの「表示数を増やす」をクリックします。
- 「役割と管理者」メニューの「役割と管理者」をクリックします。
- ロールで「Exchangeの管理者」をクリックします。
- 「Exchangeの管理者」画面で「割り当ての追加」をクリックします。
- 「検索」で「アプリの新規登録」作業で作成したアプリケーションの名前を入力し、表示されたアプリを選択した後に「追加」ボタンをクリックします。
- アクセス許可の追加後、「APIのアクセス許可」画面で「管理者の同意を与えます」をクリックします。
- 確認メッセージが表示されるので、「はい」をクリックします。
アプリの設定¶
ダウンロードしたHABエクスポートツールのフォルダに含まれる「HABGroupExportTool.exe.config」ファイルをテキストエディタで開き、以下の項目の値を設定します。
※No.5については値の変更は不要です。
No. | 項目 | 概要 | 設定例 |
---|---|---|---|
1 | FileName | 出力されるCSVファイル名を入力します。 ※ファイル名には拡張子を含めないでください。 |
Address |
2 | ida:Tenant | Microsoft Entra テナントIDを入力します。 値の確認方法につきましては、Microsoft社の公式情報をご参照ください。 テナント ID とプライマリ ドメイン名を確認する |
11111111-1111-1111-1111-111111111111 |
3 | ida:TenantName | Microsoft Entra プライマリドメイン名を入力します。 値の確認方法につきましては、Microsoft社の公式情報をご参照ください。 テナント ID とプライマリ ドメイン名を確認する |
○○.onmicrosoft.com |
4 | ida:ClientId | 登録したアプリのアプリケーション(クライアント)IDを入力します。 値の確認方法につきましては、Microsoft社の公式情報をご参照ください。 アプリケーション ID (クライアント ID) |
11111111-1111-1111-1111-111111111111 |
5 | ida:AADInstance | Azure クラウド インスタンス を入力します。 | https://login.microsoftonline.com/{0} ※上記の値は固定値のため、値の変更は不要です。 |
6 | ida:CertPath | 「証明書の配置」で配置した証明書の、拡張子までを含めた絶対パスを入力してください。 | C:\work\AddressLook\AddressLookConsoleCert.pfx |
7 | GroupId | CSVファイルに出力する最上位グループ(部署)のオブジェクトIDを入力してください。 値の確認方法につきましては、「最上位グループ(部署)のオブジェクトID」をご参照ください。 |
11111111-1111-1111-1111-111111111111 |
8~22 | UserItem01~UserItem15 | CSVファイルのUserItem01~15項目に出力するユーザーのEntra IDプロパティ名を入力します。 | CreatedDateTime |
最上位グループ(部署)のオブジェクトID
HABエクスポートツールの初期設定で入力する、最上位グループ(部署)のオブジェクトIDの確認方法について説明します。
- Microsoft Entra 管理センターに管理者アカウントでサインインします。
https://entra.microsoft.com/ - 「グループ」メニューから、「すべてのグループ」をクリックします。
- 「検索」で情報を出力したい最上位グループ(部署)の名前を入力し、クリックします。
- 「基本情報」の中にある「オブジェクトID」が「アプリの設定」のNo.7で入力する値となります。
Exchange Online PowerShell モジュールのインストール¶
- Exchange Online PowerShell モジュールをインストールします。
インストール方法につきましては、Microsoft社の公式情報をご参照ください。
Exchange Online PowerShell モジュールをインストールする
※モジュールがすでにインストールされている場合、この手順は不要です。
確認方法につきましては、「Exchange Online PowerShell モジュールの確認方法」をご参照ください。 - Exchange Online PowerShell モジュールのインストール後、「Exchange Online PowerShell モジュールを読み込む」手順を実施してください。
・Exchange Online PowerShell モジュールを読み込む
- PowerShellを管理者権限で起動します。
- 以下のコマンドを入力し、実行します。
1
Import-Module ExchangeOnlineManagement
・Exchange Online PowerShell モジュールの確認方法
- PowerShellを管理者権限で起動します。
- 以下のコマンドを入力し、実行します。
1
Get-Module
- 「Name」に「ExchangeOnlineManagement」が存在することを確認します。
HABエクスポートツールの利用方法¶
HABエクスポートツールの利用方法について説明します。
HABエクスポートツールの実行¶
- 「HABGroupExportTool.exe」を右クリックし、「管理者として実行」をクリックします。
- アプリが実行され、アプリと同一階層にCSVファイルが作成されます。
出力されるCSVファイルについて¶
出力されるCSVファイルについて説明します。
出力先¶
HABエクスポートツールアプリの存在する階層と同一階層にCSVファイルが出力されます。
出力対象¶
部署情報¶
- AddressLookに表示する部署情報を指します。
- 「アプリの設定」のNo.7「GroupId」に設定されたグループを、最上位の部署として出力します。
- グループのメンバーとして登録されているグループを、配下の部署として出力します。
- グループの情報はMicrosoft Entra IDから取得し、出力します。
アドレス情報¶
- AddressLookに表示するユーザー、リソース(会議室・備品)、連絡先情報を指します。
- 「アプリの設定」のNo.7「GroupId」に設定されたグループのメンバー(グループ以外)を、アドレス情報として出力します。
- メンバーが所属するグループを、メンバーの所属部署として出力します。
- Microsoft Entra IDにて、ユーザーが無効なアカウント(AccountEnable属性)の場合は、出力対象外とします。
- 表示名、メールアドレスが未設定のアカウントは出力対象外とします。
出力形式¶
- CSVファイルは「アプリの設定」で入力したファイル名にて出力されます。
- 出力されるCSVファイルの拡張子は「.csv」となります。
- 出力されるCSVファイルは上書き保存となります。
-
CSVファイルには以下の項目が出力されます。
No. 項目名 出力種別 内容 1 Operator グループ/ユーザー add 2 ClassObject グループ/ユーザー グループの場合:Hierarchy
ユーザーの場合:Address3 DisplayName グループ/ユーザー 表示名(最大255文字)
設定必須項目です。4 DisplayNameKana 表示名(フリガナ)(最大255文字) 5 Priority グループ/ユーザー 表示順(0~999999)
※値の大きいものほど上位に表示します。6 ParentHierarchyPath グループ/ユーザー 所属する親グループ階層 7 Address ユーザー メールアドレス(最大300文字)
設定必須項目です。8 Sn ユーザー 姓(最大255文字) 9 GivenName ユーザー 名(最大255文字) 10 SnKana 姓(フリガナ)(最大255文字) 11 GivenNameKana 名(フリガナ)(最大255文字) 12 MainNickname ユーザー エイリアス(最大300文字) 13 Title ユーザー 役職(最大255文字) 14 Department ユーザー 部署(最大255文字) 15 Company ユーザー 会社名(最大255文字) 16 PhysicalDeliveryOfficeName ユーザー 事業所(最大255文字) 17 L ユーザー Microsoft Entra IDの市区町村+番地(最大255文字) 18 TelephoneNumber ユーザー 電話番号(最大255文字) 19 AddressType ユーザー アドレス種別 - 2:ユーザー
- 3:連絡先
- 4:リソース(会議室・備品)
20 Description グループ グループの説明(最大255文字) 21 UpdateDisplayName 更新後の表示名 22 UpdateAddress 更新後のメールアドレス 23 UpdateParentHierarchyPath 更新後の親グループ階層 24~38 UserItem01~UserItem15 ユーザー 「アプリの設定」で設定したNo.8~No.22の項目名のプロパティを取得します。 ※出力するデータの文字数が最大文字数を超過する場合は、超過した分を切り捨てて出力されます。
ログについて¶
HABエクスポートツール利用時に出力されるログファイルについて説明します。
出力先¶
HABエクスポートツールアプリの存在する階層と同一階層にログファイルが出力されます。
出力形式¶
- ログファイルは「HABGroupExportTool_log」というファイル名で出力されます。
- 出力されるログファイルの拡張子は「.log」となります。
- 出力されるログファイルは上書き保存となります。
出力したCSVファイルのインポート手順について¶
HABエクスポートツールを使用して出力したCSVファイルをインポートする手順については、以下をご参照ください。
- GUIで実施する手順
「組織階層情報メンテナンスツール」の「CSVに関する機能」をご参照ください。 - コマンドで実施する手順
「組織階層情報メンテナンスツール(コマンド)」の「CSVに関する機能」をご参照ください。