Eksport danych

Za pomocą usługi Business Integration Service (BIS) można eksportować dane z baz danych oraz importować dane do baz danych. Wyeksportowane dane są zapisywane w Knowledge Store jako pliki i odczytywane stamtąd podczas importu.

Dostępne typy plików:

• Rozszerzalny język znaczników (XML) (*.xml)
• Tekst rozdzielany separatorami (CSV) (*.csv)
• Tekst Unicode rozdzielany tabulatorami (*.xls)

Zalecane jest używanie formatu XML, ponieważ umożliwia zapisanie złożonych danych w jednym pliku, określenie i weryfikację schematu pliku oraz integrację zmian w modelu danych bez problemów.

Aplikacja Eksport danych umożliwia rozpoczęcie indywidualnego eksportu danych. Eksport danych jest zawsze przeprowadzany dla określonej jednostki biznesowej.

Zakres danych do wyeksportowania może być ograniczany na dwa sposoby:

• Filtr — definiuje zestaw atrybutów jednostki biznesowej, które mają zostać uwzględnione w eksporcie
• Wyszukiwanie — ogranicza zbiór instancji obiektów biznesowych, które mają zostać wyeksportowane

Definicje pojęć

• Rozszerzalny język znaczników (XML) — XML umożliwia zapisywanie ustrukturyzowanych danych w pliku tekstowym. Język opisu umożliwia definiowanie, przesyłanie, sprawdzanie i interpretowanie danych między aplikacjami i jest szczególnie odpowiedni do wymiany danych strukturalnych. W przypadku dokumentów XML, zawartość, struktura i informacje o reprezentacji są rozdzielone. XML jest koordynowany i zdefiniowany jako standard przez W3C.
• Tekst rozdzielany separatorami (CSV) — CSV to typ pliku, w którym wartości poszczególnych kolumn są oddzielone separatorem. Wiersze są oddzielone znakami końca wiersza. Separator musi być znany, aby plik mógł zostać zaimportowany. Typowymi separatorami są na przykład zwykły przecinek i średnik. Dane zapisane w tym formacie mogą być używane i przetwarzane w wielu programach. Prosta, niehierarchiczna struktura CSV sprawia, że ten typ pliku nie nadaje się do mapowania złożonych struktur danych.
• Unicode — Comarch ERP Enterprise korzysta z Unicode. Dlatego wszystkie znaki używane na całym świecie mogą być używane i drukowane na formularzach. Przed pojawieniem się Unicode potrzebnych było wiele różnych systemów kodowania do wyświetlania znaków. Żaden z tych systemów nie zawierał wystarczającej liczby znaków. W samej Unii Europejskiej potrzebnych było kilka systemów kodowania do wyświetlania różnych języków krajów członkowskich. Dzięki zastosowaniu Unicode, Comarch ERP Enterprise może być bezpośrednio zaimplementowany w różnych systemach. Różne kraje i języki nie stanowią problemu. Złożone adaptacje nie są wymagane, ponieważ Unicode umożliwia globalną wymianę tekstu bez utraty informacji. Unicode nadaje każdemu znakowi własny numer – niezależny od platformy, programu i języka.
• Tekst Unicode rozdzielany tabulatorami — ten typ pliku jest podobny do CSV, z tym wyjątkiem, że separatorem jest tabulator, a kod znaków to Unicode. Pliki w tym formacie mogą być używane między innymi w programie Microsoft Excel. Aby zapisać ten typ pliku w programie Excel, musisz określić typ pliku o tej samej nazwie w programie Excel.
• Konsorcjum World Wide Web (W3C) — organizacja założona w celu wykorzystania pełnego potencjału sieci. W tym celu opracowywane są znormalizowane technologie, takie jak specyfikacje, wytyczne, oprogramowanie i narzędzia, które mają na celu promowanie rozwoju sieci oraz zapewnienie jej interoperacyjności.
• Schemat XML (XSD) — schemat XML (XML Schema Definition, XSD) to formalna specyfikacja reguł dokumentu XML wskazująca, które elementy i kombinacje elementów są dopuszczalne w dokumencie.
• Język transformacji arkuszy stylów (XSLT) — XSLT to język programowania służący do przekształcania dokumentów XML. XSLT opiera się na logicznej strukturze drzewa dokumentu XML i służy do definiowania reguł konwersji. Opisuje konwersję dokumentu XML na inny dokument.

Opis aplikacji

Aplikacja składa się z nagłówka i obszaru roboczego, które zostały opisane poniżej. Filtr używany do eksportu jest definiowany w nagłówku.

Aby wykonać eksport, filtr musi być otwarty w aplikacji. Filtr określa jednostkę biznesową oraz wybór atrybutów do wyeksportowania. Oprócz filtrów zapisanych w bazie danych można używać także nowo utworzonych filtrów. Nie ma konieczności zapisywania nowo utworzonego filtra, aby użyć go do eksportu. Filtr można zapisać w bazie danych, jeśli ma być używany ponownie w późniejszym czasie.

Podczas procesu eksportu dane mogą być konwertowane z formatu danych BIS wygenerowanego przez kontroler eksportu na inny format. Konwersja jest przeprowadzana zgodnie z określonym plikiem XSLT.

W obszarze roboczym można określić wybór atrybutów filtra oraz ograniczyć eksport do określonych instancji obiektów biznesowych.

Można użyć funkcji wyszukiwania w nagłówku, aby znaleźć filtry i encje biznesowe. Po wybraniu filtra jest on otwierany, a po wybraniu jednostki biznesowej przygotowywany jest dla niej nowy filtr.

Nagłówek

Pola w nagłówku tej aplikacji służą do definiowania filtra wyświetlanego w obszarze roboczym.

• Filtr — nazwa filtra. Określa filtr, który ma zostać otwarty. W przypadku nowo utworzonego filtra sugerowana jest nazwa, którą można zmienić.
• Oznaczenie — dodatkowa nazwa filtra. Znaczące opisy ułatwiają wyszukiwanie. Można wybrać dowolny opis, który może być niejednoznaczny, co oznacza, że kilka filtrów może mieć to samo oznaczenie. Zaleca się przypisywanie unikalnych opisów w każdym przypadku.
• Jednostka biznesowa — jednostka biznesowa, której dane są eksportowane na podstawie filtra
• Baza danych — baza danych, z której eksportowana jest jednostka biznesowa
• Ustawienie języka — określa, czy atrybuty wielojęzyczne mają być eksportowane w jednym języku (Jeden język), czy we wszystkich językach bazy danych (Wielojęzyczny).
  Wielojęzyczny jest ustawiony jako domyślny. Przy ustawieniu Wielojęzyczny może być używany tylko typ pliku XML.
• Format czasu — określa sposób serializacji atrybutów czasu.
  Możliwe wartości:
  • Forma kompaktowa
  • Forma znormalizowana
    Domyślną wartością jest Forma kompaktowa. Szczegółowe informacje o znaczeniu wartości znajdują się w rozdziale Daty i znaczniki czasu w artykule Wprowadzenie: Wymiana danych.
• Pik transformacji — identyfikator URI pliku XSLT. Jeżeli identyfikator URI nie zostanie podany, dane są eksportowane bez transformacji.

Obszar roboczy

Obszar roboczy składa się z dwóch zakładek. W zakładce Filtr dokonywany jest wybór atrybutów dla otwartego filtra. Zakładka ta zapewnia również przegląd atrybutów jednostki biznesowej.

Zestaw instancji jednostek biznesowych, które mają zostać wyeksportowane, określa się w zakładce Ograniczenie.

Zakładka Filtr

Model danych jednostki biznesowej

Model danych jednostki biznesowej jest wyświetlany jako drzewo w zakładce Filtr.

Kliknięcie folderu powoduje wyświetlenie dodatkowych elementów. Dla każdego wpisu po ikonie wymieniane są następujące informacje:

• Nazwa atrybutu lub relacji
• Tekst opisowy dla wpisu
• Prymitywny typ danych dla prostych atrybutów lub informacje o kardynalności dla relacji albo obiektu zależnego (podawane w nawiasach)

Dalsze właściwości wybranego elementu można zobaczyć w zakładce Właściwości w panelu nawigacji.

Wybór atrybutów

Możliwe jest aktywowanie lub dezaktywowanie poszczególnych atrybutów dla eksportu poprzez zaznaczenie lub usunięcie zaznaczenia odpowiednich pól wyboru.

Aplikacja udostępnia również opcję wyboru wielu atrybutów według określonych kryteriów. W tym celu należy wybrać folder i kliknąć jeden z przycisków na pasku narzędzi w zakładce Filtr. Powoduje to zmianę aktywacji wszystkich atrybutów tego folderu oraz jego podfolderów. Te same funkcje są dostępne w menu kontekstowym folderu.

Szczegółowy opis funkcji przycisków:

• Bez atrybutu — wszystkie atrybuty wybranego folderu i jego podfolderów są dezaktywowane
• Czytelny wybór — aktywowane są wszystkie atrybuty funkcjonalne, tj. wszystkie atrybuty zawierające wartości do odczytu. Na przykład kod atrybutu (pc, kg itp.) jest aktywowany dla jednostek miary. Ten wybór jest predefiniowany dla całej jednostki biznesowej podczas tworzenia filtra.
  Uwaga

  Ten wybór jest zalecany, jeśli wyeksportowane dane mają zostać zaimportowane do innej bazy danych lub do bazy danych innej firmy.

• Czytelne bez identyfikatorów GUID — aktywowane są wszystkie atrybuty funkcjonalne, tj. wszystkie atrybuty zawierające wartości do odczytu, ale bez identyfikatorów GUID
• Wybór techniczny — aktywowane są wszystkie atrybuty techniczne, czyli atrybuty zawierające klucz techniczny (np. GUID jednostki miary)
• Wszystkie atrybuty — aktywowane są wszystkie atrybuty wybranego folderu i jego podfolderów

Zakładka Ograniczenia

Zakres danych do wyeksportowania można zdefiniować na poziomie instancji w zakładce Ograniczenia. W tym celu można określić kryteria wyszukiwania lub użyć instrukcji OQL definiującej klucz podstawowy odpowiednich instancji obiektów biznesowych.

W przypadku zastosowania wyszukiwania dla ograniczenia możliwe jest wyświetlenie stanów jednostki biznesowej odpowiadających określonym kryteriom zapytania przed rozpoczęciem eksportu. Funkcja ta nie jest dostępna przy użyciu ograniczenia za pomocą instrukcji OQL.

Możliwe jest również określenie sortowania eksportowanych danych.

• W przypadku wyszukiwania odbywa się to poprzez wybranie przycisku [Sortuj] poniżej pól zapytania.
• W przypadku użycia instrukcji OQL sortowanie można zdefiniować w instrukcji OQL za pomocą dodatku Order by.

Dostępna jest także akcja [Zmień ustawienia wyszukiwania], umożliwiająca modyfikację wyszukiwań oferowanych w aplikacji Eksport danych, na przykład w celu określenia dodatkowych parametrów zapytania. Dostosowanie musi być wykonywane na poziomie (System, Użytkownik i system, Baza danych itp.), który będzie aktywny również podczas kolejnej operacji eksportu. Jest to szczególnie istotne w sytuacjach, gdy operacja eksportu jest wykonywana jako zlecenie przetwarzania przez innego użytkownika.

Na zakładce dostępne są następujące pola:

• Wyszukiwanie — wyszukiwanie, które ma być używane dla ograniczenia. Dostępne wyszukiwania zależą od jednostki biznesowej.
  Pozycja Z poleceniem OQL umożliwia użycie instrukcji OQL do określenia ograniczenia. Wynik instrukcji OQL musi zawierać wszystkie atrybuty klucza głównego jednostki biznesowej, który w większości przypadków stanowi identyfikator GUID.
• Pola zapytania — jeżeli zostanie wybrane wyszukiwanie, odpowiednie pola zapytania są wyświetlane w zależności od wybranej metody.
  W przypadku opcji Z poleceniem OQL dostępne jest pole wielowierszowe, w którym można wprowadzić instrukcję OQL.
  Przycisk [Wyszukaj] — wybranie tego przycisku powoduje wyświetlenie zestawu wyników ponownego ograniczenia, co umożliwia wcześniejsze przetestowanie efektu. Ograniczenie jest również wykonywane ponownie podczas rzeczywistej operacji eksportu, jeżeli przycisk nie został użyty wcześniej.
  Ta akcja nie jest dostępna, gdy do określenia ograniczenia używany jest element stanu OQL.

Okno dokowane Właściwości

Aplikacja zawiera okno dokowane Właściwości, które wyświetla dalsze informacje o wybranym elemencie w filtrze. W zależności od wybranego typu elementu wyświetlane są niektóre z poniższych pól:

• Typ elementu — określa, czy element jest jednostką biznesową, atrybutem, relacją czy obiektem zależnym
• Ścieżka elementu — określa ścieżkę elementu dla atrybutu. Ścieżka zawiera wszystkie elementy prowadzące do atrybutu, zaczynając od obiektu biznesowego, który go zawiera.
• Oznaczenie — opis elementu
• Pochodzenie — określa pochodzenie elementu. Możliwe wartości:
  • Obiekt rozwojowy — element stanowi część odpowiedniego obiektu rozwojowego (obiektu biznesowego, części) i jest dostarczany w wersji standardowej lub w wersji standardowej partnera rozwojowego
  • Rozszerzenie — element pochodzi z rozszerzenia obiektu rozwojowego i jest tworzony jako część adaptacji. Szczegółowe informacje znajdują się w artykule Obiekty deweloperskie.
  • Inne pola — element pochodzi z innych pól odpowiedniej aplikacji. Elementy o takim pochodzeniu są zawarte wyłącznie w odpowiedniej bazie danych i zasadniczo nie mogą być importowane do innych baz danych.
  • Controller — element nie pochodzi bezpośrednio z obiektu rozwojowego, lecz został dodany oddzielnie przez kontroler (np. klasę Java). W sytuacjach, gdy model danych w bazie danych nie może być użyty bezpośrednio do importu lub eksportu, kontroler umożliwia zdefiniowanie własnego modelu danych.
• Logiczny typ danych — logiczny typ danych atrybutu. Szczegółowe informacje znajdują się w artykule Obiekty deweloperskie.
• Pierwotny typ danych — pierwotny typ danych atrybutu
• Obiekt docelowy — obiekt docelowy relacji lub obiektu zależnego
• Model relacji — model relacji lub obiektu zależnego. Możliwe wartości to 1..1 lub 1..n.
• Controller eksportu — kontroler używany do eksportu jednostki biznesowej. Jeżeli kontroler nie zostanie określony, stosowany jest ogólny eksport.
• Controller importu — kontroler używany do importu jednostki biznesowej. Jeżeli kontroler nie zostanie określony, stosowany jest ogólny import.
• Program korygujący — aplikacja umożliwiająca poprawianie niekompletnych lub nieprawidłowych danych w przypadku niepowodzenia importu danych

Akcje związane z aplikacją

W aplikacji Eksport danych dostępne są następujące akcje związane z aplikacją:

• [Utwórz schemat XML]
• [Utwórz WSDL]
• [Eksportuj dane]

Utwórz schemat XML

Akcja [Utwórz schemat XML] służy do rozpoczęcia generowania pliku schematu XML dla aktualnie otwartego filtra. Brane są pod uwagę również niezapisane zmiany w filtrze oraz wybór atrybutów. Kliknięcie przycisku [Utwórz schemat XML] otwiera okno dialogowe Utwórz schemat XML, w którym można określić plik i wprowadzić dodatkowe ustawienia.

Szczegółowy opis pól w oknie dialogowym Utwórz schemat XML

• Plik — plik, który ma zostać wygenerowany. Istniejące pliki są nadpisywane. Należy wprowadzić pełną ścieżkę do pliku, używając file:/// lub kstore:// w nazwie.
  Domyślnie jest to plik w standardowym obszarze roboczym bazy danych OLTP, do której użytkownik jest zalogowany. Ścieżka zawiera nazwę bieżącego użytkownika i nazwę filtra.
• Konwencja nazw XML — określa, czy wygenerowany plik schematu XML ma zawierać dodatkowe deklaracje przestrzeni nazw XML. Możliwe wartości:
  • Wspierany — plik schematu XML jest generowany w taki sposób, że możliwa jest walidacja za pomocą standardowych narzędzi XML
  • Niewspierany— plik schematu XML jest generowany w taki sposób, że zawiera wyraźną deklarację atrybutu XML xmlns, umożliwiając walidację za pomocą narzędzi XML, które tego wymagają, np. w produkcie Seeburger BIC

Utwórz WSDL

Akcja [Utwórz WSDL] służy do rozpoczęcia generowania pliku WSDL dla aktualnie otwartego filtra. Niezapisane zmiany w filtrze i wybór atrybutów nie są w tym przypadku brane pod uwagę, ponieważ usługi sieciowe zawsze wymagają trwałego filtra. Z tego powodu akcja ta nie jest dostępna dla nowych filtrów ani dla filtrów zmienionych, ale jeszcze niezapisanych. Kliknięcie przycisku [Utwórz WSDL] otwiera okno dialogowe Utwórz WSDL, w którym można określić plik i wprowadzić dodatkowe ustawienia.

Szczegółowy opis pól w oknie dialogowym Utwórz WSDL

• Plik — plik, który ma zostać wygenerowany. Istniejące pliki są nadpisywane. Należy wprowadzić pełną ścieżkę do pliku, używając file:/// lub kstore:// w nazwie.
  Domyślnie jest to plik w standardowym obszarze roboczym bazy danych OLTP, do której użytkownik jest zalogowany. Ścieżka zawiera nazwę bieżącego użytkownika i nazwę filtra.
• Podstawowy adres URL — bazowy adres URL serwera aplikacji, na którym ma być używana usługa internetowa. Domyślnie jest to podstawowy adres URL serwera aplikacji, do którego użytkownik jest aktualnie zalogowany.
• Format obszaru nazw — określa sposób generowania pliku WSDL względem bazy danych OLTP. Możliwe wartości:
  • Wszystkie bazy danych OLTP — określone rozszerzenia, takie jak Pola zdefiniowane przez użytkownika, są ignorowane. Wygenerowany plik WSDL może być używany także w innych bazach danych OLTP niż bieżąca lub w innych systemach.
  • Specyficzny dla bazy danych OLTP — uwzględniane są określone rozszerzenia, takie jak Pola zdefiniowane przez użytkownika. Wygenerowany plik WSDL może być używany wyłącznie do dostępu do bieżącej bazy danych OLTP.

Eksportuj dane

Akcja [Eksportuj dane] służy do uruchamiania operacji eksportu dla otwartego filtra. Kliknięcie przycisku [Eksportuj dane] otwiera okno dialogowe Eksport danych, w którym można wprowadzić ustawienia pliku docelowego. Eksport może być wykonany natychmiast lub jako zlecenie przetwarzania.

Zakładka Parametr w oknie dialogowym Eksport danych zawiera następujące pola:

• Plik docelowy — plik, do którego eksportowane są dane. Istniejący plik docelowy jest nadpisywany w tym procesie. To, czy dodatkowo wygenerowane pliki (np. zawartość atrybutów BLOB) zostaną nadpisane, zależy od odpowiedniego kontrolera. Jeżeli nie zostanie znaleziona żadna instancja obiektu do wyeksportowania, plik nie jest generowany.
  Należy wybrać plik, do którego mają być eksportowane dane, i wprowadzić pełną ścieżkę, używając file:/// lub kstore:// w nazwie. Jeżeli plik ma rozszerzenie .gz, zostaje rozpoznany jako plik skompresowany GZIP i jest automatycznie kompresowany podczas generowania.
  Domyślnie plik docelowy to skompresowany plik GZIP w obszarze roboczym bazy danych OLTP, do której użytkownik jest zalogowany. Ścieżka zawiera nazwę bieżącego użytkownika i nazwę jednostki biznesowej. W nazwie pliku docelowego można stosować zmienne, które są zastępowane podczas generowania pliku.
  Dostępne zmienne:
  • {user} — nazwa użytkownika
  • {timestamp} — data i godzina z milisekundami (rrrrMMdd_HHmmss_SSS)
  • {datetime} — data i godzina (rrrrMMdd_HHmmss)
  • {date} — data (rrrrMMdd)
  • {time} — czas (HHmmss)
  • {week} — tydzień kalendarzowy (ww)
  • {rok} — rok (rrrr)
  • {miesiąc} — miesiąc (MM)
  • {day} — dzień (dd)
• Typ pliku — typ pliku docelowego.
  Możliwe wartości:
  • XML
  • Tekst rozdzielony separatorem
  • Tekst Unicode rozdzielony tabulatorem
  • JSON
• Kodowanie — kodowanie znaków dla pliku docelowego. W przypadku typu pliku Tekst rozdzielony separatorem można określić kodowanie znaków. Dostępne kodowania zależą od wersji Javy bieżącego serwera aplikacji. Należy pamiętać, że jeśli import jest wykonywany jako zlecenie przetwarzania, serwer aplikacji, na którym działa kolejka przetwarzania, kontroluje określone kodowanie.
• Separator — separator między polami w pliku docelowym. W przypadku typu pliku Tekst rozdzielony separatorem można określić separator. Dostępna jest opcja (pozostałe), umożliwiająca ręczne wprowadzenie separatora.
• Znak rozpoznawczy tekstu — znak używany do oznaczania tekstów w pliku docelowym. Teksty ujęte w znak rozpoznawania tekstu mogą zawierać sam separator. W przypadku typu pliku Tekst rozdzielony separatorem można wskazać znak rozpoznawania tekstu. Domyślnie jest to podwójny cudzysłów.
• Poziom protokołowania— wskazuje, czy rejestrowanie jest aktywne podczas eksportu. Możliwe wartości:
  • Bez protokołowania
  • Aktywowano protokołowanie
    Domyślną opcją jest Aktywowano protokołowanie.

Konfiguracja

Aplikacja Eksport danych nie wymaga dodatkowych ustawień w aplikacji Konfiguracja.

Jednostki biznesowe

Jednostka biznesowa Filtr:
com.cisag.sys.tools.bi.obj.FilterDefinition — wykorzystywana jest przez aplikację Eksport danych między innymi w celu:

• Przyporządkowywania uprawnień
• Konfigurowania definicji działań
• Importu i eksportu danych

Uprawnienia

Uprawnienia mogą zostać przypisane za pomocą ról uprawnień jak również poprzez przyporządkowanie organizacji. Szczegółowe informacje można znaleźć w artykule Uprawnienia.

Uprawnienia specjalne

Dla aplikacji Eksport danych nie ma dostępnych uprawnień specjalnych.

Przyporządkowania organizacji

Dla aplikacji Eksport danych nie są wymagane przyporządkowania organizacji.

Funkcje specjalne

Należy wziąć pod uwagę następujące funkcje specjalne aplikacji Eksport danych:

• Eksport danych z zapisanymi filtrami — aby wykonać eksport przy użyciu zapisanych filtrów, wystarczy funkcja [Otwórz]. Do tworzenia, zapisywania lub usuwania filtrów wymagane są odpowiednie funkcje na poziomie jednostki biznesowej.
• Uprawnienia do zapisu plików — wykonywanie eksportu danych wymaga uprawnień do zapisywania plików w Knowledge Store

Uprawnienia dla partnerów biznesowych

Aplikacja Eksport danych nie jest udostępniana partnerom biznesowym.