Otwieranie nowej sprawy z systemu zewnętrznego
W systemie zewnętrznym można umieścić przycisk lub odnośnik, który otwiera istniejący formularz nowej sprawy w eFOB. Link może wskazać firmę, pracownika i typ sprawy. Użytkownik uzupełnia pozostałe dane, sprawdza wybrany kontekst i sam zatwierdza utworzenie sprawy.
Link nie jest osobnym API ani metodą uwierzytelniania. Korzysta ze standardowego logowania, formularzy i procesu obsługi spraw w eFOB.
Zastosowanie
Link pozwala rozpocząć pracę nad sprawą bez ponownego wyszukiwania firmy, pracownika i typu sprawy. Można go dodać na przykład do przycisku w systemie klienta, w którym użytkownik ma już otwarty rekord pracownika lub wybrany proces.
Wartości przekazane w linku są wstępnym wyborem. Użytkownik może je zmienić, jeżeli pozwalają na to obecne reguły formularza i jego uprawnienia.
Format linku
https://<adres-eFOB>/#/cases/new?companyCode=<kod-firmy>&workerId=123&caseTypeCode=KOM
Parametry znajdują się po znaku ? i są rozdzielone znakiem &. Ich nazwy i wartości należy kodować zgodnie z regułami URL, na przykład za pomocą URLSearchParams.
Parametry
| Parametr | Znaczenie |
|---|---|
companyCode | Wymagany kod z pola Kod firmy (QR) w panelu Firma (/#/company). Nie jest to nazwa firmy, NIP ani identyfikator używany w adresie firmy. |
mode | Opcjonalny tryb. Wartość worker otwiera sprawę dla wskazanego pracownika, a self własną sprawę w module Moje sprawy. Brak parametru oznacza tryb worker. |
workerId | ID rekordu pracownika w eFOB. Nie jest to ID konta użytkownika. |
externalId1 | Identyfikator zapisany w polu external_id_1 profilu pracownika. |
externalId2 | Identyfikator zapisany w polu external_id_2 profilu pracownika. |
caseTypeId | ID typu sprawy w eFOB. |
caseTypeCode | Kod typu sprawy zapisany w polu case_code, na przykład KOM. |
Zasady walidacji
companyCodejest wymagany.- Link musi zawierać dokładnie jeden parametr typu sprawy:
caseTypeIdalbocaseTypeCode. - W trybie
workerlink musi zawierać dokładnie jeden identyfikator pracownika:workerId,externalId1alboexternalId2. - W trybie
selfpracownik jest ustalany na podstawie zalogowanego użytkownika w wybranej firmie. Link może nie zawierać identyfikatora pracownika albo zawierać dokładnie jeden identyfikator służący do potwierdzenia zgodności. Niezgodność blokuje otwarcie formularza. - Przekazanie kilku alternatywnych identyfikatorów jest błędem, nawet jeśli wszystkie wskazują ten sam rekord. eFOB nie przełącza automatycznie trybu
selfnaworkerani odwrotnie. workerIdicaseTypeIdmuszą być dodatnimi liczbami całkowitymi.externalId1iexternalId2są tekstem. Zera na początku wartości są zachowywane.- Kody i identyfikatory są dopasowywane dokładnie, bez wyszukiwania fragmentów i bez niejawnej zmiany wielkości liter.
- Puste wartości, powtórzone parametry i parametry spoza opisanej listy powodują błąd walidacji.
Co dzieje się po otwarciu linku
- Jeśli użytkownik nie ma aktywnej sesji, eFOB kieruje go do zwykłego logowania. Kontekst linku jest zachowywany podczas logowania, SSO, 2FA i ewentualnej akceptacji dokumentów prawnych.
- eFOB wyszukuje firmę po
companyCodewśród firm dostępnych dla użytkownika. - Jeśli użytkownik pracuje obecnie w innej firmie, aplikacja przełącza pełny kontekst firmy przed wyszukaniem pracownika i typu sprawy.
- eFOB sprawdza identyfikatory oraz uprawnienia użytkownika w wybranej firmie.
- W trybie
workerotwiera się formularz nowej sprawy ze wstępnie wybranym pracownikiem i typem sprawy. W trybieselfotwiera się formularz w module Moje sprawy. - Użytkownik sprawdza firmę, pracownika i typ sprawy, uzupełnia wymagane dane, a następnie zatwierdza utworzenie sprawy.
Po zapisaniu sprawy obowiązuje jej zwykły proces, w tym osoby odpowiedzialne, formularze etapów i ich walidacja.
Przykładowe linki
Sprawa pracownika wskazanego przez ID i typ sprawy wskazany przez ID:
https://<adres-eFOB>/#/cases/new?companyCode=<kod-firmy>&workerId=123&caseTypeId=17
Sprawa pracownika wskazanego przez pierwszy identyfikator zewnętrzny:
https://<adres-eFOB>/#/cases/new?companyCode=<kod-firmy>&externalId1=000123&caseTypeCode=KOM
Sprawa pracownika wskazanego przez drugi identyfikator zewnętrzny:
https://<adres-eFOB>/#/cases/new?companyCode=<kod-firmy>&externalId2=HR-456&caseTypeCode=KOM
Własna sprawa zalogowanego użytkownika:
https://<adres-eFOB>/#/cases/new?companyCode=<kod-firmy>&mode=self&caseTypeCode=KOM
Uprawnienia i utworzenie sprawy
Link nie rozszerza uprawnień użytkownika. eFOB udostępnia tylko firmy, pracowników i typy spraw, do których użytkownik ma dostęp. Samo otwarcie linku nie tworzy sprawy. Użytkownik widzi wybrany kontekst w formularzu i świadomie zatwierdza utworzenie sprawy.