W systemie pola zdefiniowane przez użytkownika mogą być importowane w celu ich przetwarzania w systemie. Dokument zawiera instrukcje importu pól użytkownika z wykorzystaniem usługi Business Integration Service (BIS), której szczegółowy opis znajduje się w dokumentacji Import danych.
Cechy szczególne pól zdefiniowanych przez użytkownika
Pola zdefiniowane przez użytkownika są wykorzystywane w następujących miejscach w systemie:
- W aplikacji Artykuły oraz Partnerzy, na zakładce Inne pola
- W aplikacji Cechy artykułów
- W aplikacji Zasoby, Operacje oraz Marszruty, na zakładce Parametry
- W aplikacji Reguły konfiguracji produktu, w widoku Parametry konfiguracji
Procedura importu pól niestandardowych zależy od aplikacji, w której zostały utworzone. W przypadku zakładki Inne pola utworzone dane są niezależne od danych aplikacji, w której zostały dodane (import – eksport pól niezależnych). W przeciwieństwie do parametrów utworzonych w aplikacji Zasoby, Operacje lub Marszruty (import – eksport pól zależnych). Proces importu w zależności od zdefiniowanego pola charakteryzuje się następującymi cechami:
- dla pól niezależnych proces importu odbywa się niezależnie od metadanych (danych aplikacji w których zostały zdefiniowane).
- dla pól zależnych proces importu jest związany z importem danych całej aplikacji.
- jeśli w danych aplikacji znajdują się odniesienia do innych pól pomimo ich niezależności, możliwe jest zaimportowanie stworzonych pól przed procesem importu danych aplikacji.
- w przypadku pól zawierających listę wartości dane zdefiniowane przez użytkownika są traktowane jako jedna wartość. Pod czas procesu eksportu zostaną wyeksportowane z systemu wszystkie wartości.
Import
W aplikacji Import danych, na zakładce Filtr 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.
Import rodzajów pól
- Otworzyć aplikację Import danych.
- W polu Filtr wybrać jednostkę biznesową cisag.app.general.extension.obj.Datatype
- W oknie aplikacji widoczny jest filtr dla importu danych.
- Na zakładce filtr są zaznaczone atrybuty z możliwością ich modyfikacji.
Jeżeli w wyszukiwanych przez użytkownika filtrach system nie odnajdzie potrzebnej jednostki biznesowej, wówczas przy pomocy przycisku [Wyszukaj] w oknie dokowanym należy wyszukać interesujący użytkownika obszar i dopiero wtedy zapisać taki filtr jako nowy. Należy pamiętać, że zestaw dostępnych filtrów nie zawiera w sobie wszystkich jednostek biznesowych, lecz jedynie część z nich jako wartości predefiniowane. Pozostałe jednostki biznesowe muszą zostać wyszukane i zapisane jako nowy filtr.
- Użyć przycisku [Importuj dane] na standardowym pasku przycisków.
- Pojawia się okno dialogowe Import danych.
- Możliwe jest wprowadzenie ustawień dla tworzonego pliku importu np. typ pliku, katalog źródłowy. Szczegółowy opis pól znajduje się w dokumentacji aplikacji Import danych.
- Uruchomić import danych za pomocą przycisku [W tle].
Import metadanych Innych pól
- Otworzyć aplikację Import danych.
- W polu Filtr wybrać jednostkę biznesową cisag.app.general.extension.obj.EntityExtensionSet
- W oknie aplikacji widoczny jest filtr dla importu danych.
- Na zakładce filtr są zaznaczone atrybuty z możliwością ich modyfikacji.
Jeżeli w wyszukiwanych przez użytkownika filtrach system nie odnajdzie potrzebnej jednostki biznesowej, wówczas przy pomocy przycisku [Wyszukaj], w oknie dokowanym należy wyszukać interesujący użytkownika obszar i dopiero wtedy zapisać taki filtr jako nowy. Należy pamiętać, że zestaw dostępnych filtrów nie zawiera w sobie wszystkich jednostek biznesowych, lecz jedynie część z nich jako wartości predefiniowane. Pozostałe jednostki biznesowe muszą zostać wyszukane i zapisane jako nowy filtr.
Metadane pól dodatkowych są importowane oraz eksportowane za pomocą jednostki biznesowej com.cisag.app.general.extension.obj.EntityExtensionSet. Jeśli w sekcji filtra znajduje się odniesienie do innego obiektu biznesowego, odbywa się to za pomocą relacji klucza obcego. W tym przypadku atrybuty klucza obcego są automatycznie w relacji wybierane przez system. Wybór ten jest również niezbędny do udanego importu i powinien być zmieniany tylko w wyjątkowych przypadkach.
- Użyć przycisku [Importuj dane] na standardowym pasku przycisków.
- Pojawia się okno dialogowe Import danych.
- Możliwe jest wprowadzenie ustawień dla tworzonego pliku importu np. typ pliku, katalog źródłowy. Szczegółowy opis pól znajduje się w dokumentacji aplikacji Import danych.
- Uruchomić import danych za pomocą przycisku [W tle].
Eksport pól zdefiniowanych przez użytkownika
W systemie pola zdefiniowane przez użytkownika mogą zostać wyeksportowane z systemu w celu ich ręcznej modyfikacji, przeniesienia do innego systemu lub ich analizy. Poniżej znajdują się instrukcje eksportu pól użytkownika z wykorzystaniem usługi Business Integration Service (BIS), której szczegółowy opis znajduje się w dokumentacji Eksport danych.
Eksport
W aplikacji Eksport danych na zakładce Filtr 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.
Eksport metadanych Innych pól
- Otworzyć aplikację Eksport danych.
- W polu Filtr wybrać jednostkę biznesową umożliwiająca eksport danych pól cisag.app.general.extension.obj.EntityExtensionSet lub jednostkę biznesową aplikacji, a której zostaną wyeksportowane inne pola. Spis jednostek biznesowych, z których możliwy jest eksport danych innych pól został przedstawiony poniżej.
Jeżeli w wyszukiwanych przez użytkownika filtrach system nie odnajdzie potrzebnej jednostki biznesowej, wówczas przy pomocy przycisku [Wyszukaj], w oknie dokowanym należy wyszukać interesujący użytkownika obszar i dopiero wtedy zapisać taki filtr jako nowy. Należy pamiętać, że zestaw dostępnych filtrów nie zawiera w sobie wszystkich jednostek biznesowych, lecz jedynie część z nich jako wartości predefiniowane. Pozostałe jednostki biznesowe muszą zostać wyszukane i zapisane jako nowy filtr.
- W oknie aplikacji widoczny jest filtr dla eksportu danych.
- Wybrane atrybuty filtra są już zaznaczone. Możliwa jest edycja filtrów na zakładce Filtr.
- Kliknąć przycisk [Eksport danych] na standardowym pasku przycisków.
- Pojawia się okno dialogowe Eksport danych.
- Możliwe jest wprowadzenie ustawień dla pliku eksportu. Szczegółowy opis pól znajduje się w dokumentacji aplikacji Eksport danych.
- Uruchomić eksport danych za pomocą przycisku [W tle].
Jednostki biznesowe obsługujące Inne pola
Następujące jednostki biznesowe obsługują funkcję Inne pola:
Artykuły (podstawowe) |
com.cisag.app.general.obj.Item |
Artykuły sprzedaży |
com.cisag.app.sales.obj.SalesItem |
Artykuły zakupowe |
com.cisag.app.purchasing.obj.PurchaseItem |
Artykuły produkcyjne |
com.cisag.app.production.obj.ProductionItem |
Rodzaje dokumentów |
com.cisag.app.general.docman.obj.Document |
Dane dostawców artykułu zakupu |
com.cisag.app.purchasing.obj.SupplierPurchaseItem |
Artykuły magazynowe |
com.cisag.app.inventory.obj.InventoryItem |
Dane Księgowe artykułów |
com.cisag.app.financials.obj.ItemAccountingData |
Dane klientów artykułu sprzedaży |
com.cisag.app.sales.obj.CustomerSalesItem |
Partnerzy |
com.cisag.app.general.obj.Partner |
Klienci |
com.cisag.app.sales.obj.Customer |
Pracownicy |
com.cisag.app.general.obj.Employee |
Dane księgowe partnerów |
com.cisag.app.financials.obj.PartnerAccountingData |
Dane marketingowe partnerów |
com.cisag.app.crm.obj.PartnerMarketingInfo |
Dostawcy |
com.cisag.app.purchasing.obj.Supplier |
Klasyfikacja klientów oraz Artykuły sprzedaży |
com.cisag.app.sales.obj.CustomerClassificationItem |
Cechy artykułu |
com.cisag.app.general.obj.ItemPropertyCollection |
Zlecenie pomocy |
com.cisag.app.internal.obj.SupportRequest |
Wymiana danych dla parametrów
Parametry definiowane w produkcji są innymi polami powiązanymi z aplikacjami w których są tworzone. Są one definiowane dla:
- Zasobów
- Grup zasobów
- Operacji
- List zasobów
W przypadku, gdy zdefiniowany parametr odnosi się do typu pola zdefiniowanego w aplikacji Rodzaje pól w momencie eksportu jest tworzony znacznik. Znacznik ten pozwala na odwołanie się do definicji pola po zaimportowaniu danych. Jeśli pole nie odnosi się do rodzaju pola to wszystkie jego dane są zapisywane pod atrybutem DatatypeDefined.
Obszar roboczy – zakładka Filtr
Poniżej znajduje się opis pól obowiązkowych oraz głównych atrybutów dla poszczególnych obiektów biznesowych.
Datatype
Obiekt biznesowy Datatype opisuje atrybuty pola zdefiniowanego przez użytkownika.
Nazwa pola/Atrybut |
Definicja |
Relacja kluczowa |
code (Atrybut główny) |
Rodzaj pola |
|
type |
Rodzaj pola, dostępne są następujące wartości: · STRING – tekst · EMAIL – adres e-mail · URL – Uniform Resource Locator · DATE – Data · TIME – Czas · CLASSIFICATION – Klasyfikacja · FOREGINAMOUNT – kwota · FOREGINPRICE – cena · DOMESTICAMOUNT – kwota w walucie podstawowej · DOMESTICPRICE – cena w walucie podstawowej · DECIMAL – wartość dziesiętna · ILOSĆ – ilość · VALUESET – pole wyboru · BUISNESSOBJECT – jednostka biznesowa |
|
label |
Identyfikator pola |
|
Description |
Nazwa pola |
|
multiValue |
Ilość wartości: |
|
classification |
Identyfikator klasyfikacji. Dotyczy tylko pól typu Klasyfikacja. |
Klasyfikacja zdefiniowana w polu musi być dostępna w systemie (powinna zostać zaimportowana lub stworzona). Może zostać zaimportowana przy pomocy jednostki biznesowej: com.cisag.app.general.exten sion.obj.EntityExtensionHierarchy |
maxLength |
Maksymalna długość pola. Dotyczy tylko typów Tekst, Email oraz URL. |
|
definedValues |
Liczba zdefiniowanych wartości. Dotyczy tylko typu Pole wyboru. |
|
businessEntity |
Identyfikator jednostki biznesowej. Dotyczy tylko pola typu Jednostka biznesowa. |
Odwołuje się do wybranej jednostki biznesowej. |
organizationHierarchyType |
Rodzaj organizacji, którego wymaga zdefiniowane pole. Dotyczy tylko pola typu Jednostka biznesowa. Przyjmuje wartość: · COSTING – dla organizacji kosztowej · EXTERNAL – dla organizacji zewnętrznej · SALES – dla organizacji sprzedaży · FINANCIALS – dla organizacji księgowej · INVENTORY – dla organizacji logistycznej · PURCHASING – dla organizacji zakupu |
|
Ograniczenia typów pól
Dla każdego typu pola jest możliwe określenie ograniczenia dotyczącego dozwolonych wartości. Poniżej zostały przedstawione możliwe ograniczenia w zależności od rodzaju pola:
Rodzaj pola |
Możliwe ograniczenie |
Text |
Długość |
|
Długość |
URL |
Długość |
Data |
DayTypeValues, DayOfWeekValues, DateRangeValues |
Data oraz Czas |
DayTypeValues, DayOfWeekValues, DateRangeValues |
Klasyfikacja |
Klasyfikacje |
Kwota |
CurrencyValues, NumericRangeValues |
Cena |
CurrencyValues, NumericRangeValues |
Kwota w walucie podstawowej |
NumericRangeValues |
Cena w waucie podstawowej |
NumericRangeValues |
Wartość dziesiętna |
NumericRangeValues |
Ilość |
UomTypeValues, UomValues, NumericRangeValues |
Pole wyboru |
ValueSetValues |
Jednostka biznesowa |
Jednostka biznesowa |
AllowedValueSetValues
W konfiguratorze produktu zdefiniowane parametry konfiguracji są ograniczone zdefiniowanym zakresem wartości. W przypadku eksportu innych pól ograniczenie to jest reprezentowane przez atrybut:
Nazwa pola/Atrybut |
Definicja |
Value |
Numeracja dozwolonych wartości wyboru |
ValueSetValues
Atrybuty definiujące wartości pól wyboru:
Nazwa pola/Atrybut |
Definicja |
description |
Identyfikator wartości |
label |
Nazwa wartości |
value |
Numeracja dozwolonych wartości wyboru |
<ValueSetValues> <description>26"</description> <label>Rozmiar ramy 26 cali</label> <value>1</value> </ValueSetValues>
Currency values
W przypadku pola typu Cena lub Kwota, niezbędne jest zdefiniowanie waluty. Waluty są opisane w pliku eksportu/importu poniższym atrybutem:
Nazwa pola/Atrybut |
Definicja |
Currency |
Kod ISO waluty |
<CurrencyValues> <Currency>EUR</Currency> </CurrencyValues>
DateRangeValues
Wartości daty dla pól są opisane poniższymi atrybutami:
Nazwa pola/Atrybut |
Definicja |
Type |
Typ zakresu dat, dopuszczalne są wartości: · BEFORE – przed datą · AFTER – po dacie · BETWEEN – między datami |
dateFrom |
Data rozpoczęcia zakresu |
dateUntil |
Data zakończenia zakresu |
_timeZone |
Strefa czasowa |
<DateRangeValues> <type>AFTER</type> <dateFrom>2022-09-20T22:00:00.000Z</dateFrom> <dateUntil>2022-09-23T22:00:00.000Z</dateUntil> <_timeZone>CET</_timeZone> </DateRangeValues>
DayOfWeekValues
Wartości dni tygodnia dla pól są ograniczone poniższymi atrybutami:
Nazwa pola/Atrybut |
Definicja |
dayOfWeek |
Dzień tygodnia: · SUNDAY – niedziela · MONDAY – poniedziałek · TUESDAY – wtorek · WEDNESDAY – środa · THURSDAY – czwartek · FRIDAY – piątek · SATURDAY – sobota |
<DayTypeValues> <DayType>10</DayType> </DayTypeValues>
UomValues
Jednostki ilości są opisane dla pól poniższym atrybutem:
Nazwa pola/Atrybut |
Definicja |
Uom |
Oznaczenie jednostki miary |
<UomValues> <Uom>cm</Uom> </UomValues>
UomTypeValues
Typy jednostki miary są opisane poniższym atrybutem:
Nazwa pola/Atrybut |
Definicja |
uomType |
Typ jednostki: · LENGHT – dla jednostek długości · VOLUME – dla jednostek objętości · DENSITY – dla jednostek gęstości · MASS – dla jednostek masy · TIME – dla jednostek czasu · OTHER – dla innych jednostek |
<UomTypeValues> <uomType>LENGTH</uomType> </UomTypeValues>
NumericValues
Wartości i zakresy wartości dla pól numerycznych opisane są poniższymi atrybutami:
Nazwa pola/Atrybut |
Definicja |
numericRangeSet |
Identyfikator zakresu |
NumericRange.lowerLimit |
Dolna granica zakresu wartości |
NumericRange.lowerRelOp |
Operatory relacji dla dolnej granicy: · EQUAL – równe · UNEQUAL – nierówne · LESS THAN – mniej niż · GREATER THAN – większe niż · LESS_EQUAL – mniejsze równe niż · GREATER_EQUAL – większe równie niż |
NumericRange.upperLimit |
Górna granica zakresu wartości |
NumericRange.upperRelOp |
Operatory relacji dla górnej granicy: · EQUAL – równe · UNEQUAL – nierówne · LESS THAN – mniej niż · GREATER THAN – większe niż · LESS_EQUAL – mniejsze równe niż GREATER_EQUAL – większe równie niż |
<NumericValues> <NumericRange> <lowerLimit>0</lowerLimit> <lowerRelOp>GREATER_EQUAL</lowerRelOp> <upperLimit>10.000000</upperLimit> <upperRelOp>LESS_EQUAL</upperRelOp> </NumericRange> </NumericValues>
DefaultValues
Wartości domyślne dla typu pola są definiowane w aplikacji Rodzaje pól. Wartość domyślna jest używana jako wartość początkowa dla wybranego pola. Użytkownik posiada możliwość zmiany wartości pola ze zdefiniowaną wartością domyślną. Możliwe jest również zdefiniowanie kilku wartości domyślnych za pomocą parametru Lista wartości. Wartości klasyfikacji i jednostek biznesowych nie mogą być eksportowane. Poniżej znajdują się atrybuty dla eksportu rodzajów pól:
Nazwa pola/Atrybut |
Definicja |
code (Atrybut główny) |
Sekwencja, ma znaczenie dla wielokrotnej wartości |
date.timeStamp |
Wartość daty, ma znaczenie dla rodzaju pola Data |
date.timeZone |
Wartość daty, ma znaczenie dla rodzaju pola Data |
time.timeStamp |
Wartość czasu, ma znaczenie dla rodzaju pola Data i godzina |
time.timeZone |
Wartość czasu, ma znaczenie dla rodzaju pola Data i godzina |
string |
Wartość tekstu, ma znaczenie dla rodzaju pola URL, E-mail oraz Tekst |
Decimal |
Wartość dziesiętna, ma znaczenie dla rodzaju pola Dziesiętny |
quantity.amount |
Wartość ilości, ma znaczenie dla rodzaju pola Ilość |
quantity.uom |
Jednostka ilości, ma znaczenie dla rodzaju pola Ilość |
quantity.Uom |
Oznaczenie jednostki ilości, ma znacznie dla rodzaju pola Ilość |
domesticAmount.amount1 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.currency1 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.amount2 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.currency2 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.amount3 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.currency3 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.exact |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
omesticAmount.exactAmountIn dex |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.Currency1 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.Currency2 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
domesticAmount.Currency3 |
Wartość w walucie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
foreignAmount.amount |
Wartość w walucie nie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
foreignAmount.currency |
Wartość w walucie nie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
foreignAmount.Currency |
Wartość w walucie nie standardowej, ma znaczenie dla rodzaju pola Kwota/Cena |
_organization |
Organizacja odniesienia w celu zdefiniowania waluty standardowej, ma znaczenie dla rodzaju pola Kwota/Cena przyjmującego walutę standardową |
_conversionDate |
Data przewalutowania wartości w walucie lokalnej, ma znaczenie dla rodzaju pola Kwota/Cena przyjmującego walutę standardową |
valueSet |
Wartość wyboru, ma znacznie dla rodzaju pola Pole wyboru |
Atrybuty innych pól dostępne w zależności od użytkownika
W systemie istnieją filtry eksportu wartości innych pól w zależności od definiującego je użytkownika. Metadane są używane dla wszystkich instancji, ale dane zdefiniowane przez użytkownika mogą być użyte w konkretnej instancji. Podczas eksportu/importu należy przestrzegać następujących zasad:
- Proces importu przeprowadzić według instrukcji opisanej w rozdziale Import metadanych Innych pól
- Proces eksportu przeprowadzić według instrukcji opisanej w rozdziale Eksport metadanych innych pól
- Pola muszą zostać utworzone przed zaimportowaniem danych użytkownika
Należy pamiętać, że w zależności od rodzaju pola są przypisywane inne atrybuty. Poniżej wymienione są atrybuty dostępne w filtrze eksportu:
Typ rodzaju pola |
Definicja |
Tekst |
Wartość pola |
|
Wartość pola |
URL |
Wartość pola |
Data |
Znacznik czasu, strefa czasowa |
Data oraz Czas |
Znacznik czasu, strefa czasowa |
Klasyfikacja |
Ścieżka węzła klasyfikacji |
Kwota |
Ilość, waluta |
Cena |
Ilość, waluta |
Kwota w walucie podstawowej |
Ilość 1, ilość 2, ilość 3, ilość (zakodowana w bitach), indeks dokładniej wartości, waluta 1, waluta 2, waluta 3 |
Cena w walucie podstawowej |
Ilość 1, ilość 2, ilość 3, ilość (zakodowana w bitach), indeks dokładniej wartości, waluta 1, waluta 2 , waluta 3 |
Wartość dziesiętna |
Wartość pola |
Ilość |
Ilość, jednostka |
Pole wyboru |
Wybrana wartość pola wyboru |
Jednostka biznesowa |
Identyfikator jednostki biznesowej |
Eksport parametrów
W przypadku parametrów należy wyeksportować metadane oraz dane użytkownika. Eksport metadanych zawiera definicje zdefiniowanych parametrów, a dane użytkownika przypisane im wartości. Poniżej wymienione są atrybuty dostępne dla podczas eksportu pól:
Typ rodzaju pola |
Definicja |
Name |
Nazwa parametru (identyfikator) |
Label |
Nazwa pola |
Description |
Opis pola (Tooltip) |
Sequence |
Sekwencja wyświetlania |
Required |
Parametr – pole obowiązkowe |
Status |
Atrybut ustawiany przez system, podany w celach informacyjnych. |
DatatypeDefined |
Rodzaj pola zdefiniowany dla konkretnego pola. Szczegółowe informacje znajdują się w rozdziale Datatype. |
Datatype |
Odwołanie do rodzaju pola zdefiniowanego w aplikacji Rodzaje pól. Musi zostać wcześniej zaimportowany do systemu. |
Datatype.code (Atrybut główny) |
Nazwa typu pola |
Datatype.type |
Rodzaj pola. Szczegółowe informacje znajdują się w rozdziale Datatype. |
Value |
Dane użytkownika pola. Szczegółowe informacje znajdują się w rozdziale DefaultValues |
Nadpisywanie parametrów
W przypadku importu parametrów jest możliwe ich nadpisanie. Jeśli zostały one zarejestrowane tylko w instancji nadrzędnej (np. zasób – grupa zasobów).
- W filtrze dla obiektu biznesowego ProductionPlan w folderach Parameters i Details.GroupParameter
- W filtrze dla obiektu biznesowego Resource w folderach GroupResourceParameter i GroupResourceUseParameter
można znaleźć następujące atrybuty:
Typ rodzaju pola |
Definicja |
Name |
Nazwa parametru (identyfikator) |
Value |
Dane użytkownika pola. Szczegółowe informacje znajdują się w rozdziale DefaultValues |