Dokumentacja techniczna dostępnych makr w szablonach dokumentów umów systemu GW-MAX

Transkrypt

1 Dokumentacja techniczna dostępnych makr w szablonach dokumentów umów systemu GW-MAX Szablon dokumentu umowy czy korespondencji jest standardowym dokumentem o ustalonym formacie gdzie występuje stały tekst i makra. Makra w takim dokumencie reprezentują informacje z bazy danych. Proces tworzenia dokumentu jest procesem zamiany nazwy makra na reprezentującą makro informacje z bazy danych. Po przetworzeniu wszystkich makr powstaje nowy dokument. Dostępne są następujące predefiniowane typy: html rtf PS Txt Inny/Różny Makra specjalne ^date_printer macro^ ^clock_printer macro^ ^newid macro^ ^uid macro^ ^uid_rule macro^ ^uid_name macro^ ^uid_surname macro^ ^uid_surname_name macro^ ^uid_master macro^ ^uid_name_prefix macro^ ^db macro^ ^db_xl macro^ ^db_optima macro^ ^server macro^ ^version_software macro^ ^modul_software macro^ ^full_name_modul macro^ ^windows_version macro^ ^sql_host_id macro^ ^workstation macro^ Bieżąca data przygotowania dokumentu (format krótkiej daty z konfiguracji Windows) Bieżąca godzina przygotowania dokumentu (format gg:mm:ss) Niepowtarzalny identyfikator na 26 znakach (format A9D5BCC A0D-BC5D- 151A36A30ADD) Identyfikator bieżącego operatora Rola (tekst) bieżącego operatora Imię bieżącego operatora Nazwisko bieżącego operatora Nazwisko i imię bieżącego operatora Przełożony bieżącego operatora Tytuł grzecznościowy bieżącego operatora Nazwa bazy danych serwera SQL Nazwa bazy danych serwera SQL systemu Comarch CDN XL Nazwa bazy danych serwera SQL systemu Comarch Optima Nazwa lub adres IP serwera SQL Pełna nazwa systemu GW-MAX Skrócona nazwa modulu systemu GW-MAX Pełna nazwa systemu GW-MAX Pełna nazwa systemu operacyjnego Wartość zmienne SQL HOST_ID dla bieżącej identyfikacji Nazwa stacji roboczej z konfiguracji GW-MAX ^opis s^ pozwalające na wprowadzenie dowolnego ciągu znaków (max 200 zn.) ^opis sml^ pozwalające na wprowadzenie dowolnego tekstu znaków (max 2048 zn.) w tym CR i NL ^opis d^ pozwalające na wprowadzenie daty, zwraca format rrrr/mm/dd ^opis d1^ pozwalające na wprowadzenie daty, zwraca format daty clariona ^opis i^ pozwalające na wprowadzenie liczby całkowitej ^opis b^ pozwalające wybór tak lub nie (tak zwraca 1 nie 0) ^opis n^ pozwalające na wprowadzenie kwoty (max 13.2) format kwoty ^opis mr^ pozwalające na wprowadzenie miesiąca i roku, zwracające ilość miesięcy liczona mc+(rok*12) ^opis t^ pozwalające na wprowadzenie godziny w formacie Clariona ^opis f^ Macro pozwalające na wybór filtra z słownika (po aktualnej nazwie procedury). zwraca poprawny filtr SQL

2 ^opis yko^ ^opis yo^ ^opis yrob^ ^opis yw^ ^opis yctu^ ^opis yc^ ^opis ysb^ ^opis ysw^ ^opis ysp^ ^opis ysg^ ^opis ysm^ ^opis ysd^ ^opis ysu^ ^opis yro^ ^opis yka^ ^opis ykb^ ^opis ykc^ ^opis ykd^ ^opis yke^ ^opis ykf^ wyboru z listy kontrahentów (YKO_Akronim 20zn.) wyboru z listy obiektów (YO_Akronim 20 zn.) wyboru z listy formuł obciążeń (YROB_Akronim 20 zn.) wyboru z listy wodomierzy (YW_NrKartoteki 20 zn.) wyboru z cennika towarów i usług (YCTU_Symbol 20 zn.) wyboru z cennika Wod/Kan (YC_Symbol 5 zn.) wyboru z listy struktur bilansowych (YSB_NrKartoteki 20 zn.) wyboru z słownika województw, zwraca nazwę województwia (YSW_Nazwa 30 zn.) wyboru z słownika powiatów, zwraca nazwę powiatu (YSP_Nazwa 30 zn.) wyboru z słownika gmin, zwraca nazwę gminy (YSG_Nazwa 30 zn.) wyboru z słownika miejscowości, zwraca nazwę miejscowości (YSM_Nazwa 30 zn.) wyboru z słownika dzielnic, zwraca nazwę dzielnicy (YSD_Nazwa 30 zn.) wyboru z słownika ulic, zwraca nazwę ulicy (YSU_Nazwa 30 zn.) wyboru z słownika rejonów, zwraca nazwę rejonu (YRO_Nazwa 30 zn.) wyboru z słownika klasyfikatora A (YKA_Nazwa 30 zn.) wyboru z słownika klasyfikatora B (YKB_Nazwa 30 zn.) wyboru z słownika klasyfikatora C (YKC_Nazwa 30 zn.) wyboru z słownika klasyfikatora D (YKD_Nazwa 30 zn.) wyboru z słownika klasyfikatora E (YKE_Nazwa 30 zn.) wyboru z słownika klasyfikatora F (YKF_Nazwa 30 zn.) ^nazwa_formuły formula^ ^nazwa_licznika nlicznik^ ^nazwa_licznika alicznik^ Formułą SQL zdefiniowana w słowniku formuł SQL, poleceniu SQL są dostępne następujące makra: ^yko:id macro^ - pole yko_id, ^yuk:id macro^ - pole yuk_id (oczywiście jeżeli dany kontekst wywołania jest odpowiedni) Wartość reprezentująca następny element licznika o nazwie nazwa_licznika. (Lp licznika zostanie inkrementowane) jest ekwiwalentem funkcji NLicznik(<nazwa_licznika>) w formule wydruków Wartość reprezentująca następny element licznika o nazwie nazwa_licznika. jest ekwiwalentem funkcji ALicznik(<nazwa_licznika>) w formule wydruków

3 Makra reprezentujące informacje z bazy danych są dostępne w określonym kontekście (pozycji) wywołania. W systemie są dostępne następujące konteksty wywołania: K Kontrahent U Umowa A - Aneks Kontekst ^yuk:nr_umowy macro^ U Nr umowy ^yuk:typ_umowy macro^ U Typ umowy ^yuk:data_zawarta macro^ U Data zawarcia umowy (format krótkiej daty z konfiguracji Windows) ^yuk:data_obowiazuje_od macro^ U Data od kiedy obowiązuje umowa ^yuk:data_obowiazuje_do macro^ U Data od kiedy obowiązuje umowa (jak data jest pusta to makro jest reprezentowane tekstem bezterminowo ) ^yuk:data_aneks_termin macro^ U Data przedłużenia obowiązywania umowy (wynikająca z aneksu) ^yuk:uwagi macro^ U Uwagi z kartoteki umowy Kontekst ^yauk:nr_aneksu^ A,U,K Nr Aneksu ^yauk:status^ A,U,K Status aneksu ^yauk:data_zawarta^ A,U,K Data zawarcia aneksu (format krótkiej daty z konfiguracji Windows) ^yauk:data_obowiazuje_od^ A,U,K Data od kiedy obowiązuje aneks ^yauk:data_obowiazuje_do^ A,U,K Data do kiedy obowiązuje aneks (jak data jest pusta to makro jest reprezentowane tekstem bezterminowo ) ^yauk:uwagi^ A,U,K Uwagi z kartoteki aneksu Kontekst ^yu:adres1 macro^ U,K Adres z kartoteki użytkownika systemu GW-MAX w ^yu:adres2 macro^ U,K Adres z kartoteki użytkownika systemu GW-MAX w, ^yu:nazwa macro^ U,K Pełna nazwa z kartoteki użytkownika systemu GW-MAX ^yu:nip macro^ U,K Nr NIP z kartoteki użytkownika systemu GW-MAX ^yu:regon macro^ U,K Nr Regon z kartoteki użytkownika systemu GW-MAX ^yu:miasto macro^ U,K Miejscowość z kartoteki użytkownika systemu GW-MAX ^yu:ulica macro^ U,K Ulica z adresu kartoteki użytkownika systemu GW-MAX ^yu:kod_poczta macro^ U,K Kod pocztowy z adresu kartoteki użytkownika systemu GW-MAX ^yu:poczta macro^ U,K Poczta z adresu kartoteki użytkownika systemu GW-MAX ^yu:nrdomu macro^ U,K Nr Domu z adresu kartoteki użytkownika systemu GW-MAX ^yu:nrlokalu macro^ U,K Nr Lokalu z adresu kartoteki użytkownika systemu GW-MAX ^yu:tel1 macro^ U,K Telefon (1) z adresu kartoteki użytkownika systemu GW-MAX ^yu:tel2 macro^ U,K Telefon (2) z adresu kartoteki użytkownika systemu GW-MAX ^yu:tel3 macro^ U,K Telefon (3) z adresu kartoteki użytkownika systemu GW-MAX ^yu:fax macro^ U,K Nr Fax z kartoteki użytkownika systemu GW-MAX ^yu: macro^ U,K z kartoteki użytkownika systemu GW-MAX ^yu:www macro^ U,K URL z kartoteki użytkownika systemu GW-MAX Kontekst ^yko:akronim macro^ U,K Akronim kontrahenta ^yko:adres1 macro^ U,K Adres kontrahenta w ^yko:adres2 macro^ U,K Adres kontrahenta w ^yko:adres3 macro^ U,K Adres kontrahenta w

4 ^yko:adres4 macro^ U,K Adres kontrahenta w ^yko:nazwa macro^ U,K Pełna z kartoteki kontrahenta ^yko:nip macro^ U,K Nr NIP z kartoteki kontrahenta ^yko:regon macro^ U,K Nr REGON z kartoteki kontrahenta ^yko:pesel macro^ U,K Nr PESEL z kartoteki kontrahenta ^yko:pesel2 macro^ U,K Nr PESEL 2 z kartoteki kontrahenta ^yko:nrdowod macro^ U,K Nr Dowodu Osobistego z kartoteki kontrahenta ^yko:dowod_wydany macro^ U,K Kto wydał dowód osobisty z kartoteki kontrahenta ^yko:dowod_wydany_data macro^ U,K Data wydania dowodu osobistego z kartoteki kontrahenta ^yko:nrdowod2 macro^ U,K Nr Dowodu Osobistego 2 z kartoteki kontrahenta ^yko:dowod_wydany2 macro^ U,K Kto wydał dowód osobisty 2 z kartoteki kontrahenta ^yko:dowod_wydany_data2 macro^ U,K Data wydania dowodu osobistego 2 z kartoteki kontrahenta ^yko:krs macro^ U,K Nr Wpisu do działalności KRS ^yko:miasto macro^ U,K Miejscowość z adresu kartoteki kontrahenta ^yko:ulica macro^ U,K Ulica z adresu kartoteki kontrahenta ^yko:kod_poczta macro^ U,K Kod pocztowy z adresu kartoteki kontrahenta ^yko:poczta macro^ U,K Poczta z adresu kartoteki kontrahenta ^yko:nrdomu macro^ U,K Nr Domu z adresu kartoteki kontrahenta ^yko:nrlokalu macro^ U,K Nr Lokalu z adresu kartoteki kontrahenta ^yko:tel1 macro^ U,K Telefon (1) z adresu kartoteki kontrahenta ^yko:tel2 macro^ U,K Telefon (2) z adresu kartoteki kontrahenta ^yko:fax macro^ U,K Fax z adresu kartoteki kontrahenta ^yko:adr_uwagi macro^ U,K Uwagi z adresu kartoteki kontrahenta ^yko: macro^ U,K Adres poczty elektronicznej z kartoteki kontrahenta ^yko:url macro^ U,K Adres URL z kartoteki kontrahenta ^yko:kontofk macro^ U,K Konto rozliczeń należności z kartoteki kontrahenta ^yko:kontobank macro^ U,K Nr rachunku bankowego płatności masowych z kartoteki kontrahenta ^yko:uwagi macro^ U,K Uwagi z kartoteki kontrahenta ^yko:kor_adres1 macro^ U,K Adres korespondencyjny kontrahenta w ^yko:kor_adres2 macro^ U,K Adres korespondencyjny kontrahenta w ^yko:kor_adres3 macro^ U,K Adres korespondencyjny kontrahenta w ^yko:kor_adres4 macro^ U,K Adres korespondencyjny kontrahenta w ^yko:kor_nazwa macro^ U,K Pełna korespondencyjny z kartoteki kontrahenta ^yko:kor_miasto macro^ U,K Miejscowość adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_ulica macro^ U,K Ulica adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_kod_poczta macro^ U,K Kod pocztowy adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_poczta macro^ U,K Poczta adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_nrdomu macro^ U,K Nr Domu adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_nrlokalu macro^ U,K Nr Lokalu adresu korespondencyjnego z kartoteki kontrahenta ^yko:kor_tel1 macro^ U,K Telefon (1) z adresu korespondencyjnego kontrahenta ^yko:kor_tel2 macro^ U,K Telefon (2) z adresu korespondencyjnego kontrahenta ^yko:kor_uwagi macro^ U,K Uwagi z adresu korespondencyjnego kontrahenta Kontekst ^yo:akronim macro^ U 1 Akronim obiektu z umowy ^yo:nazwa macro^ U 1 Pełna u obiektu z umowy ^yo:miasto macro^ U 1 Miejscowość z adresu obiektu umowy ^yo:ulica macro^ U 1 Ulica z adresu obiektu umowy ^yo:kod_poczta macro^ U 1 Kod pocztowy z adresu obiektu umowy ^yo:poczta macro^ U 1 Poczta z adresu obiektu umowy ^yo:nrdomu macro^ U 1 Nr Domu z adresu obiektu umowy ^yo:nrlokalu macro^ U 1 Nr Lokalu z adresu obiektu umowy ^yo:tel1 macro^ U 1 Telefon (1) z adresu obiektu umowy

5 ^yo:tel2 macro^ U 1 Telefon (2) z adresu obiektu umowy ^yo:fax macro^ U 1 Fax z adresu obiektu umowy ^yo:uwagi macro^ U 1 Uwagi z adresu obiektu umowy ^yo:symbol_obcy macro^ U 1 Symbol obcy na kartotece obiektu z umowy ^yo:sekcja_mapy macro^ U 1 Sekcja mapy na kartotece obiektu z umowy ^yo:nrinwentarzowy macro^ U 1 Nr Inwentarzowy na kartotece obiektu z umowy ^yo:wlasnosc_tytul macro^ U 1 Tytuł własności na kartotece obiektu z umowy ^yo:wlasnosc_opis macro^ U 1 do własności na kartotece obiektu z umowy ^yo:ilosc_osob macro^ U 1 Ilość osób w lokalu/obiekcie ^yo:powierzchnia_lokalu macro^ U 1 Powierzchnia lokalu/obiektu ^yo:adres1 macro^ U,K Adres obiektu w ^yo:adres2 macro^ U,K Adres obiektu w ^yo:adres3 macro^ U,K Adres obiektu w ^yo:adres4 macro^ U,K Adres obiektu w ^lista:yo:adres2 macro^ U,K Lista adresów obiektów będących w eksploatacji bieżącego kontrahenta w ^lista:yo:adres3 macro^ U,K Lista adresów obiektów będących w eksploatacji bieżącego kontrahenta w ^lista:yo:adres4 macro^ U,K Lista adresów obiektów będących w eksploatacji bieżącego kontrahenta w 1 wartość makra jest dostępna, jeżeli kartotece umowy mamy dopisany akronim obiektu Uwagi: Makra źle wpisane są pokazywane w następujący sposób (*** BŁĄD, nieznane makro=tutaj_źle_wpisane_makro ***). Należy pamiętać aby wstawiane makra (czyli kody wartości zastępowanych pomiędzy znakami ^ daszka) nie rozdzielały różnych atrybutów formatów (typu czcionka czy pogrubienie). Jeżeli jest potrzeba, aby wartość makra miała jakiś atrybut to należy włączyć go przed znakiem ^ a wyłączyć po końcowym znakiem ^. Np. włączamy pogrubienie do makra bieżącej daty włączamy pogrubienie przed ^date_printer macro^ a wyłączamy po. Przy przetwarzaniu dokumentu RTF z szablonu do docelową postać zawartość pomiędzy znakami makra ^ (daszek) zostanie zastąpiona wartością z programu a atrybuty formatujące pozostaną (przed i po) i będą teraz formatowały nową wartość. Program został przetestowany z edytorem tekstu RTF WordPad z systemu Windows XP, ale istnieje wiele edytorów potrafiących redagować tekst w formacje RTF, z ciekawych jest to WinPad, AbiWord i na pewno wiele jeszcze. Jeżeli jest błąd w szablonie, polegający na wpisaniu znaku daszka (^) bez poprawnej nazwy makra a tekst zawarty po pierwszym znaku daszka (^) ma długość większą niż 64 znaki to cały akapit zostanie wycięty z dokumentu, jeżeli jest to lista punktowana to cała taka lista zostanie wycięta z dokumentu.