Interný messaging - ABRA správy a automatické generovanie správ

Príklad: Nech obchodník vystavil faktúru a chce byť informovaný o tom, že dôjde k jej zaplateniu, aby potom mohol s klientom dohadovať ďalšie kroky a pod.

Na tomto príklade si demonštrujeme použitie systémového kontrolného bodu Zaplatenie dokladu a vytvorenie definície automatickej správy typu ID podľa neho.

Detail kontrolného bodu Zaplatenie dokladu. Tento bod nemá žiadnu väzbu na skriptovanie (nie je potrebná, funkcionalita je daná v dodávanom programe) ani nemá zadané agendy, pre ktoré má platiť (nie je to potrebné, opäť je to dané programom a platí pre všetky, kde je možné doklady platiť).

Nadefinujeme si novú definíciu automatickej správy pre tento kontrolný bod. To je možné najjednoduchšie takto:

1. Otvoríme agendu faktúr vydaných a vyhľadáme sledovanú faktúru. Nech je to napr. FV-8/2009. Postavíme kurzor na ňu.
2. Vyvoláme funkciu Autom. správy. Vyvolá sa Sprievodca tvorbou definície automatickej správy.
3. V 1. kroku sprievodcu v položke Kontrolný bod vyberieme "Zaplatenie dokladu". V položke Typ sprievodcu vyberieme voľbu "Zmena zaplatenia dokladu":

   

   Zadanie hodnôt v 1. kroku sprievodcu. ABRA vzhľad modrý.

4. V ďalšom kroku zadáme adresátov.
5. Tento typ sprievodcu už ďalšie kroky nemá, po stlačení Dokončiť sa uloží nová definícia autom. správy do agendy Definícia automatických správ podobná nasledujúcemu obrázku:

   

   Detail definície automatickej správy. Údaje sa predvyplnili automaticky jednak textami danými výrobcom (keďže ide o systémový kontrolný bod) a jednak číslom a ID dokladu, pre ktorý sme funkciu vyvolali. Ako adresát bude uvedený prihlásený užívateľ. Ak by ste chceli definíciu zmeniť (napr. pridať ďalších adresátov, môžete to urobiť priamo v agende Definícia automatických správ.

6. Otvoríme agendu Naplánované úlohy a zadáme novú úlohu typu Automatické správy s intervalom spúšťania napr. každých 5 minút:

   

   Príklad definície naplánovanej úlohy.

7. Zabezpečíme nastavenie a spustenie Automatizačného servera. Viď Čo je potrebné na prevádzku e-mailov a interných správ.

Teraz bude platiť: Akonáhle dôjde k zmene v zaplatení sledovanej faktúry, zaznamená sa interne požiadavka na generovanie autom. správy. V okamihu, keď automatizačný server spustí úlohu typu Automatické správy, tak tí, ktorí sú uvedení medzi adresátmi vyššie vytvorenej definície autom. správy, dostanú správu s predmetom a textom podľa tejto definície.

Príklad: Nech užívateľ chce byť informovaný, že dôjde k zaplateniu faktúry vystavenej na firmu ABC (s firmou boli v minulosti problémy a užívateľ chce byť informovaný o prebiehajúcich platbách dokladov, ktoré na ňu boli vystavené).

Na tomto príklade si demonštrujeme využitie systémového kontrolného bodu Zaplatenie dokladu i pre výrazovú definíciu automatickej správy.

Nadefinujeme si novú definíciu automatickej správy pre tento kontrolný bod. To je možné najjednoduchšie takto:

1. Otvoríme agendu faktúr vydaných. (Teraz nebudeme definovať definíciu typu ID (ako v príklade 1), takže je jedno, na ktorý záznam postavíme kurzor.)
2. Vyvoláme funkciu Autom. správy. Vyvolá sa Sprievodca tvorbou definície automatickej správy.
3. V 1. kroku sprievodcu v položke Kontrolný bod vyberieme "Zaplatenie dokladu" rovnako ako v príklade 1. V položke Typ sprievodcu ale vyberieme voľbu "Výraz".
4. V ďalšom kroku zadáme adresátov.
5. Tento typ sprievodcu má ďalší krok, kde zadáme požadované údaje.

    

   Zadanie hodnôt v 2. kroku sprievodcu

6. Po stlačení Dokončiť sa uloží nová definícia autom. správy do agendy Definícia automatických správ podobná nasledujúcemu obrázku:

   

   Detail definície automatickej správy. Údaje sa predvyplnili automaticky textami zadanými v sprievodcovi. Na rozdiel od príkladu 1 tu ide o podmienky typu výraz. Ak by ste chceli definíciu zmeniť (napr. pridať ďalších adresátov, môžete to urobiť priamo v agende Definícia automatických správ.

7. Ďalej musí existovať naplánovaná úloha a musí byť sprevádzkovaný automatizačný server, ako v príklade 1.

Teraz bude platiť: Akonáhle dôjde k zmene v zaplatení nejakej faktúry, zaznamená sa interne požiadavka na generovanie autom. správy. V okamihu, keď automatizačný server spustí úlohu typu Automatické správy, vyhodnotí sa podmienka (tzn. či daná faktúra bola vystavená na firmu, ktorej ID bolo uvedené vo výraze). Ak je podmienka splnená, tak tí, ktorí sú uvedení medzi adresátmi vyššie vytvorenej definície autom. správy, dostanú správu s predmetom a textom podľa tejto definície.

Príklad: Užívateľ chce byť upozornený, keď dôjde k prijatiu vybraného tovaru.

Tu je potrebné najskôr zadať užívateľský kontrolný bod a pomocou skriptovania zabezpečiť umiestnenie (zaháčikovanie) kontrolného bodu do sledovanej agendy. Prijatie tovaru mení stavy na business objekte Čiastková skladová karta. Na príklade budeme demonštrovať, že kontrolný bod je možné nastaviť aj do inej agendy (Skladové karty), ako z ktorej je sledovaný objekt (Čiastkové skladové karty). Ďalej tu budeme demonštrovať, ako sa dá pomocou skriptovania knižnice naprogramovať nový typ sprievodcu pre tento kontrolný bod a jeho správanie (v našom príklade bude slúžiť na výber skladu).

Predpoklady príkladu:

• Musí existovať kontrolný bod, napr. s názvom "Prijatie tovaruí". Musí mať interný názov (napr. WD5B2FMTMIB41CGVTMY4Z0HYXW) zhodný s interným názvom uvedeným v balíčku skriptov s rovnakým menom, ako je zadané v konfigurácii skriptovania (napr. GoodsReceive) v definícii kontrolného bodu a tento balíček musí obsahovať knižnicu s rovnakým menom, ako je meno knižnice v konfigurácii skirptovania (napr. tiež GoodsReceive). Kontrolný bod je definovaný k agende Skladové karty, tzn. v zozname agend je uvedená agenda Skladové karty.
• Existuje balíček skriptov s názvom GoodsReceive a knižnicou GoodsReceive. Ďalej obsahuje skript pre Business objekt Čiastková skladová karta na "zaháčikovanie" kontrolného bodu. Balíček musí byť skompilovaný a musí mať nastavené Používať. (Balíček skriptov bude vytvorený ku kontrolnému bodu "Prijatie tovaru" funkciou Vygenerovať knižnicu. Predvyplnená šablóna skriptu bude následne doplnená).

Postup:

1. Otvoríme agendu Kontrolné body a zadáme nový kontrolný bod s názvom "Prijatie tovaru". Interný názov nech je napr. WD5B2FMTMIB41CGVTMY4Z0HYXW. V konfigurácii skriptovania zadáme názov balíčka skriptov, napr. GoodsReceive a názov knižnice GoodsReceive. V zozname jeho agend vyberieme agendu Skladové karty a uložíme.

   

   Detail definície kontrolného bodu.

2. Vytvoríme zodpovedajúci balíček skriptov. To sa dá najjednoduchšie pomocou funkcie Generovať knižnicu. Vygenerovaná šablóna obsahuje predvyplnené metódy uvedené vyššie, viď Metódy skriptu Knižnica. Väčšina z nich je prázdna, len GetHelperCaption, GetHelperDescriotion a GetWDPInternalName sú predvyplnené podľa údajov kontrolného bodu. Môže vyzerať napr. takto:

   Tento príklad zodpovedá len verzii 9.02 a vo vyšších verziách sa môže líšiť. Tu slúži len na ilustratívne účely.

   function GetHelperCaption(const SiteForm: TSiteForm): String;
   begin
   // Helper name in wizard form
   Result := 'Prijatie tovaru';
   end;
   function GetHelperDescription(const SiteForm: TSiteForm): String;
   begin
   // Helper description in wizard form
   Result := 'Sledovanie prijatia tovaru';
   end;
   function GetWDPInternalName(const SiteForm: TSiteForm): String;
   begin
   // Should return WatchDogPoint InternalName (packed GUID) 
   // or Null packed GUID) 
   Result := 'O1Q25DAREN3OHBMZPNMYQE3VV0';
   end;
   function IsConditionHelper(const SiteForm: TSiteForm): Boolean;
   begin
   // Return True, if helper use expression.
   // Return False, if helper use business object ID.
   Result := True;
   end;
   function GetRequestDescription(const SiteForm: TSiteForm; const ObjId: String;
   Params: TNxParameters): String;
   begin
   // Should return short description about expression.
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   Result := '';
   end;
   function GetRequestCondition(const SiteForm: TSiteForm; const ObjId: String;
   Params: TNxParameters): String;
   begin
   // if IsConditionHelper return False, return empty string.
   // if IsConditionHelper return True, return expression.
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   Result := '';
   end;

3. Otvoríme agendu Balíčky skriptov a doplníme knižnicu GoodsReceive. Balíček skompilujeme a nastavíme mu Používať. V tomto príklade boli napr. upravené popisy v metódach GetHelperCaption a GetHelperDescription, ďalej bol zadaný druhý krok sprievodcu, kde užívateľ môže zvoliť sklad, na ktorom chce prijatie sledovať, a ďalej boli doplnené texty, ktoré sa použijú na predvyplnenie názvu definície, predmetu a textu správy.

   Úpravy tu uskutočnené sa spätne nepremietnu do definície kontrolného bodu. V každom prípade musí zodpovedať interný názov kontrolného bodu tomu, ktorý je uvedený v skripte v metóde GetWDPInternalName.

   Tento príklad zodpovedá len verzii 9.02 a vo vyšších verziách sa môže líšiť. Tu slúži len na ilustratívne účely.

   var
   StoreCardCode, StoreCardName, StoreCode, StoreName : String;
   const
   rSUBJECT = 'Naskladnenie tovaru'; // RequestSubject
   rMESSAGE = 'Skladové zásoby boli rozšírené.' + #13#10 + '%DISPLAYNAME%'; // RequestMessage
   function GetHelperCaption(const SiteForm: TSiteForm): String;
   begin
   // Helper name in wizard form
   Result := 'Prijatie tovaru - sprievodca';							// Názov ponúkaný ako Typ sprievodcu
   end;
   function GetHelperDescription(const SiteForm: TSiteForm): String;
   begin
   // Helper description in wizard form
   Result := 'Pošle správu, keď dôjde k naskladneniu tovaru';				// Popis daného Typu sprievodcu
   end;
   function GetWDPInternalName(const SiteForm: TSiteForm): String;
   begin
   // Should return WatchDogPoint InternalName (packed GUID) 
   // or Null packed GUID) 
   Result := 'WD5B2FMTMIB41CGVTMY4Z0HYXW';							// Interný názov zviazaného kontrolného bodu WD5B2FMTMIB41CGVTMY4Z0HYXW
   end;
   function IsConditionHelper(const SiteForm: TSiteForm): Boolean;
   begin
   // Return True, if helper use expression.
   // Return False, if helper use business object ID.
   Result := True;										// Nastavenie, že ide o definíciu typu Výraz
   end;
   function GetRequestDescription(const SiteForm: TSiteForm; const ObjId: String;// Generovanie názvu pre definíciu autom. správy Params: TNxParameters): String;
   begin
   // Should return short description about expression.
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   Result := 'Definícia užívateľa:' + NxGetUserName + ' [' + FormatDateTime('YYYYMMDD HH:MM',Now) + ']';   
   end;
   function GetRequestCondition(const SiteForm: TSiteForm; const ObjId: String;
   Params: TNxParameters): String;
   Var mParamItem1, mParamItem2: TNxParameter;
   begin
   // if IsConditionHelper return False, return empty string.
   // if IsConditionHelper return True, return expression.
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   mParamItem1 := Params.GetOrCreateParam(dtString,'StoreID',pkInputOutput);
   mParamItem2 := Params.GetOrCreateParam(dtString,'StoreCardID',pkInputOutput);
   Result := '(NEW.Quantity > OLD.Quantity) And';
   Result := Result + '(NEW.Store_ID = ' + QuotedStr(mParamItem1.AsString) + ') And ';
   Result := Result + '(NEW.StoreCard_ID = ' + QuotedStr(mParamItem2.AsString) + ')';
   end;
   function GetRequestSubject(const SiteForm: TSiteForm; const ObjId: String;		// Generovanie predmetu správy pre definíciu autom. správy Params: TNxParameters): String;
   begin
   // Define message subject which will be sent to user
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   Result := rSUBJECT;
   Result := Result + ' [ ' + StoreCardName + ' na ' +StoreName + ' ]'
   end;
   function GetRequestMessage(const SiteForm: TSiteForm; const ObjId: String;// Generovanie textu názvu pre definíciu autom. správy Params: TNxParameters): String;
   begin
   // Define message body which will be sent to user
   // ObjId param is business object ID.
   // Params param contain values stored in GetValuesFromControls() function.
   Result := rMESSAGE;
   Result := Result + #13#10 + 'Skladová karta: ' + StoreCardCode + ' - ' + StoreCardName;
   Result := Result + #13#10 + 'Sklad: ' + StoreCode + ' - ' + StoreName;
   end;
   function CreateWizardFrame(const SiteForm: TSiteForm; const Panel: TPanel): Boolean;// Vytvorenie kroku sprievodcu
   var mCombo: TComboBox;
   mListbox: TListBox;
   mLabel1, mLabel2: TLabel;
   OS: TNxCustomObjectSpace;
   BO: TNxCustomBusinessObject;
   mResult: TStringList;
   ii : Integer;
   begin
   // Create controls and place them to Panel
   // Return True if any control created.
   // Return False if no control created.
   OS:= SiteForm.BaseObjectSpace;
   BO:= TBusRollSiteForm(SiteForm).CurrentObject;
   StoreCardCode := BO.GetFieldValueAsString('Code');
   StoreCardName := BO.GetFieldValueAsString('Name');
   mLabel1 := TLabel.Create(SiteForm);
   mLabel1.Top := 40;
   mLabel1.Left := 50;
   mLabel1.Width := 300;
   mLabel1.Height := 15;
   mLabel1.Caption := 'Pre skladovú kartu: ';
   mLabel1.Caption := mLabel1.Caption + StoreCardCode + ' - ' + StoreCardName;
   mLabel1.Visible := True;
   mLabel1.Parent := Panel;
   mLabel2 := TLabel.Create(SiteForm);
   mLabel2.Top := 70;
   mLabel2.Left := 50;
   mLabel2.Width := 300;
   mLabel2.Height := 15;
   mLabel2.Caption := 'Pre sklad: ';
   mLabel2.Visible := True;
   mLabel2.Parent := Panel;
   mCombo := TComboBox.Create(SiteForm);
   mCombo.Top := 70;
   mCombo.Left := 150;
   mCombo.Width := 300;
   mCombo.Height := 15;
   mCombo.Text := 'Sklad';
   mCombo.Visible := True;
   mCombo.Enabled := True;
   mCombo.Parent := Panel;
   mCombo.Name := 'mCombo';
   mListBox := TListBox.Create(SiteForm);
   mListBox.Top := 0;
   mListBox.Left := 0;
   mListBox.Width := 300;
   mListBox.Height := 30;
   mListBox.Visible := False;
   mListBox.Enabled := True;
   mListBox.Parent := Panel;
   mListBox.Name := 'mListBox';
   mResult:= TStringList.Create;
   OS.SQLSelect('Select ID, Code || '+QuotedStr(' - ')+' || Name From Stores', mResult);
   mCombo.Clear;
   mListBox.Clear;
   For ii := 0 To mResult.Count -1 Do
   begin
   mCombo.AddItem(copy(mResult.Strings[ii],13,Length(mResult.Strings[ii])-13),nil);
   mListBox.AddItem(copy(mResult.Strings[ii],1,10),nil);
   end;
   mCombo.ItemIndex := 0;
   Result := True;
   OS.free;
   BO.Free;
   mResult.free;
   end;
   function ValidateWizardFrame(const SiteForm: TSiteForm; const Panel: TPanel): Boolean;
   begin
   // Check control's values.
   // Return True if user fill the controls properly.
   // Return False if any control has an invalid value.
   Result := True;
   end;
   procedure GetValuesFromControls(const SiteForm: TSiteForm; const Panel: TPanel;
   Params: TNxParameters);
   var mCombo1: TComboBox;
   mListbox1: TListBox;
   mParamItem1,mParamItem2: TNxParameter;
   BOStore, BOCard: TNxCustomBusinessObject;
   OS: TNxCustomObjectSpace;
   begin
   // Get control's values and store them into Params.
   BOCard := TBusRollSiteForm(SiteForm).CurrentObject;
   mListBox1 := TListBox(NxFindChildControl(Panel, 'mListBox'));
   mCombo1 := TComboBox(NxFindChildControl(Panel, 'mCombo'));
   mParamItem1 := Params.GetOrCreateParam(dtString,'StoreID',pkInputOutput);
   mParamItem1.AsString := mListBox1.Items.Strings[mCombo1.ItemIndex];
   mParamItem2 := Params.GetOrCreateParam(dtString,'StoreCardID',pkInputOutput);
   mParamItem2.AsString := BOCard.GetFieldValueAsString('ID');
   OS := SiteForm.BaseObjectSpace;
   BOStore := OS.CreateObject('SFMSB5W15BDL3CL100C4RHECN0');
   BOStore.Load(mListBox1.Items.Strings[mCombo1.ItemIndex],nil);
   StoreCode := BOStore.GetFieldValueAsString('Code');
   StoreName := BOStore.GetFieldValueAsString('Name');
   BOStore.Free;
   BOCard.FRee;
   OS.free;
   end;
   begin
   end.

4. Teraz si nadefinujeme novú definíciu automatickej správy analogicky ako v príklade 1. Tzn.:
5. Otvoríme agendu skladových kariet. Postavíme sa kurzorom na sklad. kartu, pre ktorú chceme nastaviť sledovanie príjmu.
6. Vyvoláme funkciu Autom. správy. Táto funkcia je tu dostupná, pretože sme si nadefinovali kontrolný bod "Prijatie tovaru" pre túto agendu, viď vyššie Predpoklady príkladu. Vyvolá sa Sprievodca tvorbou definície automatickej správy.
7. V 1. kroku sprievodcu v položke Kontrolný bod sa teraz ponúka náš kontrolný bod "Prijatie tovaru". V položke Typ sprievodcu ale vyberieme voľbu "Výraz":

   

   Typ sprievodcu sa tu ponúka pod názvom s popisom uvedeným v metódach GetHelperCaption a GetHelperDescription v skripte

8. V ďalšom kroku zadáme adresátov.
9. Keďže sme si v skripte naprogramovali, že tento typ sprievodcu má mať ďalší krok, tento sa ponúkne. V našom príklade tu užívateľ môže zvoliť sklad, na ktorom chce prijatie aktuálne sledovať.
10. Po stlačení Dokončiť sa uloží nová definícia autom. správy do agendy Definícia automatických správ podobná nasledujúcemu obrázku:

    

    Detail definície automatickej správy. Údaje sa predvyplnili automaticky textami zadanými tentokrát v skriptovaní v sprievodcovi (na rozdiel od príkladu 1 a príkladu 2), zo sprievodcu sa doplnilo akurát ID zvoleného skladu do konštrukcie výrazu. Ak by ste chceli definíciu zmeniť (napr. pridať ďalších adresátov), môžete to urobiť priamo v agende Definícia automatických správ.

11. Ďalej musí existovať naplánovaná úloha a musí byť sprevádzkovaný automatizačný server, ako v príklade 1.

Teraz bude platiť: Akonáhle dôjde k nejakej zmene na čiastkových skladových kartách, zaznamená sa interne požiadavka na generovanie autom. správy. V okamihu, keď automatizačný server spustí úlohu typu Automatické správy, vyhodnotí sa podmienka (tzn. či došlo k zvýšeniu počtu, či dané zvýšenie počtu bolo na skladovú kartu, ktorej ID bolo uvedené vo výraze a na sklad, ktorého ID je vo výraze). Ak je podmienka splnená, tak tí, ktorí sú uvedení medzi adresátmi vyššie vytvorenej definície autom. správy, dostanú správu s predmetom a textom podľa tejto definície.