Parent page: メンテナンス
Enterprise Server には、Enterprise Server の設定に関して次の項目に対応するコマンドラインツールが用意されています。
- User Management – 企業内システムや記録から得たユーザー/ロール設定を一括で事前投入し、Workspace のブラウザベースのインターフェースで個別にエントリを作成する必要をなくします。このツールは、標準のカンマ区切り *.csv ファイルから Users、Roles、およびユーザー‐ロールの所属データをインポートできます。
- Part Choice Indexing – ユーザー定義の Part Sources(ローカル部品データベースへの接続)を通じて取得した、Workspace ライブラリコンポーネントの Part Choices を手動で再インデックスできるようにします。
Part choice の再インデックスは自動実行するよう設定することもできます。カスタムデータベースの part source を定義する際に、
Indexing part choices every フィールドで設定してください。Part sources は、Workspace 管理者が Workspace のブラウザインターフェースの
Part Providers ページ(
Admin – Part Providers)で定義します。詳細は
Configuring a Custom Database Part Source を参照してください。
このツール(avconfiguration.exe)は Enterprise Server のインストールに含まれており、\Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool フォルダにあります。
設定ツールへのアクセス
ツールを使用するには次の手順に従います。
- Windows のコマンドプロンプトを起動します。
- 正しいフォルダへ移動します。ホストコンピュータの C ドライブに既定でインストールした場合は次の場所になります:
cd C:\Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool\。
- ツールを実行して利用可能なオプションを一覧表示するには、プロンプトで次を入力します:
avconfiguration ?
。サーバー PC の OS によっては、コピーしたテキストを右クリックまたは Ctrl+V、あるいはその両方でコマンドプロンプトに貼り付けできます。
コマンドプロンプトから設定ツールにアクセスしているところ。
? に注意してください。これを含めると、設定ツールで利用可能な機能のヘルプが表示されます。
usermanagement – Users と Roles のインポート。
suppliers – Part Choice のインデックス作成。
help – ヘルプ画面の表示(文字列 help の代わりに ? を使用できます)。
Usermanagement の構文とスイッチ
ツールの usermanagement 機能を使用する際に利用できるスイッチは次のとおりです。
avconfiguration usermanagement [-help | params [options]]
利用可能な params は次のとおりです。
- --url – 必須。対象 Enterprise Server のアドレスとポート。
- --user – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の User Name 部分。
- --password – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の Password 部分(大文字小文字を区別)。
- --roles – インポートするロールを含むファイルのファイル名。
- --users – インポートするユーザーを含むファイルのファイル名。
- --memberships – インポートするユーザー所属情報を含むファイルのファイル名。
CSV 入力データファイルの既定の検索パスは、現在のディレクトリ(avconfiguration.exe ファイルが存在する場所)です。データファイルが現在のディレクトリにない場合は、データファイルへのパスを含める必要があります。
利用可能なオプションは次のとおりです。
- -d – 指定したファイルに記載されていないユーザーとロールを削除します。Enterprise Server Workspace に存在するユーザー/ロールのうち、指定ファイルに記載されていないものはすべて削除されます(System および admin ユーザー、ならびに Administrators ロールを除く)。
- -o – 既存データを上書きします。Enterprise Server Workspace にユーザーが存在し、かつインポート対象ファイルにも含まれている場合、Workspace 側の情報はインポートファイルの内容で上書きされます。
avconfiguration usermanagement だけを入力すると、これらのスイッチが補助情報として一覧表示されます。
usermanagement モードでツールを使用する際に利用できるスイッチ。
Usermanagement Example
次のエントリは、インストールディレクトリに含まれるサンプルファイル(users.csv、roles.csv、memberships.csv)で定義されたユーザー、ロール、およびユーザー‐ロール所属情報をインポートします。users.csv ファイルで一致するユーザーが定義されている場合、既存のユーザーデータは上書きされます。さらに、users.csv および roles.csv ファイルに定義されていない既存の Enterprise Server ユーザーとロールはすべて削除されます。
avconfiguration usermanagement --url=http://localhost:9780 --user=admin --password=admin --roles=roles.csv --users=users.csv --memberships=memberships.csv -d -o
ウムラウトやグレイヴなどの言語固有文字はサポートされない点に注意してください。
ツールは、Enterprise Server に内容をインポートする前にファイルデータの妥当性を解析し、実行中に処理した各ファイルについてインポート成功/失敗メッセージも表示します。
サンプルの configuration-usermanagement コマンドを実行した結果。
サンプル CSV ファイル
認識される各 *.csv ファイルのサンプルがツールのディレクトリ(\Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool)に含まれています。各ファイル種別の内容説明と要件を以下に示します。
users.csv
ユーザープロファイルデータを含みます。
| フィールド名 |
説明 |
要件 |
| FIRSTNAME |
名 |
必須(少なくとも 1 文字) |
| LASTNAME |
姓 |
必須(少なくとも 1 文字) |
| USERNAME |
ユーザー名 |
必須 |
| PASSWORD |
ユーザーパスワード |
「Built In」認証モードでは必須 |
| PHONE |
電話番号 |
|
| AUTHTYPE |
AUTHTYPE |
必須: 認証タイプ。0 は「Built In」認証、1 は「Windows」(ドメイン)認証 |
| EMAIL |
メールアドレス |
|
| DOMAIN |
ドメイン名 |
「Windows」認証モードでは必須。 |
- 各ユーザーはファイルの新しい行に定義する必要があります。
users.csv ファイルで必須フィールドのデータが欠けている場合、Enterprise Server Workspace には何もインポートされません。
- AUTHTYPE が誤って 0(「Built In」)に設定されているのに DOMAIN が含まれている、などデータに誤りがある場合、ユーザーエントリはインポートされません。
- すべてのフィールドが CSV ファイル内に存在し、カンマで区切られている必要があります。必須でないフィールドのデータは空欄にしてください(例: field1,,field2,...)。
roles.csv
ロールデータを含みます。
| フィールド名 |
説明 |
| ROLENAME |
ロール名(少なくとも 1 文字) |
- 各ロールはファイルの新しい行に定義する必要があります。
memberships.csv
ユーザーのロール所属データ(どのユーザーがどのロールのメンバーか)を含みます。
| フィールド名 |
説明 |
| ROLENAME |
ロール名 |
| USERNAME |
ユーザー名 |
- 各ユーザー‐ロール所属定義はファイルの新しい行に定義する必要があります。
- フィールドはカンマで区切る必要があります。
- 無効な USERNAME–ROLENAME の組み合わせは失敗しますが、有効な組み合わせのインポートは妨げられません。
Suppliers の構文とスイッチ
ツールの suppliers 機能を使用する際に利用できるスイッチは次のとおりです。
avconfiguration suppliers [-help | params]
利用可能な params は次のとおりです。
- --url – 必須。対象 Enterprise Server のアドレスとポート。
- --user – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の User Name 部分。
- --passwordMD5 – 必須。Enterprise Server Workspace ユーザーのアクセス資格情報の Password 部分(MD5 ハッシュ値)。
- --reindexPartChoice – 必須。Part choice のインデックス作成を開始する Supplier 名。これは、ローカルの社内部品データベースに接続するよう設定された、ユーザー定義のカスタムデータベース Part Source の名前です。複数の Suppliers(Part Sources)はカンマで区切って指定します。なお、カンマ文字は区切りとして使用されるため、Part Source 名の中には使用できません。
avconfiguration suppliers だけを入力すると、これらのスイッチが補助情報として一覧表示されます。
suppliers モードでツールを使用する際に利用できるスイッチ。
入力例は次のとおりです。
avconfiguration suppliers --url=http://localhost:9780 --user=admin --passwordMD5=21232f297a57a5a743894a0e4a801fc3 --reindexPartChoice=MySQLODBC,MsSQL