export_csv.aspx

Systemy działające w ramach StudioSystem można integrować z innymi systemami poprzez przekazywanie danych za pomocą plików z danymi. Jedną z wielu dostępnych opcji jest zapis danych do pliku tekstowego. Uniwersalna transakcja pozwalająca na eksportowanie dowolnych danych z bazy do pliku tekstowego typu CSV, TXT. Całość konfiguracji opiera się definicje skorowidza kod CSV.

Konfiguracja

Konfigurację ustawia się za pomocą skorowidza CSV. Definiując parametry opisujące stronę możemy używać własnych styli formatujących tekst zgodnych z HTML5, CSS3. Najprościej poprzez użycie tagów typu header <h1>, <h2> itp.

export_csv_konfiguracja

gdzie:

  • KOD – unikalny identyfikator, który przekazujemy jako parametr uruchamiając transakcję export_csv.aspx
  • TYP DANYCH – oznaczenie w jaki sposób będą rozdzielone poszczególne informacje, wstawiamy dowolny symbol np. średnik, przecinek itp. Jeżeli chcemy, aby znakiem rozdzielającym był znak tabulacji należy wpisać słowo TAB
  • CECHA – zapytanie do bazy SQL, które pobierze dane, które mają być wyeksportowane
  • OPIS CECHY – nazwa połączenia do bazy danych, zwykle baza główna (tzw root) czyli softwarestudioConnectionString lub baza indywidualna customConnectionString
  • PARAMETRY – lista parametrów i wartości rozczielona znakiem |. Parametry pozwalają sterować wyglądem i działaniem transakcji Np. folder=TempReports|plik=ImportMMW-@REFNO.txt|tytul=<h2>Eksport dokumentu Mm</h2>|pytanie=<h3>Czy utworzyć plik z danymi ?</h3>|button=Utwórz plik TXT|link=Pobierz plik|sukces=Plik został utworzony, kliknij na przycisk aby go pobrać.
    • folder – nazwa folderu w którym zostanie zapisany plik
    • plik – nazwa pliku
    • tytul – informacja wyświetlana jako główny nagłówek
    • pytanie – informacja wyświetlana jako środek informacji
    • button – tekst wyświetlny w przycisku do generowania pliku
    • link – parametr opcjonalny, jeżeli występuje to po utworzeniu pliku pojawi się przycisk w kolorze zielonym pozwalający na pobranie utworzonego pliku.
    • sukces – tekst jaki zostanie wyświetlony na środku okna po zakończeniu ekportu danych

Uruchomienie

Transakcję uruchamiamy z wymaganym parametrem kod np.

role_sys/export_csv.aspx?kod=VIS1

Opcjonalnie można przekazać parametr refno, który może być wykorzystany w zapytaniu do bazy np. jako warunek filtrujący, np.

role_sys/export_csv.aspx?kod=VIS1&refno=

Informacja o wykonanym eksporcie danych zapisywana jest w tabeli _historia z kodem CSV.

Parametry dodatkowe :

Autorun=1

Użycie parametru autorun spowoduje automatyczne utworzenie pliku csv, po uruchomieniu transakcji zostanie wyświetlony przycisk umożliwiający pobranie pliku.

Closewindow=1 oraz nSek=1500

Użycie powyższych parametrów spowoduje, że okno po kliknięciu przycisku odpowiedzialnego za pobranie pliku okno zostanie zamknięte po określonym czasie. nSek – parametr, w którym zapisywany jest czas opóźnienia zamkięcia okna w ms.

Przykład

export_csv_krok_1

 

export_csv_krok_2

 

Nazwa pliku

Tworząc plik możemy zdecydować o jego nazwie podając definicję nazwy pliku w parametrze plik.

Przykładowo, chcemy aby każdorazowo dane były zapisywane w pliku o stałej nazwie np. dokument-mm.csv, to wpisujemy

plik=dokument-mm.csv

Istnieje możliwość dynamicznego tworzenia nazw pliku w oparciu o podanie zmiennych np. chcemy aby częścią nazwy pliku był numer referencyjny wówczas definiujemy parametr plik następująco:

plik=dokument-mm-@REFNO.csv

W efekcie utworzony plik może przyjąć następującą postać: dokument-mm-1234567890.csv

Kolejny przykład chcemy, aby w nazwie pliku pojawiła się informacja o dacie jego utworzenia

plik=dokument-@DATA-mm-@REFNO.csv

W efekcie otrzymać możemy plik: dokument-201605-14-mm-1234567893.csv

Poniżej lista zmiennych jakie można wykorzystać przy projektowaniu nazwy pliku:

  • @REFNO – podstawiana jest wartość przekazanego parametru refno
  • @KTO – nazwa użytkownika, który tworzy plik (login)
  • @DATA – skrócona data utworzenia pliku np. 2016-05-14
  • @DATATIME – skrócona data i czas utworzenia pliku np. 201605141512
  • @MAGAZYN – symbol magazynu pracownika tworzącego plik
  • @MPK – symbol MPK pracownika tworzącego plik
  • @ODDZIAL – symbol oddziału pracownika tworzącego plik

 

Zapytanie zwracające dane

Wykonanie zapytania zwracającego dane, które mają być eksportowane można rozbudować o obsługę zmiennych wykorzystywanych zwykle w warunku filtrowania danych. Przykładowo chcemy pobrać wyłącznie dane powiązane z określonym dokumentem, wówczas stosujemy zmienną @REFNO. Możemy jednak potrzebować użyć warunku filtrowania danych powiązanych z danym użytkownikiem programu poprzez jego LOGIN lub symbol magazynu.

Poniżej lista zmiennych jakie można wykorzystać w zapytaniu SQL:

  • @REFNO – podstawiana jest wartość przekazanego parametru refno
  • @KTO – nazwa użytkownika, który tworzy plik (login)
  • @DATA – skrócona data utworzenia pliku np. 2016-05-14
  • @MAGAZYN – symbol magazynu pracownika tworzącego plik
  • @MPK – symbol MPK pracownika tworzącego plik
  • @ODDZIAL – symbol oddziału pracownika tworzącego plik