Zeile 116: | Zeile 116: | ||
==Dateiimport== | ==Dateiimport== | ||
Der Pfad für die Importfiles kann in den Systemeinstellungen in der Gruppe <code>Object Import Einstellungen</code> im Property <code>Eigenschaften-Import Pfad</code> festgelegt werden. Die gewünschte Dateierweiterung kann im Property <code>Eigenschaften-Import Dateierweiterung</code> eingestellt werden. | Der Pfad für die Importfiles kann in den Systemeinstellungen in der Gruppe <code>Object Import Einstellungen</code> im Property <code>Eigenschaften-Import Pfad</code> festgelegt werden. | ||
Die gewünschte Dateierweiterung kann im Property <code>Eigenschaften-Import Dateierweiterung</code> eingestellt werden. | |||
Der definierten Ordner wird alle 2 Minuten auf neue Dateien geprüft. | Der definierten Ordner wird alle 2 Minuten auf neue Dateien geprüft. |
Version vom 16. Februar 2022, 12:56 Uhr
Ab Version 2021.16 können beliebige Objekte angelegt und deren Eigenschaften (z.B. Zuname, E-Mail Adressen, etc.) über diese Webservice Schnittstelle geändert werden.
Link zur Funktionsbeschreibung.
Objekt anlegen
/New ?objectType=<Objekttyp des neuen Objektes> &indexQuery=<Index für Verifizierung> &matchString=<Wert für Suche auf Index> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Beispiele Personal
Neues Personal mit Personalnummer "PNR123" ab 01.01.2020.
/New?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&keyDate=01.01.2020
Beispiele Benutzer
Neuer Benutzer mit Username "USER1"
/New?objectType=AlexUser&indexQuery=UserX&matchString=USER1
Objekt ändern
/Set ?objectType=<Objekttyp auf dem geändert wird> &indexQuery=<Index über den das Objekt gefunden wird> &matchString=<Wert für Suche auf Index> &importType=<Eigenschaft die geändert werden soll> &valueString=<Wert der der Eigenschaft, URL-Encoded> &keyDate=<Stichtag bei zeitlich begrenzbaren Eigenschaften>
Format für Datum:
DD.MM.YYYY
Ergebnis:
Enthält eine etwaige Fehlermeldung.
Beispiele Personal
Beim Setzen von zeitlich abgrenzbaren Eigenschaften von Personal wird der Beginn automatisch begrenzt mit 'Ist bis'.
Wird ein keyDate mitgegeben, so wird der Beginn mit dem MAXIMUM zwischen keyDate und "Ist bis" genommen.
Setzen von Email "test@example.com" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEmailAddress&valueString=test@example.com
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "PNR123" ab 01.01.2020.
Achtung, ist das "Ist bis" Datum z. B. der 01.03.2020 so würde der Beginn auch erst ab 01.03.2020 gesetzt werden!
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeCardID&valueString=1234567&keyDate=01.01.2020
Setzen von Zuname "Mustermann" bei Personal mit Personalnummer "PNR123" ab 01.10.2020.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Surname&valueString=Mustermann&keyDate=01.10.2020
Setzen von Vorname "Max" bei Personal mit Personalnummer "PNR123".
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=Forname&valueString=Max
Beispiele Benutzer
Setzen von Email "test@example.com" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=UserEmail&valueString=test@example.com
Setzen von Username "USER1NEU" bei User mit Username "USER1".
/Set?objectType=AlexUser&indexQuery=UserX&matchString=USER1&importType=Username&valueString=USER1NEU
Externe Kennzeichen (Foreign Keys)
Der Import von Externen Kennzeichen (Foreign Keys) ist über die interne ObjectID
von ALEX möglich oder über Fremdschlüssel, die zuvor initialisiert werden müssen.
Fremdschlüssel stehen für die gängigsten Objekttypen zur Verfügung:
- Berufsgruppe
- Planungseinheit
- Vertrag
- Qualifikation
- Lohnartenumschlüsselung
Eingebettete Objekte (Records)
Der Import von eingebetteten Objekten (Records) ist ebenfalls möglich.
Beispiele für eingebettete Objekte:
- Anspruchszeile am Personal
- Informationen über Kinder für Pflegefreistellung
Setzen von Anspruchszeile bei Personal.
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeEntitlement_Urlaub&valueString=EmployeeRecEntitlementKeyDate####02.02.2012&EmployeeRecEntitlementCustomPostingKeyDate####03.02.2012&EmployeeRecEntitlementValue####200,00&keyDate=01.10.2020
Setzen von Kindern bei Personal.
1. Kind
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeChildren&keyString=0&valueString=ChildName####Franz&ChildBirthday####03.02.2012
2. Kind
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeChildren&keyString=1&valueString=ChildName####Hans&ChildBirthday####03.02.2013
7. Kind
/Set?objectType=Employee&indexQuery=EmployeeIDX&matchString=PNR123&importType=EmployeeChildren&keyString=6&valueString=ChildName####Karl&ChildBirthday####03.02.2014
Ausgabe
Json-Objekt in der Form:
{ "request" : "" , "status" : "" , "details" : "" }
- "request": Angeforderter Request als "Handshake"
- "status": "ok" oder "error"
- "details": Optionale Detailinformationen bei "error"
Dateiimport
Der Pfad für die Importfiles kann in den Systemeinstellungen in der Gruppe Object Import Einstellungen
im Property Eigenschaften-Import Pfad
festgelegt werden.
Die gewünschte Dateierweiterung kann im Property Eigenschaften-Import Dateierweiterung
eingestellt werden.
Der definierten Ordner wird alle 2 Minuten auf neue Dateien geprüft.
Format für Datei
{ "objectType": "string", "indexQuery": "string", "importType": "string", "lines": [ { "matchString": "string", "valueString": "string", "keyDate": "DD.MM.YYYY" } ] }
Beispiele Personal
Setzen von Kartennummer "1234567" bei Personal mit Personalnummer "1" ab 01.01.2020.
{ "objectType": "Employee", "indexQuery": "EmployeeIDX", "importType": "EmployeeCardID", "lines": [ { "matchString": "1", "valueString": "1234567", "keyDate": "01.01.2020" } ] }
Setzen von Email "test@example.com" bei Personal mit Personalnummer "1" ab 01.01.2020.
{ "objectType": "Employee", "indexQuery": "EmployeeIDX", "importType": "EmployeeEmailAddress", "lines": [ { "matchString": "1", "valueString": "test@example.com", "keyDate": "01.01.2020" } ] }
Setzen von Zuname "Mair" bei Personal mit Personalnummer "1" ab 01.01.2020 und setzen von Zuname "Huber" bei Personal mit Personalnummer "2" ab 01.02.2020.
{ "objectType": "Employee", "indexQuery": "EmployeeIDX", "importType": "Surname", "lines": [ { "matchString": "1", "valueString": "Mair", "keyDate": "01.01.2020" }, { "matchString": "2", "valueString": "Huber", "keyDate": "01.02.2020" } ] }