= [wiki:DeployerGuide Przewodnik wdrożeniowca] > Podstawowa konfiguracja systemu eDokumenty (uruchomienie modułu BSConnect) = #konfiguracja

[wiki:DeployerGuide/Customization/Integration Strona główna Integracji]


=== Wprowadzenie === #menu
 1. [#zrodlo_danych Konfiguracja źródeł danych]
 2. [#uruchomienie Uruchomienie modułu BSConnect]
 3. [#zrodla_wymiany_danych Konfiguracja źródeł wymiany danych] 


== Konfiguracja źródła danych == #zrodlo_danych

Sekcja ta opisuje sposób konfiguracji źródła danych. Źródło jest ciągiem tekstowym, który zawiera dane połączenia do zewnętrznej bazy danych, takie jak:
 * Server - Nazwę instancji serwera. Zawiera w sobie adres hosta serwera baz danych, numer portu (np. dla zdalnych połączeń z Ms SQL Server). Przykładowe dane to {{{localhost\sqlexpress}}} lub też {{{192.168.0.1:1024}}},
 * Database - Nazwę bazy danych.
 * Uid, User - identyfikator użytkownika baz danych
 * Pwd, Password - hasło użytkownika bazy danych
 * Port - [parametr opcjonalny] numer portu, na którym nasłuchuje serwer baz danych. Parametr nie jest wykorzystywany przez Ms SQL Server.
 * Encoding - [parametr opcjonalny] kodowanie połączenia z systemem zewnętrznym.

W poniższym listingu przedstawiono przykładowe ciągi połączeń dla różnych systemów zarządzania bazami danych:
{{{
# Microsoft SQL Server :
Server=localhost\sqlexpress;Database=eDok;Uid=edokumenty;Pwd=edokumenty;
lub 
Server=192.168.0.1:1433;Database=eDok;Uid=edokumenty;Pwd=edokumenty;

# MySQL :
Server=192.168.0.1;Port=3306;Database=eDok;User=edokumenty;Password=edokumenty;

# Oracle :
Server=192.168.0.1;Database=192.168.0.1/eDok;Uid=edokumenty;Pwd=edokumenty;encoding=AL32UTF8;

# PostgreSQL :
host=localhost port=5432 dbname=eDok user=edokumenty password=edokumenty

}}}

Konfigurację źródła danych przeprowadzamy w menu ''Ustawienia > Panel Sterowania > Źródła danych'' :

[[Image(20131111_090914.png)]][[BR]]''Rys. 1. Ustawienia > Panel Sterowania''[[BR]]
[[Image(20131111_091202.png)]][[BR]]''Rys. 2. Panel Sterowania i Źródła danych''[[BR]]
[[Image(20131111_091317.png)]][[BR]]''Rys. 3. Okno konfiguracji źródeł danych''[[BR]]

W oknie tym można uruchamiać dodawanie, edycję lub też usuwać źródła danych. W przypadku dodawania lub edycji uruchomi się okno, w którym należy:
 * wprowadzić unikalną nazwę (najlepiej identyfikującą system zewnętrzny)
 * wybrać sterownik do odpowiedniego SZBD
 * wpisać ciąg połączenia.

[[Image(20131111_091456.png)]][[BR]]''Rys. 4. Okno dodawania / edycji źródła danych''[[BR]]

Po kliknięciu przycisku Zapisz okienko edycji powinno się zamknąć. Oznacza to, że źródło zostało poprawnie dodane. W przeciwnym przypadku zostanie wyświetlony komunikat o błędzie połączenia.

''[#konfiguracja Powrót do menu]''  

== Uruchomienie modułu BSCOnnect == #uruchomienie

Kolejnym etapem w procesie Integracji z systemem zewnętrznym jest uruchomienie modułu '''BSConnect'''.
Aby rozpocząć prace integracyjne należy włączyć moduł BSConnect. Moduł ten włącza się modyfikując plik {{{config.inc}}} w katalogu: {{{ [katalog instalacji]/public_html/apps/edokumenty/config.inc }}}.
W pliku tym należy wprowadzić następujace wyrażenie:
{{{
#!php
define('SYNC_ACTIVE', 'NEW');
}}}

[[Image(001.jpg)]][[BR]]''Rys. 5. Wpis w pliku config.inc''

Następnie należy zalogować się ponownie na koncie administratora systemu eDokumenty.
Po ponownym zalogowaniu się w menu ''Narzędzia'' powinno pojawić się polecenie ''Połączenia z systemami zewnętrznymi'':

[[Image(003.jpg)]][[BR]]''Rys. 6. Widok menu po uruchomieniu modułu BSConnect''

Klikając na polecenie: ''Narzędzia > Połączenia z systemami zewnętrznymi'' uruchamia się okno konfiguracji połączeń z systemami zewnętrznymi.:

[[Image(004.jpg)]][[BR]]''Rys. 7. Okno konfiguracji połączeń z systemami zewnętrznymi''

''[#konfiguracja Powrót do menu]''  

== Konfiguracja źródeł wymiany danych == #zrodla_wymiany_danych

Sprzedane na allegro:

Mając otwarte okno konfiguracji połączeń z systemami zewnętrznymi można odpowiednio:
 * dodawać nowe połączenie
 * edytować połączenie
 * usuwać połączenie
 * planować zadania dla każdego z połączeń osobno
 * przeglądać historię dla wybranego połączenia
 * przeglądać dziennik zdarzeń związanych z wybranym połączeniem
 * definiować źródło wymiany danych
 
Pierwszym krokiem, który należy wykonać to zdefiniować źródło wymiany danych. Jest obiekt pośredniczący, który definiuje przy pomocy jakich mechanizmów dane połączenie będzie miało pobierać lub eksportować dane. W tym celu na pasku menu należy kliknąć Źródła wymiany danych. W nowo otwartym oknie po wybraniu opcji Nowe otworzy się okno, w którym można zdefiniować parametry źródła wymiany danych. Są to:
 * Nazwa unikalna źródła wymiany danych
 * Typ źródła wymiany danych


[[Image(20131111_100120.png)]][[BR]]''Rys. 8. Konfiguracja źródła wymiany danych''[[BR]]

Wyróżnia się następujące typy źródeł wymiany danych:
 * DB - Wymaga danych poprzez bazę danych (wymaga utworzenia dedykowanych widoków)
 * CUSTOM_DB - Wymaga danych poprzez bazę danych z wykorzystaniem dedykowanej klasy PHP. Klasę należy umieścić w lokalizacji 
 {{{
 public_html/apps/edokumenty/classes/BSConnectReadOnly/exchange/custom.
}}}
Przykład takiej klasy zamieszczono poniżej.
 * XML - Wymiana poprzez plik XML o odpowiedniej strukturze.
 * CUSTOM_XML - Wymiana poprzez plik XML o odpowiedniej strukturze z dedykowaną klasę PHP.
 * CUSTOM_SOAP - Wymiana danych poprzez usługę SOAP - określenie dedykowanej klasy PHP
 * EPUAP - Wymiana danych ze skrzynką podawczą ePUAP (określenie konfiguracji podmiotu ePUAP)

Przykład klasy PHP dla wymiany CUSTOM_DB. 
{{{
#!php
<?php

require_once('./classes/BSConnectReadOnly/exchange/db/BSConnectDBExchange.inc');

final class CustomDBExchange extends BSConnectDBExchange {

    // Dostępne klasy w BSConnect
    // DOCUMENT
    // CONTACT
    // CONTACTPERSON
    // PRODUCT

    public function releaseFromQueue($configuration, $clsnam, $keyval) {
	
            parent::releaseFromQueue($configuration, $clsnam, $keyval);
            
            // Wywołanie obiektu połączenia z PostgreSQL
            $db = PgManager::getInstance();
            
            // Sprawdzanie, czy klucz jest liczbą, czy tablicą (musi być tablicą)
            if (is_numeric($keyval)){
                $keyval = array($keyval);
            }
                
            // Wywołanie dla każdego obiektu
            if (is_array($keyval)) {
                
                foreach($keyval AS $contid){
                    
				// tutaj operacje

                }
            }
    }

} // class CustomDBExchange

?>

}}}


Dalsze parametry źródła wymiany danych zależą od wybranego typu.
dla typu:
 * '''DB'''
  * Źródło danych - zdefiniowane źródło danych (''Ustawienia > Panel Sterowania > Źródła danych '')
  * Nazwa schemy - nazwa schematu w bazie danych (Uwaga, dla SZBD typu MsSQL pole należy zostawić puste. Spowodowane jest to faktem, że system ten nie obsługuje schematów).
[[Image(20131125_095523.png)]][[BR]]''Rys. 9. Opcje dla typu DB ''[[BR]]
 * '''CUSTOM_DB''' - zawiera podobne pola jak typ ''DB'', z dodatkowym polem na nazwę klasy np. ''CustomDBExchange''
[[Image(20131125_095837.png)]][[BR]]''Rys. 10. Opcje dla typu CUSTOM_DB ''[[BR]]
 * '''XML'''
  * Ścieżka składu - ścieżka dostępu do pliku XML, np. {{{/mnt/integration/}}} lub dla Ms Windows {{{ D:/Integracja/ }}}. Uwaga należy używać znaków slash zamiast back-slash (jak jest to pokazane w przykładach)
  * Szablon - nazwa pliku szablonu flexy .tpl znajdującego się w katalogu systemu eDokumenty: {{{ public_html/apps/edokumenty/var/tpl/bs_connect}}}.
[[Image(20131125_100444.png)]][[BR]]''Rys. 11. Opcje dla typu XML ''[[BR]]
 * '''CUSTOM_XML''' - integracja poprzez plik XML ze wskazaniem własnej klasy. Nazwę klasy należy podać zamiast szablonu nazwę klasy.
[[Image(20131125_100742.png)]][[BR]]''Rys. 11. Opcje dla typu CUSTOM_XML ''[[BR]]

Należy dodać, iż jedno połączenie może zawierać w sobie odwołania do wielu źródeł wymiany danych. Np. w konfiguracji ogólnej możemy wybrać jedno domyślne źródło wymiany danych (np. typu DB), natomiast dla poszczególnych akcji połączenia z systemem zewnętrznym możemy wybrać inne (np. CUSTOM_DB lub XML).
 
''[#konfiguracja Powrót do menu]''