Příklady využití skriptování

Jak bylo řečeno výše, skriptování značně rozšiřuje možnosti systému. Součástí instalace je řada dodávaných příkladů již hotových skriptů, z nichž si lze udělat představu o možnostech a využití skriptování a čerpat inspiraci pro tvorbu vlastních skriptů. Viz podadresář Examples v adresáři s vaší instalací systému ABRA Flores.

Příklady zde jsou:

• ve formě *.xml souborů samotných balíčků skriptů, které si můžete přímo načíst do agendy Balíčky skriptů pomocí funkce Import z XML. Zde si je můžete prohlédnout. Pokud si je chcete vyzkoušet, je třeba je zkompilovat pomocí funkce Zkompilovat a případně si dle pokynů v popisu skriptů i založit požadované definovatelné položky a naimportovat si požadované definovatelné formuláře.
• ve formě *.ais souborů instalačních sad, které si můžete načíst do agendy Instalační sady pomocí funkce Importovat sadu. V tomto případě se balíčky skriptů obsažené v dané sadě přidají do agendy Balíčky skriptů automaticky v rámci importu sady. Zde si je můžete prohlédnout, příp. si je po zkompilování vyzkoušet shodně, jak bylo psáno v předchozím bodě.

O možnostech rozšíření a úprav systému pomocí skriptování si můžete udělat představu i na základě popisu uvedeného zde. Většinou se jedná o stručný slovní popis některého z dodávaných příkladů. V takovém případě si pak konkrétní skript, který danou úlohu řeší, můžete prohlédnout v agendě Balíčky skriptů po importu daného příkladu.

Příklad úpravy vzhledu agendy. V tomto případě byla upravena barva fontu v položce Název číselníku středisek.

Příklad úpravy vzhledu agendy. Doplnění vlastních funkčních tlačítek přímo na formulář záložky Detail.

Úprava předyplňovaných podmínek v průvodci výběrem dokladu - Využívá se háčku SetSelectionWizardParams_Hook, který lze volat v dokladových agendách, z kterých se volá Průvodce výběrem dokladu. Umožňuje rozšířit seznam podmínek v sekci Předvyplnit podmínky.

Příklad úpravy nabízených podmínek v sekci Předvyplnit podmínky v průvodci vyvolaném z agendy Objednávek přijatých v rámci funkce Nová podle nabídky vydané.

Příklad syntaxe skriptu

Skript, který zajistí přidání vlastních omezujících podmínek, které se mají předvyplňovat, dle obrázku výše:

Druh skriptu: Agenda, Agenda: Objednávky přijaté

{
Vyvolává se před spuštěním výběrového průvodce(SelectionWizard)
}
procedure SetSelectionWizardParams_Hook(Self: TDynSiteForm; ADocumentTypes: String; AIsImport: Boolean; AParams: TNxParameters);
var
mSingleCond, mValues: TNxParameters;
begin
if not AIsImport then
begin
// Nastavení podmínky DocQueue_ID (Řada dokladu)
mSingleCond := AParams.GetOrCreateParam(dtList, 'DocQueue_ID').AsList;
mSingleCond.GetOrCreateParam(dtInteger, 'USEDKIND').AsInteger := ckSingle;
mSingleCond.NewFromDataType(dtString, 'Caption').AsString := 'Řada dokladu (NV - Nabídky vydané)';
mValues := mSingleCond.NewFromDataType(dtList, 'Values').AsList;
mValues.NewFromDataType(dtString, '{:VALUE}').AsString := '''1800000101''';
// Nastavení podmínky UserDynSQLCondition (Výraz)
mSingleCond := AParams.GetOrCreateParam(dtList, 'UserDynSQLCondition').AsList;
mSingleCond.GetOrCreateParam(dtInteger, 'USEDKIND').AsInteger := ckSingle;
mSingleCond.NewFromDataType(dtString, 'Caption').AsString := 'Popisek obsahuje "4"';
mValues := mSingleCond.NewFromDataType(dtList, 'VALUEBAG').AsList;
mValues.NewFromDataType(dtString, 'DYNUSERSQL').AsString := 'Description like ''%4%''';
end;
end;
begin
end.

procedure AfterInitializeWizard_Hook(Self: TNxDocumentImportManager; AForm: TForm);
begin
	TCheckBox(AForm.FindComponent('chkDoNotCloseFormAfterImport')).Checked := True;
end;

begin
end.

Příkladů využití skriptování v praxi však může být daleko více. Pomocí skriptování lze řešit dále např.:

• automatické nabízení provozoven k výběru po zadání firmy do hlavičky dokladu (viz též Tip pro vás v popisu parametru Předvyplňovat firemní provozovny)
• automatické nabízení osob patřících k firmě k výběru po zadání firmy do hlavičky dokladu
• vyvolání tisku, exportu či B2B exportu přímo ze skriptování (viz procedury NxPrintByIDs, NxExportByIDs, NXB2BExportByIDs)
• tisk více tiskových sestav najednou (viz též Často kladené otázky - Tisk více tiskových sestav najednou)

• možnost vyexportovat Business object do XML a následně ho za naimportovat (procedure NxFillBOFromXML, procedure NxFillXMLNodeWithBO, ...).Tato možnost je vhodná např. pro přenos dat z uživatelsky definovatelného číselníku do jiné instalace systému apod.

  V jedné instalaci je připraven definovatelný číselník a naplněn nějakými výchozími daty. Číselník je přenesen pomocí instalační sady k uživateli do jiné instalace, výchozí data pak pomocí skriptování.

• možnost volat funkce na práci s externími DLL (viz LoadLibrary (nahraje DLL do paměti a vrátí ukazatel na ni), FreeLibrary (uvolní DLL z paměti), GetProcAddress, ...)
• apod.

V tiskových sestavách, definovatelných exportech, B2B exportech, ale obecně všude, kde lze využívat QR funkce (např. v panelech definovatelných údajů apod.), je k dispozici možnost spouštět přímo z reportů skripty a to pomocí funkce QR funkce NxScript. To výrazně rozšiřuje možnosti definic tiskových sestav, jelikož kromě QR funkcí dodávaných výrobcem lze volat i libovolnou jinou funkci, kterou si uživatel nadefinuje ve skriptování.

Skriptovací funkce musí být deklarována ve správné syntaxi v nějakém balíčku skriptů, ve skriptu druhu Knihovna. Jednotlivé procedury nebo metody musí mít jako první parametr AReportHelper:TNxQRScriptHelper. Jinak samozřejmě lze volat i funkci, která přímo vrátí výsledek, viz dále Příklad deklarace funkce.

Volání:

• Při volání se první parametr neuvádí, je doplněn automaticky, viz dále Příklady volání.

• Název volané skriptovací funkce:

  • Volání z tiskových sestav:

    • se buď musí uvést jako plně kvalifivané, tj. včetně identifikace balíčku skriptů a knihovny, která obsahuje požadovanou funkci v syntaxi JmenoBalicku.JmenoKnihovny.JmenoFunkce
    • nebo se může uvést zkráceně (jen jméno skriptovací funkce, bez jména balíčku a knihovny). V tom případě ale musí být v definici dané tiskové sestavy vyplněna položka Výchozí balíček pro skriptování.
  • Při volání z jiných míst programu, kde není k dispozici možnost specifikovat výchozí balíček pro skriptování, je třeba zadat plně kvalifikované jméno skriptovací funkce.

function MojeFunkce(AReportHelper:TNxQRScriptHelper;Value: Boolean): string;
					
begin
	if Value then Result := 'OK' else Result := 'Chyba';
end;

function SectiCisla(AReportHelper:TNxQRScriptHelper;ACislo1:Integer;ACislo2:Integer):Integer;
					
begin
	Result := ACislo1 + ACislo2
end;

function Test(AReportHelper:TNxQRScriptHelper;TEXT:String):Boolean;

begin
	ShowMessage(TEXT);
	Result := False;
end;

V uživatelsky definovatelných formulářích je rovněž k dispozici možnost přímo z formuláře volat skripty a to s využitím Pluginů neboli Doplňků a definice tlačítka, které daný skript vyvolá. Více viz Tlačítka s akcemi (ButtonsPlugin) - typ Run Script.

Skriptování je také nezbytné pro některé jiné části systému. Např.:

• pro možnost definice funkcí pro zajištění v SCM
• pro zpřístupnění systému ABRA Flores pro webové služby (definice operací)
• pro možnost definice uživatelských kontrolních bodů v Komunikaci
• pro možnost definice naplánované úlohy typu Skript
• pro možnost definice pravidla zpracování doručené e-mailové pošty s akcí typu Spustit skript v Komunikaci
• pro možnost definice pravidla zpracování front souborů s akcí typu Spustit skript v Dokumentech
• pro možnost přizpůsobení chování Průvodce přeceněním resp. Průvodce kontrolou prodejních cen
• pro možnost upravit výpočet mezd pomocí skriptů výpočtového schématu
• pro možnost definice typu kampaně s akcí typu Spustit skript v CRM
• pro definici Skriptovacích ovladačů (driverů) pro provádění B2B importů, pokud chce uživatel tyto importy provádět svým vlastním driverem namísto B2B driverů dodávaných výrobcem
• apod.

Ve skriptování jsou mj. k dispozici funkce, které umožňují vyvolat standardní dialog na vytváření QR výrazů a "evaluator" na objektu, na kterém se aktuálně pracuje.

Pro editaci slouží funkce:

• NxEditObjectExpr - Zobrazí dialog pro editaci výrazu nad business objektem.
• NxEditParametersExpr - Zobrazí dialog pro editaci výrazu nad parametry.

Pro vyhodnocování slouží funkce:

• NxEvalObjectExprAsString - Vyhodnotí výraz nad business objektem a vrátí výsledek jako řetězec.
• NxEvalObjectExprAsInteger - Vyhodnotí výraz nad business objektem a vrátí výsledek jako celé číslo.
• NxEvalObjectExprAsFloat - Vyhodnotí výraz nad business objektem a vrátí výsledek jako reálné číslo.
• NxEvalObjectExprAsBoolean - Vyhodnotí výraz nad business objektem a vrátí výsledek jako logickou hodnotu.
• NxEvalObjectExprAsDateTime - Vyhodnotí výraz nad business objektem a vrátí výsledek jako datum a čas.
• NxEvalParametersExprAsString - Vyhodnotí výraz nad parametry a vrátí výsledek jako řetězec.
• NxEvalParametersExprAsInteger - Vyhodnotí výraz nad parametry a vrátí výsledek jako celé číslo.
• NxEvalParametersExprAsFloat - Vyhodnotí výraz nad parametry a vrátí výsledek jako reálné číslo.
• NxEvalParametersExprAsBoolean - Vyhodnotí výraz nad parametry a vrátí výsledek jako logickou hodnotu.
• NxEvalParametersExprAsDateTime - Vyhodnotí výraz nad parametry a vrátí výsledek jako datum a čas.

Funkce se slovem "Object" v názvu pracují s výrazem v kontextu předaného business objektu, funkce se slovem "Parameters" pracují v kontextu předaného objektu TNxParameters. Objekt TNxParameters může být libovolně strukturovaný, vnořené parametry se ve výrazu oddělují tečkou. Parametrový evaluátor je vytvořen speciálně k použití ve skriptování.

Ve skriptování je možné mj. volat tzv. SiteCommands (např. prostřednictvím funkce NxShowSite). Více k nejtypičtějším "SiteCommandům", které jsou v systému k dispozici, je uvedeno v rámci popisu Doplňků (pluginů) uživatelsky definovatelných formulářů, viz Tlačítka s akcemi (ButtonsPlugin) - ABRASiteCommands. Obdobným způsobem lze tam popsané SiteCommandy využít i zde ve skriptování.

procedure _AfterSave_PostHook(Self: TDynSiteForm);

begin
	ShowMessage('Bude vytvořena FV');
	NxShowSite('PLC2EX0BUJD13ACP03KIU0CLP4', Self.SiteContext, nil, nil, 0, False, 'DoNewOnlyWithoutPrompt;ImportDocuments;' + Self.ActiveDataset.BusinessObjectCLSID + ';' + Self.CurrentObject.OID + ';SelectedHeader=' + Self.CurrentObject.OID + ';DocQueue_ID=5600000101');
end;