|
Rozdział ten jest poświęcony bibiotece API programu, umożliwiającej tworzenie indywidualnych rozwiązań dla potrzeb konkretnego klienta. Biblioteka ta udostępnia programistom wewnętrzne funkcje programu. Przy ich wykorzystaniu można napisać własne aplikacje współpracujące z programem lub dodatki modyfikujące jego funkcjonalność.
Udostępnione funkcje można podzielić na dwie grupy:
DI (Data Interface) - umożliwiające operacje na bazie danych programu - dzięki nim zewnętrzne aplikacje mogą mieć dostęp do bazy danych programu i wykonywać operacje na bazie w taki sam sposób, jak wykonuje to program.
Funkcje API w zakresie operacji na bazie danych umożliwiają przykładowo:
import danych początkowych z dotychczasowych systemów (wdrożenie)
współpracę z innymi aplikacjami
tworzenie własnych modułów ułatwiających wprowadzanie danych
tworzenie nowych zewnętrzych modułów zwiększających funkcjonalność systemu.
Dzięki funkcjom API możemy we własnej aplikacji w prosty sposób odczytać dane z dowolnych tabel programu. Natomiast przy wprowadzaniu nowych rekordów do tabel programu mamy większą pewność spójności danych, gdyż:
podstawiają się wartości początkowe wymaganych pól
zakładają się automatycznie wymagane rekordy w tabelach powiązanych
przeliczają się wartości pól wtórnych (np. VAT)
przechwytywane są komunikaty programu o błędnie wprowadzonych wartościach pól.
UI (User Interface) - modyfikujące interfejs użytkownika programu - dzięki nim zewnętrzne aplikacje mogą modyfikować interfejs użytkownika programu i rozszerzyć jego funkcjonalność.
Funkcje API w zakresie interfejsu użytkownika umożliwiają przykładowo:
zmianę wyglądu okien w programie (np. dostawienie dodatkowych pól do wypełnienia wraz z ich inicjalizowaniem i kontrolą wypełnienia)
rozbudowę funkcji programu (np. dostawienie i oprogramowanie działania nowego przycisku lub pozycji menu)
tworzenie własnych skomplikowanych raportów lub bezpośredni eksport obrobionych danych
tworzenie nowych wewnętrznych modułów zwiększających funkcjonalność systemu
Aplikacja korzystająca z API w trybie UI musi być uruchamiana jako tzw. AddOn (dodatek) razem z programem R2fk. AddOn'y współpracujące z programem określamy w menu Ustawienia - Środowisko na zakładce Dodatki.
Funkcje i procedury biblioteki API zawarte są w pliku R2firmaApi.dll, znajdującym się w folderze BIN. Plik R2firmaApi.dll instaluje się automatycznie razem z właściwym programem. Automatycznie jest również aktualizowany.
Przykładowe kody źródłowe demonstrujące korzystanie z API w językach C#, Delphi i VB znajdują się w folderze DEMOS. Przykłady obejmują:
DI (Data Interface)
UI (User Interface)
kopiowanie wybranego dokumentu jako nowego dokumentu ze zmienioną datą (przycisk Kopiuj w oknie KSIĘGA)
własny raporty w menu Raporty - Mój raport - sprzedaż dla poszczególnych nabywców z podziałem na miesiące.
interakcję z tabelą w oknie KONTRAHENCI - dodanie do tabeli Kontrahenci własnego pola o nazwie Symbol, które w przejętym zdarzeniu OnBeforePost będzie ustawiane na 2 pierwsze litery skrótu nazwy. Pole Symbol jest widoczne na zakładce Pozycja w oknie Kontrahenci.
Szczegółowy opis poszczególnych funkcji API zawarty jest w plikach R2SimpleApi.pas i R2Api.pas znajdujących się w folderze DEMOS\Delphi.
W trakcie pisania aplikacji korzystających z API pomocna będzie lista tabel występujących w bazie danych znajdująca się w rodziale ZAŁĄCZNIKI - Lista modułów danych i tabel.
, 