Schnittstellen
Die Fabasoft Personalakte ermöglicht Drittprodukten den Zugriff auf Personalakten über vordefinierte URLs bzw. Webservices.
URLs
Folgende Friendly URLs stehen zur Verfügung.
Darstellung einer Personalakte
Zur Darstellung einer Personalakte z. B. in einem Webbrowser können Sie folgende URLs verwenden:
Aufruf anhand der Personalnummer
Syntax |
|---|
https://<server>/<vdir>/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396257 https://<server>/<vdir>/personnelfile/<Personalnummer>/<Fabasoft Cloud ID der Personalaktenablage> |
Parameter:
- shelfid
Fabasoft Cloud ID der Personalaktenablage. - persnum
Personalnummer der zu öffnenden Personalakte.
Beispiel |
|---|
https://at.cloud.fabasoft.com/folio/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396257&shelfid=COO.1.3285.3.19&persnum='00001' https://at.cloud.fabasoft.com/folio/personnelfile/00001/COO.1.3285.3.19 |
Aufruf anhand der Benutzer-ID
Syntax |
|---|
https://<server>/<vdir>/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396256 https://<server>/<vdir>/personnelfile/<Fabasoft Cloud ID bzw. E-Mail-Adresse des zugeordneten Benutzers>/<Fabasoft Cloud ID der Personalaktenablage> |
Parameter:
- shelfid
Fabasoft Cloud ID der Personalaktenablage. - userid
Fabasoft Cloud ID des der Personalakte zugeordneten Benutzers. Wird die userid nicht definiert, versucht das System eine mit dem aktuell angemeldeten Benutzer verknüpfte Personalakte zu identifizieren (Akteneinsicht durch Mitarbeiter).
Beispiel |
|---|
https://at.cloud.fabasoft.com/folio/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396256 https://at.cloud.fabasoft.com/folio/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396256&shelfid=COO.1.3285.3.19 https://at.cloud.fabasoft.com/folio/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396256&shelfid=COO.1.3285.3.19&userid=cadence.jones@fabasoft.com https://at.cloud.fabasoft.com/folio/fscasp/content/bin/fscvext.dll?ax=COO.1.1001.1.396256&shelfid=COO.1.3285.3.19&userid=COO.1.3285.1.15 https://at.cloud.fabasoft.com/folio/personnelfile/ https://at.cloud.fabasoft.com/folio/personnelfile/cadence.jones@fabasoft.com/COO.1.3285.3.19 |
Hochladen von Dokumenten
Zum Hochladen von Dokumenten in eine Personalakte können Sie folgende URL verwenden:
Syntax |
|---|
https://<server>/<vdir>/uploadpfdocument/<Personalnummer>/<Fabasoft Cloud ID der Personalaktenablage>/<Dokumentname mit Dateierweiterung>/<externer Schlüssel der Kategorie>/<externer Schlüssel des Personalaktenregisters>/<gültig ab: yyyy-mm-dd>/<gültig bis: yyyy-mm-dd>/<Dokumentstatus: PersonnelFileDocumentInProgress oder PersonnelFileDocumentClosed> |
Das Dokument muss im HTTP-Body mitgeliefert werden. Die Parameter „Personalnummer“, „Dokumentname mit Dateierweiterung“ und der Inhalt des Dokuments müssen angegeben werden. Wenn kein Personalaktenregister jedoch eine Kategorie angegeben ist, wird versucht über die Kategorie ein Personalaktenregister zu ermitteln. Wenn kein eindeutiges Personalaktenregister ermittelt werden kann, wird ein Fehler generiert.
Beispiel |
|---|
https://at.cloud.fabasoft.com/folio/uploadpfdocument/00002/doc.txt//HRDOCUMENT_PAYROLL//2017-01-30/ |
Webservice
Über ein Webservice können Dokumente hochgeladen, Personalakten erzeugt und ausgelesen werden.
Die WSDL ist unter folgender URL erreichbar:
https://<server>/<vdir>/fscdav/wsdl?WEBSVC=FSCPERSONNELFILE_1_1001_WebServicesPersonnelFile
Das Webservice unterstützt auch das JSON-Format:
https://<host>/<vdir>/wsjson/FSCPERSONNELFILE_1_1001_WebServicesPersonnelFile/<operation>
Operationen:
- GetPersonnelFile
Ermittelt eine Liste von Personalakten anhand der Personalnummer. Wenn keine Personalakten gefunden wurden, wird eine Liste von möglichen Personalaktenablagen zurückgegeben. - CreatePersonnelFile
Dient zum Erzeugen einer Personalakte mit den angegebenen Eigenschaften. - UpdatePersonnelFile
Aktualisiert eine Personalakte. Einwertige Eigenschaften werden überschrieben, wenn sie angeführt sind. Um den Wert einer einwertigen Eigenschaft zu entfernen, darf die Eigenschaft nicht mitgeliefert werden und muss in overwriteattributes angeführt sein. Werte von mehrwertigen Eigenschaften werden standardmäßig angefügt. Wenn sie in overwriteattributes angeführt sind, werden sie überschrieben. Mit implicitcreateonupdate kann festgelegt werden, ob eine Personalakte erzeugt werden soll, wenn keine Personalakte mit der angegebenen Kombination aus persnum und shelfid existiert.
Wenn in der Personalakten-Konfiguration definiert ist, dass eindeutige Personalnummern über alle Personalaktenablagen hinweg verwendet werden sollen, können bestehende Personalakten durch Angabe einer anderen shelfid verschoben werden. - UploadDocument
Dient zum Hochladen von Dokumenten in eine Personalakte. - UploadScannedDocument
Dient zum Hochladen von gescannten Dokumenten in die Personalakte. Dazu müssen die Personalaktenablage und der Barcode als Parameter mitgegeben werden. Nach dem erfolgreichen Hochladen des Dokuments wird dieses automatisch aus der Scan-Warteschlange entfernt.
Hinweis: Die Webservice-Aufrufe mit dem JSON-Format müssen mittels der HTTP-Anfragemethode „POST“ aufgerufen werden.
Beispiel |
|---|
Request-JSON (GetPersonnelFile): {"shelfid":"COO.200.200.4.156","persnum":"00000008"} {"shelfid":null,"persnum":"00000000"} Request-JSON (CreatePersonnelFile): { ] Request-JSON (UpdatePersonnelFile): { "supervisorid": "laura.hammond@example.com", ], Request-JSON (UploadDocument): { |
Weitere Informationen über die Parameter der Operationen finden Sie hier: https://help.developer.fabasoft.com/index.php: neues Fenster. Suchen Sie nach den zugehörigen Aktionen (WSGetPersonnelFile, WSCreatePersonnelFile, WSUpdatePersonnelFile, WSUploadDocument, UploadScannedDocument).