Uživatelské nástroje

Nástroje pro tento web


crm:admin:xmltrans

Transportní soubor crm

Úvod

InTouch CRM umí zpracovat takovýto soubor a na jeho základě vytvořit kontakt, případně k němu příslušné obchodní případy a to včetně vložených produktů, služeb i položek.

V podstatě se jedná o XML dokument jehož struktura je popsána v DTD souboru na adrese www.anneca.cz/dtd/intouch.dtd. Jednotlivé značky a jejich popis je uveden níže. Nechybí ani jednoduchý příklad již vytvořeného dokumentu.

Struktura dokumentu

Struktura dokumentu je naznačena v následující ukázce. Blok customer označuje kontakt (zákaznáka) a musí být uveden vždy alespoň jednou. Blok buscase označuje obchodní případ a nemusí být uveden vůbec, stejně jako položky obchodního případu (bcitems). Všechny tyto základní bloky mohou být v dokumentu zopakovány vícekrát. Z toho plyne, že v jednom dokumentu může být libovolný počet kontaktů (vždy alespoň jeden), k němu příslušných obchodních případů (různých typů) a každý obch. případ může (ale nemusí) obsahovat libovolné množství položek (položek, služeb, produktů).

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE InTouch-CRM SYSTEM "http://www.anneca.cz/dtd/intouch.dtd">
<InTouch-CRM>
	<customer>
		<company>Název společnosti</company>
		...
		<buscase>
			<class>com.anneca.intouch.shop.Order</class>
			<subject>Nějaký název</subject>
			...
			<buscase-param>
				<param-name>jméno parametru</param-name>
				<param-value>hodnota</param-value>
			</buscase-param>
			...
			<bcitem>
				<type>1</type>
				<orderCode>obj-kod</orderCode>
				<title>Název produktu</title>
				<qty>3</qty>
				<unit>101</unit>
				...
			</bcitem>
		</buscase>
		...
	</customer>
</InTouch-CRM>

Výsledný dokument se do InTouch CRM dopraví jako příloha mailu. Příloha musí mít příponu crm, jinak ji InTouch CRM nebude zpracovávat požadovaným způsobem, ale bude se k ní chovat jako k jakémukoliv jinému souboru příslušného typu.

Seznam jednotlivých značek

V následujících tabulkách jsou v abecedním poředí uvedeny všechny podporované značky, rozdělené podle příslušnosti k jednotlivým sekcím. Tabulka vždy obsahuje název značky, popis (význam) a možné hodnoty, kterých může nabývat.

Kontakt

Zde uvedené značky jsou uzavřeny do bloku customer, který se musí v dokumentu nelézat vždy alespoň jednou. Pokud je v tabulce hodnota prázdná, jde o textový řetězec nebo číslo.

ZNAČKAPOPISHODNOTA
acceptance Souhlasí se zpracováním osobních údajů true/false
acceptanceAll Souhlasí s poskytováním osobních údajů třetím osobám true/false
bankAccount Číslo účtu
bankCode Kód banky
bankSymbol Spec.symbol
bornNumber Rodné číslo
buscaseBlok s informací o obch. případuPodřízený blok
card Číslo zákaznické karty
city Město
cityM Město (korespondenční)
comment Komentář
company Společnost
country Země Dvoumístný kód země (cs, sk, …)
datakt Datum aktualizace Datum ve tvaru dd.mm.yyyy (22.6.2005)
datvzn Datum vzniku Datum ve tvaru dd.mm.yyyy (22.6.2005)
department Oddělení
dic DIČ
drvlst Druh vlastnictví Hodnota z číselníku „Druh vlastnictví“ v InTouch CRM
email E-mail
emailSec E-mail 2
employees Počet pracovníků Hodnota z číselníku „Počet zaměstnanců“ v InTouch CRM
fax Fax
firstname Jméno
hearAbout Jak se o nás dozvěděl Hodnota z číselníku „How hear About Us“ v InTouch CRM
ico IČO
id Kód Kód zákazníka v databázi InTouch CRM
importance Důležitost Hodnota z číselníku „Customer: importance“ v InTouch CRM
importProtected Neaktualizovat z importu true/false
language Jazyk komunikace Hodnota z číselníku „Languages“ v InTouch CRM (např. cz, sk, rus, en, …)
mobile Mobil
newsLetter Zasílat zpravodaj true/false
okec5A OKEČ 1 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
okec5B OKEČ 2 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
okec5C OKEČ 3 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
okec5D OKEČ 4 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
okec5E OKEČ 5 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
okec5F OKEČ 6 Hodnota z číselníku „Číselný kod klasifikace OKEČ“ v InTouch CRM
ourInfo Zasílat info o našich akcích true/false
ownerGroup Vlastník (skupina) Zkratka uživatelské skupiny
ownerUser Vlastník (uživatel) Přihl. jméno uživatele InTouch CRM
partnerInfo Zasílat info partnerů true/false
pravfor Právní forma Hodnota z číselníku „Právní forma“ v InTouch CRM
private Osobní true/false
role Pozice/Funkce
salutation Oslovení
seller Obchodník Přihl. jméno uživatele InTouch CRM
shire Okres Hodnota z číselníku „Okres“ v InTouch CRM
sna Sektory národních účtu Hodnota z číselníku „Sektory národních účtu“ v InTouch CRM
street Ulice a č.
street1 Ulice a č. 2
street1M Ulice a č. 2 (korespondenční)
street2 Ulice a č. 3
street2M Ulice a č. 3 (korespondenční)
streetM Ulice a č. (korespondenční)
surname Příjmení
symbol Symbol Identifikátor kontaktu v jiném
telPrivate Telefon 3
telWork Telefon
telWork2 Telefon 2
titleAfter Titul za jménem
titleBefore Titul před jménem
turnOver Roční obrat (mil. Kč) Desetinné číslo
turnOverYear Rok obratu Např. 2004
typfo Typ fyzické osoby Hodnota z číselníku „Typ fyzické osoby“ v InTouch CRM
useHtmlMailPoužít HTML formát v emailu
velobec Velikost obce Hodnota z číselníku „Velikost obce“ v InTouch CRM
vip VIP kontakt true/false
web Web Internetová adresa kontaktu
z_jmeni Základní jmění Celé číslo
zip PSČ
zipM PSČ (korespondenční)

Obchodní případ

Zde uvedené značky jsou uzavřeny do bloku buscase, který musí být vnořen do bloku customer. Může také úplně chybět.

ZNAČKAPOPISHODNOTA
agendaCategoryZařazeníHodnota z číselníku „Zařazení“ v InTouch CRM
approvedSchválenoDatum ve tvaru dd.mm.yyyy hh:mm (22.6.2005 14:45)
approvedBySchválil(a)Přihl. jméno uživatele InTouch CRM
bcitemPoložka obchodního případuPodřízený blok
buscase-paramBlok s parametry specifickými pro daný typ obch. případuVždy obsahuje dva prvky [param-name (název), param-value (hodnota)]
canceledStornovánotrue/false
caseTypeTyp obch. případuČíslo typu obch. případu ze seznamu typů obch. případů v InTouch CRM
classTřída (class) obch. případu Hodnota „class“ typu obch. případu ze seznamu typů obch. případů v InTouch CRM. Musí být vždy uvedena.
commentKomentář
currencyMěna ve které je zadána hodnota „entMoney“Není-li uvedeno, použije se výchozí měna z nastavení obch. případu
discountBySleva: změna oDesetinné číslo
discountPercentSleva: v %Celé číslo
discountToSleva: naDesetinné číslo
discountTypeTyp slevy 0 - žádná, 1 - v %, 2 - o, 3 - na
entMoneyČástkaDesetinné číslo, částka napevno vložená do obch. případu
expenseNákladyDesetinné číslo, částka napevno vložená do obch. případu
expenseCurrencyMěna ve které je zadána hodnota „expense“Není-li uvedeno, použije se výchozí měna z nastavení obch. případu
finishSplnit doDatum ve tvaru dd.mm.yyyy (22.6.2005 14:45)
finishedSplněnoDatum ve tvaru dd.mm.yyyy (22.6.2005 14:45)
ownerGroupVlastník (skupina)Zkratka uživatelské skupiny
ownerUserVlastník (uživatel)Přihl. jméno uživatele InTouch CRM
payedZaplacenotrue/false
responsibleVyřizujePřihl. jméno uživatele InTouch CRM nebo zkratka uživ. skupiny uvozená znakem #
sellerObchodníkPřihl. jméno uživatele InTouch CRM
showInCalendarZobrazovat v kalendářitrue/false
subjectNázev
vatDPH0 - bez, 1 - nižší (10%), 2 - vyšší (20%)

Položka obch. případu

ZNAČKAPOPISHODNOTA
commentKomentář
discountBySleva: změna oDesetinné číslo
discountPercentSleva: v %Celé číslo
discountToSleva: naDesetinné číslo
discountTypeTyp slevy0 - žádná, 1 - v %, 2 - o, 3 - na
lockedUzamčenotrue/false
orderCodeObjednávkový kódObjednávkový kód produktu (jinde než u produktu se neuvádí)
qtyMnožstvíČíslo (celé nebo desetinné podle typu zvolené jednotky)
refIdReferenční kódU produktu „id“ v databázi (nemusí být uvedeno), u služby „kód“ (nutné), u položky se neuvádí
storeSkladId skladu v databázi, není-li uvedeno použije se sklad dle nastavení (jen u produktů)
titleNázev (titulek)
typeTyp položky1 - produkt, 2 - služba, 3 - položka. Musí být vždy uvedeno
unitJednotkaKód jednotky podle tabulky uvedené dále v textu
unitExpenseNáklady na jednotkuDesetinné číslo (pouze u položky)
unitPriceJednotková cenaDesetinné číslo (pouze u položky)</entry>

Tabulka jednotek (unit)

Tabulka jednotek obsahuje ke každé jednotce používané v InTouch CRM její kód. Používejte prosím jednotky společně s množstvím řádným způsobem, aby nedocházelo k tekovým věcem jako je např. 2,5 kusu nějakého produktu a podobně.

JednotkaHODNOTA
Sekunda1
Minuta2
Hodina3
Den4
Týden5
Měsíc6
čtvrtletí7
Půlrok8
Rok9
Kus101
Procento201
Gram301
Dekagram302
Kilogram303
Tuna304
Milimetr401
Centimetr402
Metr403
Kilometr404
Mililitr501
Decilitr502
Litr503
Hektolitr504

Ukázkový soubor crm

V následujícím textu je uveden příklad jednoduchého crm souboru. Obsahuje jednen kontakt k němu příslušný obchodní případ typu objednávka a v něm produkt, službu a položku.

		
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE InTouch-CRM SYSTEM "http://www.anneca.cz/dtd/intouch.dtd">
<InTouch-CRM>
	<customer>
		<company>Anneca s.r.o.</company>
		<surname>Bleša</surname>
		<firstname>Tomáš</firstname>
		<titleBefore>Ing.</titleBefore>
		<role>Jednatel</role>
		<ico>48528919</ico>
		<dic>214-48528919</dic>
		<street>Hrbovická 182</street>
		<city>Ústí nad Labem</city>
		<zip>40001</zip>
		<web>www.anneca.cz</web>
		<email>info@anneca.cz</email>
		<buscase>
			<class>com.anneca.intouch.shop.Order</class>
			<subject>Testovací objednávka</subject>
			<entMoney>100</entMoney>
			<currency>EUR<currency>
			<buscase-param>
				<param-name>comment</param-name>
				<param-value>Komentář k obchodnímu případu</param-value>
			</buscase-param>
			<!-- Produkt -->
			<bcitem>
				<type>1</type>
				<orderCode>obj-kod</orderCode>
				<title>InTouch CRM</title>
				<qty>1</qty>
				<unit>101</unit>
			</bcitem>
			<!-- Služba -->
			<bcitem>
				<type>2</type>
				<refId>PROGR</refId>
				<title>Rozšíření InTouch CRM</title>
				<qty>7.5</qty>
				<unit>3</unit>
				<!-- Sleva 5% -->
				<discountType>1</discountType>
				<discountPercent>5</discountPercent>
			</bcitem>
			<!-- Obecná položka -->
			<bcitem>
				<type>3</type>
				<title>Další služby</title>
				<qty>6</qty>
				<unit>6</unit>
				<!-- Nastavení ceny -->
				<unitExpense>800</unitExpense>
				<unitPrice>2100</unitPrice>
				<vat>1</vat>
				<!-- Sleva na 10 000 -->
				<discountType>3</discountType>
				<discountTo>10000</discountTo>
			</bcitem>
		</buscase>
	</customer>
</InTouch-CRM>
				

Blok buscase-param byl použit pouze jako ukázka. V tomto případě by bylo pohodlnější použít značku comment. Blok buscase-param je vhodné použít tam, kde je nadefinován vlastní typ obch. případu a pro příslušné specifické kolonky neexistuje odpovídající značka.

Zpracování souboru v InTouch CRM

Vytvořený soubor přijmeme jako přílohu e-mailu v InTouch CRM. Po kliknutí na tuto přílohu označenou ikonou ikonka souboru CRM. Aplikace soubor zpracuje a nabídne nám možnosti jak získané informace uložit do InTouch CRM. Ke každému bloku customer se pokusí najít odpovídající záznamy v již existující databázi a nabídne možnost připojení obch. případů k některému z již existujících záznamů. Případně můžeme použít kontakt přímo obsažený v souboru ne bo vybrat úplně jiný kontakt z databáze. V okamžiku kdy jsme s výběrem spokojeni, stiskneme tlačítko uložit. Aplikace vytvoří příslušné kontakty i obch. případy a zobrazí seznam právě vytvořených obch. případů.

 zpracování souboru CRM

crm/admin/xmltrans.txt · Poslední úprava: 23.05.2010 11:05 (upraveno mimo DokuWiki)