Opis konfiguracji ESM
W tym dokumencie opisano schematy XML dla platformy Efecte. Istnieją 2 schematy XML:
- Schemat szablonów definiujących karty danych.
- Schemat kart danych.
Niniejszy dokument jest przeznaczony dla użytkowników oprogramowania Efecte oraz dostawców integracji, którzy muszą zrozumieć schematy XML oprogramowania Efecte.
Uwagi i propozycje usprawnień można przesyłać na adres: servicedesk@efecte.com.
Odbiorcami tego dokumentu są pracownicy techniczni klientów Efecte, którzy chcą zrozumieć możliwości oferowane przez schematy XML Efecte. Przykłady sytuacji, w których schematy XML Efecte mogą być potrzebne:
- Migracja danych z istniejących systemów do Efecte.
- Integracja Efecte z istniejącymi systemami informatycznymi.
- Aktualizacja danych Efecte przy użyciu danych zebranych przez Efecte Inspector .
W niniejszym dokumencie zastosowano następujące nazwy i skróty:
Nazwa |
Opis |
Atrybut |
Atrybuty to najmniejsze bloki informacji w hierarchii danych Efecte. Etykietują pola karty danych oraz definiują reguły i właściwości dla dozwolonych typów danych. |
Klasa |
Podczas tworzenia szablonu możesz grupować zestawy atrybutów, które zazwyczaj występują razem, w ramach jednej klasy, dzięki czemu możesz ponownie wykorzystać tę grupę także w innych szablonach. |
Wiszące odniesienie |
Odwołanie z karty danych do innej karty danych, która nie zawiera żadnych danych. |
Karta danych |
Karta danych to miejsce, w którym informacje w systemie Efecte są przechowywane i wyświetlane użytkownikom. Karta danych opiera się na szablonie, który definiuje jej wygląd i dopuszczalną zawartość informacyjną. |
Pole karty danych |
Pola kart danych przechowują część informacji z karty danych. Pole karty danych jest definiowane przez powiązany z nim atrybut. |
Odniesienie osadzone |
Relacja nadrzędny-podrzędny pomiędzy szablonami, a zatem i kartami danych prezentującymi te szablony. |
HMAC |
Uwierzytelnianie wiadomości za pomocą kryptograficznej funkcji skrótu (MD5 lub SHA-1) w połączeniu z tajnym kluczem współdzielonym. Importowanie XML z systemów zewnętrznych może odbywać się za pomocą HMAC. |
Odniesienie |
Odwołanie to link z atrybutu do szablonu lub szablonów albo do adresu zewnętrznego. Na karcie danych odwołanie pojawia się jako link z karty danych do innej karty danych lub do adresu zewnętrznego. |
Szablon |
Szablon składa się z klas i atrybutów, które określają na przykład wygląd i dozwoloną zawartość kart danych. |
XML |
XML to skrót od Extensible Markup Language (rozszerzalny język znaczników). Jest to sposób prezentacji hierarchicznie ustrukturyzowanych danych w formacie czytelnym dla człowieka. |
Definicja szablonu
Szablony definiują strukturę danych dla kart danych w produktach Efecte. Szablony zawierają klasy, które działają jak kontenery dla atrybutów. Atrybuty definiują właściwości pól kart danych, takie jak ich typ danych oraz sposób ich wstawiania i prezentowania, tj. typ danych wejściowych i wyjściowych. Poniższy rysunek przedstawia relację między szablonami a kartami danych. Należy zauważyć, że nie widać związku między klasami a danymi, ponieważ klasy służą głównie do porządkowania danych wyjściowych. Klasy mogą być również używane do udostępniania danych między szablonami, są one „przeciążone” i nie służą wyłącznie do porządkowania danych wyjściowych.
Więcej informacji na temat struktury szablonu można znaleźć w Podręczniku administratora Efecte. Celem poniższych akapitów jest wyjaśnienie funkcjonalności interfejsu XML szablonu. Zrozumienie struktury szablonu jest przydatne do lepszego zrozumienia faktycznego interfejsu XML karty danych.
Eksport szablonu XML
Eksport szablonu XML można wykonać z poziomu interfejsu użytkownika Efecte opartego na przeglądarce internetowej lub za pośrednictwem API Efecte Web. Wynikowy plik XML będzie zawierał wybrane szablony i wszystkie ich właściwości. Podczas kopiowania szablonów między różnymi instancjami Efecte, ważne jest, aby wszystkie szablony, które mają między sobą odniesienia, zostały wyeksportowane razem, tak aby odniesienia te zostały automatycznie odtworzone podczas importowania pliku XML do innej instancji Efecte.
Narzędzie do transportu konfiguracji (CTT) może pomóc w procesie eksportu i importu szablonów. Należy pamiętać, że obsługuje ono tylko jeden szablon na raz. Aby uzyskać więcej informacji na temat narzędzia CTT, zapoznaj się z artykułem „Narzędzie do transportu konfiguracji” .
Import szablonu XML
Szablony można importować do instancji Efecte za pośrednictwem interfejsu użytkownika opartego na przeglądarce internetowej Efecte. Nie jest przeprowadzana synchronizacja ani aktualizacja istniejących danych hierarchii szablonów, co oznacza, że szablony są tworzone jako nowe instancje szablonów, nawet jeśli istnieje już szablon o tych samych danych identyfikacyjnych. To zachowanie może ulec zmianie w przyszłych wersjach Efecte.
Definicja karty danych
Format XML karty danych służy do przesyłania danych z karty danych między Efecte a systemami zewnętrznymi. Interfejs użytkownika Efecte i API sieciowe oferują możliwość tworzenia nowych kart danych, a także aktualizacji istniejących. Kolejne rozdziały wyjaśnią najpierw, jak działa import karty danych, a następnie omówią funkcjonalność eksportu.
Importowanie kart danych
Podstawy importu
Importy danych są zawsze ukierunkowane na określony szablon. Na przykład, aby zaimportować użytkowników z systemów zewnętrznych, szablon użytkownika musi istnieć w Efecte. Rezultatem importu jest utworzenie nowych kart danych lub aktualizacja istniejących.
Szablon definiuje typy danych karty danych, dlatego importowane typy danych należy uwzględnić podczas tworzenia szablonu do importu danych. Na przykład, jeśli importowani mają być użytkownicy, a zewnętrzne dane użytkownika zawierają datę urodzenia, należy utworzyć szablon Efecte, aby zawierał on również odpowiednie pole daty.
Import kart danych obsługuje wszystkie typy atrybutów obsługiwane przez platformę Efecte:
Typ danych |
Ograniczenia dotyczące formy danych |
Smyczkowy |
Maksymalna długość jest zdefiniowana w pliku framework.properties . Domyślnie to 450 znaków. Bazy danych obsługują różne długości, dlatego jeśli długość ciągu znaków zostanie zwiększona w stosunku do domyślnej, należy zwrócić uwagę na ograniczenia bazy danych. |
Numer |
Liczba jest ograniczona przez typ całkowity Java : –2^31 – 2^31 oraz możliwe ograniczenia bazy danych. Zazwyczaj bazy danych obsługują co najmniej ten sam zakres, co liczby całkowite Java . |
Liczba dziesiętna |
Format liczb dziesiętnych jest zdefiniowany w pliku framework.properties . Można ustawić żądaną precyzję liczb dziesiętnych. Java BigDecimal i zakres liczb w bazie danych definiują prawidłowy zakres liczb dziesiętnych. |
Data |
Wzorzec wprowadzania daty jest podany w pliku framework.properties . Jeśli oryginalne dane mają inny wzorzec, należy je przekonwertować zgodnie ze wzorcem w programie Efecte lub dodać wzorzec daty wejściowej do programu Efecte. Minimalne i maksymalne wartości daty można skonfigurować w pliku framework.properties i również zależą one od bazy danych. |
Data i godzina |
Wzorzec wprowadzania daty i godziny jest podany w pliku framework.properties . Jeśli oryginalne dane mają inny wzorzec, należy je przekonwertować zgodnie ze wzorcem w programie Efecte lub dodać wzorzec wejściowy do programu Efecte. Minimalne i maksymalne wartości daty można skonfigurować w pliku framework.properties i również zależą one od bazy danych. |
Tekst |
Jedynym ograniczeniem tekstu są ograniczenia sprzętowe (pamięć RAM i miejsce na dysku twardym). |
Odniesienia |
Odwołania podlegają tym samym ograniczeniom co ciągi znaków. |
Osadzone odniesienia |
Odwołania osadzone podlegają tym samym ograniczeniom co ciągi znaków. |
Odniesienia zewnętrzne |
Odwołania zewnętrzne podlegają tym samym ograniczeniom co ciągi znaków. |
Dane zewnętrzne można zaimportować do dowolnego z tych typów, jeśli walidacja wybranego typu zakończy się pomyślnie. Walidacja sprawdza poprawność typu, a także inne możliwe ograniczenia, takie jak unikalność, oraz czy wartość jest wymagana.
Dopasowywanie przychodzącej karty danych do szablonu
Prawidłowy typ karty danych – tj. szablon – dla przychodzących danych XML jest definiowany za pomocą kodu szablonu, który powinien być unikalny wśród szablonów w instancji Efecte. Analogicznie, pola karty danych są dopasowywane do przychodzących danych XML za pomocą kodów atrybutów. Zatem, jeśli chcemy zaimportować karty danych komputerowych do Efecte i użyliśmy kodu szablonu „komputer” dla szablonu komputerowego, musimy użyć tego samego kodu w przychodzącym elemencie szablonu XML. Poniższy fragment kodu XML przedstawia element szablonu, który sprawia, że dane XML są dopasowywane do karty danych z szablonem komputerowym.
<template code="computer"/>
Dopasowywanie przychodzącej karty danych do istniejącej
Aby móc dopasować przychodzący plik XML karty danych do istniejącej karty danych w systemie Efecte, musi istnieć pole karty danych zdefiniowane jako unikatowe w konfiguracji atrybutów szablonu. Import Efecte interpretuje przychodzące dane na podstawie informacji z szablonu, a po znalezieniu unikatowego pola, Efecte próbuje dopasować je do danych w istniejących kartach danych. W przypadku znalezienia dopasowania, istniejąca karta danych zostanie zaktualizowana.
Pola referencyjne
Jeśli importowane karty danych zawierają pola referencyjne (zdefiniowane za pomocą ustawienia typu danych atrybutu w hierarchii szablonów), te odniesienia są tworzone podczas importu poprzez dopasowanie danych elementu wartości atrybutu XML do unikalnych wartości pól w istniejących kartach danych Efecte. Jeśli mamy kartę danych zgłoszenia pomocy technicznej z polem referencyjnym do szablonu klienta, możemy mieć w pliku XML następujące wiersze, aby utworzyć odniesienie do odpowiedniego klienta.
<attribute code="job_client">
<value>job.client@company.com</value>
</attribute>
Jeśli definicja szablonu klienta zawiera pole adresu e-mail zdefiniowane jako unikatowe i w programie Efecte istnieje karta danych klienta z tym samym adresem e-mail, co w powyższym pliku XML, otrzymamy odniesienie między zaimportowanym biletem a istniejącym klientem.
Wiszące odniesienia
Czasami karta danych, która odwołuje się do innej karty danych, jest importowana do Efecte przed kartą danych, do której się odwołuje. W takim przypadku funkcja „wiszących odniesień” może zostać wykorzystana do wcześniejszego utworzenia odniesienia. Efecte osiąga to poprzez utworzenie pustej karty danych w miejscu karty danych, do której się odwołuje. Po zaimportowaniu karty danych, do której się odwołuje, pustą kartę danych zaktualizuje, a w rezultacie w Efecte znajdują się zarówno karty danych, jak i odniesienie między nimi.
Osadzone odniesienia
Osadzone referencje służą do tworzenia struktur kart danych typu rodzic-dziecko, w których cykl życia karty danych dziecka jest zależny od karty nadrzędnej. Usunięcie karty nadrzędnej danej karty powoduje również usunięcie karty podrzędnej. Żadna inna karta danych nie może odwoływać się do karty podrzędnej; jest ona w całości własnością karty nadrzędnej. Relacje kart danych typu rodzic-dziecko można importować do programu Efecte, ale z pewnym ograniczeniem: karta nadrzędna i jej karty podrzędne muszą być zaimportowane w tym samym dokumencie XML i muszą używać elementu embeddedreference do określenia referencji między nimi. Oto przykład, jak wygląda osadzona referencja w formacie XML wewnątrz encji nadrzędnej:
<attribute code="embedded_display">
<embeddedreference id="559122" name="DISP0001"/>
</attribute>
Wówczas w tym samym pliku XML będziesz mieć również osadzoną kartę danych z pasującym identyfikatorem.
<entity id="559122" name="DISP0001">
Notatki dotyczące karty danych
Notatki do kart danych można również tworzyć za pomocą interfejsu importu XML. Oto przykładowy fragment XML przedstawiający pojedynczą notatkę:
<note creator="user_1" timestamp="21.01.2004 00:42" follow-references="false">
<name>Should this card be deleted?</name>
<text><![CDATA[I think that this card could be removed from the system. Am I correct?]]></text>
</note>
Przykład importu karty danych
W produkcie Efecte Asset istnieje szablon o nazwie Komputer w domyślnym wyborze szablonów. Zaprezentujemy teraz scenariusz, w którym nowy komputer jest tworzony w Efecte za pomocą interfejsu importu XML. Dla zwięzłości, XML został skrócony i zawiera tylko kilka pól karty danych. Oto XML:
<?xml version="1.0" encoding="UTF-8" ?>
<entityset>
<entity name="COMPUTER001">
<template code="computer"/>
<attribute code="software">
<value>ATI Display Driver</value>
<value>Java Web Start</value>
</attribute>
<attribute code="host_name">
<value>computer001</value>
</attribute>
</entity>
</entityset>Jak widać z pliku XML, zaimportowany komputer zawiera dwa pola: oprogramowanie i nazwę hosta. Teraz wystarczy, że nasz szablon komputera będzie zawierał kod „komputer”, a oba pola będą miały odpowiadające sobie kody w szablonie komputera. Załóżmy, że nazwa hosta jest unikalnym identyfikatorem kart danych komputera.
Atrybut oprogramowania w naszym szablonie „Komputer” został skonfigurowany jako odwołanie do szablonu „Oprogramowanie”. Oznacza to, że dla każdego typu oprogramowania mamy osobne karty danych. Podczas importu odwołania są tworzone poprzez dopasowanie zawartości elementów wartości XML do unikalnych pól w instancji „Efecte”. Oznacza to, że w naszym przykładzie musimy zdefiniować co najmniej jeden atrybut jako unikalny, a rzeczywiste pola danych zdefiniowane przez ten atrybut powinny zawierać nazwy oprogramowania. Jak opisano w rozdziale 3.1.5, możemy użyć trybu odwołania wiszącego do tworzenia kart oprogramowania z importami komputerów.
Wysyłanie żądania importu
Dostęp do interfejsu importu XML karty danych można uzyskać na kilka sposobów. Najprostszym sposobem jest skorzystanie z interfejsu użytkownika Efecte opartego na przeglądarce internetowej. Dane można również zaimportować, wysyłając plik XML jako żądanie HTTP POST na określony adres URL Efecte. Dla oprogramowania zewnętrznego należy wygenerować kod uwierzytelniania wiadomości (HMAC), który zostanie przesłany jako parametr w żądaniu HTTP. Efecte udostępnia narzędzia importu, które pomagają w generowaniu skrótów i konwertowaniu danych zewnętrznych do akceptowalnej postaci XML.
W Efecte 4.0 wprowadzono web API , które jest preferowanym sposobem importowania kart danych do Efecte. Nie są potrzebne żadne narzędzia do generowania HMAC, ponieważ stosowane jest uwierzytelnianie HTTP BASIC; wystarczy identyfikator użytkownika i hasło. Korzystanie z web API przez HTTPS jest niezbędne, aby zapobiec przesyłaniu poufnych informacji w postaci zwykłego tekstu.
Eksportowanie kart danych
Karty danych można eksportować z programu Efecte w formacie XML. Funkcjonalności wyszukiwania programu Efecte pozwalają na zdefiniowanie zestawu eksportowanych kart danych. Dodatki zawierają przykładowy wygląd wyeksportowanego pliku XML karty danych. Jak widać, format XML jest bardzo podobny do formatu importu. Schemat XML karty danych zawiera wiele opcjonalnych atrybutów, ponieważ zazwyczaj tylko podzbiór atrybutów jest potrzebny w przypadku importu, podczas gdy w formacie eksportu potrzeba więcej atrybutów, aby zachować notatki karty danych, osadzone odniesienia i tym podobne.
Narzędzie Efecte Service Management Tool (ESM) udostępnia dwa różne interfejsy API : API sieciowe i REST API (zastępujące poprzednie), które umożliwiają wyszukiwanie kart danych. Umożliwia to pobranie informacji o kartach danych z Efecte.
Załączniki
Opis hierarchii szablonów
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<!--
Efecte Template hierarchy XML Schema Definition
$Revision: 19053 $
$Date: 2006-03-14 15:07:15 +0200 $
-->
<xs:element name="templateset">
<xs:complexType>
<xs:sequence>
<xs:element ref="template" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="template">
<xs:complexType>
<xs:sequence>
<xs:element ref="id" minOccurs="0" maxOccurs="1"/>
<xs:element ref="code" minOccurs="1" maxOccurs="1"/>
<xs:element ref="name" minOccurs="1" maxOccurs="1"/>
<xs:element ref="description" minOccurs="0" maxOccurs="1"/>
<xs:element ref="system-code" minOccurs="1" maxOccurs="1"/>
<xs:element ref="protected" minOccurs="1" maxOccurs="1"/>
<xs:element ref="reference-cascade" minOccurs="1" maxOccurs="1"/>
<xs:element ref="class" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="id" type="xs:string"/>
<xs:element name="code" type="xs:string"/>
<xs:element name="name" type="xs:string"/>
<xs:element name="description" type="xs:string"/>
<xs:element name="system-code" type="xs:string"/>
<xs:element name="protected" type="xs:boolean"/>
<xs:element name="reference-cascade" type="xs:boolean"/>
<xs:element name="class">
<xs:complexType>
<xs:sequence>
<xs:element ref="id" minOccurs="0" maxOccurs="1"/>
<xs:element ref="name" minOccurs="1" maxOccurs="1"/>
<xs:element ref="order" minOccurs="1" maxOccurs="1"/>
<xs:element ref="attribute" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="order" type="xs:nonNegativeInteger"/>
<xs:element name="attribute">
<xs:complexType>
<xs:sequence>
<xs:element ref="id" minOccurs="0" maxOccurs="1"/>
<xs:element ref="code" minOccurs="0" maxOccurs="1"/>
<xs:element ref="name" minOccurs="1" maxOccurs="1"/>
<xs:element ref="primary" minOccurs="0" maxOccurs="1"/>
<xs:element ref="datatype" minOccurs="1" maxOccurs="1"/>
<xs:element ref="odniesienia" minOccurs="0" maxOccurs="1"/>
<xs:element ref="opis" minOccurs="0" maxOccurs="1"/>
<xs:element ref="domyślny" minOccurs="0" maxOccurs="1"/>
<xs:element ref="wielowartościowy" minOccurs="1" maxOccurs="1"/>
<xs:element ref="wyjście-jest-zawsze-pokazywane" minOccurs="1" maxOccurs="1"/>
<xs:element ref="statyczny" minOccurs="1" maxOccurs="1"/>
<xs:element ref="wartości-statyczne" minOccurs="0" maxOccurs="1"/>
<xs:element ref="hierarchia" minOccurs="1" maxOccurs="1"/>
<xs:element ref="hierarchy-leafs-only" minOccurs="1" maxOccurs="1"/>
<xs:element ref="specjalny" minOccurs="1" maxOccurs="1"/>
<xs:element ref="rozszerz-odniesienia-automatycznie" minOccurs="1" maxOccurs="1"/>
<xs:element ref="expand-complete-output-automatically" minOccurs="1" maxOccurs="1"/>
<xs:element ref="import-odwołane-dane-do-odwołującego" minOccurs="1" maxOccurs="1"/>
<xs:element ref="handler" minOccurs="0" maxOccurs="1"/>
<xs:element ref="nagłówek" minOccurs="0" maxOccurs="1"/>
<xs:element ref="stopka" minOccurs="0" maxOccurs="1"/>
<xs:element ref="dużytekst" minOccurs="1" maxOccurs="1"/>
<xs:element ref="zapytanie-ukryte" minOccurs="1" maxOccurs="1"/>
<xs:element ref="ukrytewyjście" minOccurs="1" maxOccurs="1"/>
<xs:element ref="ukryty-nagłówek-zapytania" minOccurs="1" maxOccurs="1"/>
<xs:element ref="ukryty-nagłówek-wyjściowy" minOccurs="1" maxOccurs="1"/>
<xs:element ref="szerokość-pola" minOccurs="1" maxOccurs="1"/>
<xs:element ref="wysokość-pola" minOccurs="1" maxOccurs="1"/>
<xs:element ref="zapotrzebowanie-na-przestrzeń" minOccurs="1" maxOccurs="1"/>
<xs:element ref="zamówienie" minOccurs="1" maxOccurs="1"/>
<xs:element ref="wybrane" minOccurs="1" maxOccurs="1"/>
<xs:element ref="unikalny" minOccurs="1" maxOccurs="1"/>
<xs:element ref="wymagane" minOccurs="1" maxOccurs="1"/>
<xs:element ref="chroniony" minOccurs="1" maxOccurs="1"/>
<xs:element ref="metadane" minOccurs="0" maxOccurs="nieograniczony"/>
</xs:sekwencja>
</xs:complexType>
</xs:element>
<xs:element nazwa="podstawowa" typ="xs:boolean"/>
<xs:element nazwa="typdanych">
<xs:simpleType>
<xs:ograniczenie podstawa="xs:string">
<xs:wyliczenie wartość="data"/>
<xs:wyliczenie wartość="dataigodzina"/>
<xs:wyliczenie wartość="osadzoneodniesienie"/>
<xs:wyliczenie wartość="odniesieniezewnętrzne"/>
<xs:wyliczenie wartość="float"/>
<xs:wyliczenie wartość="liczbacałkowita"/>
<xs:wyliczenie wartość="odniesienie"/>
<xs:wyliczenie wartość="ciąg"/>
<xs:wyliczenie wartość="tekst"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element nazwa="odniesienia">
<xs:complexType>
<xs:sekwencja>
<xs:element nazwa="odniesienie" typ="xs:string" minOccurs="1" maxOccurs="nieograniczony"/>
</xs:sekwencja>
</xs:complexType>
</xs:element>
<xs:element nazwa="domyślna" typ="xs:string"/>
<xs:element nazwa="wielowartościowy" typ="xs:boolean"/>
<xs:element nazwa="wyjście-jest-zawsze-pokazywane" typ="xs:boolean"/>
<xs:element nazwa="statyczna" typ="xs:boolean"/>
<xs:element nazwa="wartości-statyczne">
<xs:complexType>
<xs:sekwencja>
<xs:element ref="wartość-statyczna" minOccurs="1" maxOccurs="nieograniczony"/>
</xs:sekwencja>
</xs:complexType>
</xs:element>
<xs:element nazwa="wartość-statyczna">
<xs:complexType>
<xs:sekwencja>
<xs:element ref="wartość" minoccurs="0" maxOccurs="1"/>
<xs:element ref="wartość-statyczna" minOccurs="0" maxOccurs="nieograniczony"/>
</xs:sekwencja>
<xs:atrybut nazwa="wartość" typ="xs:string" użyj="opcjonalne"/>
</xs:complexType>
</xs:element>
<xs:element nazwa="wartość" typ="xs:string"/>
<xs:element nazwa="hierarchia" typ="xs:boolean"/>
<xs:element nazwa="hierarchy-leafs-only" typ="xs:boolean"/>
<xs:element nazwa="specjalny" typ="xs:boolean"/>
<xs:element nazwa="rozszerz-odniesienia-automatycznie" typ="xs:boolean"/>
<xs:element nazwa="rozszerz-uzupełnij-wyjście-automatycznie" typ="xs:boolean"/>
<xs:element nazwa="import-odwołane-dane-do-referrer" typ="xs:boolean"/>
<xs:element nazwa="obsługujący" typ="xs:string"/>
<xs:element nazwa="nagłówek" typ="xs:string"/>
<xs:element nazwa="stopka" typ="xs:string"/>
<xs:element nazwa="dużytekst" typ="xs:boolean"/>
<xs:element nazwa="zapytanie-ukryte" typ="xs:boolean"/>
<xs:element nazwa="ukrytewyjście" typ="xs:boolean"/>
<xs:element nazwa="ukryty-nagłówek-zapytania" typ="xs:boolean"/>
<xs:element nazwa="ukrytynagłówekwyjściowy" typ="xs:boolean"/>
<xs:element nazwa="szerokość-pola" typ="xs:nonNegativeInteger"/>
<xs:element nazwa="wysokość-pola" typ="xs:nonNegativeInteger"/>
<xs:element nazwa="potrzeba-przestrzeni">
<xs:simpleType>
<xs:ograniczenie podstawa="xs:integer">
<xs:minInclusive wartość="1"/>
<xs:maxInclusive wartość="4"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element nazwa="wybrane" typ="xs:boolean"/>
<xs:element nazwa="unikalna" typ="xs:boolean"/>
<xs:element nazwa="wymagane" typ="xs:boolean"/>
<xs:element nazwa="metadane">
<xs:complexType>
<xs:atrybut nazwa="nazwa" typ="xs:string" użyj="wymagane"/>
<xs:atrybut nazwa="wartość" typ="xs:string" użyj="wymagane"/>
</xs:complexType>
</xs:element>
</xs:schema>Przykład szablonu XML
<?xml version="1.0" encoding="UTF-8"?>
<templateset>
<template>
<id>171</id>
<code>client_contact</code>
<name>Contact</name>
<system-code>client</system-code>
<protected>false</protected>
<reference-cascade>false</reference-cascade>
<class>
<id>279</id>
<name>Contact information</name>
<order>0</order>
<attribute>
<code>contact_first_name</code>
<name>First name</name>
<datatype>string</datatype>
<multivalue>false</multivalue>
<output-is-always-shown>false</output-is-always-shown>
<static>false</static>
<hierarchy>false</hierarchy>
<hierarchy-leafs-only>false</hierarchy-leafs-only>
<special>false</special>
<expand-references-automatically>false</expand-references-automatically>
<expand-complete-output-automatically>false</expand-complete-output-automatically>
<import-referenced-data-to-referrer>false</import-referenced-data-to-referrer>
<large-text>false</large-text>
<query-hidden>false</query-hidden>
<output-hidden>false</output-hidden>
<query-header-hidden>false</query-header-hidden>
<output-header-hidden>false</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>3</space-demand>
<order>100</order>
<selected>false</selected>
<unique>false</unique>
<required>false</required>
<protected>false</protected>
</attribute>
<attribute>
<name>Photo</name>
<datatype>externalreference</datatype>
<multivalue>false</multivalue>
<output-is-always-shown>false</output-is-always-shown>
<static>false</static>
<hierarchy>false</hierarchy>
<hierarchy-leafs-only>false</hierarchy-leafs-only>
<special>true</special>
<expand-references-automatically>false</expand-references-automatically>
<expand-complete-output-automatically>false</expand-complete-output-automatically>
<import-referenced-data-to-referrer>false</import-referenced-data-to-referrer>
<handler>com.bitmount.equipment.entitydatahandler.plugin.ImageHandler</handler>
<large-text>false</large-text>
<query-hidden>true</query-hidden>
<output-hidden>true</output-hidden>
<query-header-hidden>false</query-header-hidden>
<output-header-hidden>false</output-header-hidden>
<field-width>40</field-width>
<field-height>1</field-height>
<space-demand>4</space-demand>
<order>100</order>
<selected>false</selected>
<unique>false</unique>
<required>false</required>
<protected>false</protected>
</attribute>
<attribute>
<code>contact_last_name</code>
<name>Last name</name>
<datatype>string</datatype>
<multivalue>false</multivalue>
<output-is-always-shown>false</output-is-always-shown>
<static>false</static>
<hierarchy>false</hierarchy>
<hierarchy-leafs-only>false</hierarchy-leafs-only>
<special>false</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>3</space-demand>
<order>200</order>
<selected>fałsz</selected>
<unique>fałsz</unique>
<required>fałsz</required>
<protected>fałsz</protected>
</atrybut>
<atrybut>
<code>contact_full_name</code>
<nazwa>Pełny imię</nazwa>
<primary>prawda</primary>
<datatype>ciąg</datatype>
<multivalue>fałsz</multivalue>
<output-is-always-shown>fałsz</output-is-always-shown>
<static>fałsz</static>
<hierarchy>fałsz</hierarchy>
<hierarchy-leafs-only>fałsz</hierarchy-leafs-only>
<special>prawda</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<handler>com.bitmount.equipment.entitydatahandler.plugin.AttributeCombinerHandler</handler>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>3</space-demand>
<order>300</order>
<selected>prawda</selected>
<unique>prawda</unique>
<required>fałsz</required>
<protected>fałsz</protected>
<metadane nazwa="imię_kontaktu" wartość="20"/>
<metadane nazwa="nazwisko_kontaktowe" wartość="10"/>
<metadane nazwa="separator" wartość=","/>
</atrybut>
<atrybut>
<code>contact_company</code>
<name>Firma</name>
<datatype>ciąg</datatype>
<multivalue>fałsz</multivalue>
<output-is-always-shown>fałsz</output-is-always-shown>
<static>prawda</static>
<wartościstatyczne>
<wartość-statyczna>
<wartość>Firma 1</wartość>
</wartość-statyczna>
<wartość-statyczna>
<wartość>Firma 2</value>
</wartość-statyczna>
</wartości-statyczne>
<hierarchy>fałsz</hierarchy>
<hierarchy-leafs-only>fałsz</hierarchy-leafs-only>
<special>fałsz</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>1</space-demand>
<order>350</order>
<selected>fałsz</selected>
<unique>fałsz</unique>
<required>fałsz</required>
<protected>fałsz</protected>
</atrybut>
<atrybut>
e-mail
<name>E-mail</name>
<datatype>ciąg</datatype>
<multivalue>fałsz</multivalue>
<output-is-always-shown>fałsz</output-is-always-shown>
<static>fałsz</static>
<hierarchy>fałsz</hierarchy>
<hierarchy-leafs-only>fałsz</hierarchy-leafs-only>
<special>fałsz</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>3</space-demand>
<order>400</order>
<selected>prawda</selected>
<unique>prawda</unique>
<required>prawda</required>
<protected>fałsz</protected>
</atrybut>
<atrybut>
<code>numer_telefonu_kontaktowego</code>
<nazwa>Telefon numer</nazwa>
<datatype>ciąg</datatype>
<multivalue>fałsz</multivalue>
<output-is-always-shown>fałsz</output-is-always-shown>
<static>fałsz</static>
<hierarchy>fałsz</hierarchy>
<hierarchy-leafs-only>fałsz</hierarchy-leafs-only>
<special>fałsz</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>1</field-height>
<space-demand>1</space-demand>
<order>450</order>
<selected>fałsz</selected>
<unique>fałsz</unique>
<required>fałsz</required>
<protected>fałsz</protected>
</atrybut>
<atrybut>
<code>adres_kontaktowy</code>
<name>Adres</name>
<datatype>tekst</datatype>
<multivalue>fałsz</multivalue>
<output-is-always-shown>fałsz</output-is-always-shown>
<static>fałsz</static>
<hierarchy>fałsz</hierarchy>
<hierarchy-leafs-only>fałsz</hierarchy-leafs-only>
<special>fałsz</special>
<expand-references-automatically>fałsz</expand-references-automatically>
<expand-complete-output-automatically>fałsz</expand-complete-output-automatically>
<import-referenced-data-to-referrer>fałsz</import-referenced-data-to-referrer>
<large-text>fałsz</large-text>
<query-hidden>fałsz</query-hidden>
<output-hidden>fałsz</output-hidden>
<query-header-hidden>fałsz</query-header-hidden>
<output-header-hidden>fałsz</output-header-hidden>
<field-width>25</field-width>
<field-height>4</field-height>
<space-demand>3</space-demand>
<order>600</order>
<selected>fałsz</selected>
<unique>fałsz</unique>
<required>fałsz</required>
<protected>fałsz</protected>
</atrybut>
</klasa>
</szablon>
</zestaw_szablonów>Schemat XML karty danych Efecte
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<xs:element name="entityset">
<xs:complexType>
<xs:sequence>
<xs:element ref="entity" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- entity element contains the data for one card -->
<xs:element name="entity">
<xs:complexType>
<!-- entity element contains either scanner error or data elements -->
<xs:choice>
<xs:element ref="error" minOccurs="1" maxOccurs="1"/>
<xs:group ref="standardEntityElements"/>
</xs:choice>
<xs:attribute name="id" type="xs:string" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
<xs:attribute name="ip" type="xs:string" use="optional"/>
<!-- If card is marked as hidden, it is not defaultly shown in -->
<!-- Efecte UI. This mode is used for Efecte Help closed jobs -->
<xs:attribute name="hidden" type="xs:boolean" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="error" type="xs:string"/>
<xs:group name="standardEntityElements">
<xs:sequence>
<xs:element ref="template" minOccurs="1" maxOccurs="1"/>
<xs:element ref="attribute" maxOccurs="unbounded"/>
<xs:element ref="note" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:group>
<xs:element name="template">
<xs:complexType>
<xs:attribute name="id" type="xs:string" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
<xs:attribute name="code" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="attribute">
<xs:complexType>
<xs:sequence>
<xs:element ref="header" minOccurs="0"/>
<xs:choice>
<xs:element ref="value" maxOccurs="unbounded"/>
<xs:element ref="reference" maxOccurs="unbounded"/>
<xs:element ref="embeddedreference" maxOccurs="unbounded"/>
<xs:element ref="externalreference" maxOccurs="unbounded"/>
</xs:choice>
<xs:element ref="footer" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="id" type="xs:string" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
<xs:attribute name="code" type="xs:string" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="reference">
<xs:complexType>
<xs:attribute name="id" type="xs:string" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="embeddedreference">
<xs:complexType>
<xs:attribute name="id" type="xs:string" use="optional"/>
<xs:attribute name="name" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="externalreference">
<xs:complexType>
<xs:attribute name="name" type="xs:string" use="optional"/>
<xs:attribute name="location" type="xs:string" use="optional"/>
</xs:complexType>
</xs:element>
<xs:element name="header" type="xs:string"/>
<xs:element name="value" type="xs:string"/>
<xs:element name="footer" type="xs:string"/>
<xs:element name="note">
<xs:complexType>
<xs:sequence>
<xs:element ref="name" minOccurs="1" maxOccurs="1"/>
<xs:element ref="text" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
<xs:attribute name="creator" type="xs:string" use="required"/>
<xs:attribute name="timestamp" type="xs:string" use="optional"/>
<xs:attribute name="follow-references" type="xs:boolean" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="name" type="xs:string"/>
<xs:element name="text" type="xs:string"/>
</xs:schema>Przykład 1 karty danych Efecte w formacie XML (wyeksportowany z Efecte)
<?xml version="1.0" encoding="ISO-8859-15"?>
<entityset>
<entity id="230626" name="Amarillion Amanda">
<template id="26" name="Contact" code="client"/>
<attribute id="1100" name="Last name" code="last_name">
<value>Amarillion</value>
</attribute>
<attribute id="1099" name="First name" code="first_name">
<value>Amanda</value>
</attribute>
<attribute id="1584" name="Company" code="company">
<reference id="230404" name="Customer Company"/>
</attribute>
<attribute id="1974" name="Title" code="title">
<value>Senior Manager</value>
</attribute>
<attribute id="1112" name="Email" code="email">
<value>amanda.amarillion@customercompany.com</value>
</attribute>
<attribute id="1101" name="Full name" code="full_name">
<value>Amarillion Amanda</value>
</attribute>
<attribute id="1201" name="ID" code="person_number">
<value>CLIENT10379</value>
</attribute>
<attribute id="1206" name="Direct phone" code="direct_phone">
<value>555 5555</value>
</attribute>
<attribute id="2194" name="Mobile phone" code="gsm">
<value>055 555 5555</value>
</attribute>
<attribute id="458456" name="Department" code="department">
<value>LEGAL</value>
</attribute>
</entity>
</entityset>
Przykład 2 karty danych Efecte w formacie XML (zwrócony przez Efecte Inspector )
<?xml version="1.0" encoding="UTF-8" ?>
<entityset>
<entity name="COMPUTER001">
<template code="computer"/>
<attribute code="computer_name">
<value>COMPUTER001</value>
</attribute>
<attribute code="scanning_date">
<value>2004-05-21 14:22:27</value>
</attribute>
<attribute code="ram">
<value>1023</value>
<footer>MB</footer>
</attribute>
<attribute code="software">
<value>ArGoSoft Mail Server Pro</value>
<value>ATI Display Driver</value>
<value>BEA WebLogic Platform 8.1</value>
<value>F-Secure Anti-Virus for Windows NT Server</value>
<value>F-Secure BackWeb</value>
<value>F-Secure Management Agent</value>
<value>Internet Explorer Q831167</value>
<value>Java Web Start</value>
</attribute>
<attribute code="computer_product_serial">
<value></value>
</attribute>
<attribute code="bios_serial_number">
<value></value>
</attribute>
<attribute code="mother_board_serial_number">
<value>AZMV30807979</value>
</attribute>
<attribute code="display_adapter">
<value>Radeon 7000 / Radeon VE</value>
</attribute>
<attribute code="processor_count">
<value>1</value>
</attribute>
<attribute code="system_environment_variables">
<value>ComSpec=%SystemRoot%\system32\cmd.exe</value>
<value>NUMBER_OF_PROCESSORS=1</value>
<value>OS=Windows_NT</value>
<value>Os2LibPath=%SystemRoot%\system32\os2\dll;</value>
<value>PATHEXT=.COM;.EXE;.BAT;.CMD;.VBS;.VBE;.JS;.JSE;.WSF;.WSH</value>
<value>PROCESSOR_ARCHITECTURE=x86</value>
<value>PROCESSOR_IDENTIFIER=x86 Family 15 Model 2 Stepping 7, GenuineIntel</value>
<value>PROCESSOR_LEVEL=15</value>
<value>PROCESSOR_REVISION=0207</value>
<value>Path=%SystemRoot%\system32;%SystemRoot%;%SystemRoot%\System32\Wbem;C:\Program Files\Resource
Kit\</value>
<value>TEMP=%SystemRoot%\TEMP</value>
<value>TMP=%SystemRoot%\TEMP</value>
<value>windir=%SystemRoot%</value>
</attribute>
<atrybut kod="usługa">
<value>Alert</value>
<wartość>F-Secure BackWeb</value>
<wartość>beasvc moja_domena_mój_serwer</value>
<wartość>Efecte Proxy</value>
<wartość>Tło Inteligentny Przenosić Usługa</value>
<wartość>Komputer Przeglądarka</value>
<wartość>Rozproszone Plik System</value>
<wartość>DHCP Klient</value>
<wartość>Logiczny Dysk Menedżer</value>
<wartość>DNS Serwer</value>
<wartość>DNS Klient</value>
<wartość>Wydarzenie Dziennik</value>
<wartość>COM+ Wydarzenie System</value>
<wartość>F-Secure Portier Treser Starter</value>
<wartość>F-Secure Sieć Wniosek Broker</value>
<wartość>F-Secure Kierownictwo Agent</value>
<wartość>Intersite Wiadomości</value>
<wartość>Kerberos Klawisz Dystrybucja Centrum</value>
<value>Serwer</value>
<value>Stacjarobocza</value>
<wartość>Licencja Wycięcielasu Usługa</value>
<wartość>TCP/IP NetBIOS Pomocnik Usługa</value>
<value>Merkury</value>
<value>Komunikat</value>
<wartość>Rozproszone Transakcja Koordynator</value>
<wartość>Sieć Logowanie</value>
<wartość>Sieć Połączenia</value>
<wartość>Plik Replikacja Usługa</value>
<wartość>NT LM Bezpieczeństwo Wsparcie Pro</value>
<wartość>Usuwalny Przechowywanie</value>
<wartość>Wtyczka I Odtwórz</value>
<wartość>IPSEC Polityka Agent</value>
<wartość>Pro Przechowywanie</value>
<wartość>Zdalny Dostęp Automatyczny Połączenie Menedżer</value>
<wartość>Zdalny Dostęp Połączenie Menedżer</value>
<value>Effecte Zdalny</value>
<wartość>Zdalny Rejestr Usługa</value>
<wartość>Zdalny Procedure Dzwonić (RPC) Lokalizator</value>
<wartość>Zdalny Procedure Dzwonić (RPC)</value>
<wartość>Bezpieczeństwo Konta Menedżer</value>
<wartość>Zadanie Harmonogram</value>
<wartość>Uruchomjako Usługa</value>
<wartość>System Wydarzenie Powiadomienie</value>
<wartość>SoundMAX Agent Usługa</value>
<wartość>Drukuj Bufor</value>
<value>Telefonia</value>
<wartość>Terminal Usługi</value>
<wartość>Rozproszone Połączyć Śledzenie Serwer</value>
<wartość>Rozproszone Połączyć Śledzenie Klient</value>
<wartość>Okna Czas</value>
<wartość>Okna Kierownictwo Instrumentacja</value>
<wartość>Okna Kierownictwo Oprzyrządowanie Kierowca Rozszerzenia</value>
<wartość>Automatyczne Aktualizacje</value>
<wartość>Efecte Agent</value>
</atrybut>
<atrybut kod="domena_windows">
<value>TEST</value>
</atrybut>
<atrybut kod="nazwa_hosta">
<value>komputer001</value>
</atrybut>
<atrybut kod="domena">
<value>mojadomena.com</value>
</atrybut>
<atrybut kod="data_biosu">
<value>25.10.02</value>
</atrybut>
<atrybut kod="typ_systemu">
<value>x86</value>
</atrybut>
<atrybut kod="producent_systemu">
<value>D850MV</value>
</atrybut>
<atrybut kod="model_systemu">
<value>MV85010A</value>
</atrybut>
<atrybut kod="dysk_twardy">
<wartość>Maxtor 6E040L0 (atapi)</value>
</atrybut>
<atrybut kod="napęd">
<wartość>C:\ 30,87 WielkaBrytania / 38,28 GB</value>
</atrybut>
<atrybut kod="cdrom">
<wartość>HL-DT-ST DVD-ROM GDR8161B (atapi)</value>
</atrybut>
<atrybut kod="pojemność_dysku">
<value>38,28</value>
<footer>GB</footer>
</atrybut>
<atrybut kod="prędkość_procesora">
<value>2407</value>
<footer>MHz</footer>
</atrybut>
<atrybut kod="ostatni_zalogowany_użytkownik">
<value>Administrator</value>
</atrybut>
<atrybut kod="os">
<wartość>Okna 2000 Serwer</value>
</atrybut>
<atrybut kod="service_pack">
<wartość>Usługa Pakiet 4</value>
</atrybut>
<atrybut kod="id_produktu">
<value>51876-335-7841125-05307</value>
</atrybut>
<atrybut kod="adres_ip">
<value>10.1.1.51</value>
<value>10.1.1.50</value>
</atrybut>
<atrybut kod="typ_ip">
<value>statyczny</value>
</atrybut>
<atrybut kod="domyślna_bramka">
<wartość>10.1.1.1</wartość>
</atrybut>
<atrybut kod="maska_podsieci">
<wartość>255.255.255.0</wartość>
<wartość>255.255.255.0</wartość>
</atrybut>
<atrybut kod="adres_mac">
<value>00-04-75-C2-2F-51</value>
</atrybut>
<atrybut kod="karta_sieciowa">
<wartość>3Com EtherLink PCI</value>
</atrybut>
<atrybut kod="wpełni_kwalifikowana_nazwa_domeny">
<value>komputer001.mycompany.com</value>
</atrybut>
<atrybut kod="processor_vendor">
<value>Intel</value>
</atrybut>
<atrybut kod="model_procesora">
<wartość>Intel(R) Pentium(R) 4 Procesor 2,40GHz</value>
</atrybut>
<atrybut kod="użytkownicy">
<value>Administrator</value>
</atrybut>
<atrybut kod="inspector_agent_version">
<value>2.0.20</value>
</atrybut>
<atrybut kod="unikalny_id">
<value>c14a2a0f-b0d5-4019-bbb28018efef318b</value>
</atrybut>
</jednostka>
</zestaw_jednostek>