Interní messaging - ABRA vzkazy a automatické generování zpráv

Příklad: Nechť obchodník vystavil fakturu a chce být informován, pokud dojde k jejímu zaplacení, jelikož poté bude sjednávat s klientem další kroky apod.

Na tomto příkladu si demonstrujeme použití systémového kontrolního bodu Zaplacení dokladu a vytvoření definice automatického vzkazu typu ID podle něj.

Detail kontrolního bodu Zaplacení dokladu. Tento bod nemá žádnou vazbu na skriptování (není potřeba, funkcionalita je dána v dodávaném programu) ani nemá zadané agendy, pro něž má platit (není potřeba, opět je to dáno programem a platí pro všechny, kde lze doklady platit).

Nadefinujeme si novou definici automatického vzkazu pro tento kontrolní bod. To lze nejjednodušeji takto:

1. Otevřeme agendu faktur vydaných a dohledáme sledovanou fakturu. Nechť je to např. FV-8/2009. Postavíme kurzor na ni.
2. Vyvoláme funkci Autom. vzkazy. Vyvolá se Průvodce tvorbou definice automatického vzkazu.
3. V 1. kroku průvodce v položce Kontrolní bod vybereme "Zaplacení dokladu". V položce Typ průvodce vybereme volbu "Změna zaplacení dokladu":

   

   Zadání hodnot v 1. kroku průvodce. ABRA vzhled modrý.

4. V dalším kroku zadáme adresáty.
5. Tento typ průvodce již další kroky nemá, po stisku Dokončit se uloží nová definice autom. vzkazu do agendy Definice automatických vzkazů obdobná následujícímu obrázku:

   

   Detail definice automatického vzkazu. Údaje se předvyplnily automaticky jednak texty danými výrobcem (jelikož se jedná o systémový kontrolní bod) a jednak číslem a ID dokladu, pro který jsme funkci vyvolali. Jako adresát bude uveden přihlášený uživatel. Pokud byste chtěli definici změnit (např. přidat další adresáty, můžete tak učinit přímo v agendě Definice automatických vzkazů.

6. Otevřeme agendu Naplánované úlohy a zadáme novou úlohu typu Automatické vzkazy s intervalem spouštění např. každých 5 minut:

   

   Příklad definice naplánované úlohy.

7. Zajistíme nastavení a spuštění Automatizačního serveru. Viz Co je třeba k provozu e-mailů a interních vzkazů.

Nyní bude platit: Jakmile dojde ke změně v zaplacení sledované faktury, zaznamená se interně požadavek na generování autom. vzkazu. Jakmile automatizační server spustí úlohu typu Automatické vzkazy, ti, co jsou uvedeni mezi adresáty výše vytvořené definice autom. vzkazu, dostanou vzkaz s předmětem a textem dle této definice.

Příklad: Nechť uživatel chce být informován, pokud dojde k zaplacení faktury vystavené na firmu ABC (s firmou byly problémy a uživatel chce být informován o probíhajících platbách dokladů, které na ni byly v minulosti vystaveny).

Na tomto příkladu si demonstrujeme využití systémového kontrolního bodu Zaplacení dokladu i pro výrazovou definici automatického vzkazu.

Nadefinujeme si novou definici automatického vzkazu pro tento kontrolní bod. To lze nejjednodušeji takto:

1. Otevřeme agendu faktur vydaných. (Nyní nebudeme definovat definici typu ID (jako v příkladu 1), takže je jedno, na který záznam postavíme kurzor.)
2. Vyvoláme funkci Autom. vzkazy. Vyvolá se Průvodce tvorbou definice automatického vzkazu.
3. V 1. kroku průvodce v položce Kontrolní bod vybereme "Zaplacení dokladu" stejně jako v příkladu 1. V položce Typ průvodce ale vybereme volbu "Výraz".
4. V dalším kroku zadáme adresáty.
5. Tento typ průvodce má další krok, kde zadáme požadované údaje.

    

   Zadání hodnot v 2. kroku průvodce

6. Po stisku Dokončit se uloží nová definice autom. vzkazu do agendy Definice automatických vzkazů obdobná následujícímu obrázku:

   

   Detail definice automatického vzkazu. Údaje se předvyplnily automaticky texty zadanými v průvodci. Na rozdíl od příkladu 1 se zde jedná o podmínky typu výraz. Pokud byste chtěli definici změnit (např. přidat další adresáty, můžete tak učinit přímo v agendě Definice automatických vzkazů.

7. Dále musí existovat naplánovaná úloha a být zprovozněn automatizační server, jako u příkladu 1.

Nyní bude platit: Jakmile dojde ke změně v zaplacení nějaké faktury, zaznamená se interně požadavek na generování autom. vzkazu. Jakmile automatizační server spustí úlohu typu Automatické vzkazy, pak vyhodnotí podmínku (tj. zda daná faktura byla vystavena na firmu, jejíž ID bylo uvedeno ve výrazu). Pokud je podmínka splněna, pak ti, co jsou uvedeni mezi adresáty výše vytvořené definice autom. vzkazu, dostanou vzkaz s předmětem a textem dle této definice.

Příklad: Uživatel chce být upozorněn, pokud dojde k přijetí vybraného zboží.

Zde je třeba nejdříve zadat uživatelský kontrolní bod a pomocí skriptování zajistit umístění (zaháčkování) kontrolního bodu do sledované agendy. Přijetí zboží mění stavy na business objektu Dílčí skladová karta. Na příkladu budeme demonstrovat, že lze nastavit kontrolní bod i do jiné agendy (Skladové karty), než ze které je sledovaný objekt (Dílčí skladové karty). Dále zde budeme demonstrovat, jak si pomocí skriptování knihovny naprogramovat nový typ průvodce pro tento kontrolní bod a jeho chování (v našem příkladě bude sloužit pro výběr skladu).

Předpoklady příkladu:

• Musí existovat kontrolní bod, např. s názvem "Přijetí zboží". Musí mít interní název (např. WD5B2FMTMIB41CGVTMY4Z0HYXW) shodný s interním názvem uvedeným v balíčku skriptů téhož jména, jako je zadáno v konfiguraci skriptování (např. GoodsReceive) v definici kontrolního bodu a tento balíček musí obsahovat knihovnu téhož jména, jako je jméno knihovny v konfiguraci skirptování (např. rovněž GoodsReceive). Kontrolní bod je definován k agendě Skladové karty, tj. v seznamu agend je uvedena agenda Skladové karty.
• Existuje balíček skriptů s názvem GoodsReceive a knihovnou GoodsReceive. Dále obsahuje skript pro Business objekt Dílčí skladová karta pro "zaháčkování" kontrolního bodu. Balíček musí být zkompilován a mít nastaveno Používat. (Balíček skriptů bude vytvořen ke kontrolnímu bodu "Přijetí zboží" funkcí Vygenerovat knihovnu. Předvyplněná šablona skriptu bude následně doplněna).

Postup:

1. Otevřeme agendu Kontrolní body a zadáme nový kontrolní bod s názvem "Přijetí zboží". Interní název nechť je např. WD5B2FMTMIB41CGVTMY4Z0HYXW. V konfiguraci skriptování zadáme název balíčku skriptů např. GoodsReceive a název knihovny GoodsReceive. V seznamu jeho agend vybereme agendu Skladové karty a uložíme.

   

   Detail definice kontrolního bodu.

2. Vytvoříme odpovídající balíček skriptů. To lze nejjednodušeji pomocí funkce Generovat knihovnu. Vygenerovaná šablona obsahuje předvyplněné metody uvedené výše, viz Metody skriptu Knihovna. Většina je prázdných, pouze GetHelperCaption, GetHelperDescriotion a GetWDPInternalName jsou předvyplněny podle údajů kontrolního bodu. Může vypadat např. takto:

   Tento příklad odpovídá pouze verzi 9.02 a ve vyšších verzích se může lišit. Zde slouží pouze pro ilustrativní účely.

   function GetHelperCaption(const SiteForm: TSiteForm): String;
   begin
   // Helper name in wizard form
   Result := 'Přijetí zboží';
   end;
   function GetHelperDescription(const SiteForm: TSiteForm): String;
   begin
   // Helper description in wizard form
   Result := 'Sledování přijetí zboží';
   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. Otevřeme agendu Balíčky skriptů a doplníme knihovnu GoodsReceive. Balíček zkompilujeme a nastavíme mu Používat. V tomto příkladu např. byly upraveny popisy v metodách GetHelperCaption a GetHelperDescription, dále byl zadán druhý krok průvodce, kde uživatel může zvolit sklad, na němž chce přijetí sledovat, a dále byly doplněny texty, které se použijí pro předvyplnění názvu definice, předmětu a textu zprávy.

   Úpravy provedené zde se zpětně neprojeví do definice kontrolního bodu. V každém případě musí odpovídat interní název kontrolního bodu tomu, který je uveden ve skriptu v metodě GetWDPInternalName.

   Tento příklad odpovídá pouze verzi 9.02 a ve vyšších verzích se může lišit. Zde slouží pouze pro ilustrativní účely.

   var
   StoreCardCode, StoreCardName, StoreCode, StoreName : String;
   const
   rSUBJECT = 'Naskladnění zboží'; // RequestSubject
   rMESSAGE = 'Skladové zásoby byly rozšířeny.' + #13#10 + '%DISPLAYNAME%'; // RequestMessage
   function GetHelperCaption(const SiteForm: TSiteForm): String;
   begin
   // Helper name in wizard form
   Result := 'Přijetí zboží - průvodce';							// Název nabízený jako Typ průvodce
   end;
   function GetHelperDescription(const SiteForm: TSiteForm): String;
   begin
   // Helper description in wizard form
   Result := 'Pošle vzkaz, když dojde k naskladnění zboží';				// Popis daného Typu průvodce
   end;
   function GetWDPInternalName(const SiteForm: TSiteForm): String;
   begin
   // Should return WatchDogPoint InternalName (packed GUID) 
   // or Null packed GUID) 
   Result := 'WD5B2FMTMIB41CGVTMY4Z0HYXW';							// Interní název svázané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;										// Nastavení, že se jedná o definici typu Výraz
   end;
   function GetRequestDescription(const SiteForm: TSiteForm; const ObjId: String;		// Generování názvu pro definici autom. vzkazu
   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 := 'Definice uživatele:' + 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;		// Generování předmětu zprávy pro definici autom. vzkazu
   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;		// Generování textu názvu pro definici autom. vzkazu
   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;		// Vytvoření kroku průvodce
   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 := 'Pro skladovou 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 := 'Pro 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. Nyní si nadefinujeme novou definici automatického vzkazu obdobně jako v příkladu 1. Tj.:
5. Otevřeme agendu skladových karet. Postavíme se kurzorem na sklad. kartu, pro kterou chceme nastavit sledování příjmu.
6. Vyvoláme funkci Autom. vzkazy. Tato funkce je zde dostupná, jelikož jsme si nadefinovali kontrolní bod "Přijetí zboží" pro tuto agendu, viz výše Předpoklady příkladu. Vyvolá se Průvodce tvorbou definice automatického vzkazu.
7. V 1. kroku průvodce v položce Kontrolní bod se nyní nabízí náš kontrolní bod "Přijetí zboží". V položce Typ průvodce ale vybereme volbu "Výraz":

   

   Typ průvodce se zde nabízí pod názvem s popisem uvedeným v metodách GetHelperCaption a GetHelperDescription ve skriptu

8. V dalším kroku zadáme adresáty.
9. Jelikož jsme si ve skriptu naprogramovali, že tento typ průvodce má mít další krok, tento se nabídne. V našem příkladu zde uživatel může zvolit sklad, na němž chce přijetí aktuálně sledovat.
10. Po stisku Dokončit se uloží nová definice autom. vzkazu do agendy Definice automatických vzkazů obdobná následujícímu obrázku:

    

    Detail definice automatického vzkazu. Údaje se předvyplnily automaticky texty zadanými tentokrát ve skriptování v průvodci (na rozdíl od příkladu 1 a příkladu 2), z průvodce se doplnilo akorát ID zvoleného skladu do konstrukce výrazu. Pokud byste chtěli definici změnit (např. přidat další adresáty), můžete tak učinit přímo v agendě Definice automatických vzkazů.

11. Dále musí existovat naplánovaná úloha a být zprovozněn automatizační server, jako u příkladu 1.

Nyní bude platit: Jakmile dojde k nějaké změně na dílčích skladových kartách, zaznamená se interně požadavek na generování autom. vzkazu. Jakmile automatizační server spustí úlohu typu Automatické vzkazy, pak vyhodnotí podmínku (tj. zda došlo ke zvýšení počtu, zda dané zvýšení počtu bylo na skladovou kartu, jejíž ID bylo uvedeno ve výrazu a na sklad, jehož ID je ve výrazu). Pokud je podmínka splněna, pak ti, co jsou uvedeni mezi adresáty výše vytvořené definice autom. vzkazu, dostanou vzkaz s předmětem a textem dle této definice.