Eksport i import szablonów dokumentów końcowych

W systemie szablony dokumentów mogą być przenoszone do innego systemu Comarch ERP Enterprise. Dokument ten zawiera instrukcje eksportu i importu szablonów dokumentów z wykorzystaniem usługi Business Integration Service (BIS) czyli aplikacji Eksport danych oraz Import danych.

Eksport

W zakładce Filtry możliwy jest wybór jednego lub więcej szablonów dokumentów, które mają zostać wyeksportowane. Szczegółowy opis dostępnych filtrów znajduje się w rozdziale Obszar roboczy – zakładka Filtr.

Z uwagi na to, że większość atrybutów jest polami obowiązkowymi, preferowany jest plik eksportu w formacie XML.

Wskazówka
Jeśli użytkownik eksportuje szablon dokumentu zawierający szablon zastępczy lub dodatkowy, to najpierw należy wyeksportować te szablony, szczególnie jeśli wyeksportowane szablony mają zostać importowane do bazy danych OLTP.
Wskazówka
Jeśli ścieżka KStore występuje w szablonie dokumentu, to podczas eksportu nazwy baz danych zastępuje się zmiennymi. Podczas importu zmienne te będą zastąpione nazwami baz danych.

Eksport danych

  1. Pierwszym krokiem jest uruchomienie aplikacji Eksport danych.
  2. W polu Filtr należy wybrać jednostkę biznesową cisag.app.general.obj.DocumentOutputOptions.
    W oknie aplikacji widoczny jest filtr dla eksportu danych.
  3. Wybrane atrybuty filtra są już zaznaczone. Możliwa jest edycja filtrów na zakładce Filtr.
  4. Możliwe jest ustawienie ograniczeń dla eksportu danych w zakładce Ograniczenie. Szczegółowy opis zakładki znajduje się w rozdziale Obszar roboczyzakładka Ograniczenia.
  5. Przycisk [Eksport danych], znajdujący się na standardowym pasku narzędzi, otwiera okno dialogowe Eksport danych.
  6. Możliwe jest wprowadzenie ustawień dla pliku eksportu. Szczegółowy opis pól znajduje się w dokumentacji aplikacji Eksport danych.
  7. Użytkownik uruchamia eksport danych za pomocą przycisku [W tle].

Import

W celu przeprowadzenia importu danych należy posiadać plik wyeksportowany wcześniej z innego środowiska Comarch ERP Enterprise. W przypadku importu szablonu zawierającego szablon zamienny lub dodatkowy, najpierw należy importować te szablony.

Import danych

  1. Pierwszym krokiem jest uruchomienie aplikacji Import danych.
  2. W polu Filtr należy wybrać jednostkę biznesową cisag.app.general.obj.DocumentOutputOptions.
    W oknie aplikacji widoczny jest filtr dla importu danych.
  3. Wybrane atrybuty filtra są już zaznaczone. Możliwa jest edycja filtrów w zakładce Filtry.
  4. Przycisk [Importuj dane], znajdujący się w standardowym pasku narzędzi, otworzy okno dialogowe Import danych.
  5. Możliwe jest wprowadzenie ustawień dla pliku importu. Szczegółowy opis pól znajduje się w dokumentacji aplikacji Import danych.
  6. Użytkownik uruchamia import danych za pomocą przycisku [W tle].

Obszar roboczy – zakładka Ograniczenie

Zakładka Ograniczenie umożliwia zawężenie eksportu szablonów dokumentów. Składa się z następujących pól oraz przycisków:

  • Wyszukiwanie – umożliwia wybór trybu zawężenia eksportu danych:
    • Eksport Szablony dokumentów końcowych – umożliwia ograniczenie eksportu danych z użyciem interfejsu systemu.
    • Z poleceniem OQL – umożliwia ograniczenie eksportu danych z użyciem obiektowego języka zapytań.
  • Nazwa techniczna (pole domyślne) – pokazuje jednostkę biznesową eksportowanych danych
  • [Nowy filtr] – umożliwia zdefiniowanie nowego ograniczenia eksportu
  • [Zapisz filtr] – umożliwia zapisanie nowego ograniczenia eksportu, do wyboru są poniższe funkcjonalności:
    • [Zapisz wzorzec filtra] – zapisuje nowe ograniczenie eksportu.
    • [Zmień nazwę wzorca filtra] – umożliwia zmianę nazwy zapisanego wzorca eksportu.
    • [Dopasuj filtr] – umożliwia edycje atrybutów wyszukiwania w aplikacji Dopasuj wyszukiwanie.
    • [Zapisz widok] – umożliwia zapisanie zdefiniowanego widoku.
    • [Przywróć widok] – umożliwia przywrócenie domyślnego widoku.
  • Wybór wzoru filtra – umożliwia wybór zdefiniowanego ograniczenia eksportu.
  • Szablon dokumentu końcowego – umożliwia wybór szablonów dokumentu końcowego, które zostaną wyeksportowane.
  • Oznaczenie – umożliwia odfiltrowanie danych w tabeli po oznaczeniu.
  • Tryb wydania – umożliwia odfiltrowanie danych w tabeli po trybie wydania.
  • Medium wydania – umożliwia odfiltrowanie danych w tabeli po zdefiniowanym sposobie publikacji dokumentu.

Poniżej znajduje się tabela, w której dodawane są wybrane pozycje szablonów dokumentów końcowych, które zostaną wyeksportowane przez aplikację.

Obszar roboczy – zakładka Filtry

Poniżej znajduje się opis pól obowiązkowych oraz głównych atrybutów dla poszczególnych obiektów biznesowych.

Model danych BIS dla szablonów dokumentów składa się z obiektu głównego DocumentOutputOptions oraz powiązań Additions, Replacements i FilterDefinition.  Powiązanie FilterDefinition jest powiązaniem obcym. Additions i Replacements są zależnościami (Dependents). Obiekt główny DocumentOutputOptions modelu danych BIS zawiera następujące atrybuty:

Nazwa pola/Atrybut główny Definicja
code (Atrybut główny) (Pole obowiązkowe) Nazwa szablonu składająca się z maksymalnie 25 znaków.
guid GUID szablonu dokumentu.
description Oznaczenie szablonu dokumentu, może zawierać do 65 znaków i może być tłumaczone na inne języki.
reportGuid GUID raportu, który ma być użyty dla dokumentu końcowego.
reportName (Pole obowiązkowe) Nazwa raportu dla dokumentu końcowego. Nazwa nie może przekraczać 200 znaków.
modes (Pole obowiązkowe) Atrybut zawiera zakodowane specyficzne ustawienia dla publikacji dokumentu, sprecyzowane w aplikacji Szablony dokumentów. (Np. ustawienia drukarki, ustawienia podajnika papieru itd.).
values (Pole obowiązkowe) Atrybut zawiera zakodowane ustawienia wydania. (np. format, liczba kopii)
outputMode (Pole obowiązkowe) Publikacja dokumentu, określa czy dokument będzie opublikowany fizycznie. Dostępne wartości:

  • Wydanie
  • Brak wydania
outputMedium (Pole obowiązkowe) Medium wydania w przypadku użycia danego szablonu dokumentu końcowego. Dostępne wartości:

  • Drukarka
  • Faks
  • E-mail

W zależności od wyboru medium, w aplikacji Szablony dokumentów pojawią się odpowiednie ustawienia.

outputDeviceName (Pole obowiązkowe) Nazwa urządzenia do wydania dokumentu. Atrybut określany jest na podstawie atrybutu values podczas eksportu. Podczas importu uwzględniana będzie jego wartość dla atrybutu values.
printerRedirectDirectory (Pole obowiązkowe) Folder zapisu pliku. W przypadku braku folderu zostanie on utworzony podczas generowania pliku. Należy podać kompletną ścieżkę dla folderu używając schematu file:/// lub kstore://.  Nazwa pliku może zawierać zmienne. Podczas generowania pliku zmienne będą zastępowane odpowiadającymi im wartościami. Poniżej opisano zmienne i ich definicje

  • {report} oznaczenie raportu
  • {user} nazwa użytkownika
  • {timestamp} data i godzina z podaniem milisekund (yyyyMMdd_HHmmss_SSS)
  • {datetime} data i godzina (yyyyMMdd_HHmmss)
  • {date} data (yyyyMMdd)
  • {time} godzina (HHmmss)
  • {week} tydzień kalendarzowy (ww)
  • {year} rok (yyyy)
  • {month} miesiąc (MM)
  • {day} dzień (dd)
  • {document} oznaczenie dokumentu
  • {number} pełny numer zamówienia/zlecenia (rodzaj i numer)

Import/eksport obsługuje również następujące zmienne:

  • #OLTP_DATABASE#
  • #REPOSITORY_DATABASE#

Atrybut określany jest na podstawie atrybutu values podczas eksportu. Podczas importu uwzględniana będzie jego wartość dla atrybutu values.

printerRedirectFile (Pole obowiązkowe) Nazwa pliku bez rozszerzenia może zawierać zmienne. Atrybut określany jest na podstawie atrybutu values podczas eksportu. Podczas importu uwzględniana będzie jego wartość dla atrybutu values.
exportMode (Pole obowiązkowe) Tryb eksportu dla elektronicznej wymiany danych. Dostępne wartości:

  • Eksport
  • Brak eksportu
exportFilterDefinitionGuidexportFilterDefinitionGuid Filtr stosowany w eksporcie. Filtr eksportu należy uprzednio utworzyć w aplikacji Eksport danych. Musi on odpowiadać jednostce biznesowej dokumentu, który ma być wydany przy użyciu szablonu.
exportCreateMode (Pole obowiązkowe) Czas, w którym ma nastąpić eksport. Wartość wybrana dla tego atrybutu odnosi się do ustawienia w atrybucie Tryb eksportu. Dostępne wartości:

  • Podczas wydania oryginału
  • Podczas wydania oryginału i kopii
exportDirectory (Pole obowiązkowe) Tryb eksportu elektronicznej wymiany danych. Należy podać kompletną ścieżkę dla folderu używając schematu file:/// lub kstore://.

Aby nie zapisywać zbyt wielu plików w jednym folderze, następujące zmienne dla przypisywania nazwy folderu:

  • {report} nazwa raportu
  • {user} nazwa użytkownika
  • {timestamp} data i godzina z podaniem milisekund (yyyyMMdd_HHmmss_SSS)
  • {datetime} data i godzina (yyyyMMdd_HHmmss)
  • {date} data (yyyyMMdd)
  • {oltp} baza danych OLTP
  • {time} godzina (HHmmss)
  • {week} tydzień kalendarzowy (ww)
  • {year} rok (yyyy)
  • {month} miesiąc (MM)
  • {day} dzień (dd)
  • {document} oznaczenie dokumentu
  • {number} pełny numer zamówienia/zlecenia (rodzaj i numer)

Import/eksport obsługuje również następujące zmienne:

  • #OLTP_DATABASE#
  • #REPOSITORY_DATABASE#

 

exportFileName (Pole obowiązkowe) Nazwa pliku docelowego dla eksportu bez rozszerzenia pliku. Nazwa pliku może zawierać zmienne. Podczas generowania pliku zmienne będą zastępowane odpowiadającymi im wartościami. Poniżej opisano zmienne i ich definicje:

  • {report} oznaczenie raportu
  • {user} nazwa użytkownika
  • {timestamp} data i godzina z podaniem milisekund (yyyyMMdd_HHmmss_SSS)
  • {datetime} data i godzina (yyyyMMdd_HHmmss)
  • {date} data (yyyyMMdd)
  • {time} godzina (HHmmss)
  • {week} tydzień kalendarzowy (ww)
  • {year} rok (yyyy)
  • {month} miesiąc (MM)
  • {day} dzień (dd)
  • {document} oznaczenie dokumentu
  • {number} pełny numer zamówienia/zlecenia (rodzaj i numer)
exportMimeType (Pole obowiązkowe) Typ danych podczas eksportu utworzonych plików. Aktualnie obsługiwany jest tylko XML (*.xml).
archiveMode (Pole obowiązkowe) Tryb archiwizacji w Zarządzaniu dokumentami. Dostępne wartości:

  • Archiwizuj
  • Nie archiwizuj

Jeśli użytkownik nie posiada odpowiednich uprawnień do zarządzania dokumentami, dostępna jest tylko wartość Nie archiwizuj.

archiveCreateMode (Pole obowiązkowe) Data zapisu w folderze odpowiadającym za archiwizację dokumentów. Wartość wybrana w tym polu odnosi się do ustawienia w polu Tryb archiwizacji. Dostępne wartości:

  • Podczas wydania oryginału
  • Podczas wydania oryginału i kopii
archiveDirectory (Pole obowiązkowe) Folder, w którym zapisywane są kopie w celach archiwizacyjnych dokumentów. Należy podać kompletną ścieżkę dla folderu używając schematu kstore://.

Aby nie zapisywać zbyt wielu plików w jednym folderze, stosuje się następujące zmienne dla przypisywanie nazwy folderu:

  • {report} nazwa raportu
  • {user} nazwa użytkownika
  • {timestamp} data i godzina z podaniem milisekund (yyyyMMdd_HHmmss_SSS)
  • {datetime} data i godzina (yyyyMMdd_HHmmss)
  • {date} data (yyyyMMdd)
  • {time} godzina (HHmmss)
  • {week} tydzień kalendarzowy (ww)
  • {year} rok (yyyy)
  • {month} miesiąc (MM)
  • {day} dzień (dd)
  • {document} oznaczenie dokumentu
  • {number} pełny numer zamówienia/zlecenia (rodzaj i numer)

Import/eksport obsługuje również następujące zmienne:

  • #OLTP_DATABASE#
  • #REPOSITORY_DATABASE#

Jeśli ścieżki Bazy Wiedzy (Knowledge Store) występują w szablonie dokumentu, to podczas eksportu ich nazwy obszarów roboczych (Workspace) odpowiadające nazwom baz danych są zastępowane zmiennymi. Podczas importu zmienne te będą zastąpione nazwami baz danych.

archiveFileName (Pole obowiązkowe) Nazwa pliku zapisu w zarządzaniu dokumentami bez rozszerzenia pliku. Rozszerzenie pliku jest dodawane automatycznie.

Nazwa pliku może zawierać zmienne. Poniżej opisano zmienne i ich definicje:

  • {report} oznaczenie raportu
  • {user} nazwa użytkownika
  • {timestamp} data i godzina z podaniem milisekund (yyyyMMdd_HHmmss_SSS)
  • {datetime} data i godzina (yyyyMMdd_HHmmss)
  • {date} data (yyyyMMdd)
  • {time} godzina (HHmmss)
  • {week} tydzień kalendarzowy (ww)
  • {year} rok (yyyy)
  • {month} miesiąc (MM)
  • {day} dzień (dd)
  • {document} oznaczenie dokumentu
  • {number} pełny numer zamówienia/zlecenia (rodzaj i numer)
archiveOutputFormat (Pole obowiązkowe) Typ plików utworzonych w zarządzaniu dokumentami. Dostępne wartości:

  • PDF (*.pdf)
  • Crystal Reports (*.rpt)
  • HTML (*.html)
  • Microsoft Excel (*.xls)
  • Microsoft Word (*.doc)
  • Rich Text Format (*.rtf)
  • Text (*.txt)
  • Tekst oddzielony przecinkiem (*.csv)
  • Tekst oddzielony pozycją tabulatora (*.tsv)
  • XML (*.xml)

Zależność Additions modelu danych BIS opisuje szablon dodatkowy i zawiera następujące atrybuty:

Nazwa pola/Artybut główny Definicja
guid GUID zależności szablonu
documentOutputOptionsGuid (Atrybut główny) GUID głównego szablonu dokumentu.
sequenceNumber (Atrybut główny) Atrybut określa kolejność wydania szablonów dodatkowych.
additional DocumentOutputOptionsGuid GUID szablonu dodatkowego.

Zależność Replacements modelu danych BIS opisuje szablon zastępczy i zawiera następujące atrybuty:

Nazwa pola/Artybut główny Definicja
guid GUID zależności szablonu
documentOutputOptionsGuid (Atrybut główny) GUID głównego szablonu dokumentu.
personGuid (Atrybut główny) Osoba, dla której ma być użyty zamienny szablon dokumentu.
replacementDocumentOutputOptionsGuid GUID szablonu zamiennego.

Odniesienie obce FilterDefinition opisuje filtr, który jest wykorzystywany podczas eksportu. Zawiera następujące atrybuty:

Nazwa pola/Artybut główny Definicja
guid GUID filtra
name (Atrybut główny) Nazwa filtra

Czy ten artykuł był pomocny?