Informacje ogólne

Comarch DMS został wyposażony w mechanizm wspomagający modelowanie procesów oparty
o kompilator C#. Wersja kompilatora jak również wersja języka C# jest uzależniona od Microsoft .NET Framework. Zalecana jest aktualizacja Microsoft .NET Framework do najnowszej dostępnej wersji.

Środowisko kompilacji C#

Wynikowymi bibliotekami kompilatora Comarch DMS są zawsze biblioteki dll.

Po skompilowaniu, biblioteki są automatycznie konfigurowane do pracy na serwerze IIS. Dzięki temu funkcjonalność jest dostępna dla wszystkich platform (aplikacji stacjonarnej, webowej, mobilnych iOS i Android).

Miejsca przechowywania bibliotek:

1. {Apl. www (serwerowa)}\bin\.scriptcs_cache – katalog do którego są kopiowane biblioteki po kompilacji kodu C#.

2. {Apl. www(serwerowa)}\bin\Scriptcs_bin – miejsce na biblioteki dll używane przez kod C# jako referencje.

Przed kompilacją skryptów C# na komputerze z IIS należy nadać użytkownikowi IIS_IUSRS prawo zapisu do katalogu .scriptcs_cache

Okno kompilacji języka C# jest dostępne z poziomu właściwości wybranych kontrolek. Kontrolki
obsługują poniższe zdarzenia:

1. Init (zdarzenie OnInit)

2. Obserwator (zdarzenie OnChange)

3. Wciśnięcie przycisku (zdarzenie OnClick)

Jeżeli zaistnieje potrzeba skorzystania z biblioteki referencyjnej w której znajdują się funkcje do
wywołania w kodzie C#, bibliotekę należy wgrać do katalogu bin\Scriptcs_bin. Nazwę tej biblioteki
należy podać w oknie „Referencje”( zob. poniżej punkt Język C# na definicjach kontrolek).

Istnieje możliwość skorzystania z referencji bibliotek com (.NET) zarejestrowanych na serwerze IIS. W takim przypadku, w oknie „Referencje” należy wpisać nazwę biblioteki bez rozszerzenia dll.

Kompilacja kodu C# odbywa się po naciśnięciu ikony lub kliknięciu przycisku „Kompiluj i zapisz”. Elementy te znajdują się w oknie edycji kodu C#. ( zob. poniżej punkt Język C# na definicjach kontrolek)

Jeżeli skompilowane biblioteki dll zostaną usunięte z katalogu .scriptcs_cache, to przed pierwszym użyciem funkcjonalności (podniesienie dokumentu DMS) zamodelowanej metodą C# nastąpi automatyczne skompilowanie bibliotek.

Włączenie funkcjonalności

Aby włączyć funkcjonalność należy:

• 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. 

Jeżeli operator nie posiada odpowiedniej licencji, a zaznaczył parametr „PremiumFunctionality”, wówczas przy próbie logowania w oknie logowania zostanie wyświetlona na czerwono informacja o braku licencji Premium, a dostęp do Comarch DMS nie będzie możliwy.

Włączenie edytora C# skutkuje pojawieniem się dodatkowych opcji na definicjach kontrolek.

Zasady pisania kodu C#

Kod C# dzięki któremu można programować inicjowanie wartości w poszczególnych kontrolkach programuje się w udostępnianych przez kontrolki edytorach na zasadzie skryptu. Można przyjąć, że obszar edytora to „wnętrze” metody obsługującej określone zdarzenie.

W zależności od edytora kontrolki (wybranego zdarzenia), administrator ma dostęp do listy właściwości, które można przywołać wpisując nazwę „Global”.

Obiekt „Global” skupia w sobie wszystkie inne obiekty, które można wykorzystać podczas pisania obsługi zdarzenia. Poprzez ten obiekt użytkownik ma również dostęp do wartości kontrolek znajdujących się na karcie obiegu.

W przypadku zdarzeń „Inicjowanie”, każda kontrolka posiada obiekt „Common” z następującymi właściwościami:

Obiekt „Global” posiada również obiekt „MainFrame”.

Po nazwie „MainFrame” występują nazwy identyfikatorów kontrolek, następnie właściwości lub metody.

Elementy udostępniane przez obiekt „MainFrame” zależą od kontrolki, dla której pisze się obsługę zdarzenia, zdarzeń oraz od innych zdefiniowanych na karcie obiegu kontrolek.

W przypadku obiektu „MainFrame”, dostęp do właściwości odbywa się w oparciu o następującą ścieżkę:

Globals.MainFrame.Identyfikator kontrolki.Nazwa właściwości lub nazwa metody

Język C# na definicjach kontrolek

Oprogramowano funkcjonalność tworzenia własnych zdarzeń w języku C#. W aktualnej wersji możliwość modelowania zdarzeń w języku C# dostępna jest w kontrolkach:

W większości kontrolek możliwe jest tworzenie skryptów służących zarówno inicjowaniu wartości w kontrolkach, jak i obserwowaniu wartości innych kontrolek. Obserwowanie wartości umożliwia „reagowanie” na zmiany. Dla kontrolek typu dane tabelaryczne oraz własna akcja możliwa jest również „obserwacja samej siebie”.

Po wskazaniu inicjowania wartości za pomocą C# Script i kliknięciu w 
uruchamiana jest formatka, w której należy wpisać kod C#.

Okno Skrypt C# składa się z pola, w którym należy wpisać kod, a następnie skompilować i zapisać przyciskiem [Kompiluj i zapisz].

Kod po skompilowaniu zapisywany jest w formie biblioteki w lokalizacji …\bin\.scriptsc_cache w katalogu, w którym zainstalowano aplikację serwerową (dawna web) Comarch DMS.

W polu Referencje należy wpisać nazwy bibliotek, z których będzie korzystał kod C#. Domyślną lokalizacją, w której należy umieścić biblioteki jest …\bin\scripts_bin w katalogu, w którym zainstalowano aplikację serwerową (dawna web)Comarch DMS.

Warunkiem koniecznym do poprawnego działania jest nadanie operatorowi IIS_USER uprawnień pełnej kontroli do katalogu .scriptsc_cache, pozwoli to na dynamiczny zapis skompilowanych plików.

W edytorze skryptów C# wyświetlane są podpowiedzi zawierające obiekty kontrolek karty obiegu (Globals.MainFrame.*) oraz zmienne (Globals.Common.*).

Podpowiedzi wyświetlane w edytorze skryptów C#

W kontrolce typu Dane tabelaryczne dostępne są następujące funkcje i właściwości:

Użytkownik może modyfikować wartości kontrolek poprzez modyfikację właściwości „Value” lub „Text”. Np. Globals.MainFrame.Liczba.Value = 10;

Możliwe jest to jednak tylko dla kontrolek, dla których został wprowadzony kod C#, czyli zostało wywołane zdarzenie OnInit lub OnChange (obserwacja). Pozostałe właściwości są tylko do odczytu.

Dla kontrolki „Własna akcja” został oprogramowany przełącznik, dzięki któremu można wskazać miejsce uruchomienia skompilowanego kodu C#. Istnieje możliwość uruchomienia kodu w ramach procesu IIS lub w ramach niezależnego procesu (jednowątkowego).

Uruchomienie na niezależnym procesie zalecane jest w przypadku obsługi API, które nie powinno działać na procesach wielowątkowych, jakim jest proces IIS.

Od wersji 2022.0 w Comarch DMS Premium dostępna jest funkcjonalność weryfikacji kontrahentów na białej liście podatników.

Kontrahent jest weryfikowany według numeru NIP. Wedle tej informacji można także sprawdzić, czy kontrahent był zarejestrowany na białej liście podatników w danym dniu.

Aby zweryfikować kontrahenta, w konfiguracji kontrolki używa się metody C#:

Przyklad

Metoda GetStatusVAT(string nip) – przykład

1. Użytkownik w ramach obiegu dokumentów tworzy dwie kontrolki typu tekst.

Są to:

• Kontrolka Czy kontrahent zweryfikowany? (identyfikator kontrolki: weryfikacja_kontrolka)
• Kontrolka NIP (identyfikator kontrolki: nip_kontrolka)

 

2. Następnie we właściwościach kontrolki Czy kontrahent zweryfikowany? użytkownik dodaje w ramach pola Kontrolki powiązane kontrolkę NIP, a jako Wzór na wartość wybiera C# Script i klika Ustaw. Następnie wpisuje następujący wzór:

var nip = Globals.MainFrame.nip_kontrolka.Text;

if (!string.IsNullOrEmpty(nip))
Globals.MainFrame.weryfikacja_kontrolka.Text = Globals.Common.GetStatusVAT(nip).ToString();
else
Globals.MainFrame.weryfikacja_kontrolka.Text = „”;

 

i wybiera przycisk , aby skompilować wzór i zapisać.

3. Następnie zamyka okno Skrypt C#, zapisuje obieg i sprawdza działanie kontrolek.

 

 

Możliwe wartości zwrócone po weryfikacji do kontrolki „Czy kontrahent zweryfikowany?” to:

• No – podatnik nie jest VATowcem
• Yes – podatnik jest czynnym VATowcem
• Free – podatnik jest zwolniony z VAT
• None – wystąpił błąd podczas weryfikacji
• NIPError – niepoprawny numer NIP

 

 

Przyklad

Metoda GetStatusVATForDate(string nip, DateTime date) – przykład

1. Użytkownik w ramach obiegu dokumentów tworzy dwie kontrolki typu tekst i jedną kontrolkę typu data. Są to:

• Kontrolka typu tekst Czy kontrahent był danego dnia na białej liście? (identyfikator kontrolki: kontrahent_dzien)
• Kontrolka typu tekst NIP (identyfikator kontrolki: NIP)
• Kontrolka typu data Data (identyfikator kontrolki: Data)

 

 

 

2. Następnie we właściwościach kontrolki Czy kontrahent był danego dnia na białej liście? użytkownik dodaje w ramach pola Kontrolki powiązane kontrolki: NIP i Data, a jako Wzór na wartość wybiera C# Script i klika Ustaw. Następnie wpisuje następujący wzór:

var nip = Globals.MainFrame.NIP.Text;
var data1 = Convert.ToDateTime(Globals.MainFrame.Data.Value);

if (!string.IsNullOrEmpty(nip))
Globals.MainFrame.kontrahent_dzien.Text = Globals.Common.GetStatusVATForDate(nip, data1).ToString();
else
Globals.MainFrame.kontrahent_dzien.Text = „”;

 

i wybiera przycisk , aby skompilować wzór i zapisać.

 

3. Następnie użytkownik zamyka okno Skrypt C#, zapisuje obieg i sprawdza działanie kontrolek.

 

 

Możliwe wartości zwrócone po weryfikacji do kontrolki „Czy kontrahent był danego dnia na białej liście?” to:

• No – podatnik nie był w danym dniu VATowcem
• Yes – podatnik był w danym dniu czynnym VATowcem
• Free – podatnik był w danym dniu zwolniony z VAT
• None – wystąpił błąd podczas weryfikacji
• NIPError – niepoprawny numer NIP

 

Informacje ogólne

W wersji 2023.1.0 w aplikacji desktop Comarch DMS udostępniono funkcjonalność robotyzacji procesów.

W ramach mechanizmu robotyzacji użytkownik korzysta ze skryptów C#, z zastosowaniem predefiniowanych klas. W tym celu został udostępniony lokalny kompilator C#.

Skrypty mogą korzystać z referencji.

Skrypty są aktywowane ręcznie

Zakładka „Konfiguracja automatycznego trybu pracy” – nadawanie uprawnień do zakładki i elementy okna

W wersji 2023.1.0 została dodana nowa zakładka [Konfiguracja automatycznego trybu pracy] , dostępna w menu głównym aplikacji desktop Comarch DMS nad ikoną panelu użytkownika .

Zakładka [Konfiguracja automatycznego trybu pracy] jest dostępna w menu głównym aplikacji desktop Comarch DMS jedynie wtedy, gdy danemu operatorowi nadano uprawnienie do tej zakładki na karcie pracownika.

Aby przyznać uprawnienie do zakładki [Konfiguracja automatycznego trybu pracy] pracownikowi należy przejść na zakładkę [Struktura organizacyjna], następnie kliknąć na sekcje „Pracownicy”, na danego pracownika i na zakładkę „Uprawnienia”. Następnie należy wybrać sekcję „Funkcjonalności” i w ramach pola „Konfiguracja automatycznego trybu pracy” wybrać wartość „Tak”, a następnie zapisać zmiany znakiem dyskietki. Wówczas pracownik będzie mógł tworzyć skrypty do pracy automatycznej.

Jeżeli w polu „Konfiguracja automatycznego trybu pracy” ustawiona jest wartość „Nie”, wówczas zakładka nie jest widoczna dla pracownika i nie ma on uprawnień do tworzenia skryptów do pracy automatycznej.

Po pierwszym przejściu na zakładkę [Konfiguracja automatycznego trybu pracy] widoczne jest puste okno ze zwiniętym panelem „Skrypty” . W górnej części okna dostępne są następujące przyciski:

Aby dodać nową pozycję, należy nacisnąć przycisk [Dodaj]. Wówczas zostanie dodany nowy program z predefiniowaną nazwą „Nazwa programu 1”. W ramach okna widoczne są dwie zakładki:

Zakładka „Edytor skryptów”

W wersji 2023.1.0 została dodana nowa zakładka [Konfiguracja automatycznego trybu pracy] , dostępna w menu głównym aplikacji desktop Comarch DMS nad ikoną panelu użytkownika .

Zakładka [Konfiguracja automatycznego trybu pracy] jest dostępna w menu głównym aplikacji desktop Comarch DMS jedynie wtedy, gdy danemu operatorowi nadano uprawnienie do tej zakładki na karcie pracownika.

Aby przyznać uprawnienie do zakładki [Konfiguracja automatycznego trybu pracy] pracownikowi należy przejść na zakładkę [Struktura organizacyjna], następnie kliknąć na sekcje „Pracownicy”, na danego pracownika i na zakładkę „Uprawnienia”. Następnie należy wybrać sekcję „Funkcjonalności” i w ramach pola „Konfiguracja automatycznego trybu pracy” wybrać wartość „Tak”, a następnie zapisać zmiany znakiem dyskietki. Wówczas pracownik będzie mógł tworzyć skrypty do pracy automatycznej.

Jeżeli w polu „Konfiguracja automatycznego trybu pracy” ustawiona jest wartość „Nie”, wówczas zakładka nie jest widoczna dla pracownika i nie ma on uprawnień do tworzenia skryptów do pracy automatycznej.

Po pierwszym przejściu na zakładkę [Konfiguracja automatycznego trybu pracy] widoczne jest puste okno ze zwiniętym panelem „Skrypty” . W górnej części okna dostępne są następujące przyciski:

Aby dodać nową pozycję, należy nacisnąć przycisk [Dodaj]. Wówczas zostanie dodany nowy program z predefiniowaną nazwą „Nazwa programu 1”. W ramach okna widoczne są dwie zakładki:

Zakładka „Uprawnienia”

W ramach zakładki „Uprawnienia” zostają zdefiniowane uprawnienia operatorów do uruchamiania skryptów.

Uprawnienia dla każdego utworzonego programu są nadawane oddzielnie.

Na zakładce dostępne są następujące pola:

Uruchamianie i zatrzymywanie programu

Okno „Uruchom program”

Aby uruchomić program, należy kliknąć w ikonę  [Uruchom], która jest widoczna:

• 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

 

Po naciśnięciu ikony [Uruchom] zostaje otwarte okno „Uruchom program”. W ramach tego okna operator może uruchomić program. W oknie znajdują się dwa pola:

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

Uwaga

W ramach pola „Uruchom program” widoczne są tylko te programy, do których przyznano danemu operatorowi uprawnienia na zakładce „Uprawnienia” w oknie „Konfiguracja automatycznego trybu pracy”  (zob. Zakładka „Uprawnienia”).

 

• 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.

Okno „Automatyczny tryb pracy”

Po naciśnięciu w oknie „Uruchom program” przycisku [Uruchom] zostaje otwarte okno „Automatyczny tryb pracy”.

W ramach okna „Automatyczny tryb pracy” znajduje się nazwa programu, który został uruchomiony, jest również podawany czas, który zajęło dotychczas wykonywanie programu.

Aby zakończyć działania programu, należy kliknąć przycisk [Zatrzymaj program], znajdujący się w dolnej części okna.

Kiedy operator naciśnie przycisk [Zatrzymaj program]:

• 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.

Klasa ACD

W obiekcie Globals dodano klasę ACD, która określa grupę metod wykonywanych jedynie w kontekście okna ACD. W klasie ACD udostępniono następujące metody:

GenerateDMSDocuments (int) – metoda umożliwia wciśnięcie przycisku „Generuj” na zakładce „Automatyczne generowanie dokumentów”.

void Trace(string)

string:message

Przykład:

Globals.Common.Trace("Trwa procesowanie dokumentów dla punktu: \"Faktury od Firmy C\"");

Konfiguracja i uruchamianie automatycznego trybu pracy – przykład

Globals.ACD.Show();

while (1==1)
{
Globals.ACD.SetPoint("Faktury od Firmy A",1);
Globals.ACD.RefreshList();
Globals.ACD.GenerateDMSDocuments();

Globals.ACD.SetPoint("Faktury od Firmy B",1);
Globals.ACD.RefreshList();
Globals.ACD.GenerateDMSDocuments();

Globals.ACD.SetPoint("Faktury od Firmy C",1);
Globals.ACD.RefreshList();
Globals.ACD.GenerateDMSDocuments();
}

Informacje podstawowe

Skrypty C# zostały wykorzystane w kontrolkach typu Własna akcja i Komunikat. Skrypt dla kontrolki typu własna akcja utworzono na podstawie wzorca API XL

Konfiguracja typu obiegu

Przykład pokazuje, w jaki sposób administrator Comarch DMS może skonfigurować definicję obiegu, aby generować dokument „Faktura zakupu” do systemu Comarch ERP XL, bez pomocy kontrolki typu Dokument ERP XL. W tym celu należy:

1. dodać nowy typ obiegu w ramach zakladki  [Definicje obiegów dokumentów] 

2. nadać nazwę typowi obiegu – np. Generowanie faktury zakupu i prefix – np. GEN

3. nadać danemu administratorowi uprawnienie do inicjowania dokumentu na zakładce „Ustawienia obiegu” w sekcji „Uprawnienia do inicjowania dokumentu”

4. W ramach zakładki „Schemat obiegu” utworzyć etap początkowy „Generuj dokument” i etap końcowy „Koniec” oraz dodać uprawnienie dla danego administratora do etapów.

5. W ramach zakładki „Karta obiegu” dodać następujące kontrolki:

 A Kontrolka typu Kontrahent – „Kontrahent” (identyfikator: Kontrahent)

B  Kontrolka typu Dane tabelaryczne – „Elementy” (identyfikator: Elementy) – w ramach kontrolki należy:

• • w zakładce „Listy” dodać następujące listy:
    • „Jm” z wartością „Jednostki miary” w polu „Inicjowanie”
    • „VAT” z wartością „Stawki VAT” w polu „Inicjowanie”

 

• • w zakładce „Ogólne” dodać następujące kolumny:
    • kolumna typu Towar – „Towar” (identyfikator: Towar)
    • kolumna typu Liczba stałoprzecinkowa – „Ilość” (identyfikator: Ilosc)
    • kolumna typu Lista – „Jm.” (identyfikator: Jm) z wartością „Jm” wybraną w polu „Listy”
    • kolumna typu Lista – „VAT” (identyfikator: VAT) z wartością „VAT” wybraną w polu „Listy”
    • kolumna typu Liczba stałoprzecinkowa –  „Cena netto” (identyfikator: CenaNetto)
    • kolumna typu  Liczba stałoprzecinkowa – „Cena brutto” (identyfikator: CenaBrutto)
    • kolumna typu  Liczba stałoprzecinkowa – „Wartość Netto” (identyfikator: WartoscNetto)
    • kolumna typu  Liczba stałoprzecinkowa – „Wartość Brutto” (identyfikator: WartoscBrutto)

 

 

• • w zakładce „Inicjowanie wartości” :
    • w ramach pola „Kontrolki powiązane” kliknąć przycisk „Dodaj” i wybrac kontrolkę „Elementy”
    • w ramach pola „Wzór na wartość” wybrać opcję „SQL OD”, kliknąć „Ustaw”, a następnie wprowadzić następujące zapytanie:

 if  @^InitSenderControlName@ = 'Elementy'
Begin
    
    declare @vat decimal(22,4) = 0.0
    declare @netto decimal (22,4) = 0.0
    declare @brutto decimal (22,4) = 0.0
    declare @ilosc decimal (22,4) = 0.0
    
    if  @Elementy_Column@ in (2,4,5)
    Begin
        select @netto = CenaNetto, @ilosc = Ilosc from  @Elementy@ 
where POS = @Elementy_Row@ 
        select @vat = case 
            when VAT = 1 then 23
            when VAT = 2 then 8
            when VAT = 3 then 0
            when VAT = 4 then 0
            when VAT = 5 then 0
            when VAT = 6 then 7
            when VAT = 7 then 5
            else 0 end
        from  @Elementy@ where POS = @Elementy_Row@ 
        set @brutto = ((@netto*@vat)/100)+@netto
        
        update @Elementy@ set CenaBrutto = @brutto, WartoscBrutto = @ilosc * @brutto, 
        WartoscNetto = @ilosc * @netto where POS = @Elementy_Row@  
        select * from  @Elementy@ 
    End

    if @Elementy_Column@  = -1
    Begin
        update @Elementy@ set Ilosc = 1, JM = 1, VAT = 1 
        where POS = @Elementy_Row@  
        select * from  @Elementy@ 
    End
End

 

Wprowadzone zapytanie należy zapisać, klikając w przycisk „Zapisz” w oknie „Wyrażenie kontrolki”

 

 

 

• • w zakładce „Ograniczenie Edycji” zaznaczyć checkboxy na obydwóch etapach dla kolumn: „Cena netto”, „Cena brutto”, „Wartość Netto”, „Wartość Brutto”

C kontrolka typu Własna akcja – „Generuj dokument” (identyfikator: GenerujDokument) – w ramach definicji kontrolki należy kliknąć w link „Ustaw” w polu „C# Script”, następnie w otwartym oknie „Skrypt C#” w polu „Miejsce wykonania skryptu” wybrać „Proces (exe)” i wprowadzić następujący kod:

using System.Threading;
using System.Runtime.InteropServices;
using cdn_api;


static ThreadLocal<bool> threadToClarionAttached = new ThreadLocal<bool>(() => false);

[DllImport("ClaRUN.dll")]
private static extern void AttachThreadToClarion(int flag);
public void AttachThreadToClarion()
{
    try
    {
        if (!threadToClarionAttached.Value)
        {
            AttachThreadToClarion(1); // C8
            threadToClarionAttached.Value = true;
        }
    }
    catch (DllNotFoundException ex)
    {
    // -----------------------------------------------------------------
    // Tu przekaż informacje o statusie działania skryptu
    // -----------------------------------------------------------------
    Globals.MainFrame.GenerujDokument_CSSCRIPT.Text = ex.Message;
    }
}


AttachThreadToClarion();

int _lSesjaID = 0;
string blad = "";

try
{
    int documentId = 0;
    int wersjaApi = odpowiedniawersjaapi;
    
    var loginInfo = new XLLoginInfo_odpowiedniawersjaapi()
    {
        Wersja = odpowiedniawersjaapi,
        ProgramID = "Comarch DMS",
        Winieta = -1,
        TrybWsadowy = 1,
        Baza = "nazwafirmy",
        OpeIdent = "Login",
        OpeHaslo = "hasło",
        SerwerKlucza = @"serwerklucza"
    };
    
    var XLLoginResult = cdn_api.cdn_api.XLLogin(loginInfo, ref _lSesjaID);
    if (XLLoginResult != 0)
    {
        blad = "Funkcja XLLogin zwróciła bład nr: " + XLLoginResult;
        throw new Exception();
    }
    
    // -----------------------------------------------------------------
    // Tu dodaj kod obsługi API
    // -----------------------------------------------------------------
    
    var dokumentNagInfo = new XLDokumentNagInfo_odpowiedniawersjaapi
    {
        Wersja = odpowiedniawersjaapi,
        Typ = 1521,//FZ
        KntTyp = 32,
        KntNumer = Globals.MainFrame.Kontrahent.Id ?? 0, // Pobierz GidNumer kontrahenta
        RodzajZakupu = 1,
        //Avista = 1
    };

    var XLNowyDokumentResult = cdn_api.cdn_api.XLNowyDokument (_lSesjaID, ref documentId, dokumentNagInfo);
    if (XLNowyDokumentResult != 0)
    {
        blad = "Funkcja XLNowyDokument zwróciła bład nr: " + XLNowyDokumentResult;
        throw new Exception();
    }
    
    //var element;
    
    for (int i=0; i<Globals.MainFrame.Elementy.RowCount; i++)
    {

        var element = new XLDokumentElemInfo_odpowiedniawersjaapi();
        
        element.Wersja = odpowiedniawersjaapi;
        element.TwrTyp = 16;
        element.Ilosc = Globals.MainFrame.Elementy.Items[i].Ilosc.Value.ToString();
        element.TwrNumer = Globals.MainFrame.Elementy.Items[i].Towar.Id;
        element.JmZ = Globals.MainFrame.Elementy.Items[i].Jm.Text;
        element.Cena = Globals.MainFrame.Elementy.Items[i].CenaNetto.Value.ToString();
    
        
        var XLDodajPozycjeResult = cdn_api.cdn_api.XLDodajPozycje(documentId, element);
        if (XLDodajPozycjeResult != 0)
        {
            blad = "Funkcja XLDodajPozycje zwróciła bład nr: " + XLDodajPozycjeResult;
            throw new Exception();
        }        
    }
    
    var zamkniecieDokumentuInfo = new XLZamkniecieDokumentuInfo_odpowiedniawersjaapi
    {
        Wersja = odpowiedniawersjaapi,
        Tryb = 1
    };
    
    var XLZamknijDokumentResult = cdn_api.cdn_api.XLZamknijDokument(documentId, zamkniecieDokumentuInfo);
    if (XLZamknijDokumentResult != 0)
    {
        blad = "Funkcja XLZamknijDokument zwróciła bład nr: " + XLZamknijDokumentResult;
        throw new Exception();
    }    
    
}
catch (Exception ex)
{
    if (blad == "")
        blad = "Nieokreślony błąd: " + ex.Message;
}
finally
{
    var XLLogoutResult = cdn_api.cdn_api.XLLogout(_lSesjaID);
    if (XLLogoutResult != 0)
    {
        blad = "Funkcja XLLogout zwróciła bład nr: " + XLLogoutResult;
    }
    // -----------------------------------------------------------------
    // Tu przekaż informacje o statusie działania skryptu
    // -----------------------------------------------------------------
    if ( blad == "")
        Globals.MainFrame.GenerujDokument_CSSCRIPT.Text = "Operacja zakończona sukcesem.";
    else
        Globals.MainFrame.GenerujDokument_CSSCRIPT.Text = blad;
}

gdzie należy zmienić następujące wartości:

odpowiedniawersjaapi – wersja API ERP XL zgodna z wersją pliku cdn_api[wersja].net.dll

nazwafirmy – nazwa Firmy Comarch ERP XL (nazwę firmy można sprawdzić w managerze baz Comarch ERP XL)

Login – login operatora Comarch ERP XL

hasło – hasło operatora Comarch ERP XL

serwerklucza – serwer klucza licencji

Po wprowadzeniu kodu należy nacisnąć przycisk [Kompiluj i zapisz], a następnie, gdy w dolnej części okna zostanie wyświetlony napis „Kompilacja skryptu zakończyła się sukcesem” nacisnąć przycisk „Zamknij”.

D Kontrolka typu Komunikat – należy w ramach pola:

• • „Nazwa (identyfikator)” wprowadzić nazwę „Msg1”
  • „Tytuł” wprowadzić tekst „Status wykonania API ERP XL”
  • „Kontrolki powiązane” kliknąć w link „Dodaj” i wybrać kontrolkę „Generuj dokument”
  • „Wzór na wartość” wybrać wartość „C# Script”, kliknąć „Ustaw”, a następnie wprowadzić następujący kod:

 Globals.MainFrame.Msg1.Message = Globals.MainFrame.GenerujDokument_CSSCRIPT.Text;

Po wprowadzeniu kodu należy nacisnąć przycisk [Kompiluj i zapisz], a następnie, gdy w dolnej części okna zostanie wyświetlony napis „Kompilacja skryptu zakończyła się sukcesem” nacisnąć przycisk „Zamknij”.

6. zapisać typ obiegu za pomocą przycisku [Zapisz]

Generowanie dokumentu FZ do Comarch ERP XL – jak działa

Po zdefiniowaniu typu obiegu operator przechodzi na zakładkę [Dokumenty], klika na typ obiegu „Generowanie faktury zakupu” i naciska przycisk [Dodaj]. Następnie kolejno:

1. zapisuje nowy dokument, naciskając [Zapisz]

2. wybiera kontrahenta w ramach kontrolki „Kontrahent”

3. w ramach kontrolki „Elementy” dodaje towar w kolumnie „Towar”, wybiera opcję w kolumnach „Jm.” i „VAT” oraz wpisuje wartość w kolumnie „Cena netto” (jeśli poprawnie skonfigurowano obieg, wówczas kolumny „Cena brutto”, „Wartość Netto” i „Wartość Brutto” powinny zostać uzupełnione automatycznie)

4. naciska przycisk „Generuj dokument” – wówczas następuje generowanie dokumentu – poniżej przycisku widoczne są poruszające się punkty

5. Jeśli generowanie dokumentu zakończyło się powodzeniem, wówczas na środku ekranu wyświetlany jest następujący komunikat:

Film

Aby zobaczyć przebieg generowania dokumentu do Comarch ERP XL, kliknij w poniższy film:

 

 

Wygenerowany dokument jest już widoczny w Comarch ERP XL:

 

Informacje podstawowe

Skrypty C# zostały wykorzystane w kontrolkach typu Własna akcja i Komunikat. Skrypt dla kontrolki typu własna akcja utworzono na podstawie wzorca API XL

Konfiguracja typu obiegu

Przykład pokazuje, w jaki sposób administrator Comarch DMS może skonfigurować definicję obiegu, aby zatwierdzić dokument „Faktura zakupu” w systemie Comarch RP XL z poziomu Comarch DMS. W tym celu należy:

1. dodać nowy typ obiegu w ramach zakladki  [Definicje obiegów dokumentów] 

2. nadać nazwę typowi obiegu – np. Zatwierdzanie faktury zakupu i prefix – np. ZAT

3. nadać danemu administratorowi uprawnienie do inicjowania dokumentu na zakładce „Ustawienia obiegu” w sekcji „Uprawnienia do inicjowania dokumentu”.

4. W ramach zakładki „Schemat obiegu” utworzyć etap początkowy „Zatwierdzanie dokumentu” i etap końcowy „Koniec” oraz dodać uprawnienie dla danego administratora do etapów.

5. W ramach zakładki „Karta obiegu” dodać następujące kontrolki:

 A Kontrolka typu Dokument elektroniczny – „Faktura zakupu” (identyfikator: FakturaZakupu) – w polu „Typ” należy wybrać „Faktura zakupu”

B kontrolka typu Własna akcja – „Zatwierdź dokument” (identyfikator: ZatwierdzDokument) – w ramach definicji kontrolki należy kliknąć w link „Ustaw” w polu „C# Script”, następnie w otwartym oknie „Skrypt C#” w polu „Miejsce wykonania skryptu” wybrać „Proces (exe)” i wprowadzić następujący kod:

using System.Threading;
using System.Runtime.InteropServices;
using cdn_api;


static ThreadLocal<bool> threadToClarionAttached = new ThreadLocal<bool>(() => false);

[DllImport("ClaRUN.dll")]
private static extern void AttachThreadToClarion(int flag);
public void AttachThreadToClarion()
{
    try
    {
        if (!threadToClarionAttached.Value)
        {
            AttachThreadToClarion(1); // C8
            threadToClarionAttached.Value = true;
        }
    }
    catch (DllNotFoundException ex)
    {
    // -----------------------------------------------------------------
    // Tu przekaż informacje o statusie działania skryptu
    // -----------------------------------------------------------------
    //Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text = ex.Message;
    Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text=ex.Message;
    }
}


AttachThreadToClarion();

int _lSesjaID = 0;
string blad = "";

try
{
    int documentId = 0;
    int wersjaApi = odpowiedniawersjaapi;
    
    var loginInfo = new XLLoginInfo_odpowiedniawersjaapi()
    {
        Wersja = odpowiedniawersjaapi,
        ProgramID = "Comarch DMS",
        Winieta = -1,
        TrybWsadowy = 1,
        Baza = "nazwafirmy",
        OpeIdent = "Login",
        OpeHaslo = "hasło",
        SerwerKlucza = @"serwerklucza"
    };
    
    var XLLoginResult = cdn_api.cdn_api.XLLogin(loginInfo, ref _lSesjaID);
    if (XLLoginResult != 0)
    {
        blad = "Funkcja XLLogin zwróciła bład nr: " + XLLoginResult;
        throw new Exception();
    }
    
    // -----------------------------------------------------------------
    // Tu dodaj kod obsługi API
    
                var otworzDocumentInfo = new XLOtwarcieNagInfo_odpowiedniawersjaapi
                {
                    Wersja = odpowiedniawersjaapi,
                    GIDTyp = 1521,
                    GIDNumer = Globals.MainFrame.FakturaZakupu.Id ?? 0,
                    Tryb = 2

                };

                var XLOtwarcieInfoResult = cdn_api.cdn_api.XLOtworzDokument(_lSesjaID, ref documentId, otworzDocumentInfo);
                if (XLOtwarcieInfoResult != 0)
                {
                    blad = "Funkcja XLOtworzDokument zwróciła bład nr: " + XLOtwarcieInfoResult;
                    throw new Exception();
                }


                var zamkniecieDokumentuInfo = new XLZamkniecieDokumentuInfo_odpowiedniawersjaapi
                {
                    Wersja = odpowiedniawersjaapi,
                    Tryb = 0
                };

                               
                var XLZamknijDokumentResult = cdn_api.cdn_api.XLZamknijDokument(documentId, zamkniecieDokumentuInfo);
                if (XLZamknijDokumentResult != 0)
                {
                    blad = "Funkcja XLZamknijDokument zwróciła bład nr: " + XLZamknijDokumentResult;
                    throw new Exception();
                }
    // -----------------------------------------------------------------
}
catch (Exception ex)
{
    if (blad == "")
        blad = "Nieokreślony błąd: " + ex.Message;
}
finally
{
    var XLLogoutResult = cdn_api.cdn_api.XLLogout(_lSesjaID);
    if (XLLogoutResult != 0)
    {
        blad = "Funkcja XLLogout zwróciła bład nr: " + XLLogoutResult;
    }
    // -----------------------------------------------------------------
    // Tu przekaż informacje o statusie działania skryptu
    // -----------------------------------------------------------------
    
    //Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text = blad; 
    if (blad == "")
        Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text = "Operacja zakończona sukcesem";
    else 
        Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text = blad;
    
}

gdzie należy zmienić następujące wartości:

odpowiedniawersjaapi – wersja API ERP XL zgodna z wersją pliku cdn_api[wersja].net.dll

nazwafirmy – nazwa Firmy Comarch ERP XL (nazwę firmy można sprawdzić w managerze baz Comarch ERP XL)

Login – login operatora Comarch ERP XL

hasło – hasło operatora Comarch ERP XL

serwerklucza – serwer klucza licencji

Następnie należy kliknąć w przycisk [Referencje], znajdujący się w prawym górnym rogu okna „Skrypt C#”, w wpisać tam nazwę odpowiedniego pliku dll:

 cdn_api[odpowiedni numer wersji].net.dll

Następnie należy nacisnąć przycisk  [Zapisz].

Po wprowadzeniu kodu do edytora i nazwy dll w oknie „Referencje”  należy nacisnąć przycisk [Kompiluj i zapisz], a następnie, gdy w dolnej części okna zostanie wyświetlony napis „Kompilacja skryptu zakończyła się sukcesem” nacisnąć przycisk „Zamknij”.

Uwaga

Jeśli w ramach okna „Referencje” po kliknięciu przycisku [Referencje] wprowadzono niewłaściwą nazwę pliku dll, wówczas po naciśnięciu przycisku [Kompiluj i zapisz] w dolnej części okna wyświetlana jest informacja „Assembly not found”.

C Kontrolka typu Komunikat – należy w ramach pola:

 Globals.MainFrame.Message1.Message = Globals.MainFrame.ZatwierdzDokument_CSSCRIPT.Text

Po wprowadzeniu kodu należy nacisnąć przycisk [Kompiluj i zapisz], a następnie, gdy w dolnej części okna zostanie wyświetlony napis „Kompilacja skryptu zakończyła się sukcesem” nacisnąć przycisk „Zamknij”.

6. zapisać typ obiegu za pomocą przycisku [Zapisz].

Zatwierdzanie dokumentu FZ w Comarch ERP XL – jak działa

Po zdefiniowaniu typu obiegu operator przechodzi na zakładkę [Dokumenty], klika na typ obiegu „Zatwierdzanie faktury zakupu” i naciska przycisk [Dodaj]. Następnie kolejno:

1. zapisuje nowy dokument, naciskając [Zapisz]

2. dodaje dokument z Comarch ERP XL w ramach kontrolki „Faktura zakupu”

3. naciska przycisk „Zatwierdź dokument” – wówczas następuje zatwierdzanie dokumentu – poniżej przycisku widoczne są poruszające się punkty

4. Jeśli zatwierdzanie dokumentu zakończyło się powodzeniem, wówczas na środku ekranu wyświetlany jest następujący komunikat:

Uwaga

Jeśli operator w kontrolce „Faktura zakupu” wybierze dokument, który już został zatwierdzony w Comarch ERP XL, i kliknie przycisk „Zatwierdź dokument”, wówczas zostaje wyświetlony następujący komunikat:

 

Od wersji 2024.0.2 możliwe jest wskazanie identyfikatora connection stringa za pomocą kodu C#, aby określić  connection string, na podstawie którego będzie następowało połączenie do bazy danych. Jeżeli:

• <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)