• przy instalacji lub aktualizacji systemu zaznaczyć parametr „Wersja Premium”

lub

• w pliku Web.config wartość klucza PremiumFunctionality ustawić na „True” i wprowadzić odpowiedni klucz licencji. 

• Globals.Common.DocumentCompanyId – Id spółki powiązanej z kontrolką, np. DocumentCompanyId (typu int)
• Globals.Common.DocumentId – Id dokumentu DMS, np. DocumentId (typu int?)
• Globals.Common.ParentDocumentId – Id właściciela dokumentu, np. ParentDocumentId (typu int?)
• Globals.Common.StageId – Id etapu w którym znajduje się dokument, StageId (typu int?)
• Globals.Common.UserId – Id zalogowanego operatora, np.  UserId (typu int)
• Globals.Common.WorkflowId – Id typu obiegu, np. WorkflowId (typu int)

Typ zakończony „?” (int?) oznacza, że oprócz wartości numerycznych zmienna może przechowywać również wartość NULL (pustą). Przykładowa sytuacja to brak wpisanej wartości w kontrolce typu liczba całkowita

W przypadku zdarzeń „Obserwacja”, każda z kontrolek posiada dodatkowo właściwość:

• Globals.Common.SenderControlName – Identyfikator kontrolki inicjującej zdarzenie

• Dane tabelaryczne,
• Dane tabelaryczne, kolumna typu lista,
• Data i godzina,
• Dokument elektroniczny,
• Komunikat,
• Kontrahent,
• Liczba całkowita,
• Liczba rzeczywista,
• Liczba stałoprzecinkowa,
• Lista,
• Tekst,
• Towar,
• Własna akcja.

• MainFrame.<nazwaDT>.Items[Index]… – odwołanie do wartości kontrolki
  • Funkcje
    • MainFrame.<nazwaDT>.AddRow() – dodaj kolejny wiersz.
    • MainFrame.<nazwaDT>.AddRows(count) – dodaj wiersze, gdzie „count” oznacza ile wierszy ma zostać dodane.
    • MainFrame.<nazwaDT>.RemoveRow(index) – usuń wiersz, gdzie „index” to wiersz, który ma zostać usunięty.
    • MainFrame.<nazwaDT>.Clear() – usuwa wszystkie wiersze.
  • Właściwości
    • MainFrame.<nazwaDT>.Column – informacja o modyfikowanej komórce – numer kolumny.
    • MainFrame.<nazwaDT>.Row – informacja o modyfikowanej komórce – numer wiersza.
    • MainFrame.<nazwaDT>.RowCount – informacja o ilości wierszy w DT

• GetStatusVAT(string nip) – aby sprawdzić, czy kontrahent jest na białej liście podatników;
• GetStatusVATForDate(string nip, DateTime date) – aby sprawdzić, czy kontrahent w danym dniu był na białej liście podatników

• [Dodaj] – po naciśnięciu przycisku zostaje dodany nowy skrypt
• [Usuń] – przycisk pozwala na usunięcie programu z listy programów w oknie „Konfiguracja automatycznego trybu pracy” oraz z listy programów, które mogą być uruchomione przez użytkownika
• [Zapisz] – przycisk służy do zapisywania zmian w programie
• [Uruchom] – przycisk otwiera okno „Automatyczny tryb pracy”; przycisk widoczny jedynie dla użytkowników, którym nadano uprawnienie do danego programu na zakładce „Uprawnienia” w ramach okna „Konfiguracja automatycznego trybu pracy” (zob. Uruchamianie i zatrzymywanie programu).

• Edytor skryptów
• Uprawnienia

• [Dodaj] – po naciśnięciu przycisku zostaje dodany nowy skrypt
• [Usuń] – przycisk pozwala na usunięcie programu z listy programów w oknie „Konfiguracja automatycznego trybu pracy” oraz z listy programów, które mogą być uruchomione przez użytkownika
• [Zapisz] – przycisk służy do zapisywania zmian w programie
• [Uruchom] – przycisk otwiera okno „Automatyczny tryb pracy”; przycisk widoczny jedynie dla użytkowników, którym nadano uprawnienie do danego programu na zakładce „Uprawnienia” w ramach okna „Konfiguracja automatycznego trybu pracy” (zob. Uruchamianie i zatrzymywanie programu).

• Edytor skryptów
• Uprawnienia

• Nazwa spółki – pole dostępne jedynie w trybie wielospółkowym Comarch DMS; należy w nim dokonać wyboru spółki, z której pochodzi operator, któremu mają zostać nadane uprawnienia
• Typ – w ramach tego pola możliwy jest wybór pracownika, działu lub stanowiska, dla którego mają zostać przyznane uprawnienia do danego programu
• Wartość – w zależności od wyboru dokonanego w polu „Typ” w ramach tego pola można wybrać danego pracownika/dział/ stanowisko, któremu zostaną przyznane uprawnienia do danego programu
• Po nadaniu uprawnień należy zapisać zmiany, klikając na przycisk [Zapisz]. Wówczas operator zostaje przeniesiony na zakładkę „Edytor skryptów”, a w prawym górnym rogu okna „Konfiguracja automatycznego trybu pracy” pojawia się przycisk [Uruchom], służący do uruchomienia programu.

• na zakładce [Dokumenty] – dla każdego użytkownika, któremu przyznano uprawnienia do co najmniej jednego programu

• W ramach okna „Konfiguracja automatycznego trybu pracy”, dla operatora, któremu przyznano uprawnienia do tego okna oraz do co najmniej jednego programu

• Uruchom program – w ramach tego pola użytkownik może wybrać program, który chce uruchomić, z rozwijanej listy

• Zabezpiecz hasłem – pole domyślnie odznaczone; jeżeli zostanie zaznaczone, wówczas zatrzymanie pracy programu będzie wymagało podania hasła zalogowanego operatora w oknie „Automatyczny tryb pracy”.

• Po wyborze programu operator powinien nacisnąć przycisk [Uruchom] – wówczas okno „Uruchom program” zostanie zamknięte, a otworzy się okno „Automatyczny tryb pracy” i wybrany program rozpocznie działanie.
• Natomiast jeżeli operator nie chce jednak uruchomić programu, powinien kliknąć przycisk [Anuluj] – wtedy okno „Uruchom program” zostanie zamknięte, a program się nie uruchomi.

• jeśli w oknie „Uruchom program” nie zaznaczono checkboxa „Zabezpiecz hasłem” – wykonywanie skryptu zostanie przerwane, okno „Automatyczny tryb pracy” – zamknięte, a operator może znowu pracować z Comarch DMS;
• jeśli w oknie „Uruchom program” zaznaczono checkbox „Zabezpiecz hasłem” – wyświetlone zostaje okno, w ramach którego należy wprowadzić hasło zalogowanego operatora.

W oknie dostępne są następujące przyciski:

• [Zatrzymaj program] – kiedy operator wybierze tn przycisk, wówczas wykonywanie skryptu zostanie zatrzymane, okno „Automatyczny tryb pracy” – zamknięte, zostanie również wyświetlone okno informujące o zakończeniu działania programu, w którym należy kliknąć przycisk „Ok”. Operator będzie mógł znowu pracować z Comarch DMS;

• [Zamknij aplikację] – po naciśnięciu tego przycisku zostaje wyświetlone następujące okno:

W ramach okna znajdują się dwa przyciski:

• • Tak – aplikacja Comarch DMS zostanie zamknięta
  • Nie – jeżeli operator wybierze tę opcję, wówczas aplikacja Comarch DMS pozostaje otwarta, a skrypt nadal jest wykonywany
• [Anuluj] – jeśli użytkownik kliknie ten przycisk, wówczas okno do wprowadzenia hasła zostanie zamknięte, a skrypt będzie nadal wykonywany;
• Jeżeli operator nie wprowadzi hasła lub wprowadzi błędne hasło, a następnie kliknie w przycisk [Zatrzymaj program], wówczas zostanie wyświetlona informacja o nieprawidłowym haśle, a skrypt nadal będzie wykonywany.

• zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – kiedy wystąpił błąd

Int GenerateDMSDocuments()

Return: 0 – ok, -1 – error

GetDocumentList – metoda umożliwia pobranie informacji o zaczytanych dokumentach

• Zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – wystąpił błąd

Int GetDocumentList(ref ACDDocument[])

Struct ACDDocument

(

string Name,

byte Status

)

Name: document name

Status: 0 – correct, 1 – incorrect

Return: 0 – ok, -1 – error

GetNumberItems (ref long) – metoda, która sprawdza liczbę pobranych dokumentów w punkcie ACD

• brak parametrów wejściowych
• zwraca wyniki:
  • Liczba pobranych dokumentów
  • 0 – operacja została wykonana poprawnie
  • -1 – kiedy metoda została wywołana w niewłaściwym kontekście

int GetNumberItems(ref long)

long: number of documents

return: 0 – ok, -1 – error

RefreshList() – metoda umożliwia wciśnięcie przycisku „Odśwież” na zakładce „Automatyczne generowanie dokumentów”

• brak parametrów wejściowych
• zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – kiedy wystąpił błąd

Int RefreshList()

return: 0 – ok, -1 – error

SelectDocument (int) – metoda, która umożliwia podświetlenie dokumentu na liście (jeżeli lista prezentuje dokumenty z checkboxami – zaznaczenie checkboxa).

• Parametry wejściowe:
  • Identyfikator dokumentu
• Zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – wystąpił błąd

int SelectDocument(int)

int: document index

return: 0 – ok, -1 – error

SetPoint (string,byte) – metoda, która odpowiada za wskazanie punktu ACD i włączenie lub wyłączenie automatycznego wysyłania dokumentów do Comarch OCR

• Parametry wejściowe:
  • Pierwszy parametr jest wymagany, należy wprowadzić w nim nazwę punktu ACD, w ramach którego będzie się odbywało przetwarzanie dokumentów
  • Drugi parametr jest opcjonalny, dotyczy kwestii włączenia procesowania dokumentów w punkcie ACD, przyjmuje następujące wartości:

0 – procesowanie dokumentów jest wyłączone (dotyczy punktów ACD, które nie obsługują OCR)

1 – procesowanie dokumentów jest włączone

• Zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – kiedy wystąpił błąd
  • -2 – kiedy punkt ACD o podanej nazwie nie istnieje

int SetPoint(string,byte)

string: ACD point name

byte:1 -turn on ACD proces, 0 – turn off ACD proces

return: 0 – ok, – 1 – error, -2 – ACD point not exists

SetViewMode (byte) – metoda, która odpowiada za tryb filtrowania pobranych dokumentów

• Parametry wejściowe:
  • 0 – generowanie wszystkich dokumentów;
  • 1 – generowanie jedynie wypełnionych dokumentów;
  • 2 – generowanie wybranych dokumentów;
• Zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • -1 – wystąpił błąd

int SetViewMode(byte)

byte: 0 – all documents, 1 – correct documents, 2 – selected documents

return: 0 – ok, – 1 – error

Show – metoda, która otwiera obszar ACD

• brak parametrów wejściowych
• zwraca wyniki:
  • 0 – operacja została wykonana poprawnie
  • 1 – operator nie jest uprawniony do okna ACD – jeśli ta wartość została zwrócona, w aplikacji zostaje wyświetlony komunikat „Operator nie posiada uprawnień do automatycznego generowania dokumentów”

int Show()

return: 0 – ok, -1 – error

Klasa Common

W ramach klasy Comon udostępniono następującą metodę:

• Trace(string) – metoda umożliwia wyświetlanie dodatkowych informacji na oknie „Automatyczny tryb pracy”,

• Administrator otworzył do edycji plik DMS.exe.config, znajdujący się w folderze z aplikacją desktop Comarch DMS i w ramach klucza „RPAFolderPath” wprowadził ścieżkę do aplikacji desktop Comarch DMS – w tym przypadku <add key=”RPAFolderPath” value=”C:\dms202310″/> – a później zapisał zmianę.

• Administrator dodał na zakładce [Automatyczne generowanie dokumentów] trzy punkty ACD należące do typu „Współpraca z Comarch OCR” o następujących nazwach:

• • Faktury od Firmy A (zgodnie z ustawieniami punktu dokumenty wygenerowane w tym punkcie mają trafiać do obiegu „Faktury – firma A”)

• • Faktury od Firmy B (zgodnie z ustawieniami punktu dokumenty wygenerowane w tym punkcie mają trafiać do obiegu „Faktury – firma B”)

• • Faktury od Firmy C (zgodnie z ustawieniami punktu dokumenty wygenerowane w tym punkcie mają trafiać do obiegu „Faktury – firma C”)

• następnie administrator przeszedł na zakładkę [Konfiguracja automatycznego trybu pracy] i kliknął przycisk [Dodaj].

• Na zakładce „Edytor skryptów” w ramach pola „Nazwa programu” wpisał „Faktury z firm A,B,C”, później na zakładce „Uprawnienia” nadał uprawnienia do programu dla siebie i kilku innych operatorów i kliknął [Zapisz].

• Na zakładce „Edytor skryptów” w polu edytora administrator wprowadził następujący kod:

• Następnie administrator nacisnął przycisk [Kompiluj i zapisz]. Kompilacja przebiegła pomyślnie, więc w dolnej części okna wyświetlona została informacja „Kompilacja skryptu zakończyła się sukcesem”.

• Następnie administrator zapisał zmiany, klikając przycisk [Zapisz]. Później nacisnął przycisk [Uruchom] i w ramach otwartego okna „Uruchom program” wybrał w polu „Uruchom program” program „Faktury z firm A,B,C” i (nie zaznaczając checkboxa „Zabezpiecz hasłem”), a później kliknął przycisk [Uruchom].

• wówczas administrator został przeniesiony na zakładkę „Automatyczne generowanie dokumentów”, gdzie otworzyło się okno „Automatyczny tryb pracy”, a w tle odbywało się inicjowanie dokumentów.

• Gdy wszystkie dokumenty zostały wygenerowane, administrator kliknął przycisk [Zatrzymaj program]. Okno „Automatyczny tryb pracy” zostało zamknięte.

• Następnie administrator przeszedł na zakładkę [Dokumenty w obiegu] – na liście dokumentów widoczne były wszystkie dokumenty wygenerowane w wyniku działania programu „Faktury z firm A,B,C”. Po wejściu do przykładowego dokumentu można zauważyć, że na dokument zmapowano również wartości odczytane przez OCR, zgodnie z ustawieniami punktów ACD.

• <add key=”MultiCompany” value=”false” /> – wówczas connection stringi strConnectERPComp i strConnectERPConf1 są przechowywane w pliku Web.config
• <add key=”MultiCompany” value=”true” /> – wówczas connection stringi są przechowywane  w pliku Web.config i w tabeli do.DF_ConfCMDictionary – w tym przypadku connection stringi do baz: konfiguracyjnej i firmowej są zapisywane pod jednym ID połączenia, zastosowano zatem nastepujące identyfikatory:
  • nazwa_spółki_Comp – pobiera connection string zapisany w kolumnie CMD_ConnectionStringERP / CMD_ConnectionStringERPEncrypted
  • nazwa_spółki_Conf – pobiera connection string zapisany w kolumnie CMD_ConnectionStringERPConf / CMD_ConnectionStringERPConfEncrypted

gdzie nazwa_spółki – wartość wprowadzona w polu „Nazwa spólki” / „Nazwa spółki (baza)” na zakładce  „Połączenia z ERP” na zakładce [Ustawienia]

Identyfikatory connection stringów są wykorzystywane w kodzie C#:

• • dla MS SQL:
    • connection = new DmsSqlConnection(Globals.Common.ConnectionStrings.strConnectDMS)
    • DmsSqlCommand command = new DmsSqlCommand(connection, sqlQuery)
  • dla PostgreSQL:
    • connection = new DmsNpgsqlConnection(„pgStrConnectDMS”)
    • DmsNpgsqlCommand command = new DmsNpgsqlCommand(connection, sqlQuery)