HERMES MULTI IN/OUT DOKUMENT MIOD Opis systemu wer. 1.0.0.5 Rzeszów 2010
Spis treści 1. Wstęp...5 2. Konfiguracja...5 3. Uruchamianie...8 4. Przygotowanie skryptów...9 4.1. Zmienne globalne...9 4.2. Funkcje udostępniane przez HermesNG...11 HNG_DialogOtworz...11 HNG_DialogZapisz...13 HNG_Komunikat...15 HNG_WprowadzParametr...16 HNG_WybierzParametr...17 HNG_Powiadom...18 HNG_ZnajdzTowar...19 HNG_ZnajdzTowarEx...20 HNG_CzyscDokument...21 HNG_DopiszDoPrzyjecia...22 HNG_DopiszDoZamowieniaODB...24 HNG_DopiszDoRozchodu...26 HNG_ZnajdzDostawce...28 HNG_ZnajdzOdbiorce...30 HNG_RozpocznijDokument...32 HNG_DokZewnExist...34 5. Import/Export treści dokumentu...35 5.1. Wymiana treści przez pliki...35 5.1.1. Format plików importu...35 5.1.1.1. Format przyjęcia...35
5.1.2. Format plików eksportu...36 5.2. Wymiana treści za pomocą funkcji udostępnionych...36 6. Środowisko PHP...36 6.1. Moduły standardowo dostarczane wraz z HermesNG...36 6.1.1. Rozszerzenia dynamiczne DLL...36 6.1.2. Klasy/pliki PHP...36
HermesNG MIOD opis modułu 4 ZMIANY wer. 1.0.0.1 Wprowadzono parametr MIOD_PATH MIOD dostępny w zamówienia do dostawców wer. 1.0.0.2 Wprowadzono funkcję HNG_WprowadzParametr wer. 1.0.0.3 Wprowadzono funkcję HNG_Powiadom MIOD dostępny w opcji Magazyn -> Kartoteka Dodano parametr DOK_SPOSOB wer. 1.0.0.4 Wprowadzono funkcję HNG_WybierzParametr Wprowadzono funkcję HNG_ZnajdzDostawce Wprowadzono funkcję HNG_ZnajdzOdbiorce Wprowadzono funkcję HNG_RozpocznijDokument Wprowadzono funkcję HNG_DopiszDoZamowieniaODB
HermesNG MIOD opis modułu 5 1. WSTĘP Celem modułu Multi In/Out Dokument (MIOD), jest umoŝliwienie importu/eksportu treści dokumentów do i z HermesNG. MIOD umoŝliwia tworzenie odpowiednich interfejsów, bez konieczności modyfikacji samego Hermes a. Moduł został oparty na popularnym języku skryptowym PHP. W celu importu/eksportu treści dokumentu, HermesNG uruchamia wcześniej przygotowany, zewnętrzny skrypt PHP, którego zadaniem jest konwersja pliku w dowolnym formacie, na format zrozumiały przez HermesNG. treść dokumentu HERMESNG Silnik PHP skrypt PHP schemat ideowy wymiany MIOD Moduł MIOD umoŝliwia import/eksport treści dla: dokumentów: przyjęć, rozchodów, zamówień do dostawców, zamówień od odbiorców *, dokumentów rozliczeń * (wpłaty/wypłaty) listy magazynowej 2. KONFIGURACJA Przed wykorzystaniem przygotowanych skryptów MIOD, konieczna jest ich konfiguracja. Opcje konfiguracyjne modułu MIOD znajdują się w opcji Inne-> Konfiguracja-> Specjalne-> Wymiana MIOD. * Funkcja niedostępna w wersji 1.0.0.3 modułu
HermesNG MIOD opis modułu 6 lista zdefiniowanych modułów MIOD Konfiguracja ma na celu: wprowadzenie nazwy, umoŝliwiającej uŝytkownikowi łatwe rozróŝnienie dostępnych skryptów MIOD, określenie typu import lub eksport, wskazanie przeznaczenia skryptu (jaki typ dokumentów), wczytanie do systemu skryptu PHP z dysku lokalnego.
HermesNG MIOD opis modułu 7 konfiguracja modułu MIOD Po wprowadzeniu konfiguracji, skrypt modułu MIOD wczytywany jest do centralnej bazy danych i dostępny do uŝycia na dowolnym stanowisku z HermesNG.
HermesNG MIOD opis modułu 8 3. URUCHAMIANIE Uruchomienie skonfigurowanych skryptów MIOD, wykonuje się z poziomu edycji treści dokumentu, w opcji Inne-> Import/Export MIOD *. wywołanie modułu MIOD Po uruchomieniu opcji, zostanie wyświetlona dostępna, skonfigurowana lista modułów MIOD, które mogą być uŝyte dla aktualnego dokumentu. lista dostępnych dla dokumentu skryptów MIOD Na liście dostępna jest informacja o typie akcji, jaka zostanie podjęta (import lub eksport) oraz nazwa modułu MIOD, umoŝliwiająca rozróŝnienie dostępnych skryptów. Po wybraniu skryptu, zostanie on pobrany z centralnej bazy danych na lokalne stanowisko i uruchomiony. Prawidłowe zakończenie pracy modułu MIOD, zostanie potwierdzone odpowiednim komunikatem. * opcja wspólna dla kaŝdego typu dokumentu, chyba ze wskazano inaczej
HermesNG MIOD opis modułu 9 4. PRZYGOTOWANIE SKRYPTÓW Skrypty MIOD tworzone są w języku skryptowym PHP. Nie jest konieczne instalowanie silnika PHP na końcówce klienckiej lub oddzielnego serwera. HermesNG zawiera wszystkie niezbędne moduły, do uruchomienia środowiska PHP. Standardowo jest to wersja 5.2. Tworząc skrypt, programista ma dostęp do wszystkich standardowych funkcji PHP oraz dodatkowo do opcji oferowanych przez moduły: php_dbase.dll, php_interbase.dll, php_zip.dll. Ponad to, istnieje moŝliwość rozszerzenia lokalnego środowiska PHP, o dodatkowe moduły współpracujące z PHP (patrz 6. Środowisko PHP). Skrypt PHP musi: rozpoczynać się znacznikiem <?php kończyć znacznikiem?> uŝywać strony kodowej Windows 4.1. Zmienne globalne HermesNG uruchamiając skrypt PHP, rejestruje w środowisku zmienne globalne, umoŝliwiając modułowi MIOD, odczytanie podstawowych danych np. o dokumencie, kontrahencie oraz zapewniając przekazywanie informacji między skryptem a programem. Rejestrowane zmienne globalne: DOTYCZY NAZWA ZMIENNEJ OPIS moduł MIOD MIOD_FILEFROMHERM nazwa pliku z treścią dokumentu, przekazywanego z programu do skryptu MIOD (PHP) MIOD_FILEFORHERM nazwa pliku z treścią dokumentu, przekazywanego ze skryptu MIOD do programu MIOD_PATH lokalny folder, w którym znajdują się pliki środowiska PHP (dll, php). Wykorzystując biblioteki dodatkowe, np. PHPMailer lub inne, dołączając plik php za pomocą klauzul require/include naleŝy uŝyć wskazane folderu. program PRG_MAGAZYN oznaczenie aktywnego magazynu baza danych DB_LOKAL lokalizacja podłączonej bazy danych w programie; nazwę uŝytkownika oraz hasło dostępu do serwera, na którym znajduje się baza danych, naleŝy uzyskać od administratora systemu operator OPR_ID nr (ID) zalogowanego operatora HermesNG OPR_OPERATOR nazwa zalogowanego operatora HermesNG
HermesNG MIOD opis modułu 10 BieŜący dokument bieŝący kontrahent DOK_DOKUMENT symbol edytowanego dokumentu; UWAGA! JeŜeli skrypt uruchamiany jest przed zapisaniem dokumentu w HermesNG, symbol moŝe ulec zmianie; JeŜeli symbol dokumentu, na potrzeby pracy skryptu jest znaczący, skrypt naleŝy uruchomić PO zapisaniu dokumentu w HermesNG. DOK_DOKZEWN symbol dokumentu zewnętrznego, powiązanego z edytowanym dokumentem DOK_DATA data dokumentu DOK_TERMIN termin płatności dokumentu DOK_SPOSOB sposób płatności dokumentu DOK_KON_ID numer (ID) kontrahenta powiązanego z dokumentem DOK_UWAGI uwagi dokumentu KON_ID numer (ID) kontrahenta; unikalny identyfikator, jednoznacznie wskazujący kontrahenta w systemie KON_PLATNIK nr (ID) płatnika kontrahenta KON_NAZWA nazwa kontrahenta (50 znaków) KON_CDNAZWA druga część nazwy kontrahenta (50 znaków) KON_ADRES adres kontrahenta; zgodny z wpisami w bazie HermesNG KON_NIP NIP kontrahenta
HermesNG MIOD opis modułu 11 4.2. Funkcje udostępniane przez HermesNG HermesNG uruchamiając i konfigurując silnik PHP, dodaje do środowiska funkcje umoŝliwiające sterowanie pracą programu lub systemu, wprost ze skryptu PHP. HNG_DialogOtworz - otwarcie standardowego okna windows, umoŝliwiającego uŝytkownikowi wybranie pliku do otwarcia Opis string HNG_DialogOtworz( string $scaption, string $sdefname, string $sfilter) Funkcja zwraca nazwę oraz ścieŝkę wybranego przez uŝytkownika pliku. Parametry scaption Tekst w nagłówku okna jaki zostanie wyświetlony. sdefname Domyślna, proponowana nazwa pliku. sfilter Dostępne rozszerzenia (filtry) plików. KaŜdy filtr (typ) składa się z dwóch części: opisowej widocznej dla uŝytkownika na liście dostępnych plików, np. Pliki XML (.xml) definicji filtru sposób w jaki system będzie filtrować widoczne pliki, np. *.xml Części filtru oddzielane są znakiem, np. Pliki XML (*.xml) *.xml W przypadku kilku filtrów, kaŝdy z nich równieŝ naleŝy rozdzielić znakiem. np. Pliki XML (*.xml) *.xml Wszystkie pliki (*.*) *.* Przykład <?php $nazwa_pliku = HNG_DialogOtworz("Wybierz plik do importu ", "przyjecie.xml", "Pliki XML(*.xml) *.xml Wszystkie pliki(*.*) *.*");?> Wynik działania:
HermesNG MIOD opis modułu 12
HermesNG MIOD opis modułu 13 HNG_DialogZapisz - otwarcie standardowego okna windows, umoŝliwiającego uŝytkownikowi wybranie pliku do zapisu Opis string HNG_DialogZapisz ( string $scaption, string $sdefname, string $sfilter) Funkcja zwraca nazwę oraz ścieŝkę wybranego przez uŝytkownika pliku do zapisu. Funkcja sprawdza czy wskazany plik istnieje i ostrzega operatora przez próbą nadpisania pliku. Parametry scaption Tekst w nagłówku okna jaki zostanie wyświetlony. sdefname Domyślna, proponowana nazwa pliku. sfilter Dostępne rozszerzenia (filtry) plików. KaŜdy filtr (typ) składa się z dwóch części: opisowej widocznej dla uŝytkownika na liście dostępnych plików, np. Pliki XML (.xml) definicji filtru sposób w jaki system będzie filtrować widoczne pliki, np. *.xml Części filtru oddzielane są znakiem, np. Pliki XML (*.xml) *.xml W przypadku kilku filtrów, kaŝdy z nich równieŝ naleŝy rozdzielić znakiem. np. Pliki XML (*.xml) *.xml Wszystkie pliki (*.*) *.*
HermesNG MIOD opis modułu 14 Przykład <?php $nazwa_pliku = HNG_DialogZapisz ("Wybierz plik do zapisu dokumentu", "wydanie.xml", "Pliki XML(*.xml) *.xml Wszystkie pliki(*.*) *.*");?> Wynik działania:
HermesNG MIOD opis modułu 15 HNG_Komunikat wyświetlenie komunikatu z wybranym tekstem. Opis void HNG_Komunikat ( string $smsg, string $scaption) Funkcja wyświetla okno z komunikatem. Parametry smsg Tekst wyświetlanego komunikatu. scaption Tytuł okna z komunikatem. Przykład <?php HNG_Komunikat( "Dokument \"".$DOK_DOKUMENT."\" został zapisany i jest gotowy do wysłania", "Przygotowano!");?> Wynik działania:
HermesNG MIOD opis modułu 16 HNG_WprowadzParametr przez operatora wartości. wyświetlenie komunikatu z prośbą o wpisanie Opis string HNG_WprowadzParametr ( string $scaption, string $sprompt, [string $stekst]) Funkcja zwraca wartość wpisaną przez uŝytkownika Funkcja wyświetla okno z komunikatem. Parametry scaption Tytuł okna. sprompt Tekst komunikatu. stekst Tekst wpisany do pola edycyjnego. Przykład <?php $eml=hng_wprowadzparametr( 'Podaj adres', 'Podaj adres e-mail kontrahenta!', 'mail@mail.pl' );?> Wynik działania:
HermesNG MIOD opis modułu 17 HNG_WybierzParametr wyświetlenie okna, w którym uŝytkownik będzie miał moŝliwość wskazania odpowiedniego parametru. Opis string HNG_WybierzParametr ( string $scaption, string $sprompt, string $sinputvalue) Funkcja zwraca wartość wpisaną przez uŝytkownika Funkcja wyświetla okno z komunikatem. Parametry scaption Tytuł okna. sprompt Tekst komunikatu. sinputvalue Wartości, które mają pojawić się na liście rozwijalnej. Uwaga! Przekazywane wartości muszą być rozdzielone znakiem ; Przykład <?php $miasto = HNG_WybierzParametr( 'Lokalizacja', 'Miasto', 'Warszawa;Kraków;Rzeszów');?> Wynik działania:
HermesNG MIOD opis modułu 18 HNG_Powiadom dodanie powiadomienia, do listy informacyjnej o stanie wykonania skryptu MIOD, wyświetlanej w HermesNG. Opis void HNG_Powiadom (string $smsg) Dodaje powiadomienie do listy ze statusem wykonania modułu MIOD. Parametry smsg Tekst powiadomienia. Przykład <?php HNG_Powiadom("Dokument został wysyłany na adres \"adres@test.pl\"!");?> Wynik działania:
HermesNG MIOD opis modułu 19 HNG_ZnajdzTowar odnalezienie pozycji magazynowej, na podstawie danych podstawowych kartoteki. Opis integer HNG_ZnajdzTowar ( string $sartykul, string $sindeks, string $skreski) Funkcja na podstawie indeksu oraz kodu kreskowego, odnajduje w bieŝącym magazynie kartotekę magazynową. W przypadku braku kartoteki lub występowania kilku kartotek z tym samym indeksem lub kodem kreskowym, uŝytkownik zostanie poproszony o wybranie kartoteki z listy. Funkcja zwraca unikalny identyfikator (POZ) kartoteki magazynowej. Parametry sartykul Nazwa artykułu. Niewykorzystywana przy szukaniu, wyświetlana uŝytkownikowi, w celu identyfikacji kartoteki. sindeks skreski Indeks artykułu. Wykorzystywany podczas wyszukiwania kartoteki. Długość max 12 znaków. Kod kreskowy (EAN13) artykułu. Wykorzystywany podczas wyszukiwania kartoteki, jako pole uzupełniające w przypadku gdy indeks nie został odnaleziony. Długość max 13 znaków. Przykład <?php $POZ=HNG_ZnajdzTowar("TOWAR TESTOWY1","IND0123","9012349012348");?>
HermesNG MIOD opis modułu 20 HNG_ZnajdzTowarEx odnalezienie pozycji magazynowej, na podstawie indeksu zewnętrznego (dostawcy/odbiorcy). Opis integer HNG_ZnajdzTowarEx( string $sartykul, string $sindzewn, integer $ikon, string $skontyp) Funkcja na podstawie indeksu zewnętrznego, powiązanego z dostawcą lub odbiorcą odnajduje w bieŝącym magazynie kartotekę magazynową. W przypadku braku kartoteki lub występowania kilku kartotek z tym samym indeksem, uŝytkownik zostanie poproszony o wybranie kartoteki z listy. Funkcja zwraca unikalny identyfikator (POZ) kartoteki magazynowej. Parametry sartykul Nazwa artykułu. Niewykorzystywana przy szukaniu, wyświetlana uŝytkownikowi, w celu identyfikacji kartoteki. sindzewn ikon Indeks zewnętrzny artykułu. Wykorzystywany podczas wyszukiwania kartoteki. Długość max 20 znaków. Identyfikator (KON) kontrahenta, którego indeksy powiązane zostaną przeszukane. skontyp Typ kontrahenta: O odbiorca D dostawca Przykład <?php $POZ=HNG_ZnajdzTowarEx("TOWAR TESTOWY1","XYZ/123/WK0",1,"O");?>
HermesNG MIOD opis modułu 21 HNG_CzyscDokument usuwa treść bieŝącego dokumentu. Opis void HNG_CzyscDokument(void) Funkcja usuwa treść bieŝącego dokumentu. Przed usunięciem pozycji, uŝytkownik zostanie poproszony o potwierdzenie operacji. Parametry brak Przykład <?php HNG_CzyscDokument();?>
HermesNG MIOD opis modułu 22 HNG_DopiszDoPrzyjecia przyjęcia. dopisanie pozycji do treści dokumentu Opis integer HNG_DopiszDoPrzyjecia( integer $ipoz, string $sartykul, string $sindeks, float $filosc, float $fcenazakup, float $fodchylenie, string $svat, string $sseria, string $sdatawazn, string $skreski, float $frecykling) Funkcja dodaje do treści dokumentu przyjęcia nową pozycję. Funkcja zwraca identyfikator kartoteki (POZ), w przypadku błędu zwracana jest wartość zero (false). Parametry ipoz Unikalny identyfikator kartoteki. MoŜe być przekazany jako 0 (zero), wtedy kartoteka zostanie odnaleziona na podstawie indeksu i kodu kreskowego (podobnie jak w przypadku HNG_ZnajdzTowar). sartykul sindeks Nazwa artykułu. Indeks artykułu. Wykorzystywany podczas wyszukiwania kartoteki, w przypadku, gdy $ipoz=0. filosc Przyjmowana ilość. fcenazakup fodchylenie Cena zakupu przyjmowanej pozycji. Odchylenia (róŝnica między ceną zakupu na dok. oryginalnym a ceną zakupu realizowaną) dla pozycji. svat sseria Stawka VAT z jaką przyjmowana jest pozycja. Nr serii/nr unikatowy/atest przyjmowanej partii sdatawazn skreski Data waŝności przyjmowanej partii.
HermesNG MIOD opis modułu 23 frecykling Kod kreskowy przyjmowanej partii. Wykorzystywany podczas wyszukiwania kartoteki, w przypadku, gdy $ipoz=0. Wartość kosztów recyklingu partii towaru. Przykład 1 <?php $POZ= HNG_DopiszDoPrzyjecia(1891, "TOWAR TESTOWY1", "IND0123", 5.00, 12.01, 0.00, "22.00", "", "20090101", "9012349012348", 0.00);?> Przykład 2 <?php HNG_CzyscDokument(); $POZ=HNG_ZnajdzTowar("TOWAR TESTOWY1","IND0123","9012349012348"); if ($POZ!=0) { $POZ=HNG_DopiszDoPrzyjecia( $POZ, "TOWAR TESTOWY1", "IND0123", 5.00, 12.01, 0.00, "22.00", "", "20090101", "9012349012348", 0.00); if ($POZ!=0) { HNG_Komunikat("Dopisano pozycję do dokumentu!", "Dopisano!"); } }?>
HermesNG MIOD opis modułu 24 HNG_DopiszDoZamowieniaODB zamówienia od odbiorcy. dopisanie pozycji do treści dokumentu Opis integer HNG_DopiszDoZamowieniaODB( integer $ipoz, string $sartykul, string $sindeks, string $skreski float $filosc, float $fcenanetto, string $sindekszewn) Funkcja dodaje do treści dokumentu zamówienia nową pozycję. Funkcja zwraca identyfikator kartoteki (POZ), w przypadku błędu zwracana jest wartość zero (false). Parametry ipoz Unikalny identyfikator kartoteki. MoŜe być przekazany jako 0 (zero), wtedy kartoteka zostanie odnaleziona na podstawie indeksu i kodu kreskowego (podobnie jak w przypadku HNG_ZnajdzTowar). sartykul Nazwa artykułu. sindeks skreski Indeks artykułu. Wykorzystywany podczas wyszukiwania kartoteki, w przypadku, gdy $ipoz=0. Kod kreskowy artykułu. ffilosc Ilość zamawianej pozycji. fcenanetto Cena netto zamawianej pozycji (chwilowo nie wykorzystywana) sindekszewn Indeks zewnętrzny artykułu.
HermesNG MIOD opis modułu 25 Przykład 1 <?php $POZ = HNG_DopiszDoZamowieniaODB( 1891, "TOWAR TESTOWY1", "IND0123", "5901597860433", 12, 2.55, "");?>
HermesNG MIOD opis modułu 26 HNG_DopiszDoRozchodu dopisanie pozycji do treści dokumentu zamówienia od odbiorcy. Opis integer HNG_DopiszDoRozchodu( integer $ipoz, string $sartykul, string $sindeks, string $skreski float $filosc, float $fcenanetto, string $sindekszewn) Funkcja dodaje do treści dokumentu rozchodu nową pozycję. Funkcja zwraca identyfikator kartoteki (POZ), w przypadku błędu zwracana jest wartość zero (false). Parametry ipoz Unikalny identyfikator kartoteki. MoŜe być przekazany jako 0 (zero), wtedy kartoteka zostanie odnaleziona na podstawie indeksu i kodu kreskowego (podobnie jak w przypadku HNG_ZnajdzTowar). sartykul Nazwa artykułu. sindeks skreski Indeks artykułu. Wykorzystywany podczas wyszukiwania kartoteki, w przypadku, gdy $ipoz=0. Kod kreskowy artykułu. ffilosc Ilość pozycji. fcenanetto Cena netto zamawianej pozycji. sindekszewn Indeks zewnętrzny artykułu.
HermesNG MIOD opis modułu 27 Przykład 1 <?php $POZ = HNG_DopiszDoRozchodu( 1891, "TOWAR TESTOWY1", "IND0123", "5901597860433", 12, 2.55, "");?>
HermesNG MIOD opis modułu 28 HNG_ZnajdzDostawce odnalezienie identyfikatora dostawcy na podstawie danych podstawowych. Opis integer HNG_ZnajdzDostawce( integer $ikon, string $snazwa, string $skod, string $smiasto string $sulica, string $snip, string $scecha) Funkcja na podstawie przekazanych informacji, odnajduje kartotekę dostawcy. W przypadku braku kartoteki lub występowania kilku kartotek spełniających zadane kryterium, uŝytkownik zostanie poproszony o wybranie dostawcy z listy. Funkcja zwraca identyfikator dostawcy, w przypadku błędu zwracana jest wartość zero (false). Parametry ikon Unikalny identyfikator dostawcy. MoŜe być przekazany jako 0 (zero), wtedy dostawca zostanie odnaleziona na podstawie pozostałych informacji. snazwa Nazwa dostawcy. skod Kod pocztowy dostawcy smiasto Miasto dostawcy. sulica Ulica dostawcy. snip NIP dostawcy. scecha Cecha dostawcy.
HermesNG MIOD opis modułu 29 Przykład 1 <?php $ikon = HNG_ZnajdzDostawce( 0, "TEST", "35-123", "Rzeszów", "SPORTOWA", "800-110-10-20", "");?>
HermesNG MIOD opis modułu 30 HNG_ZnajdzOdbiorce odnalezienie identyfikatora odbiorcy na podstawie danych podstawowych. Opis integer HNG_ZnajdzOdbiorce( integer $ikon, string $snazwa, string $skod, string $smiasto string $sulica, string $snip, string $scecha) Funkcja na podstawie przekazanych informacji, odnajduje kartotekę odbiorcy. W przypadku braku kartoteki lub występowania kilku kartotek spełniających zadane kryterium, uŝytkownik zostanie poproszony o wybranie odbiorcy z listy. Funkcja zwraca identyfikator odbiorcy, w przypadku błędu zwracana jest wartość zero (false). Parametry ikon Unikalny identyfikator odbiorcy. MoŜe być przekazany jako 0 (zero), wtedy odbiorca zostanie odnaleziona na podstawie pozostałych informacji. snazwa Nazwa odbiorcy. skod Kod pocztowy odbiorcy. smiasto Miasto odbiorcy. sulica Ulica odbiorcy. snip NIP odbiorcy. scecha Cecha odbiorcy.
HermesNG MIOD opis modułu 31 Przykład 1 <?php $ikon = HNG_ZnajdzOdbiorce( 0, "TEST", "35-123", "Rzeszów", "SPORTOWA", "800-110-10-20", "");?>
HermesNG MIOD opis modułu 32 HNG_RozpocznijDokument przekazuje podstawowe informacji wypełniane podczas tworzenia nagłówka dokumentu. (MoŜe być uŝywana zarówno po stronie rozchodu jak i przychodu). Opis integer HNG_RozpocznijDokument( string $sdokument, integer $ikonid, string $sdata, string $stermin string $sdokzewn, string $suwagi) Funkcja przekazuje do programu podstawowe informacje, które zostaną umieszczone w nagłówku dokumentu. Funkcja zwraca symbol dokumentu, w przypadku błędu zwracana jest wartość pustą. Parametry sdokument Symbol dokumentu jaki ma zostać wprowadzony, jeŝeli parametr ten będzie pusty to symbol zostanie wygenerowany automatycznie. skonid Identyfikator kontrahenta, na którego będzie wystawiany dokument sdata Data dokumentu stermin Termin dokumentu sdokzewn Symbol dokumentu zewnętrznego suwagi Uwagi
HermesNG MIOD opis modułu 33 Przykład 1 <?php $sdoksymbol = HNG_RozpocznijDokument( "", 123, "2009.09.14", "2009.09.14", "FV00/11/22", "brak uwag");?>
HermesNG MIOD opis modułu 34 HNG_DokZewnExist Sprawdza czy w systemie istnieje dokument, który posiada powiązanie z dokumentem zewnętrznym. Opis integer HNG_DokZewnExist( string $sdokzewn, string $styp) Funkcja przekazuje do programu podstawowe informacje, które zostaną umieszczone w nagłówku dokumentu. Funkcja zwraca 1 jeŝeli istnieje dokument powiązany z danym dokumentem zewnętrznym lub 0 jeŝeli takiego dokumentu nie ma. Parametry sdokzewn Symbol dokumentu zewnętrznego. styo Typ: O = odbiorca D = dostawca Przykład 1 <?php $iexist = HNG_DokZewnExist( "Fv00/11/22", "O");?>
HermesNG MIOD opis modułu 35 5. IMPORT/EXPORT TREŚCI DOKUMENTU Treść dokumentu moŝe być importowana lub eksportowana, za pomocą plików pośredniczących DBF lub poprzez funkcje udostępniane przez HermesNG (np. HNG_DopiszDoPrzyjecia ). 5.1. Wymiana treści przez pliki Stosując wymianę treści dokumentów za pomocą plików, w trakcie importu, HermesNG odczytuje lokalny plik DBF przygotowany przez skrypt MIOD; w trakcie eksportu HermesNG przygotowuje plik DBF, przekazując go do skryptu MIOD. Lokalizacja plików DBF, z treścią dokumentu, przekazywana jest przez parametry globalne MIOD (patrz 4.1. Zmienne globalne). MIOD_FILEFORHERM lokalizacja pliku importu danych; skrypt PHP, przygotowując DBF a z treścią dokumentu, musi ustawiać ten parametr, MIOD_FILEFROMHERM lokalizacja pliku eksportu danych; skrypt PHP powinien odczytać parametr w celu otwarcia pliku z treścią dokumentu. 5.1.1. Format plików importu Pliki importu treści do HermesNG, w zaleŝności od przeznaczenia (przyjęcie, rozchód) mają róŝne formaty. 5.1.1.1. Format przyjęcia Nazwa pola Typ Opis unikalny identyfikator pozycji w magazynie HermesNG; POZ int w przypadku pustego pola lub wartości 0 (zero), system podejmie próbę odnalezienia pozycji magazynowej, wg pól: indeks, kreski, ind_zewn ARTYKUL char(50) nazwa artykułu INDEKS char(12) indeks artykułu w bazie HermesNG KRESKI char(13) kod kreskowy przyjmowanej partii towaru JM char(3) jednostka miary ILOSC float przyjmowana ilość CENA_ZAKUP float cena zakupu przyjmowanej partii VAT char(5) stawka VAT w jakiej przyjmowana jest pozycja ODCHYLENIE float odchylenie w cenie zakupu dla przyjmowanej pozycji DATA_WAZN char(10) data waŝności przyjmowanej partii SERIA char(15) seria/atest partii IND_ZEWN char(30) indeks zewnętrzny, powiązany z aktywnym dostawcą, wykorzystywany przy wyszukiwaniu kartoteki w magazynie
HermesNG MIOD opis modułu 36 5.1.2. Format plików eksportu dokumentu. Pliki eksportu posiadają wszystkie pola, dostępne w HermesNG, podczas edycji 5.2. Wymiana treści za pomocą funkcji udostępnionych Funkcje udostępnione umoŝliwiają skryptom PHP, bezpośrednie kierowanie pracą HermesNG, np. funkcja HNG_DopiszDoPrzyjecia dodaje do treści dokumentu nową pozycję, bez konieczności uŝycia plików pośredniczących. Aby HermesNG, pomijał plik importu, naleŝy parametr MIOD_FILEFORHERM ustawić na wartość NIE_DOTYCZY. 6. ŚRODOWISKO PHP Import/eksport danych MIOD, wykorzystuje skrypty pisane w języku PHP. Nie jest konieczna dodatkowa instalacja środowiska PHP na stanowisku gdzie pracuje HermesNG. Przed wykonaniem skryptu PHP, HermesNG sprawdza czy dostępne są wszystkie pliki i biblioteki wymagane do uruchomienia PHP. Pliki silnika PHP, znajdują się w \folder Hermesa\PHP\. Domyślne środowisko PHP, skonfigurowane jest do uŝywanie modułów dostępnych w dystrybucji HermesNG (sekcja [Dynamic Extensions] w php.ini). JeŜeli w trakcie tworzenia skryptu, zajdzie konieczność uŝycia funkcji z innych modułów, naleŝy odpowiedni pliki wgrać do ww. folderu oraz odpowiednio zmodyfikować plik php.ini (wg instrukcji do PHP). Aby przywrócić standardową instalację PHP wraz z domyślnymi ustawieniami, jaka dostępna jest w HermesNG, naleŝy usunąć folder PHP\ z katalogu, w którym zainstalowany jest Hermes. 6.1. Moduły standardowo dostarczane wraz z HermesNG 6.1.1. Rozszerzenia dynamiczne DLL php_dbase.dll php_interbase.dll php_zip.dll 6.1.2. Klasy/pliki PHP PHPMailer więcej informacji na http://phpmailer.sourceforge.net