Narzędzie do zarządzania z wiersza poleceń
Parent page: Konserwacja
Enterprise Server udostępnia narzędzie wiersza poleceń, które obejmuje następujące aspekty konfiguracji Enterprise Server:
- User Management – umożliwia wstępne załadowanie do Workspace Enterprise Server zbiorczych konfiguracji użytkowników i ról, pochodzących z systemów lub rejestrów firmowych, dzięki czemu nie ma potrzeby tworzenia wpisów pojedynczo przez przeglądarkowy interfejs Workspace. Narzędzie obsługuje import Użytkowników, Ról oraz danych przynależności użytkownik–rola ze standardowych plików *.csv rozdzielanych przecinkami.
- Part Choice Indexing – umożliwia ręczne wykonanie ponownego indeksowania Part Choices dla komponentów biblioteki Workspace, pozyskiwanych przez zdefiniowane przez użytkownika Part Sources (połączenia z lokalnymi bazami danych części).
Narzędzie – avconfiguration.exe – jest dołączone do instalacji Enterprise Server i można je znaleźć w folderze \Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool.
Dostęp do narzędzia konfiguracji
Aby użyć narzędzia:
- Uruchom Wiersz polecenia systemu Windows.
- Przejdź do właściwego folderu. Dla domyślnej instalacji na dysku C komputera hosta będzie to:
cd C:\Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool\. - Aby uruchomić narzędzie i wyświetlić dostępne opcje, w wierszu polecenia wpisz:
avconfiguration ?
Dostęp do narzędzia konfiguracji przez Wiersz polecenia.
Zwróć uwagę na ? — jego dodanie wyświetla pomoc dotyczącą funkcji dostępnych w narzędziu konfiguracji:
usermanagement– import Użytkowników i Ról.suppliers– indeksowanie Part Choice.help– wyświetlenie ekranu pomocy (? może być użyte zamiast ciągu help).
Składnia i przełączniki Usermanagement
Następujące przełączniki są dostępne podczas używania funkcji usermanagement narzędzia:
avconfiguration usermanagement [-help | params [options]]
gdzie dostępne parametry to:
- --url – wymagane. Adres i port docelowego Enterprise Server.
- --user – wymagane. Część User Name danych uwierzytelniających dostępu użytkownika Workspace Enterprise Server.
- --password – wymagane. Część Password danych uwierzytelniających dostępu użytkownika Workspace Enterprise Server (z rozróżnianiem wielkości liter).
- --roles – nazwa pliku zawierającego role do zaimportowania.
- --users – nazwa pliku zawierającego użytkowników do zaimportowania.
- --memberships – nazwa pliku zawierającego przynależności użytkowników do zaimportowania.
Dostępne opcje to:
- -d – usuń użytkowników i role niewymienione w dostarczonych plikach. Wszyscy istniejący użytkownicy i role w Workspace Enterprise Server, którzy nie są wymienieni w dostarczonych plikach, zostaną usunięci (z wyjątkiem użytkowników System i admin oraz roli Administrators).
- -o – nadpisz istniejące dane. Jeśli użytkownik istnieje w Workspace Enterprise Server i jednocześnie znajduje się w importowanym pliku, wówczas informacje w Workspace zostaną nadpisane danymi z importowanego pliku.
Wpisując tylko avconfiguration usermanagement, przełączniki te zostaną wyświetlone jako pomocna ściągawka.
Przełączniki dostępne podczas używania narzędzia w trybie usermanagement.
Przykład Usermanagement
Poniższy wpis zaimportuje użytkowników, role oraz przynależności użytkownik–rola, zgodnie z definicjami w przykładowych plikach dołączonych do katalogu instalacyjnego (users.csv, roles.csv i memberships.csv). Istniejące dane użytkowników zostaną nadpisane tam, gdzie pasujący użytkownik jest zdefiniowany w pliku users.csv. Dodatkowo wszyscy pozostali istniejący użytkownicy i role Enterprise Server, którzy nie są zdefiniowani w plikach users.csv i roles.csv, zostaną usunięci.
avconfiguration usermanagement --url=http://localhost:9780 --user=admin --password=admin --roles=roles.csv --users=users.csv --memberships=memberships.csv -d -o
Narzędzie sprawdzi poprawność danych w plikach przed zaimportowaniem zawartości do Enterprise Server, a także będzie wyświetlać komunikaty o powodzeniu/niepowodzeniu importu dla każdego przetwarzanego pliku podczas działania narzędzia.
Wynik uruchomienia przykładowej komendy configuration-usermanagement.
Przykładowe pliki CSV
Przykład każdego rozpoznawanego pliku *.csv jest dołączony w katalogu narzędzia (\Program Files (x86)\Altium\Altium NEXUS Server\Tools\VaultConfigurationTool). Opisy zawartości każdego typu pliku oraz wymagania przedstawiono poniżej.
Zawiera dane profili użytkowników.
| Nazwa pola | Opis | Wymagania |
|---|---|---|
| FIRSTNAME | Imię | Wymagane (musi mieć co najmniej jeden znak) |
| LASTNAME | Nazwisko | Wymagane (musi mieć co najmniej jeden znak) |
| USERNAME | Nazwa użytkownika | Wymagane |
| PASSWORD | Hasło użytkownika | Wymagane dla trybu uwierzytelniania „Built In” |
| PHONE | Numer telefonu | |
| AUTHTYPE | AUTHTYPE | Wymagane: typ uwierzytelniania; 0 dla uwierzytelniania „Built In”, 1 dla uwierzytelniania „Windows” (domenowego) |
| Adres e-mail | ||
| DOMAIN | Nazwa domeny | Wymagane dla trybu uwierzytelniania „Windows”. |
- Każdy użytkownik musi być zdefiniowany w nowej linii pliku.
- Żadne wpisy nie zostaną zaimportowane do Workspace Enterprise Server, jeśli w pliku
users.csvbrakuje danych dla któregokolwiek z pól wymaganych. - Wpisy użytkowników nie zostaną zaimportowane, jeśli w danych występuje błąd, np. podano domenę, gdy AUTHTYPE jest błędnie ustawione na 0 („Built In”).
- Wszystkie pola muszą być obecne w pliku CSV i oddzielone przecinkiem. Dane dla pól niewymaganych powinny być puste (np. field1,,field2,...).
Zawiera dane ról.
| Nazwa pola | Opis |
|---|---|
| ROLENAME | Nazwa roli (musi mieć co najmniej jeden znak) |
- Każda rola musi być zdefiniowana w nowej linii pliku.
Zawiera dane przynależności użytkowników do ról (tj. którzy użytkownicy są członkami których ról)
| Nazwa pola | Opis |
|---|---|
| ROLENAME | Nazwa roli |
| USERNAME | Nazwa użytkownika |
- Każda definicja przynależności użytkownik–rola musi być zdefiniowana w nowej linii pliku.
- Pola muszą być oddzielone przecinkiem.
- Nieprawidłowe dopasowania USERNAME–ROLENAME zakończą się niepowodzeniem, ale nie uniemożliwią importu prawidłowych dopasowań.
Składnia i przełączniki Suppliers
Następujące przełączniki są dostępne podczas używania funkcji suppliers narzędzia:
avconfiguration suppliers [-help | params]
gdzie dostępne parametry to:
- --url – wymagane. Adres i port docelowego Enterprise Server.
- --user – wymagane. Część User Name danych uwierzytelniających dostępu użytkownika Workspace Enterprise Server.
- --passwordMD5 – wymagane. Część Password danych uwierzytelniających dostępu użytkownika Workspace Enterprise Server, jako wartość skrótu MD5.
- --reindexPartChoice – wymagane. Nazwa(-y) dostawcy(-ów) do rozpoczęcia indeksowania wyborów części. Jest to nazwa zdefiniowanego przez użytkownika niestandardowego źródła części z bazy danych (Part Source), skonfigurowanego do łączenia z lokalną firmową bazą danych części. Wiele dostawców (Part Sources) oddziel przecinkiem. Zwróć uwagę, że ponieważ przecinek jest używany jako separator, nie może on występować w nazwie Part Source.
Wpisując tylko avconfiguration suppliers, przełączniki te zostaną wyświetlone jako pomocna ściągawka.
Przełączniki dostępne podczas używania narzędzia w trybie suppliers.
Przykładowy wpis może wyglądać następująco:
avconfiguration suppliers --url=http://localhost:9780 --user=admin --passwordMD5=21232f297a57a5a743894a0e4a801fc3 --reindexPartChoice=MySQLODBC,MsSQL