Techniczny opis integracji z Comarch ERP Optima

Ten wpis opisuje techniczne wymagania integracji xSale z Comarch ERP Optima. Jeśli szukasz API xSale, przejdź do wpisu: REST API xSale.

Dla kogo jest ten wpis

Informacje poniżej są przeznaczone przede wszystkim dla administratora Comarch ERP Optima, administratora Windows/SQL oraz osoby odpowiedzialnej za utrzymanie środowiska klienta. Wpis może być wykorzystany jako lista wymagań przed instalacją Futuriti WebService.

Wymagania środowiskowe

• WebService powinien być instalowany na serwerze, na którym działa Comarch ERP Optima albo na serwerze z dostępem wymaganym do pracy Optimy i jej bazy danych.
• Wymagane jest konto Windows z uprawnieniami administratora. Konto powinno być dedykowane dla WebService, np. xSale, aby ograniczyć ryzyko przejmowania lub blokowania sesji przez innych użytkowników.
• Konto Windows musi mieć możliwość dodawania i uruchamiania zadań w Harmonogramie zadań Windows.
• Aplikacja jest uruchamiana przez Harmonogram zadań, ponieważ API Comarch ERP Optima nie działa stabilnie jako klasyczna usługa Windows.
• Komunikacja odbywa się po HTTPS. Można użyć własnego certyfikatu.
• Wymagany jest stały adres IP po stronie klienta.
• Port wskazany w konfiguracji WebService musi być otwarty dla adresu IP Futuriti: 193.239.184.2.
• Wymagana wersja SQL Server: SQL Server 2012 (11.x) lub nowsza.

Wymagania dotyczące SQL

• Użytkownik SQL wykorzystywany przez integrację powinien mieć co najmniej uprawnienia w rolach CDN i CDNRaport.
• Uprawnienia powinny być nadane zarówno na bazie firmowej, jak i na bazie konfiguracyjnej Comarch ERP Optima.
• Na czas instalacji użytkownik SQL musi mieć uprawnienia pozwalające na dodanie funkcji i wykonanie zmian opisanych w sekcji poniżej.
• Po instalacji uprawnienia mogą zostać ograniczone do zakresu wymaganego do bieżącej pracy integracji, o ile nie blokuje to procesów synchronizacji i automatyzacji.

Dobre praktyki

• Konto operatora w Comarch ERP Optima powinno być dedykowane wyłącznie dla WebService, np. xSale. Dzięki temu dokumenty tworzone przez integrację są widoczne w ERP jako wprowadzone przez dedykowanego operatora.
• Licencje Comarch ERP Optima dla integracji warto wydzielić na osobny klucz i przypisać na wyłączność. Zmniejsza to ryzyko braku wolnej licencji podczas pracy WebService.
• Serwer powinien pracować stale. Wyłączanie serwera na noc może powodować opóźnienia lub problemy z synchronizacją.
• Przed wdrożeniem warto potwierdzić, czy aktualna wersja Comarch ERP Optima jest obsługiwana przez xSale.

Zmiany w bazie podczas instalacji

Dodawane funkcje

• [CDN].[ALPOL_GetDocumentByShipmentWaybill]
• [CDN].[ALPOL_GetDocumentByShipmentWaybillERP]
• [CDN].[ALPOL_GetSalesDocumentIdByDocumentId]
• [CDN].[ALPOL_fnTwrGrupyAtomStore]
• [CDN].[ALPOL_GetBaseSalesStocks]
• [CDN].[ALPOL_GetRecipeQuantity]
• [CDN].[ALPOL_GetRecipeQuantityInt]

Obiekty wymagające dostępu do modyfikacji

• [CDN].[TraNag] (tylko „TrN_NrListuPrzewozowego” – brak możliwości zmiany poprzez „CDN API”).
• [CDN].[DefAtrybuty] (ze względów wydajnościowych).
• [CDN].[DokAtrybuty] (ze względów wydajnościowych).

Obiekty wymagające dostępu do odczytu

• CDN.TwrGrupy
• CDN.Grupy
• CDN.TraNag
• CDN.TraElem
• CDN.DokAtrybuty
• CDN.TraNagRelacje
• CDN.Powiazania
• CDN.WdrPodlaczeniaZestawow
• CDN.WdrPodlaczeniaWydrukow
• CDN.Wydruki
• CDN.WdrZestawy
• CDN.DefAtrybuty
• CDN.TwrGrupyView
• CDN.DefCeny
• CDN.Magazyny
• CDN.DaneBinarneLinki
• CDN.TwrAtrybuty
• CDN.zamienniki
• CDN.towary
• CDN.twrkarty
• CDN.TwrGrupaPelnaNazwa(g.TwG_GrONumer)
• CDN.TwrJMZ
• CDN.ZstPromocje
• CDN.AtrybutyKlasy
• CDN.TwrPromocje
• CDN.Atrybuty
• CDN.KntPromocje
• CDN.KntGrupy
• CDN.PrmKarty
• CDN.FrsPromocje
• CDN.FrmStruktura
• CDN.AtrybutyHist
• CDN.TwrGrupyDom
• CDN.TwrIlosci
• CDN.ProdReceptury
• CDN.ProdSkladniki
• CDN.ALPOL_IntList
• CDN.ALPOL_GetRecipeQuantityInt()
• CDN.ALPOL_GetRecipeQuantity()
• CDN.Producenci
• CDN.ALPOL_fnTwrGrupyAtomStore()
• CDN.TwrCeny
• CDN.DaneKadMod
• CDN.DokRelacje
• CDN.Kontrahenci
• CDN.FromClarionDate
• CDN.KntAtrybuty
• CDN.SchematPlatnosci
• CDN.BnkNazwy
• CDN.DokAtrybuty
• CDN.KntOsoby
• CDN.PracEtaty
• CDN.Operatorzy
• CDN.BnkZdarzenia
• CDN.DokNagPliki
• CDN.DaneBinarne
• CDN.StanowiskaKomp
• CDN.FormyPlatnosci
• CDN.Zamienniki
• CDN.Powiazania
• CDN.TypDokumentu(TrN_TypDokumentu)
• CDN.BnkZapisy
• CDN.BnkRozRelacje
• CDN.BnkRozKwoty
• CDN.DokDefinicje
• CDN.ALPOL_GetDocumentByShipmentWaybill ()
• CDN.ALPOL_GetSalesDocumentIdByDocumentId ()
• CDN.Kategorie
• CDN.PodmiotyView
• CDN.KntOsoby
• CDN.PracKod
• CDN.Rabaty

Sposób pracy integracji z Comarch ERP Optima

• Obiekty są wprowadzane do Comarch ERP Optima przez CDN API.
• Integracja może dodawać lub aktualizować m.in. towary, kontrahentów, adresy, definicje atrybutów, atrybuty, płatności, rezerwacje odbiorcy, dokumenty handlowe i dokumenty magazynowe.
• Synchronizacja towarów i powiązanych elementów odbywa się po kodzie towaru. Z tego powodu nie należy zmieniać kodów towarów w ERP bez zaplanowania skutków dla xSale i ofert.
• Synchronizacja obiektów opiera się głównie na dacie ostatniej modyfikacji. Stany magazynowe są obsługiwane osobnymi procesami synchronizacji stanów.
• Wybrane operacje, których nie da się wykonać stabilnie lub wydajnie przez CDN API, korzystają z bezpośrednich zapytań SQL. Dotyczy to m.in. pracy na atrybutach oraz obsługi numeru listu przewozowego TrN_NrListuPrzewozowego.

Lokalizacje plików

• Domyślna lokalizacja instalacji: C:\!Futuriti_Programy\Futuriti Webservice Optima
• Domyślna lokalizacja backupu: C:\!Futuriti_Backup

Wymagania minimalne serwera

• Minimalne wymagania są co najmniej takie jak dla aktualnie zainstalowanej wersji Comarch ERP Optima.
• Ze względu na liczbę synchronizowanych danych i częstotliwość procesów realne wymagania mogą być wyższe niż minimalne wymagania Comarch ERP Optima.
• Serwer powinien pracować nieprzerwanie. Wyłączenie serwera, np. na noc, może powodować zaległości w synchronizacji.

Obsługiwane wersje

• Integracja jest udostępniana dla trzech ostatnich wersji Comarch ERP Optima.

Jeśli nie wiesz, czy Twoja wersja ERP jest obsługiwana przez xSale, skontaktuj się z pomocą techniczną lub opiekunem handlowym.

Przykładowy skrypt nadania uprawnień

USE [CDN_Futuriti_2021_4]
ALTER ROLE [CDN] ADD MEMBER [WebserviceOptima];
ALTER ROLE [CDNRaport] ADD MEMBER [WebserviceOptima];

USE [CDN_KNF_Konfiguracja_2021_4]
ALTER ROLE [CDN] ADD MEMBER [WebserviceOptima];
ALTER ROLE [CDNRaport] ADD MEMBER [WebserviceOptima];

Można nadać także wyższe uprawnienia, jeśli wymaga tego konfiguracja środowiska lub etap instalacji.

Uprawnienia można nadać albo zweryfikować w SQL Server Management Studio: wybierz bazę, przejdź do Security, a następnie na użytkowniku wybierz Properties → Membership.