fxLdapSync - synchronizace FX/MX uživatelů proti LDAP

Účel a funkce aplikace
Konfigurace aplikace
Popis logiky synchronizace pro FaxChange
Popis logiky synchronizace pro MobilChange

Účel a funkce aplikace

FXLDAPsync je aplikace synchronizující uživatelskou databázi FaxChange/MobilChange s LDAP serverem (tj. uživatelé musí být uloženi v databázi, ne v Active Directory; uživatelé MobilChange mohou být i v registry).

Do databáze serveru FaxChange (MobilChange) přistupuje přes existující rozhraní fxODBC (ADO), musí být tedy nainstalována na stejném serveru, kde je spuštěn FaxChange (MobilChange). Pro instalaci stačí zkopírovat obsah adresáře support\FaxChange\FxLDAPsync na UMS CD na disk serveru.
Aplikace zjišťuje dle zadaného filtru seznam uživatelů na straně LDAP a podle nich zakládá, konfiguruje nebo maže uživatele v databázi FaxChange (MobilChange). O své činnosti může zapisovat zprávy do umsMonitoru (je nutné vložit do registru soubor umsmonitor.reg z instalačního adresáře) a odesílá výsledky mailem na zvolenou adresu.

Aplikaci lze spouštět ručně nebo v pravidelných intervalech libovolným task schedulerem, např. jako úlohu umsTaskManageru.

zpět na začátek

Konfigurace aplikace

Konfigurace aplikace je uložena v registry v klíči [HKLM/Software/datasys/faxchange/fxldapsync].

Popis jednotlivých hodnot:

cesky_telecom= 0 - normální režim (synchronizace na základě e-mail adresy), 1 - režim Český Telecom (synchronizace na základě EmplID). Platí jen pro FaxChange
email_gw - typ gatewaye pro odeslání mailu, defaultně "s" (SMTP)
enable_add - povolení/zakázání (1/0) přidávání nových uživatelů do databáze
enable_remove - povolení/zakázání (1/0) mazání uživatelů z databáze
fx_charset - název kódování řetězců ve FX databázi, defaultně (není-li zadáno): CP1250
Možné hodnoty viz dokumentace knihovny libiconv
fx_server - jméno FaxChange (MobilChange) serveru
is_ad = 0/1 - nastavení pro režim Český Telecom udává, zda jde o X500 / AD
ldap_filter - filtr pro čtení z LDAPu, defaultně je to: (serialNumber=*). Pokud v LDAPu neexistuje atribut serialNumber, je nutno zadat validní filtr !
ldap_charset - název kódování řetězců v LDAPu, defaultně (není-li zadáno): UTF-8
ldap_multi_filter - template filtru pro případ kdy ldap_only_once=0; obsahuje-li řetězec "%s", dosazují se za něj písmena abecedy; pokud hodnota neexistuje, pracuje se s "(mail=%s*)"

tabulka mapování názvů LDAP atributů (ldap_nm_*) s doporučeným nastavením pro Active Directory. Hodnoty ldap_dv_* jsou defaultní hodnoty atributů (pokud ve LDAPu atribut neexistuje, vezme se tato hodnota), ldap_mf_* je přepínač modifikace hodnoty u existujícího uživatele (1=modifikovat hodnotu u existujícího uživatele (defaultně), 0=nemodifikovat).

ldap_nm_EmplID=DsFx2ID	ldap_dv_EmplID	--	ID uživatele, např. osobní číslo zaměstnance
ldap_nm_fEmail=mail	ldap_dv_fEmail	ldap_mf_fEmail	mail adresa
ldap_nm_Mobile=mobile	ldap_dv_Mobile	ldap_mf_Mobile	mobilní telefon
ldap_nm_fName=displayName	ldap_dv_fName	ldap_mf_fName	zobrazované jméno nebo jméno (givenname)
ldap_nm_fName2	ldap_dv_fName2	ldap_mf_fName2	příjmení (sn)
ldap_nm_fCostCode=DsFx2Costcode	ldap_dv_fCostCode	ldap_mf_fCostCode	účtovací kód uživatele
ldap_nm_Phone=telephoneNumber	ldap_dv_Phone	ldap_mf_Phone	telefon
ldap_nm_FaxNum=facsimileTelephoneNumber	ldap_dv_FaxNum	ldap_mf_FaxNum	fax
ldap_nm_FaxFlg	ldap_dv_FaxFlg	ldap_mf_FaxFlg	nastavení práv uživatele ve FaxChange
ldap_nm_fCover=DsFx2Coversheet	ldap_dv_fCover	ldap_mf_fCover	název krycí stránky faxu
ldap_nm_fGroup=DsFx2Group	ldap_dv_fGroup	ldap_mf_fGroup	skupina uživatele ve FaxChange
ldap_nm_Division	ldap_dv_Division	ldap_mf_Division	divize
ldap_nm_Dept=department	ldap_dv_Dept	ldap_mf_Dept	oddělení
ldap_nm_Job	ldap_dv_Job	ldap_mf_Job	název pozice zaměstnance
ldap_nm_Street=streetAddress	ldap_dv_Street	ldap_mf_Street	adresa
ldap_nm_City=l	ldap_dv_City	ldap_mf_City	město

Červené hodnoty - použity pouze v FX módu
Zelené hodnoty - použity v obou módech
Černé hodnoty - použity pouze v MX módu

ldap_only_once – způsob načítání uživatelů z LDAP serveru. Je-li rovno 0, LDAP uživatelé se získávají postupným načítáním dle písmen abecedy (nutno použít v případě, že LDAP server neumožní vrátit uživatele jediným dotazem), jinak se získají jediným dotazem. Defaultní hodnota je 1.
ldap_server_1 - prvni LDAP startovní bod, zadáno ve tvaru: host|port|root_dn|search_base|heslo
Příklad: 192.168.16.202||cn=Dir Manager,o=CESKY TELECOM,c=CZ||pass
Není-li zadán port (viz příklad), vezme se defaultní hodnota 389.
Není-li zadána search base, vytvoří se z root_dn (v příkladu se vezme: o=CESKY TELECOM,c=CZ)
Heslo musí být uloženo v zakódované podobě - vloží se tak, že se program poprvé spustí s parametrem /w a heslo zadané přes klávesnici se do registru uloží v zakódované podobě.
ldap_server_2, ldap_server_3, ... - další startovní body, pokud jsou potřeba.
ldap_sync_e - e-mailová adresa odesílatele. Zprávy s informacemi od "fxldapsync" budou odesílány s touto email adresou (default hodnota je fxLdapsync@localhost).
logpath - je-li zadáno, pak se ukládá log soubor ve tvaru fxldapsyncYYMMDD.log do tohoto adresáře
loglevel - úroveň logování: 1 (nejméně) až 5 (nejvíce), defaultně 3
pabx_len - délka provolby (PABX)
r_admines - e-mailová adresa administrátora (příjemce)
r_adminns - jméno administrátora (příjemce)
restricted_faxs - seznam faxových čísel oddělených středníkem, která se nebudou k uživatelům vkládat

Příklad nastavení v registrech pro LDAP server typu MS Active directory je v souboru fxLdapSync.reg v instalačním adresáři.

Command line parametry:

fxLdapSync [volby]
volby: /<appname>      typ aplikace (FX nebo MX). Pokud nezadáno, bere se FX
       /w              dotáže se na heslo root_DN
       /d<path>        cesta k log souboru. Platí jen pokud parametr "logpath" v registry již není
       /r<path>        název alternativní konfigurace. Ta musí být uložena jako subklíč pod HKLM/Software/datasys/faxchange/fxldapsync.
       /h              help

Alternativní konfigurace se hodí pro oddělené nastavení synchronizace pro FaxChange a MobilChange, případně při synchronizaci proti více LDAP serverům s různým nastavením.
Nástroj umí synchronizovat i distribuční skupiny a veřejné složky (pouze viditelné v adresáři) - nastavení ldap_filter ze souboru fxLdapSync.reg to umožňuje. Je ale nutno přidat kontejner "Microsoft Exchange System Objects" v Active Directory do prohledávaných větví.

zpět na začátek

Popis logiky synchronizace pro FaxChange

Společná část

Aplikace načte do paměti všechny uživatele z FX databáze, kteří mají bit 2 v poli fControl = 0 (tj. ne FX skupiny).
Aplikace načte do paměti všechny uživatele ze všech v konfiguraci odkazovaných LDAP stromů.

Může se stát, že některé položky (např. FAXFLG) v LDAPu nebudou. V takovém případě aplikace převezme z konfigurace defaultní hodnotu a použije ji, jako by byla v LDAPu.
V režimu "Český Telecom" je další zpracování specifické pro tuto firmu a není dále popsáno. Běžně se používá dále popsaný "normální" režim.

"Normální" režim

U každého uživatele v FX databázi načte jeho pole FreeText a rozparsuje ho. Zajímají nás položky:

NoSync – nesynchronizovat účet
AutoPABX – poslední použitá faxová provolba
EmailHand – synchronizovat částečně/úplně (1/0)

Pro všechny záznamy, které mají vyplněný fEmail a nemají NoSync=1:

vyhledá v načteném LDAP záznam se stejnou e-mail adresou
najde-li:
- přenese do FX databáze podle konfigurace následující položky z LDAPu (viz tabulka dále)
  1. jméno / display name (jen při plné synchronizaci)
  2. jméno FX skupiny (jen při plné synchronizaci)
  3. faxovací práva (jen při plné synchronizaci)
  4. costcode
  5. jméno coversheetu (jen při plné synchronizaci)
  6. Employee ID
  7. nastaví fGate = hodnota email_gw (jen při plné synchronizaci)
- zpracuje PABX pro daného uživatele:
  1. vezme z LDAPu faxové číslo uživatele, vezme z něj zprava posledních [pabx_len] číslic (nové PABX)
  2. pokud AutoPABX = nové PABX: nedělá nic
  3. pokud AutoPABX <> nové PABX:
    - smaže z tabulky tPABX záznam, který má fPABX = AutoPABX a zároveň fUserId = UserId aktuálního FX záznamu
    - založí v tabulce tPABX záznam fPABX = nové PABX, fUserId = aktuální UserId
    - zapíše/změní u FX záznamu do položky FreeText položku AutoPABX=nové PABX
- označí si v načteném LDAPu, že záznam byl zasynchronizován (nebo jej v paměti smaže)
nenajde-li: smaže záznam z FX databáze

Následně projde všechny načtené LDAP záznamy, které nebyly označené jako zasynchronizované (nesmazané). To jsou záznamy, které jsou v LDAP ale nejsou v FX db. Pro každý z nich:

Založí nového uživatele v tUser s unikátním fId
Přepíše do nového uživatele z LDAPu:
1. e-mail adresu
2. jméno / display name
3. jméno FX skupiny
4. faxovací práva
5. costcode
6. jméno coversheetu
7. nastaví fGate = hodnota email_gw
Založí v tabulce tPABX záznam fPABX = nové PABX, fUserId = aktuální UserId
Zapíše u FX záznamu do položky FreeText položku AutoPABX=nové PABX

Mapování položek v LDAP na položky v FX db

Jména hledaných položek v LDAP se musí brát z konfigurace, tj. změní-li se jméno položky FAXNUM na FAX_NUMBER, stačí změnit tuto informaci v konfiguraci!

Jméno v LDAP	Jméno v tUser	Poznámka
FAXNUM (string, <30 znaků)	Nemá přímý ekvivalent, ale výše popsaným algoritmem se z něj generuje položka v PABX databázi a položka AutoPABX ve FreeText	jedinečné faxové číslo, které slouží pro příjem faxů
FAXCSH (string, <30 znaků)	fCover	jméno coversheet stránky pro daného uživatele
FAXGRP (string, <30 znaků)	fGroup	definuje uživatelskou skupinu, ke které uživatel patří a jejíž standardní nastavení bude aplikováno pro tohoto uživatele u nastavení atributů pro FaxChange, které nejsou explicitně pro tohoto uživatele specifikovány
FAXFLG (string, <30 znaků)	fFlags, fControl, fLng – viz další tabulka	obsahuje nastavení atributů: práva k faxování a jazyk; struktura popsána v další tabulce
INTERNET-ADDR	fEmail	SMTP adresa
COSTCODE	fCostCode	Kód nákladového střediska
COMMON-NAME	fName	Jméno uživatele

Struktura položky FAXFLG

Jedná se o textové pole, kde každý znak specifikuje nějakou část nastavení FX.

Znak	Význam	Hodnoty	Mapování do FX
1	nastavení práv k posílání mezinárodních faxů	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 1, hodnoty Y/N/D
2	nastavení práv k posílání faxů mimo ÚTO	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 2, hodnoty Y/N/D
3	nastavení práv k posílání faxů mimo lokální ústřednu	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 3, hodnoty Y/N/D
4	nastavení práv k posílání faxů v rámci ústředny	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 4, hodnoty Y/N/D
5	nastavení práv k posílání faxů s nízkou prioritou	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 5, hodnoty Y/N/D
6	nastavení práv k posílání faxů s normální prioritou	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 6, hodnoty Y/N/D
7	nastavení práv k posílání faxů s vysokou prioritou	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 7, hodnoty Y/N/D
8	nastavení práv k plánování odeslaných faxů	y (ano), n (ne), d (standardní nastavení podle skupinových práv)	fFlags znak 8, hodnoty Y/N/D
9	nastavení práv k posílání faxů	0 (ano, standardní uživatel), 1 (ne, faxování zakázáno)	fControl bit 0: 0 = povoleno, 1 = zakázáno
10	nastavení jazyka pro komunikaci	0 (CZ), 1 (UK), 2 (SK)	fLng = "CZ", "UK" nebo "SK"

zpět na začátek

Popis logiky synchronizace pro MobilChange

Společná část

Aplikace načte do paměti všechny mail uživatele z MX databáze (account_type=1), kteří mají user_source=2,3 nebo 4
Aplikace načte do paměti všechny uživatele ze všech v konfiguraci odkazovaných LDAP stromů.

Může se stát, že některé položky v LDAPu nebudou. V takovém případě aplikace převezme z konfigurace defaultní hodnotu a použije ji, jako by byla v LDAPu.
V režimu "Český Telecom" je další zpracování specifické pro tuto firmu a není dále popsáno. Běžně se používá dále popsaný "normální" režim.

"Normální" režim

Pro všechny záznamy, které mají vyplněný i_user_id a mají x_email_rucne=0:

vyhledá v načteném LDAP záznam se stejnou e-mail adresou
najde-li:
- přenese do MX databáze podle konfigurace následující položky z LDAPu
  1. email adresu (do položky email)
  2. jméno / display name
  3. ID nákladového střediska
  4. nastaví Gateway = hodnota email_gw
- označí si v načteném LDAPu, že záznam byl zasynchronizován (nebo jej v paměti smaže)
nenajde-li: smaže záznam z MX databáze

Pokud i_user_id je prázdné (null), nastaví x_email_rucne=1.
Následně projde všechny načtené LDAP záznamy, které nebyly označené jako zasynchronizované (nesmazané). To jsou záznamy, které jsou v LDAP ale nejsou v MX db. Pro každý z nich:

Založí nového uživatele v MXUser s i_user_id=email
Přepíše do nového uživatele z LDAPu:
1. e-mail adresu
2. jméno / display name
3. ID nákladového střediska
4. nastaví Gateway = hodnota email_gw

zpět na začátek