CSV自動連携ツールの設定
このガイドでは、CSV自動連携ツールの設定について説明しています。
CloudGate UNO管理者サイト上での操作に関しては、オンラインヘルプを合わせてご参照ください。
目次
2.利用環境
2-1.利用環境
3.APIクライアントの設定
3-1.APIクライアントの設定
3-2.スコープ設定
4.CSV自動連携ツールの設定
4-1.CSV自動連携ツールのダウンロード
4-2.ツールの設定
5.CSV自動連携ツールの使い方
5-1.コマンド
5-2.実行結果
1.はじめに
1-1.このガイドの対象
CloudGate UNO基本プランの「Enterprise Plan」「Enterprise Plus Plan」「Smart Pack Plan」でご利用いただいていることが前提となります。
他プランをご利用の方はこちらでご案内しているCSV自動連携ツールはご利用いただけません。
1-2.注意点
2021年9月時点でご利用できる操作は以下です。
【一括登録】
- ユーザ
- 組織
- CloudGateグループ
【ダウンロード】
- ユーザ
- 組織
- CloudGateグループ
2.利用環境
2-1.利用環境
下記環境にて動作検証を実施しております。
| 環境 |
OpenJDK 11 |
| OS |
Windows、Linux |
| スケジューラ | Task Scheduler (Windows) , Cron (Linux) |
3.APIクライアントの設定
3-1.APIクライアントの設定
（左メニュー）APIアクセス をクリックするとAPIクライアントの設定画面が表示されます。
「新しいAPIクライアントの追加」をクリックして、任意のクライアント名を入力します。
APIクライアントが作成されます。
3-2.スコープ設定
3-1.で作成したAPIクライアント情報を開き、スコープを追加します。
操作によって登録するスコープが異なりますので、以下よりご確認ください。
一括登録
(1)ユーザー
登録するスコープ名：ユーザー、組織、レルム、サービスプロバイダー、アプリケーションモジュール 、カスタムフィールド
(2)組織
登録するスコープ名：組織、レルム
(3)グループ
登録するスコープ名：グループ、サービスプロバイダー
ダウンロード
(1)ユーザー
登録するスコープ名：ユーザー、レルム、サービスプロバイダー、アプリケーションモジュール、カスタムフィールド
(2)組織
登録するスコープ名：組織、レルム
以下のように設定すると、ユーザー、組織のダウンロードと、ユーザー、組織、グループ 一括登録の操作ができます。
4.CSV自動連携ツールの設定
4-1.CSV自動連携ツールのダウンロード
公開されているツールのダウンロードはいつでも可能ですが、動作するのは利用開始日以降となります。
| バージョン | 利用開始日 | 動作確認済みJDK |
|---|---|---|
| CSV自動連携ツール（ver.4.12.0） | 2023.10.7 | JDK 11 |
| CSV自動連携ツール（ver.4.11.0） | 2022.2.20 | JDK 11 |
- 最新バージョンをサポート対象とさせていただきます。
- 万が一、エラーが発生するなど正常な動作をご確認いただけない場合、ツールのダウンロードサイトより改めてツールをダウンロードし直してから再度お試しください。
ダウンロードしたzipファイルには、以下のファイルが保存されています。
batch-registration-app.jar ・・・実行ファイル
default.properties・・・デフォルトプロパティ
lib・・・ライブラリフォルダ
options.conf・・・設定ファイル
run.bat・・・WindowsOSで利用可能なバッチファイル
run.sh・・・LinuxOSで利用可能なシェルスクリプト
log・・・ログフォルダ（ダウンロード時には表示されません）
※ログは日付で出力されます。(yyyy-mm-dd.log)
4-2.ツールの設定
ダウンロードしたファイルの「default.properties」を開き、APIのクライアント情報を登録します。
| api_server_url = (1) api_server_token_url = (2) api_client_id = (3) api_client_secret = (4) organization_name = (5) |
(1) https://echizen.cloudgate.jp/api
(2) アクセストークンリクエストURL ※
(3) クライアントID ※
(4) クライアントシークレット ※
(5) お客様ID
※CloudGate管理者サイトで設定されているAPIクライアント情報を入力します。
プロキシサーバーをご利用のお客様は「proxy_host」と「proxy_port」の情報を追加します。
| proxy_host = (6) proxy_port = (7) |
(6) プロキシサーバーのホスト（ホスト名 または IPアドレスを指定します）
(7) プロキシサーバーのポート
5.CSV自動連携ツールの使い方
5-1.コマンド
download ：ユーザ、部署の一覧をCSV形式でダウンロードします
upload ：ユーザ、部署、グループをCSV形式で一括登録・更新・削除します
validate ：CSVファイルのフォーマットに間違いがないかを確認します
ヘルプを表示します。
| java -jar batch-registration-app.jar --help |
CSVファイルのフォーマットを確認します。（ユーザー一括登録のcsvファイル）
| java -jar batch-registration-app.jar --command validate --type USER --in ☓☓☓.csv --out ☓☓☓.txt |
ユーザー一覧をCSV形式でダウンロードします。
| java -jar batch-registration-app.jar --command download --type USER --out ☓☓☓.csv |
ユーザーの一括登録・更新・削除の処理を行います。
| java -jar batch-registration-app.jar --command upload --type USER --in ☓☓☓.csv --out ☓☓☓.txt |
組織の一括登録・更新・削除の処理を行います。
| java -jar batch-registration-app.jar --command upload --type UNIT --in ☓☓☓.csv --out ☓☓☓.txt |
5-2.処理実行結果のステータス一覧
BATCH_JOB_ALL_SUCCESS(0)
→ 全ての処理が完了しており、全ての処理結果が成功している
BATCH_JOB_EXIT_FAILURE(1)
→ システムの内部的な問題が発生している
BATCH_JOB_PARTIALLY_FAILURE(2)
→ 全てのバッチ処理が完了したが、一部の処理結果に失敗が含まれている
BATCH_JOB_CSV_FORMAT_VALIDATION_SUCCESS(3)
→ CSVフォーマットの検証に成功している
BATCH_JOB_CSV_FORMAT_VALIDATION_FAILURE(4)
→ CSVフォーマットの検証に失敗したので処理を中断している
