Przejdź do głównej zawartości
Wersja: 2023 R2

Dodatki SDK

Dodatki oferują szeroki wachlarz możliwości rozszerzania funkcjonalności WEBCOB BPS poprzez dołączanie niestandardowych funkcji, które nie są cześcią standardowo instalacji. Pozwalają one na utworzenie komponentów, które łączą się z zewnętrznymi systemami obsługując wyjątkowe przypadki, które w innym przypadku nie są wspierane.

Strona zawiera informacje o tworzeniu dodatków oraz ich rejestracji w WEBCON BPS Designer Studio. Druga strona zawiera listę dostępnych rodzajów dodatków oraz informacje o tym w jaki sposób w jaki się je konfiguruje.

Dedykowana strona dla developerów dodatków: WEBCON BPS Developers.

Tworzenie dodatków

Pakiet dodatków SDK dla WEBCON BPS znajduje się w katalogu Dokumentacji w folderze instalacyjnym. Zawiera następujące moduły:

  • Dokumentację WEBCON BPS API
  • Przykłady dodatków
  • Szablony dodatków Visual Studio

Aby rozpocząć tworzenie dodatków najlepiej zacząć od zainstalowania szablonów dodatków dla narzędzia Visual Studio. Przy ddoawaniu nowego projektu C# w Visual Studio, dodatki projektów powinny być widoczne. Można również utworzyć dodatek w istniejącym projekcie Visual Studio poprzez wybranie "Dodaj nowy obiekt" z menu kontekstowego i znalezienie odpowiedniego dodatku.

Gdy dodatek jest utworzony, należy go zarejestrować w sekcji Dodatki w WEBCON BPS Designer Studio. Po rejestracji możliwe jest użycie dodatku podczas normalnej konfiguracji WEBCON BPS w obszarach odpowiednich dla tego dodatku.

Przykładowo: Akcje użytkownika mogą być użyte w konfiguracji obiegu lub by utworzyć szablony akcji:

  • Dodaj nową definicję akcji tak jak zwykle

  • Wybierz jako typ akcji Wykonaj akcję (SDK)

  • Znajdź i wybierz zarejestrowaną Akcje użytkownika w dropdownie Dodatek (SDK)

Rejestracja dodatków w Designer Studio

Przed użyciem dodatku w konfiguracji procesu WEBCON BPS, musi on zostać zarejestrowany w sekcji Dodatki WEBCON BPS Designer Studio. Aby zarejestrować dodatek, kliknij Nowy i dodaj nową definicję do właściwego węzła na drzewie.

Możesz użyć przycisku Test znajdującego się w prawym dolnym rogu, aby zweryfikować czy dodatek został zarejestrowany poprawnie. Jeśli wynik testu będzie pozytywny, to dodatek może zostać użyty w normalnej konfiguracji procesu WEBCON BPS.

Okno rejestracji jest podobne dla wszystkich dodatków, a sekcja Zawartość występuje w dwóch różnych wariantach w zależności od typu dodatku (pole Adres URL kontrolki ASCX będzie aktywne lub wyszarzone, więcej informacji na ten temat znajduje się poniżej).

Ponadto dodatki typu Akcje użytkownika będą posiadały na dole okna rejestracji sekcję wyświetlającą Wywołania akcji, na których akcja może zostać skonfigurowana. Dostępność jest konfigurowane w kodzie dodatku i nie może zostać tutaj zmieniona.

Okno rejestracji dodatków:

drex_SDK_screen.png

1. Ogólne

Zdefiniuj podstawowe parametry takie jak Nazwa, Opis oraz Typ dodatku (zmiana typu przemieści definicję dodatku na właściwy węzeł na drzewku).

2. Zawartość

Zawartość sekcji konfiguracyjnej występuje w dwóch różnych wariantach w zależności od wybranego typu dodatku:

  • Wariant I **** (Adres URL kontrolki ASCX jest wyszarzony) – Dodatki są tworzone jako implementacja podstawowej klasy dodatków umieszczonych w całości wewnątrz pliku DLL. Ten wiariant dotyczy takich dodatków jak: Akcje Użytkownika, Customizacje Listy Pozycji, Szablony Wydruku etykiet, Niestandardowe Źródła Danych, Sterowanie Obiegiem i Reguł Biznesowe.

Kliknij przycisk Wybierz by otworzyć okno wyboru klasy dodatków.

Przycisk Pokaż wyświetla pliki DLL, których nazwy zaczynają się od wpisanej frazy. Lista plików jest ściągana z katalogu GAC (Global Assembly Cache) oraz z folderu bin aplikacji SharePoint. Z tego względu rekomentowane jest użycie wspólnego przedrostka (prefixu) takiego jak np. WEBCON.WorkFlow.Extensions dla plików DLL, które będą implementowały dodatki.

Pliki DLL będą wylistowane z uwzględnieniem: Nazwy, Źródła (GAC/bin), Wersji oraz fragmentu Klucza Publicznego którym plik został podpisany.

Po wybraniu odpowiedniego pliku lista klas implementujących klasę dodatku będzie wypełniona automatycznie. Wybranie pożądanej klasy wyświetli nazwę dodatku i jego opis - te dane są definiowane przez kreator dodatku w jego kodzie źródłowym.

  • Wariant II (Adres URL kontrolki ASCX jest aktywny) – Dodatki są tworzone jako kontrolki użytkownika i implementowane poprzez umieszczenie pliku ASCX w strukturze SharePointa, a nastepnie wdrożenia pliku DLL. Ten wariant dotyczy takich dodatków jak: Kontrolki Użytkownika, Kontrolki Atrybutów i Kontrolki Listy Pozycji.

Aby zarejestrować dodatek stworzony jako kontrolka użytkownika, wybierz lokalizację pliku kontrolnego ASCX. Kliknij na przycisku Wybierz aby otworzyć okno wyboru pliku ASCX.

Wpisz fragment adresu pliku ASCX i wybierz Pokaż aby załadować listę plików ASCX. Wybierz plik, który potrzebujesz i kliknij przycisk Uzyskaj właściwości by uzupełnić resztę pól w oknie.

3. Ograniczenie użycja akcji

Wyłącznie dla dodatków dla Akcji niestandardowych

Ta sekcja wyświetla Wywołania akcji na których dana akcja może być skonfigurowana. Dostęponość akcji jest konfigurowana w kodzie dodatku i nie może być tutaj zmieniona. Sekcja ta pełni rolę informacyjną.