W Comarch DMS dostępne są procedury (wyzwalacze), które rozszerzają funkcjonalność modelowania procesów o możliwość wykonywania dodatkowych akcji, uruchamiane poprzez określone zdarzenie występujące podczas pracy z aplikacją.
Jeśli użytkownik w dotychczasowej procedurze miał dodatkowy własny kod, wówczas po aktualizacji powinien dodać go jeszcze raz.
Comarch DMS wyposażony m. in. jest w następujące wyzwalacze:
- Baza Comarch DMS:
- do.OnAfterDocumentCreated – procedura uruchamiana po każdym utworzeniu dokumentu w Comarch DMS.
- do.OnAfterDocumentSave – procedura uruchamiana po każdej aktualizacji dokumentu Comarch DMS:
- po kliknięciu w ikonę zapisu,
- w przypadku, gdy na typie obiegu ustawiono automatyczny zapis po zainicjowaniu dokumentu,
- po kliknięciu ‘Utwórz’ w celu utworzenia dokumentu w masowym skanowaniu,
- po kliknięciu w ‘Generuj’ w celu wygenerowania dokumentu w punktach ACD,
- przy próbie zapisu dokumentu w obiegu utworzonego z poziomu kolumny typu Dokumenty w obiegu w kontrolce typu Dane tabelaryczne.
- do.OnBeforeDocumentShow – procedura uruchamiana przed wyświetleniem szczegółów dokumentu Comarch DMS:
- do.OnDocumentPropagation – procedura uruchamiana jest podczas każdego przekazania dokumentu do kolejnego etapu.
- Bazy Comarch ERP XL, Comarch ERP Optima, Comarch ERP Altum – podczas propagacji dokumentu Comarch DMS można wykonać procedurę na bazie systemu Comarch ERP:
- CDN.OnDocumentPropagation – procedura uruchamiana jest podczas każdego przekazania dokumentu do kolejnego etapu.
W każdej z procedur (wyzwalaczy) obsłużono wyjątki (Try-Catch) z możliwością przekazania informacji do aplikacji jako komunikat (MessageBox). Ponadto wyjątek zwrócony poprzez instrukcję THROW spowoduje cofnięcie transakcji. Możliwość tą można wykorzystać np. do zatrzymania przekazania dokumentu do kolejnego etapu (procedura OnDocumentPropagation) w sytuacji, gdy nie został spełniony warunek przekazania. Kliknięcie „Przekaż do kolejnego etapu” może spowodować wyświetlenie komunikatu zdefiniowanego w procedurze i zatrzymanie akcji przekazania.
Budowa procedur (wyzwalaczy) rozszerzających funkcjonalność modelowania procesów (budowa procedury zostanie wyświetlona po kliknięciu w nazwę):
Przykład zastosowania procedury do.OnAfterDocumentCreated
W przykładzie zastosowano funkcję skalarną do.ModWorkflowName zwracającą nazwę typu obiegu. W procedurze do.OnAfterDocumentCreated dodano warunek, który ogranicza wywołanie procedury do nazwy typu obiegu. Oznacza to, że procedura zostanie uruchomiona każdorazowo, gdy w ramach wskazanego typu obiegu zostanie utworzony nowy dokument i zostanie podjęta próba jego zapisu w bazie.
W przypadku, gdy kontrolka, której identyfikator wskazano w procedurze, ma uzupełnioną wartość, dokument zostanie zapisany.
W przypadku, gdy w kontrolce, której identyfikator określono w procedurze, nie zostanie uzupełniona wartość, dokument nie zostanie zapisany i zostanie wyświetlony komunikat o treści określonej w poleceniu THROW w procedurze.
Operator w ramach definicji typu obiegu „Faktury – procedura do.OnAfterDocumentCreated” dodał cztery kontrolki:
- Numer dokumentu (Numer_dokumentu)
- Data wystawienia (Data_wystawienia)
- Wartość netto (netto)
- Wartość brutto (brutto)
Następnie operator znalazł w bazie DMS procedurę do.OnAfterDocumentCreated w katalogu Programmability/Stored Procedures, kliknął na nią prawym przyciskiem myszki, wybrał opcję Modify i wprowadził następujące zapytanie:
USE [DMS]-- w nawiasie kwadratowym należy wpisać nazwę bazy Comarch DMS GO SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO ALTER PROCEDURE [do].[OnAfterDocumentCreated] @DocumentId as int = NULL, --DWD_ID z tabeli DF_Work @SavedBy as int = NULL --DCD_ID z tabeli DF_ConfOSDictionary AS BEGIN BEGIN TRY declare @string varchar(max)=''; if do.ModWorkflowName (@DocumentId)='Faktury - procedura do.OnAfterDocumentCreated' /*nazwa typu obiegu, w którym nastąpi blokada*/ Begin select @string= isnull (w.DWC_ValueString,'') from do.DF_Work d join do.DF_ConfDSHead i on d.DWD_DSHId=i.DSH_ID join do.DF_ConfCFCardDokFlow k on k.DKO_DSHId=i.DSH_ID join do.DF_WorkCF w on w.DWC_DKOId = k.DKO_ID where DWD_ID=@DocumentId and k.DKO_Name='Numer_dokumentu' /* identyfikator kontrolki, dla której wymagane jest uzupełnienie wartości*/ if @string ='' THROW 50001, 'Pole Numer dokumentu jest wymagane' ,1; -- -treść wyświetlanego komunikatu End END TRY BEGIN CATCH DECLARE @ErrorMessage varchar(max) = ERROR_MESSAGE(); THROW 50001, @ErrorMessage ,1; declare @ErrorSeverity int = ERROR_SEVERITY(), @ErrorState int = ERROR_STATE() raiserror (@ErrorMessage, @ErrorSeverity, @ErrorState); end catch END
Później operator nacisnął przycisk „Execute”, aby procedura została zastosowana, zapisał typ obiegu w Comarch DMS i spróbował zapisać nowy dokument bez wpisywania wartości do kontrolki „Numer dokumentu”. Dokument nie został zapisany i wyświetlony został komunikat Pole Numer dokumentu jest wymagane. Operator mógł zapisać dokument dopiero po wprowadzeniu wartości w kontrolce „Numer dokumentu”.
Przykład zastosowania procedury do.OnAfterDocumentSave
Operator w ramach definicji typu obiegu dodał cztery kontrolki:
- Numer dokumentu (Numer_dokumentu)
- Data wystawienia (Data_wystawienia)
- Wartość netto (netto)
- Wartość brutto (brutto)
Następnie operator znalazł w bazie DMS procedurę do.OnAfterDocumentSave w katalogu Programmability/Stored Procedures, kliknął na nią prawym przyciskiem myszki, wybrał opcję Modify i wprowadził następujące zapytanie:
USE [DMS]-- w nawiasie kwadratowym należy wpisać nazwę bazy Comarch DMS GO SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO ALTER PROCEDURE [do].[OnAfterDocumentSave] @DocumentId as int = NULL, -- DWD_ID z tabeli DF_Work @SavedBy as int = NULL -- DCD_ID z tabeli DF_ConfOSDictionary AS BEGIN begin try --declare @test int --------------------------------Blokada zapisu----------------------------- If exists( select * from do.RO_ObjectsTypes t join do.RO_Documents d on d.DFH_Id=t.DFH_Id where d.DWD_ID=@DocumentId and t.DFH_Name='Faktury' ) Begin declare @Numer_dokumentu varchar (max) declare @data_wystawienia varchar declare @netto decimal (20,4) declare @brutto decimal (20,4) select @Numer_dokumentu=isnull (value, ' ') from do.RO_ControlsValue where DKO_Name='Numer_dokumentu' and DWD_ID=@DocumentId If @Numer_dokumentu=' ' THROW 50001, 'Nie możesz zapisać dokumentu, ponieważ nie wprowadzono numeru dokumentu' ,1; select @Data_wystawienia=isnull (Value,' ') from do.RO_ControlsValue where DKO_Name='Data_wystawienia' and DWD_ID=@DocumentId If @Data_wystawienia=' ' THROW 50001, 'Nie możesz zapisać dokumentu, ponieważ nie wprowadzono daty wystawienia dokumentu' ,1; select @netto=isnull (Value,0) from do.RO_ControlsValue where DKO_Name='netto' and DWD_ID=@DocumentId If @netto=0 THROW 50001, 'Nie możesz zapisać dokumentu, ponieważ nie wprowadzono wartości netto dokumentu' ,1; select @brutto=isnull (Value,0) from do.RO_ControlsValue where DKO_Name='brutto' and DWD_ID=@DocumentId If @brutto=0 THROW 50001, 'Nie możesz zapisać dokumentu, ponieważ nie wprowadzono wartości brutto dokumentu' ,1; END end try begin catch DECLARE @ErrorMessage varchar(max) = 'W procedurze do.OnAfterDocumentSave wystąpił błąd: ' + ERROR_MESSAGE(); --THROW 50001, @ErrorMessage ,1; declare @ErrorSeverity int = ERROR_SEVERITY(), @ErrorState int = ERROR_STATE() raiserror (@ErrorMessage, @ErrorSeverity, @ErrorState); end catch END
Później operator nacisnął przycisk „Execute”, aby procedura została zastosowana, zapisał typ obiegu w Comarch DMS i spróbował zapisać nowy dokument bez wpisywania wartości do kontrolek.
Pierwsza próba zapisu nie powiodła się, a na ekranie został wyświetlony komunikat W procedurze do.OnAfterDocumentSave wystąpił błąd: Nie możesz zapisać dokumentu, ponieważ nie wprowadzono numeru dokumentu.
Operator wpisał numer dokumentu i ponownie próbował zapisać dokument, jednak próba zapisu nie powiodła się, a na ekranie został wyświetlony komunikat W procedurze do.OnAfterDocumentSave wystąpił błąd: Nie możesz zapisać dokumentu, ponieważ nie wprowadzono daty wystawienia dokumentu.
Operator wprowadził datę wystawienia dokumentu i znów próbował zapisać dokument, ale próba zapisu nie powiodła się, a na ekranie został wyświetlony komunikat W procedurze do.OnAfterDocumentSave wystąpił błąd: Nie możesz zapisać dokumentu, ponieważ nie wprowadzono wartości netto dokumentu.
Operator wprowadził wartość netto dokumentu i po raz kolejny próbował zapisać dokument, lecz próba zapisu nie powiodła się, a na ekranie został wyświetlony komunikat W procedurze do.OnAfterDocumentSave wystąpił błąd: Nie możesz zapisać dokumentu, ponieważ nie wprowadzono wartości brutto dokumentu.
Operator uzupełnił wartość brutto, spróbował zapisać dokument – i tym razem próba zapisu zakończyła się sukcesem, bo wszystkie wymagane kontrolki zostały uzupełnione.
Operator utworzył typ obiegu Blokada przekazania bez komentarza i zapisał go.
Następnie operator znalazł w bazie DMS procedurę do.OnDocumentPropagation w katalogu Programmability/Stored Procedures, kliknął na nią prawym przyciskiem myszki, wybrał opcję Modify i wprowadził następujące zapytanie:
USE [DMS] -- nazwa bazy Comarch DMS GO SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO ALTER PROCEDURE [do].[OnDocumentPropagation] @WorkflowId as int = NULL, -- DSH_ID z tabeli DF_ConfDSHead @StageId as int = NULL,-- DDS_ID z tabeli DF_ConfDSDictionary @DocumentId as int = NULL, -- DWD_ID z tabeli DF_Work @PropagatedById as int = NULL, -- DCD_ID z tabeli DF_ConfOSDictionary @DocumentOwnerId as int = NULL, -- DWD_DCDOwnerId z tabeli DF_Work @IsAutomaticPropagation as bit = NULL AS BEGIN If exists ( select * from do.RO_ObjectsTypes t join do.RO_StageActive s on t.DFH_Id=s.DFH_Id join do.RO_Documents d on s.DWD_ID=d.DWD_ID where d.DWD_ID=@DocumentId and t.DFH_Name= 'Blokada przekazania bez komentarza' -- Nazwa typu obiegu ) If exists (select * from do.RO_StageActive sa join do.DF_WorkDS ds on sa.dds_id=ds.DWS_DDSId and sa.DWD_ID=ds.DWS_DWDId where sa.DWD_ID=@DocumentId and ds.DWS_IsCurrent=1 and isnull (ds.dws_message, '')='' ) THROW 50001, 'Nie wpisano komentarza - uzupełnij puste pole pod nazwą kolejnego etapu',1; END
Później operator nacisnął przycisk „Execute”, aby procedura została zastosowana, utworzył nowy dokument i próbował przekazać go do następnego etapu bez wpisania komentarza. Dokument nie został przekazany, natomiast wyświetlony został komunikat Nie wpisano komentarza – uzupełnij puste pole pod nazwą kolejnego etapu. Operator mógł przekazać dokument dopiero po uzupełnieniu pola komentarza.