Niniejszy dokument opisuje instrukcje eksportowania i importowania raportów przy użyciu serwera Business Integration Server (BIS). Artykuł zawiera instrukcje, np. sekwencje, których należy przestrzegać podczas importowania oraz informacje o wymaganych warunkach wstępnych i skutkach importu lub eksportu.
Opis aplikacji Import danych, który zawiera szczegółowe opisy pól i przycisków, można znaleźć w dokumentacji Import danych.
Definicje pojęć
- Raporty — raport używany jest w celu wyświetlania danych zarejestrowanych w systemie w przejrzystej formie. Raport może być tworzony tak często, jak jest to wymagane, na podstawie aktualnie dostępnych danych.
Raporty dzielą się na dokumenty raportów i dokumenty końcowe. Raporty typu Dokument raportu mogą być tworzone na podstawie dowolnych danych z systemu. Zazwyczaj mają one formę listy i mogą być generowane w aplikacji Raport: Dokumenty raportów. Dokumenty końcowe mogą być tworzone w odpowiednich aplikacjach i zazwyczaj zawierają one tylko dane pojedynczego dokumentu.
Raporty mogą być tworzone jako obiekty systemowe lub obiekty deweloperskie. Raport jako obiekt deweloperski ma tę zaletę, że może być zmieniany w systemie deweloperskim, wersjonowany i przesyłany do innych systemów jako aktualizacja oprogramowania. Aby móc tworzyć i zmieniać raporty w systemach innych niż deweloperskie, aplikacja Raporty oferuje opcję tworzenia ich jako obiektów systemowych. Obiektów systemowych nie można przenosić do innych systemów.
Raporty zawierają jeden lub więcej plików raportów, które określają układ raportu.
- Plik raportu — służy do definiowania wyglądu generowanego raportu. W tym celu pliki raportów są przetwarzane w Crystal Reports. Pliki raportów mogą być zależne od języka.
- Dokument raportu — zawiera listę obiektów, na przykład listę adresów lub zamówień sprzedaży. Dokumenty mogą być archiwizowane lub wysyłane do partnera, na przykład faksem lub pocztą elektroniczną.
- Rozszerzalny język znaczników (XML) — plik XML może być używany do zapisywania ustrukturyzowanych danych w pliku tekstowym. Język pliku umożliwia definiowanie, przesyłanie, sprawdzanie i interpretowanie danych między aplikacjami i jest szczególnie odpowiedni do wymiany danych strukturalnych. Dokumenty XML oddzielają treść, strukturę i informacje do wizualizacji. XML jest koordynowany i zdefiniowany jako standard przez W3C.
- Tekst oddzielony separatorami (CSV) — CSV (comma separated values) to format pliku, w którym wartości poszczególnych kolumn są oddzielone separatorem. Wiersze są oddzielone znakami końca linii. Separator ten musi być znany w celu zaimportowania pliku. Typowymi separatorami są na przykład pojedynczy przecinek i średnik. Dane zapisane w tym formacie mogą być używane i edytowane w wielu aplikacjach. Ze względu na prostą, niehierarchiczną strukturę CSV, ten format danych nie nadaje się do mapowania złożonych struktur danych.
- Tekst Unicode oddzielony tabulatorem (XLS) — Ten format pliku jest podobny do CSV, ale tabulator jest określony jako separator, a Unicode jako kodowanie znaków. Pliki w tym formacie mogą być używane między innymi przez program Microsoft Excel. Aby zapisać ten format pliku w programie Excel, może być konieczne określenie formatu pliku w programie Excel.
Informacje ogólne
Jednostka biznesowa Raport stanowi podstawę dla wydruku dokumentów aplikacji, dokumentów raportu i dokumentów końcowych. Aby móc dostosowywać raporty dostarczane jako obiekty deweloperskie w dowolnym systemie, raporty typu Obiekt deweloperski można otwierać w aplikacji Raporty i powielać w raporcie typu Obiekt systemowy. Raporty te można konfigurować. W aplikacji Raporty można również tworzyć zupełnie nowe raporty.
Ponieważ konfiguracja raportów, a w szczególności opracowywanie i testowanie skonfigurowanych raportów, może powodować duże obciążenie bazy danych, wyraźnie zaleca się, aby konfiguracje nie były przeprowadzane w systemie produkcyjnym, ale w systemie testowym, z oddzielną bazą danych. W celu przeniesienia skonfigurowanych raportów typu Obiekt systemowy z produkcyjnego systemu testowego do systemu produkcyjnego po pomyślnym przetestowaniu, eksport i import zostały zaimplementowane dla jednostki biznesowej Raporty. Opis importu i eksportu raportów, które są rejestrowane jako obiekty deweloperskie w systemie, można znaleźć w dokumentacji Eksport i import obiektów deweloperskich.
Eksportu i importu raportów można użyć do następujących celów:
- Przekazywanie raportów typu Obiekt systemowy, po pomyślnym przetestowaniu, z systemu testowego do systemu produkcyjnego
- Przekazanie raportu w celu umożliwienia odtworzenia błędów, które występują tylko w przypadku niektórych niestandardowych raportów
Instrukcje
Raporty systemowe są importowane i eksportowane za pomocą BIS. Aby to zrobić, należy wykonać import lub eksport dla jednostki biznesowej Report (com.cisag.sys.repository.obj.Report) zgodnie z opisem w dokumentacji eksportu danych i importu danych.
Eksport
Do eksportu należy użyć aplikacji Eksport danych. Podczas eksportowania można wybrać określone raporty, które mają zostać wyeksportowane w zakładce Ograniczenie.
Ze względu na fakt, że praktycznie wszystkie atrybuty są polami obowiązkowymi, eksport ma sens tylko w postaci pliku XML. Pliki raportów zawarte w raporcie są eksportowane jako oddzielne, dodatkowe pliki w natywnym formacie odpowiedniego pliku raportu. Oznacza to, że wyeksportowane pliki .rpt mogą być również otwierane bezpośrednio w programie Crystal Reports.
Można eksportować zarówno raporty typu Obiekt systemowy, jak i raporty typu Obiekt deweloperski. Podczas eksportowania raportów typu Obiekt deweloperski zakres nazw nie jest eksportowany. Aby zaimportować te raporty, należy zmienić wartość atrybutu sourceType w pliku źródłowym z ARCHIVE na LOCAL.
Import
Do importu należy użyć aplikacji Import danych. W przypadku samej jednostki biznesowej Raport podczas importu obsługiwane są tryby CREATE, UPDATE, UPDATE_CREATE, VALIDATE i DELETE. W przypadku podmiotów zależnych obsługiwany jest tylko tryb UPDATE_CREATE, w którym usuwane są podmioty zależne niezawarte w pliku źródłowym. Należy pamiętać, że podczas importowania raportów z pliku istniejące raporty o tej samej nazwie są domyślnie nadpisywane.
Po pomyślnym zaimportowaniu raportów zawierających pliki raportów w formacie RPT (plik .rpt), dane raportu muszą zostać uzupełnione o metadane, które tylko SOM może odczytać z pliku raportu. Obejmuje to źródła danych i jednostki biznesowe używane w raporcie. Aby dodać dane, należy wykonać następujące kroki:
- Należy otworzyć aplikację Raporty.
- Należy otworzyć odpowiedni raport.
- Należy wybrać przycisk [Eksport plików raportu], znajdujący się na standardowym pasku narzędzi.
- Otworzy się okno dialogowe Wybór katalogu dla eksportu plików raportu.
4. Należy wybrać folder w Knowledge Store, do którego mają być wyeksportowane pliki raportu i zatwierdzić wybór przy pomocy przycisku [Eksportuj].
- Pliki raportów zostaną wyeksportowane.
5. Należy wybrać przycisk [Import plików raportu], znajdujący się na standardowym pasku narzędzi.
- Otworzy się okno dialogowe Wybór katalogu dla importu plików raportu.
6. Należy wybrać folder w Knowledge Store, z którego mają być zaimportowane pliki raportów i i zatwierdzić wybór przy pomocy przycisku [Importuj].
7. Pliki raportów zostaną zaimportowane, a ich metadane przeanalizowane przez SOM.
8. Należy wybrać przycisk [Zapisz], znajdujący się na standardowym pasku narzędzi, aby zweryfikować i zapisać raport wraz z metadanymi.
9. Od tego momentu można korzystać z raportów zgodnie z ich typem dokumentu.
Pola obowiązkowe i kluczowe atrybuty
Obowiązkowe pola (P) i kluczowe atrybuty (K) poszczególnych jednostek biznesowych zostały wymienione poniżej. Pola identyfikacyjne i obowiązkowe mogą ulec zmianie, a także mogą zostać rozszerzone poprzez konfigurację.
Model danych BIS dla raportów składa się z głównego obiektu Raport i obiektów zależnych Parametry, Pliki i Teksty. Główny obiekt Raport modelu danych BIS zawiera następujące atrybuty:
| Nazwa pola / kluczowy atrybut (K) | Wyjaśnienie |
| name (K) (P) | Nazwa raportu bez zakresu nazw. Nazwa raportu systemowego może zawierać wyłącznie małe i wielkie litery oraz cyfry 0-9. Pole obowiązkowe. |
| sourceType (P) | Typ raportu. Pole obowiązkowe. Możliwe wartości eksportu to:
W przypadku importu dozwolona jest tylko wartość LOCAL. Należy skonfigurować wartość i, jeśli to konieczne, nazwę raportu w pliku źródłowym, jeśli ma zostać zaimportowany raport typu Obiekt deweloperski jako raport typu Obiekt systemowy. |
| outputType (P) | Typ dokumentu raportu. Pole obowiązkowe.
Typ dokumentu określa, czy raport może być używany do tworzenia dokumentów raportów, czy do tworzenia dokumentów końcowych:
Możliwe wartości to:
|
| frameworkName (P) | Obszar składający się z nazwy i obszaru nazw, do której przypisany jest raport. Pole obowiązkowe. Raporty są przypisywane do obszarów w celu grupowania zawartości.
To przypisanie ma wpływ na przyporządkowanie i weryfikację uprawnień do raportów. Ponadto raport jest wyświetlany na karcie specyficznej dla aplikacji w aplikacji Raport: Dokumenty raportów poniżej tej struktury. |
| displayName (P) | Nazwa raportu. Pole obowiązkowe. |
| originalLanguage (P) | Oryginalny język raportu. Pole obowiązkowe. Oryginalny język jest używany, jeśli dokument raportu ma zostać utworzony w określonym języku, a plik raportu lub tekst nie jest dostępny w tym języku.
W takim przypadku plik raportu lub tekst jest używany w języku oryginalnym. |
| directHelp | Bezpośrednia pomoc dotycząca raportu w kilku językach. Bezpośrednia pomoc jest wyświetlana w aplikacji Raport: Dokumenty raportów w celu zapewnienia pomocy użytkownikom raportu. |
Parametry zależne od modelu danych BIS opisują parametry raportu i zawierają następujące atrybuty:
| Nazwa pola / kluczowy atrybut (K) | Wyjaśnienie |
| name (K) (P) | Nazwa parametru raportu. Pole obowiązkowe.
Następujące nazwy są predefiniowane lub zarezerwowane dla późniejszych rozszerzeń:
Nazwy te są zdefiniowane jako stałe w klasie com.cisag.pgm.services.output.CisAttributes. |
| logicalDataTypeName | Należy określić logiczny typ danych dla parametru raportu, którego opis danych definiuje etykietę, bezpośrednią pomoc i pomoc wydruku dla parametru.
Pierwotny typ logicznego typu danych musi być zgodny z typem pola parametru. Logiczny typ danych jest automatycznie określany dla wszystkich predefiniowanych parametrów raportu i nie można go zmienić. |
| Sequence (P) | Pole obowiązkowe. Sekwencja na liście parametrów. |
Pliki zależne od modelu danych BIS opisują pliki raportów i zawierają następujące atrybuty:
| Nazwa pola / kluczowy atrybut (K) | Wyjaśnienie |
| language (K) (P) | Język pliku raportu. Wartość X jest używana dla plików zależnych od języka. |
| languageDependent (P) | Określa, czy plik raportu jest zależny od języka, czy nie. Pole obowiązkowe.
Raport może mieć maksymalnie jeden plik niezależny od języka i dowolną liczbę plików zależnych od języka. Jeśli drukowane dane mają być w określonym języku, pliki raportu zależne od języka mają pierwszeństwo przed plikiem raportu niezależnym od języka. Domyślnie podczas tworzenia raporty mają plik raportu niezależny od języka. Korzystając z plików raportów zależnych od języka, można na przykład zaprojektować układ raportu w różny sposób w zależności od języka. Możliwe wartości to
|
| format (P) | Format pliku. Pole obowiązkowe.
|
| file (P) | Plik raportu. Ten atrybut reprezentuje rzeczywisty plik raportu, który jest przechowywany jako plik .rpt. Podczas eksportu pliki raportów są przechowywane w folderze o nazwie pliku źródłowego z rozszerzeniem files. Nazwa pliku pochodzi od nazwy raportu i języka raportu. W przypadku plików zależnych od języka jako język używana jest wartość X.
Import.xml.files Import.xml.files/Report-X.rpt |
| fileMetaData (P) | Metadane dla pliku raportu. Ten atrybut reprezentuje plik z metadanymi dla rzeczywistego pliku raportu. Plik z metadanymi jest przechowywany jako plik binarny z rozszerzeniem -meta-data.bin. Podczas eksportu pliki raportów są przechowywane w folderze o nazwie pliku źródłowego z rozszerzeniem files. Nazwa pliku pochodzi od nazwy raportu i języka raportu. W przypadku plików zależnych od języka jako język używana jest wartość X.
Przykład Import.xml
Import.xml.files Import.xml.files/Report-X-meta-data.bin Ten atrybut dotyczy tylko raportów w formacie RPT_WITH_META_DATA. W przypadku raportów w formacie RPT metadane muszą zostać dodane przez SOM w aplikacji Raporty po pomyślnym zaimportowaniu. |
| lastModified (P) | Pole obowiązkowe. Czas ostatniej modyfikacji pliku raportu. |
Pole Teksty zależne od modelu danych BIS opisuje teksty raportu i zawiera następujące atrybuty:
| Nazwa pola / kluczowy atrybut (K) | Wyjaśnienie |
| constantName (K) (P) | Pole obowiązkowe. Unikalna nazwa stałej, która może zawierać tylko wielkie litery. Służy do uzyskiwania dostępu do tekstu raportu. |
| text (P) | Tłumaczenie; tekst, który można przetłumaczyć. Pole obowiązkowe. |
