#Zatwierdzanie

#Wprowadzenie

Zatwierdzanie to typ procesu, który jest inicjowany i przetwarzany ręcznie przez użytkowników, aby decydować o statusie powiązanych danych. Jest powszechnie stosowany w automatyzacji biura lub do zarządzania procesami wymagającymi ręcznych decyzji. Pozwala na tworzenie i zarządzanie przepływami pracy dla scenariuszy takich jak „wnioski urlopowe”, „zatwierdzanie zwrotów kosztów” czy „zatwierdzanie zakupu surowców”.

Wtyczka Zatwierdzanie udostępnia dedykowany typ przepływu pracy (wyzwalacz) „Zatwierdzanie (zdarzenie)” oraz specjalny węzeł „Zatwierdzanie” dla tego procesu. W połączeniu z unikalnymi dla NocoBase niestandardowymi kolekcjami i blokami, mogą Państwo szybko i elastycznie tworzyć oraz zarządzać różnymi scenariuszami zatwierdzania.

#Tworzenie przepływu pracy

Aby utworzyć przepływ pracy zatwierdzania, proszę wybrać typ „Zatwierdzanie” podczas tworzenia nowego przepływu pracy:

Następnie, w interfejsie konfiguracji przepływu pracy, proszę kliknąć wyzwalacz, aby otworzyć okno dialogowe z dodatkowymi opcjami konfiguracji.

#Konfiguracja wyzwalacza

#Wiązanie kolekcji

Wtyczka Zatwierdzanie w NocoBase została zaprojektowana z myślą o elastyczności i może współpracować z dowolną niestandardową kolekcją. Oznacza to, że konfiguracja zatwierdzania nie wymaga ponownego definiowania modelu danych, lecz bezpośrednio wykorzystuje już istniejącą kolekcję. Dlatego po przejściu do konfiguracji wyzwalacza, w pierwszej kolejności należy wybrać kolekcję, aby określić, które dane z tej kolekcji (po utworzeniu lub aktualizacji) będą wyzwalać ten przepływ pracy:

Następnie, w formularzu tworzenia (lub edycji) danych dla wybranej kolekcji, proszę powiązać ten przepływ pracy z przyciskiem wysyłania:

Po tym, jak użytkownik prześle formularz, zostanie wyzwolony odpowiedni przepływ pracy zatwierdzania. Przesłane dane zostaną nie tylko zapisane w powiązanej kolekcji, ale także zarchiwizowane w procesie zatwierdzania, aby były dostępne do wglądu dla kolejnych osób zatwierdzających.

#Wycofanie

Jeśli przepływ pracy zatwierdzania ma umożliwiać inicjatorowi wycofanie, należy w konfiguracji interfejsu inicjatora włączyć przycisk „Wycofaj”:

Po włączeniu tej opcji, zatwierdzenie zainicjowane w ramach tego przepływu pracy może zostać wycofane przez inicjatora, zanim zostanie przetworzone przez jakąkolwiek osobę zatwierdzającą. Jednak po przetworzeniu przez osobę zatwierdzającą w kolejnym węźle zatwierdzania, wycofanie nie będzie już możliwe.

#Konfiguracja interfejsu formularza inicjatora

Na koniec należy skonfigurować interfejs formularza inicjatora. Ten interfejs będzie służył do przesyłania danych zarówno podczas inicjowania z bloku centrum zatwierdzania, jak i podczas ponownego inicjowania po wycofaniu przez użytkownika. Proszę kliknąć przycisk konfiguracji, aby otworzyć okno dialogowe:

Mogą Państwo dodać do interfejsu inicjatora formularz do wypełnienia, oparty na powiązanej kolekcji, lub tekst opisowy (Markdown) służący jako wskazówki i instrukcje. Formularz jest obowiązkowy; w przeciwnym razie inicjator nie będzie mógł wykonywać żadnych operacji po wejściu do tego interfejsu.

Po dodaniu bloku formularza, podobnie jak w standardowym interfejsie konfiguracji formularza, mogą Państwo dodawać komponenty pól z powiązanej kolekcji i dowolnie je rozmieszczać, aby zorganizować zawartość do wypełnienia w formularzu:

Oprócz przycisku bezpośredniego wysyłania, mogą Państwo również dodać przycisk akcji „Zapisz jako szkic”, aby umożliwić tymczasowe zapisywanie procesu:

#Węzeł zatwierdzania

W przepływie pracy zatwierdzania należy użyć dedykowanego węzła „Zatwierdzanie”, aby skonfigurować logikę operacyjną dla osób zatwierdzających, umożliwiającą przetwarzanie (zatwierdzanie, odrzucanie lub zwracanie) zainicjowanego zatwierdzenia. Węzeł „Zatwierdzanie” może być używany wyłącznie w przepływach pracy zatwierdzania. Proszę zapoznać się z Węzłem zatwierdzania, aby uzyskać szczegółowe informacje.

#Konfiguracja inicjowania zatwierdzania

Po skonfigurowaniu i włączeniu przepływu pracy zatwierdzania, mogą Państwo powiązać go z przyciskiem wysyłania formularza odpowiedniej kolekcji, aby użytkownicy mogli inicjować zatwierdzenie podczas przesyłania danych:

Po powiązaniu przepływu pracy, użytkownik inicjuje zatwierdzenie w momencie przesłania bieżącego formularza.

#Centrum zadań

Centrum zadań stanowi ujednolicony punkt dostępu, ułatwiający użytkownikom przeglądanie i przetwarzanie zadań do wykonania. Zatwierdzenia zainicjowane przez bieżącego użytkownika oraz jego oczekujące zadania są dostępne poprzez Centrum zadań w górnym pasku narzędzi. Różne typy zadań do wykonania można przeglądać za pomocą nawigacji po lewej stronie.

#Moje zgłoszenia

#Przeglądanie zgłoszonych zatwierdzeń

#Bezpośrednie inicjowanie nowego zatwierdzenia

#Moje zadania do wykonania

#Lista zadań do wykonania

#Szczegóły zadania do wykonania

#API HTTP

#Inicjator

#Inicjowanie z kolekcji

Aby zainicjować proces z bloku danych, mogą Państwo użyć następującego wywołania (na przykładzie przycisku tworzenia dla kolekcji posts):

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post."
  }'
  "http://localhost:3000/api/posts:create?triggerWorkflows=workflowKey"

Parametr URL triggerWorkflows to klucz przepływu pracy; wiele przepływów pracy należy oddzielić przecinkami. Ten klucz można uzyskać, najeżdżając kursorem myszy na nazwę przepływu pracy u góry obszaru roboczego przepływu pracy:

Po pomyślnym wywołaniu zostanie wyzwolony przepływ pracy zatwierdzania dla odpowiedniej kolekcji posts.

Jeśli chcą Państwo wyzwolić zdarzenie dla danych powiązanych jeden do jednego w tej operacji (relacje jeden do wielu nie są jeszcze obsługiwane), mogą Państwo użyć ! w parametrze, aby określić dane wyzwalające dla pola relacji:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "title": "Hello, world!",
    "content": "This is a test post.",
    "category": {
      "title": "Test category"
    }
  }'
  "http://localhost:3000/api/posts:create?triggerWorkflows=workflowKey!category"

Po pomyślnym wywołaniu powyższego, zostanie wyzwolone zdarzenie zatwierdzania dla odpowiedniej kolekcji categories.

#Inicjowanie z Centrum zatwierdzania

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "collectionName": "<collection name>",
    "workflowId": <workflow id>,
    "data": { "<field>": "<value>" },
    "status": <initial approval status>,
  }'
  "http://localhost:3000/api/approvals:create"

Parametry

• collectionName: Nazwa docelowej kolekcji do inicjowania zatwierdzenia, wymagane.
• workflowId: ID przepływu pracy używanego do inicjowania zatwierdzenia, wymagane.
• data: Pola rekordu kolekcji tworzonego podczas inicjowania zatwierdzenia, wymagane.
• status: Status rekordu tworzonego podczas inicjowania zatwierdzenia, wymagane. Możliwe wartości to:
  • 0: Szkic, oznacza zapisanie bez przesyłania do zatwierdzenia.
  • 1: Prześlij do zatwierdzenia, oznacza, że inicjator przesyła wniosek o zatwierdzenie, rozpoczynając proces zatwierdzania.

#Zapisz i wyślij

Gdy zainicjowane (lub wycofane) zatwierdzenie znajduje się w stanie szkicu, mogą Państwo ponownie je zapisać lub wysłać za pośrednictwem następującego API:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  '{
    "data": { "<field>": "<value>" },
    "status": 2
  }'
  "http://localhost:3000/api/approvals:update/<approval id>"

#Pobieranie listy zgłoszonych zatwierdzeń

curl -X GET -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' \
  "http://localhost:3000/api/approvals:listMine"

#Wycofanie

Inicjator może wycofać rekord aktualnie znajdujący się w procesie zatwierdzania za pośrednictwem następującego API:

curl -X POST -H 'Authorization: Bearer <your token>' -H 'X-Role: <roleName>' -d \
  "http://localhost:3000/api/approvals:withdraw/<approval id>"

Parametry

• <approval id>: ID rekordu zatwierdzenia do wycofania, wymagane.

#Osoba zatwierdzająca

Gdy przepływ pracy zatwierdzania wejdzie w węzeł zatwierdzania, dla bieżącej osoby zatwierdzającej zostanie utworzone zadanie do wykonania. Osoba zatwierdzająca może wykonać zadanie zatwierdzania za pośrednictwem interfejsu użytkownika lub poprzez wywołanie API HTTP.

#Pobieranie rekordów zatwierdzeń

Zadania do wykonania to rekordy przetwarzania zatwierdzeń. Mogą Państwo uzyskać wszystkie rekordy przetwarzania zatwierdzeń bieżącego użytkownika za pośrednictwem następującego API:

curl -X GET -H 'Authorization: Bearer <your token>' \
  "http://localhost:3000/api/approvalRecords:listMine"

Gdzie approvalRecords, jako zasób kolekcji, może również używać ogólnych warunków zapytania, takich jak filter, sort, pageSize i page.

#Pobieranie pojedynczego rekordu zatwierdzenia

curl -X GET -H 'Authorization: Bearer <your token>' \
  "http://localhost:3000/api/approvalRecords:get/<record id>"

#Zatwierdź i odrzuć

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "status": 2,
    "comment": "Looks good to me.",
    "data": { "<field to modify>": "<value>" }
  }'
  "http://localhost:3000/api/approvalRecords:submit/<record id>"

Parametry

• <record id>: ID rekordu do przetworzenia zatwierdzenia, wymagane.
• status: Pole statusu przetwarzania zatwierdzenia. 2 oznacza „Zatwierdź”, -1 oznacza „Odrzuć”, wymagane.
• comment: Uwagi do przetwarzania zatwierdzenia, opcjonalne.
• data: Oznacza modyfikacje rekordu kolekcji, w której znajduje się bieżący węzeł zatwierdzania, po zatwierdzeniu. Opcjonalne (skuteczne tylko po zatwierdzeniu).

#Cofnij v1.9.0+

Przed wersją v1.9.0, cofnięcie używało tego samego API co „Zatwierdź” i „Odrzuć”, gdzie "status": 1 oznaczało cofnięcie.

Od wersji v1.9.0, cofnięcie ma oddzielne API:

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "returnToNodeKey": "<node key>",
  }'
  "http://localhost:3000/api/approvalRecords:return/<record id>"

Parametry

• <record id>: ID rekordu do przetworzenia zatwierdzenia, wymagane.
• returnToNodeKey: Klucz docelowego węzła, do którego należy cofnąć. Opcjonalne. Jeśli w węźle skonfigurowano zakres węzłów, do których można cofnąć, ten parametr pozwala określić konkretny węzeł. W przeciwnym razie, parametr nie jest wymagany, a domyślnie proces zostanie cofnięty do punktu początkowego, aby inicjator mógł ponownie go przesłać.

#Delegowanie

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "assignee": <user id>,
  }'
  "http://localhost:3000/api/approvalRecords:delegate/<record id>"

Parametry

• <record id>: ID rekordu do przetworzenia zatwierdzenia, wymagane.
• assignee: ID użytkownika, któremu ma zostać delegowane, wymagane.

#Dodawanie osoby do podpisu

curl -X POST -H 'Authorization: Bearer <your token>' -d \
  '{
    "assignees": [<user id>],
    "order": <order>,
  }'
  "http://localhost:3000/api/approvalRecords:add/<record id>"

Parametry

• <record id>: ID rekordu do przetworzenia zatwierdzenia, wymagane.
• assignees: Lista ID użytkowników do dodania jako osoby do podpisu, wymagane.
• order: Kolejność dodanej osoby do podpisu. -1 oznacza „przed mną”, 1 oznacza „po mnie”.