Personendaten-Repositorium

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen: • PDR Admintool
Übersetzungen dieser Seite:
de

Allgemeines

Dokumentation

Zusammenarbeit

Intern

de:doc:admintool

−Inhaltsverzeichnis

PDR Admintool

Download

Download the package at http://pdrprod.bbaw.de/dl/pdr-admin.zip (md5: dedf927ea914f9948ae56454fd71d8a8)

Dokumentation

Connecting to the repository

All modules that require access to a PDR repository require additional command line parameters: 

 -pp,--padrepwd <arg>     Users PaDRe Password
 -pu,--padreuser <arg>    Username PaDRe
 -purl,--padreurl <arg>   PaDRe Url
 -surl,--solrurl <arg>    SOLR Url

Help System

 -?,--help

The command line help system output will change depending in which parameters are entered. Examples:

  • “–help“
  • “-m project –help“
  • “-m user –help“
  • “-m user -a new –help“

Will all lead to different outputs in the command line.

Macros

Save parameters and corresponding arguments in a macro-file.

Saving macros

Use “-newmacro <macroname> <parameters>“ to save all '<parameters>' under the name '<macroname>'. Excample: 

 <JARFILE> -newmacro conn --padreuser <pUser> --padrepwd <pPW> --solrurl <sURL> --padreurl <pURL>

Using a macro

“-macro <macroname> <parameters>“ inserts all parameters saved in the macro to the current command line arguments. If a parameter is used in '<parameters>' and in the macro, the one found in '<parameters>' will be used.

Excample: 

 All the required connection parameters will be taken from the saved macro. 
 <JARFILE> -macro conn -m project -a list

Functionalities (Version 1.0)

Modules (-m) Action (-a) Avilable in the GUI Beschreibung
info no Displays: Instance ID, Servertime (PaDRe, Repository), project- and objectcount
gui - Opens the graphical interface
project list yes Lists all projects in the format “<projectId>,<objectCount>,'<projectName>'“
info yes Displays projectId, Name and all occupied ID ranges.
new yes Create a new project. Will create the standard userobjects.
edit yes Changes the project name.
delete yes Delete an entire project including ALL of its objects. (WARNIGN! Cannot be undone!)
clear yes Deletes all object except all user objects. Aspect, referenc and Personobject will be deleted.
user list yes Lists a projects users. Format: <pd UserID>,<username>,<password>,[role[],…]
new yes Create a new user in an existing project.
edit yes Edit an existing users name, password and roles.
patch yes Fixes errors in object in a file by applying a certain strategy.
export all yes Export an entire project to a given path. Creates 4 files called <instanceId>.<projectId>.<Ao,Po,Uo,Ro>.xml..
range yes Export an range of objects of a certain type a local file (One object per line).
upload yes Insert object from a file to the repository (One object per line). Objects are patched and validated before upload. Temporary IDs are not supported (Subject to change)
validate yes Validates all objects in a given file (One object per line). Requires an active internet connection.
move all yes Move all object belonging to a certain user to another user.
range yes Same as 'all', except that only a range of objects are moved.
persons yes Moves specific persons and all aspects belonging to those persons other user(s).
checkids yes Displays all IDs from those objects that are never referenced or those that are referenced but dont actualy exist. Also displays duplicate IDs.
get yes Displays ranges of objects or single objects in theyr original xml form.
refIds yes Displays all objects that reference given objects IDs in any form.
files explode yes Read all valid objects from one or multiple files and outputs each object in one single file.
implode yes Read all valid objects from one or multiple files and outputs all objects in a single file.
toAEBackup yes Read all valid objects from one or multiple files and outputs with each object in one file sorted into pdrAo, pdrPo, pdrUo and pdrRo folders. This format can be read by the Archive Editos.

Noch nicht implementiert:

Target Version Modules (-m) Action (-a) Avilable in the GUI Beschreibung
.

GUI

Launches the GUI. 

--module gui

Projektverwaltung

Module: project

Liste

 -m,--module project
 -a,--action list

Information

 -m,--module project
 -a,--action info

 -pid,--projectid <arg>   The Project ID.

New

 -m,--module project
 -a,--action new

 -pid,--projectid <arg>          The Project ID.
 -pn,--projectname <arg>         The short form of the projects name.
 -pap,--pdradminpassword <arg>   Passwort for user 1 'pdruser'. (Optional)
 -ap,--adminpassword <arg>       Passwort for user 2 'admin'.
 -up,--userpassword <arg>        Passwort for user 3 'user'.

Edit

 -m,--module project
 -a,--action edit

 -pid,--projectid <arg>    The Project ID.
 -pn,--projectname <arg>   The short form of the projects name.

Delete

 -m,--module project
 -a,--action delete

 -pid,--projectid <arg>   The Project ID.

Clear

 -m,--module project
 -a,--action clear

 -pid,--projectid <arg>   The Project ID.

Benutzerverwaltung

Liste

 -m,--module user
 -a,--action list

 -pid,--projectid <arg>   The project ID.

New

 -m,--module user
 -a,--action new

 -pid,--projectid <arg>   The project ID.
 -nn,--newname <arg>      The Username.
 -p,--password <arg>      User password.
 -r,--roles <arg>         A comma separated list of roles (admin, user, guest).
 -fn,--forename <arg>     A users forename. (Optional)
 -sn,--surname <arg>      A users surname. (Optional)

Edit

 -m,--module user
 -a,--action edit

 -u,--user <arg>          Current username or userId.
 -pid,--projectid <arg>   The Project ID.

 -nn,--newname <arg>      A new Username. (Optional)
 -p,--password <arg>      Your Password. (Optional)
 -r,--roles <arg>         A comma separated list of roles. (Optional)
 -fn,--forename <arg>     A users forename. (Optional)
 -sn,--surname <arg>      A users surname. (Optional)

Sample requests

Always include the parameters required for the connection to the repository. 

--padreuser <> --padrepwd <> --solrurl <> --padreurl <>
List all users in project 6
-m user -a list -pid 6
Use the help to display all parameters used for editing a user

Does NOT require the padre and solr connection parameter. 

-m user -a edit -?
de/doc/admintool.txt · Zuletzt geändert: 2016/03/30 16:08 von mstenzel

Seiten-Werkzeuge

Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Noncommercial-Share Alike 3.0 Unported
CC Attribution-Noncommercial-Share Alike 3.0 Unported Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki