SaldeoAGENT
Instalacja, konfiguracja oraz zarządzanie SSYNC
1. Metryczka zmian w dokumencie
|
Data zmiany |
Wersja dokumentu |
Autor |
Opis zmian |
|
24.07.2018 |
2.0.0 |
Paweł Sierakowski |
Przepisanie dokumentu w związku z dużymi zmianami związanych z wydaniem wersji 2.2.0 |
|
06.08.2018 |
2.0.1 |
Paweł Sierakowski |
Dodano instrukcję do ustawienia działania aplikacja w sieci z PROXY |
|
12.10.2018 |
2.0.2 |
Paweł Sierakowski |
Aktualizacja linków aplikacji SaldeoAgent do wersji 2.2.2 |
|
19.05.2020 |
4.0.0 |
Paweł Sierakowski |
Aktualizacja linków aplikacji SaldeoAgent do wersji 4.0.3 |
|
24.09.2020 |
4.0.0 |
Wojciech Kubiak |
Przeniesienie dokumentu z GDrive na Zendesk GUIDE |
2. Informacje wstępne
Aplikacja SaldeoAGENT została utworzona na potrzeby realizacji dwóch istotnych funkcji, których nie jest w stanie realizować aplikacja SaldeoPULPIT tj.:
- pełni rolę “routingu” dla aplikacji SaldeoPULPIT, chodzi o sytuację, w której instalujemy SaldeoPULPIT na serwerze terminalowym, do którego łączy się wielu użytkowników. W opisanej sytuacji uruchomienie aplikacji na takim środowisku bez zainstalowanej i uruchomionej usługi SaldeoAGENT, a spowoduje, iż pierwsza uruchomiona aplikacja blokuje port komunikacji wszystkim pozostałym użytkownikom. Instalacja SaldeoAGENT rozwiązuje ten problem poprzez utworzenie dedykowanych portów dla każdej z uruchomionej instancji aplikacji SaldeoPULPIT
- umożliwia działanie synchronizacji danych SSYNC (funkcje zależne od posiadanego programu księgowego), w ramach której możliwe jest:
- dodawanie i aktualizowanie danych firm
- dodawanie i aktualizowanie kontrahentów
- dodawanie i aktualizowanie kategorii
- dodawanie i aktualizowanie form płatności
- dodawanie i aktualizowanie rejestrów
- dodawanie i aktualizowanie listy artykułów towarowych
- przesyłanie numerów zwrotnych nadanych w programie księgowym do SaldeoSMART
- dodawanie i aktualizowanie dedykowanych dla programu księgowego dodatkowych danych jako wymiary
- pobieranie dokumentów z Saldeo do importu w aplikacji FK
-
aplikacja działa w trybie usługi co umożliwia działanie synchronizacji danych SSYNC w tle, niezależnie od tego czy jakikolwiek użytkownik jest zalogowany do tej stacji
3. Instalacja
3.1. Pobieranie i wybór właściwej wersji instalatora
Wersje instalatora pobieramy zależnie od tego na jakim serwerze SaldeoSMART została wykupiona usługa.
BrainShare (PROD) - serwery główne SaldeoSMART
BrainShare (SHOW) - serwer dedykowany partnerom BrainShare IT sp. z o.o.
Oprócz powyższych instalatorów dedykowanych pod poszczególne serwery, dostępna jest wersja lokalna która przeznaczona jest dla klientów którzy wykupili wersję lokalną SaldeoSMART (dotyczy również wersji serwerowych i wszystkich innych gdzie SaldeoSMART działa na infrastrukturze własnej klienta).
SaldeoAgent-LOCAL
3.2. Proces instalacji i aktualizacji
|
UWAGA Jeżeli instalacja odbywa się w trybie aktualizacji z wersji wcześniejszej niż 2.2.0 należy wcześniej odinstalować:
|
|
Przed rozpoczęciem instalacji należy wyłączyć aplikację SaldeoPULPIT, o ile została wcześniej zainstalowana i uruchomiona. |
Uruchamiamy właściwą pobraną wcześniej wersję instalatora, sama instalacja ogranicza się do wybrania przycisku “Dalej” na jednym z etapów użytkownik ma możliwość wskazania ścieżki gdzie zostanie zainstalowana aplikacja. Jeżeli w systemie nie została zainstalowana odpowiednia wersja JAVA, instalator go pobierze i zainstaluje, jeżeli wystąpią problemy przy instalacji JAVA zapoznaj się z dodatkowymi informacjami w sekcji FAQ. Po instalacji usługa jest automatycznie uruchomiona.
4. Konfiguracja
Zasadniczo aplikacja jest gotowa do działania zaraz po instalacji, wymagane są jednak dodatkowe działania jeżeli chcemy skonfigurować aplikację do pracy z wersją lokalną SaldeoSMART, uruchomienia synchronizacji danych SSYNC bądź pracy w sieci gdzie ruch przechodzi wyłącznie przez serwery PROXY.
4.1. Praca z wersją lokalną SaldeoSMART
|
UWAGA Konfiguracja dotyczy tylko i wyłącznie wersji instalatora oznaczonej jako saldeo-agent-local, czyli wersji SaldeoSMART instalowanej na infrastrukturze własnej klienta |
Aby skonfigurować SaldeoAgent-a do pracy z wersją lokalną SaldeoSMART, należy przejść do katalogu gdzie został on zainstalowany w podkatalog “environment” (katalog ten jest utworzony i czytany tylko wtedy jeżeli wybraliśmy właściwy instalator do wersji lokalnej). Edytujemy znajdujący się w nim plik “saldeoagent-local.properties”, jego zawartość zaraz po instalacji wygląda mniej więcej następująco:
|
env=local/local api.xml.url=https://local.brainshare.pl/ api.java.url=https://local.brainshare.pl/api/desktop |
Powyższa konfiguracja wymaga ustawienia następujących zmiennych:
env - podajemy nazwę instancji lokalnej SaldeoSMART, nazwę poprzedzamy stałą wartością “local/”, np. nazwa instancji będzie “MOJE-SaldeoSMART” to cała zmienna wyglądać będzie następująco “env=local/MOJE-SaldeoSMART”
api.xml.url - podajemy lokalny adres serwera SaldeoSMART np.: https://moj-serwer-saldeo.moja-domena.pl/
api.java.url - podajemy lokalny adres dla API, domyślnie w przeważającej części instalacji będzie to samo co w zmiennej “api.xml.url” z dopisanym adresem np.: “https://moj-serwer-saldeo.moja-domena.pl/api/desktop”
|
UWAGA Na koniec konfiguracji wykonujemy restart usługi SaldeoAgent |
4.2. Uruchomienie synchronizacji danych SSYNC
|
Jeżeli wcześniej był skonfigurowany SSYNC do pracy z SaldeoPULPIT, to po uruchomieniu “SaldeoAgentConfiguration” z uprawnieniami administratora zarządzanie synchronizacją powinno uruchomić się od razu bez wykonywania dodatkowych czynności. Jeżeli chcemy uruchomić jako zwykły użytkownik (nie administracyjny), to trzeba wykonać dodatkowe czynności opisane w rozdziale Uruchomienie SaldeoAgentConfiguration jako zwykły użytkownik. |
Jeżeli na stanowisku nie był wcześniej skonfigurowany SALDEOSYNC, to instalator podczas instalacji dokonał już domyślnego wymaganego wpisu zmiennej systemowej - “SALDEOSYNC_HOME” ustawiając go na katalog wskazany podczas instalacji (sprawdzamy w ustawieniach systemowych, czy został prawidłowo dopisany).
Instalacja SSYNC:
- tworzymy w ścieżce %SALDEOSYNC_HOME% podkatalog libs (jeżeli system nie może przejść do określonej ścieżki tzn. że nie została ona prawidłowo określona w zmiennych systemowych)
- umieszczamy w nim wymagane do działania biblioteki tzw. provider-y (pliki jar mogą zostać zablokowane przez system Windows czytaj więcej w sekcji FAQ)
- tworzymy pliki konfiguracji “saldeosync-configuration-<ALIAS_NAZWY>.conf” oraz “saldeosync-connection.conf”
Informacje dotyczące z skąd pobrać biblioteki oraz co i jak ustawić w plikach konfiguracyjnych znajdziesz w instrukcji SaldeoSYNC.
Panel konfiguracyjny SSYNC uruchamiamy poprzez skrót “saldeoAgentConfiguration.bat” znajdujący się w katalogu aplikacji, pamiętajmy jednak iż domyślnie zainstalowana aplikacja pozwala na konfigurację i uruchomienie konfiguracji tej aplikacji tylko na kontach z uprawnieniami administratora, jeżeli chcemy uruchomić to z konta zwykłego użytkownika przeczytaj więcej w sekcji FAQ 4.2. Uruchomienie SaldeoAgentConfiguration jako zwykły użytkownik.
|
UWAGA Na koniec konfiguracji wykonujemy restart usługi SaldeoAgent |
4.3. Łączenie poprzez serwer pośredniczący PROXY
Aby skonfigurować usługę SaldeoAgent do pracy w sieci z dostępem do sieci internet za pośrednictwem PROXY, należy zdefiniować zmienną systemową o nazwie: SALDEO_AGENT_OPTS jako wartość przyjmuje następujący wymagany ciąg parametrów:
|
“-Dhttp.proxyHost=<ADRES_PROXY>” "-Dhttp.proxyPort=<PORT>" "-Dhttps.proxyHost=<ADRES_PROXY>" "-Dhttps.proxyPort=<PORT>" |
Gdzie w miejsce:
<ADRES_PROXY> - adres serwera PROXY
<PORT> - port na którym pracuje serwer PROXY
|
UWAGA Na koniec konfiguracji wykonujemy restart usługi SaldeoAgent |
4.4. Praca w sieci z przezroczystym serwerem PROXY SSL
Konfiguracja do działania z przezroczystym PROXY wymagana jest np.: w sytuacji w której certyfikat SSL nie należy do zaufanych (np. selfsigned). Jeżeli tak jest pobieramy ten certyfikat (można bezpośrednio z przeglądarki), następnie tworzymy kontener tzw. “truststore” w którym oznaczymy ten prywatny certyfikat jako zaufany. Aby to uczynić musimy pobrać i zainstalować wymagane narzędzie “keytool” który jest składnikiem w pełnego środowiska JAVA JDK. Jeżeli to już uczyniliśmy uruchamiamy konsolę i przechodzimy do katalogu w którym mamy pobrany certyfikat i wydajemy następujące polecenie:
|
keytool -import -file <saldeo-selfsigned> -alias SaldeoSelfsigned -keystore SaldeoTrustStore.jks |
gdzie w miejsce:
<saldeo-selfsigned> - wskazujemy plik z certyfikatem
System zapyta o hasło do utworzenia kontenera, które na tym etapie definiujemy. Następnie weryfikujemy utworzony kontener poprzez wydanie polecenia:
|
keytool -list -keystore SaldeoTrustStore.jks |
Kopiujemy plik SaldeoTrustStore.jks do katalogu zdefiniowanego jako %SALDEOSYNC_HOME%
Tworzymy zmienną systemową o nazwie: SALDEO_AGENT_OPTS która jako wartość przyjmuje następujący wymagany ciąg parametrów:
|
"-Djavax.net.ssl.trustStore=%SALDEOSYNC_HOME%\SaldeoTrustStore.jks" "-Djavax.net.ssl.trustStorePassword=<HASŁO_KONTENERA>" |
Gdzie w miejsce:
<HASŁO_KONTENERA> - podajemy zdefiniowane hasło do utworzonego kontenera
|
UWAGA Na koniec konfiguracji wykonujemy restart usługi SaldeoAgent |
5. Zarządzanie SSYNC z aplikacji SaldeoAgentConfiguration.bat
5.1. Uruchomienie i logowanie do aplikacji
Uruchamiamy aplikację poprzez skrót do aplikacji “saldeoAgentConfiguration.bat” znajdujący się na pulpicie (jeżeli został tam utworzony) lub przechodzimy do katalogu z zainstalowaną usługą SaldeoAGENT (domyślnie w ścieżce C:\Program Files (x86)\SaldeoAgent) i uruchamiamy bezpośrednio z katalogu.
Po uruchomieniu aplikacji logujemy się na główne konto administracyjne w SaldeoSMART.
|
Uwagi poinstalacyjne:
|
5.2. Dodanie lub połączenie istniejącej firmy w SALDEO
Uruchamiamy aplikację “SaldeoAgentConfiguration”. Po uruchomieniu powinniśmy zobaczyć w pierwszej kolejności startującą konsolę a następnie wyświetli się menu:
Wybieramy przycisk “Zarządzania synchronizacją”.
Wyświetli się lista połączeń do programów księgowych, zależna od ilości obsługiwanych w naszym biurze i instancji serwerów. Wybieramy “Pokaż” dla odpowiedniego programu księgowego.
Zostanie wyświetlona lista baz firm dostępnych w danym programie.
Przy firmie którą chcemy dodać klikamy “Konfiguruj” i zaznaczamy wszystkie dostępne opcje na “TAK”, wybór opcji zależny od systemu z którym integrujemy oraz zakresu danych, który chcemy zintegrować.Zapisujemy konfigurację “Zapisz”, co spowoduje powrót do okna z listą firm.
Przy firmie uaktywnia się funkcja “Dodaj firmę”.
Zostanie wyświetlone okno w którym w górnej wyświetlone są dane firmy pobrane z programu księgowego oraz poniżej wszystkie firmy dopisane ręcznie w SALDEO do możliwego połączenia
|
UWAGA FUNKCJI UŻYWAMY TYLKO W SYTUACJI, W KTÓREJ FIRMA ZOSTAŁA JUŻ UTWORZONA W SALDEO A TERAZ CHCEMY JĄ POŁĄCZYĆ LUB/I SYNCHRONIZOWAĆ, |
Klikamy Przycisk “Dodaj”.
Uzupełniamy dane:
- “Nazwa skrócona” - firmy ograniczona do 8 dowolnych znaków
- “Login” - firmy którym będą mogli zalogować się do panelu klienta (jeżeli takowy zostanie przez biuro/firmę udostępniony)
Operację kończymy klikając przycisk “Dodaj”. Po zakończeniu procesu dodawania firmy dostaniemy podsumowanie ilości dopisanych lub/i zaktualizowanych danych. Zamykamy wszystkie okna przy pomocy przycisków “Zamknij”.
5.3. Aktualizuj firmę - wymuszenie synchronizacji
W sytuacji w której z jakiś powodów pewne dane, które podlegają stałej synchronizacji nie zostały pobrane do SaldeoSMART, bądź chcemy włączyć dodatkowe opcje do synchronizacji, została w tym celu przewidziana procedura wymuszenia aktualizacji wszystkich danych, które w opcjach możliwych do synchronizacji danych firmy zostały oznaczone na TAK.
Aby wykonać tę operację przechodzimy do listy baz firm dostępnych w zarządzaniu synchronizacją, przy wskazanej firmie możemy wybrać funkcję “Aktualizuj firmę”. Funkcja aktywna jest tylko dla firm zsynchronizowanych z SaldeoSMART.
6. Lokalizacja błędów usługi
Aby zweryfikować czy usługa poprawnie się zainstalował, uruchamiamy menedżer usług systemowych i weryfikujemy “STAN” usługi SaldeoAgent. Usługę możemy zatrzymywać, uruchamiać i restartować. W przypadku pojawienia się poważnego błędu w SaldeoAgent może dojść do zamknięcia aplikacji. Wymagane jest aby aplikacja uruchamiała się ponownie po wystąpieniu błędu (w ustawieniach usług można to zmienić).
7. Pliki konfiguracyjne i logi aplikacji
Wszystkie pliki konfiguracyjne oraz logi SaldeoAgent zapisywane są w folderze “SaldeoAgent” tworzonym podczas instalacji programu, domyślnie zlokalizowanym w “%COMMONPROGRAMFILES(X86)%” lub “%COMMONPROGRAMFILES%”.
8. FAQ
8.1. Błąd instalacji JAVA
W niektórych środowiskach może pojawić się sytuacja, że instalator ma problemy z automatycznym pobraniem wymaganych komponentów JAVA niezbędnych do prawidłowej pracy aplikacji (w szczególności moduł synchronizacji).
W takiej sytuacji należy wykonać kroki opisane w tym artykule.
Opisuje on jak pobrać niezbędne komponenty w sposób manualny oraz jakie opcje powinny zostać wybrane podczas pracy instalatora JAVA.
8.2. Problemy z JAVA
Problemy mogą wystąpić z bardzo różnych powodów np. na danym stanowisku JAVA nie mogła zostać znaleziona lub zainstalowane są jej różne rodzaje. W tej sytuacji należy w pierwszej kolejności sprawdzić czy i jakie wersje są zainstalowane, zaktualizować i o ile to możliwe usunąć zbędnie poinstalowane stare wersje JAVA. Jeżeli się to nie powiedzie możemy spróbować ustawić jako zmienną systemową:
- JAVA_HOME w przypadku zainstalowanego pełnego środowiska JDK (np.: C:\Program Files\Java\jdk1.7.0_60)
- JRE_HOME w przypadku instalacji JRE (np.: C:\Program Files (x86)\Java\jre7)
UWAGA:
- Może być ustawiona tylko jedna bądź druga z powyższych zmiennych! Jeżeli zainstalowane jest JRE, należy ustawić tylko i wyłącznie JRE_HOME; ustawienie JAVA_HOME będzie niepoprawną konfiguracją
- SaldeoAGENT stara się samodzielnie wykryć zainstalowaną JAVA, jeżeli ustawimy powyższe zmienne przy aktualizacji JAVA należy również zaktualizować tę zmienną!
8.4. Uruchomienie apletu konfiguracji SYNC - “SaldeoAgentConfiguration” jako zwykły użytkownik
Jeżeli zamierzamy uruchamiać konfigurator usługi - “SaldeoAgentConfiguration” jako zwykły użytkownik to należy na podany niżej katalog (w wersji 32 lub 64 bit) ustawić dodatkowe uprawnienia,.
- “C:\Program Files (x86)\Common Files\SaldeoAgent” - instalacja 32-bit
- “C:\Program Files\Common Files\SaldeoAgent” - instalacja 64-bit
Na wskazanym powyżej folderze ustawiamy prawa konkretnemu użytkownikowi (bądź całej grupie “Users”/”Użytkownicy”) do pełnej kontroli.
9. Historia zmian aplikacji SaldeoAGENT
|
Wersja |
Opis |
|
2.2.0 |
|
|
2.2.2 |
|
Komentarze
Komentarze: 0
Zaloguj się, aby dodać komentarz.