Rule Engine Express
Contents
1. DLL s with your application in unmodified form When redistributing your application you need to distribute your license key in your application configuration file also INSTALLATION PROCEDURE In order to use REX ensure that you have downloaded the latest copy from the Talon Computing website http taloncomputing com Also ensure that you have purchased the correct license as well Talon Computing uses PayPal as our secure payment processor Download You can download the latest version of REX by visiting http taloncomputing com downloads rex zip Purchase License Once you have downloaded REX we recommend that you purchase a license key for the development time period that you reguire You won t be able to execute the application or use REX without a valid license If you are only trying out REX and would like a demo license complete the next two steps and then follow the procedure for ordering a demo license RULE ENGINE EXPRESS Unzip and install Once you have downloaded REX unpack it into a temporary folder and proceed with the installation application We recommend using all the default settings for the installation process Order License Key Once you have completed the installation procedure you need to reguest a license key If you have purchased a license you still need to complete the process by reguesting a key to match your purchase When your license has expired and you need to reguest a new lic2. group click on New Condition Step 2 Complete the condition properties Step 3 Click Save Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing RuleEngine TalonCo bele a Knowledge Base Knowledge Base test rule set E mak Gale BER B B New Load Save Save Edit Create Remove Edit New Remove Edit Rule Verify As Rules Rule Rule Conditions Ee tone Rule Conditions Management Now editing test rule set gt Product Selector gt Product Selector Conditions Properties Variable age Conditional Operator isBetweenExclusive 7 Value 18 Cancel Save About conditional operators Operator IsBetweenExclusive Description Determines if a numeric value is between two numeric values exclusively The values must be separated by a comma Definition x gt yandx lt z 12 RULE ENGINE EXPRESS Example Operator Description Definition Example Operator Description Definition Example Variable age Conditional Operator IsBetweenExclusive Value 18 34 IsBetweenMaxExclusive Determines if a numeric value is between two numeric values The lower bound value is inclusive and the upper bound value is exclusive The values must be separated by a comma x gt yandx lt z Variable age Conditional Operator IsBetweenMaxExclusive Value 18 34 IsBetweenMinExclusive Determines if a numeric value is bet
3. processor Inputs new Rulelnputs insurance Inputs Add age new ObjectType 25 typeof int RuleOutputs Overview Usage This class is specialized Dictionary that allows you to view the outcome of a particular processing of rule inputs The key ofthe conclusions identifies the rule that was triggered The value is comprised of a Tuple identifying Item1 as the conclusion property Item2 as the conclusion property value foreach var conclusions in insurance Outputs foreach var conclusion in conclusions Console WriteLine 1 conclusion Key conclusion Value 25 RULE ENGINE EXPRESS Sample Program This sample application demonstrates how to use the library with relative ease using System using TalonComputing RuleEngine Core using TalonComputing RuleEngine Core Loaders using TalonComputing RuleEngine Interfaces Models using TalonComputing RuleEngine Models namespace LoanApproval internal class Program private static void Main string args specify where our knowledge base file is the rule processor will automatically load the knowledge file when it needs it using this loader var loader new FileLoader App_Data insurance knowledge create a rule processor var insurance new RuleBaseProcessor loader add inputs insurance Inputs new RuleInputs insurance Inputs Add age new ObjectType 25 typeof int insuran
4. ry Organize v New folder azz e SX Favorites Documents library ee App Data 199 Libraries Name Date modifie d Computer 4 KNOWLEDGE File 6 demonstration knowledge 29 05 2014 24 Ki Network L_ einsurance knowledge 12 05 2014 24 L_ insurance knowledge 12 24 L_ insurance2 knowledge 06 05 L_ test knowledge 06 05 2014 0 L_ test2 knowledge 09 03 H Tm Filename demonstration knowledge Save as type Knowledge Base Files knowledge knowledge Hide Folders 10 RULE ENGINE EXPRESS Creating a new rule set Step 1 Under the Manage Rule Sets menu group click on Create Step 2 Enter the name and description of the rule set in the Properties section Step 3 Click Save fe Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing RuleEngine TalonComputing Con Se Knowledge Base test rule set Knowledge Base New Load Save Save Edit La Verify Rule Set Management Now editing test rule set Rule Sets ss Product Selector Properties Name Product Selector Description Aids with product selection Cancel Save L Editing a rule set Step 1 In the Rule Set Management view click on an existing rule set Step 2 Make changes to the Rule Set Properties Step 3 Click Save 11 RULE ENGINE EXPRESS Creating Conditions Step 1 In the Rule Conditions menu
5. values must be separated by a comma x E Din Yn Variable age Conditional Operator Isin Value 18 20 22 24 26 15 RULE ENGINE EXPRESS Operator Description Definition Example Operator Description Definition Example Operator Description Definition Example IsLessThan Determines if a numeric variable is less than a specific value x lt y Variable age Conditional Operator IsLessThan Value 18 IsLessThanOrEqualTo Determines if a numeric variable is less than or equal to a specific value X Sy Variable age Conditional Operator IsBetweenLessThanOrEqualTo Value 18 IsNotEqualTo Determines if a variable is not equal to a particular value x y Variable age Conditional Operator IsNotEqualTo Value 55 16 RULE ENGINE EXPRESS Operator IsNot Description Evaluates to the opposite of a particular Boolean variable Definition x Example Variable smokes Conditional Operator IsNot Value Operator IsTrue Description Determines if a variable is true Definition x true Example Variable smokes Conditional Operator IsTrue Value Creating actions Step 1 Under the Rule Actions menu group click on New Action Step 2 Select the Action Type from the drop down list Step 3 Specify the name of the property or variable you want to modify or create conclusion for Step 4 Specify the value that the property should have when the action is executed Step 5 Cli
6. variables used in your knowledge base This will be necessary for the test harness In the Variables list a list of your variables are displayed Step 2 Click on a variable Step 3 Select the Variable Type from the drop down list in the property section Step 4 Click Save Step 5 Repeat Step 2 4 for all remaining variables A r G Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing RuleEngine TalonComputing Con h EEE Knowledge Base Knowledge Base et wen E mak Gee BEE 8 8 8 d vs New Load Save re Edit Create Remove Edit New Remove Remove Edit New Remove Verify Rules Rule Rule SE Condition Condition Actions Action Action Variable Type Management Variables Properties product smokes Select the variable type string Cancel Save 19 RULE ENGINE EXPRESS Step 6 Configure the test harness inputs by clicking on Configure Inputs on the Verify menu section r RI a Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing RuleEngine TalonComputing Con Lo e Knowledge Base Knowledge Base testi Knowledge Base New Load Save Save Edit La Remove Edit New Remove Edit Remove EE New Remove Verify As Rules Rule Rule Conditions El Condition Actions Action Action S Test Harness Input Management Inputs Load Cc LS d Step 7 Click on
7. Load to load the inputs from a Comma Separated Value CSV file CSV Format The first row is the header and represents the variable names These names should be the same as the names identified in the Variable Configuration 20 RULE ENGINE EXPRESS Example age smokes activities product 34 TRUE none 29 FALSE bronze 31 FALSE silver 31 FALSE gym gold 25 FALSE gym platinum E a Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing Ru Le Steng Knowledge Base Knowledge Base testi Knowledge Base Emme Gala BB B New Load Save Sa Edit Create Remove rd Gi 3 Rule Rule Verify e m S Conditions Actions M Test Harness Input Management Step 8 Run the tests by clicking on Run Tests on the Verify menu group This will display the test harness view with a view of the test results 21 RULE ENGINE EXPRESS Step 9 When you are ready to start executing the tests click on Run Tests Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing Ru Leni Es Knowledge Base Knowledge Base testi suc ns E Load Save sme Edit La Remove Lieft New Remove Rule Rule Verify Rule Rule Conditions Actions Test Harness Test Runner Test Results Sending inputs in row 0 No rules were satisfied with the given inputs Sending inputs in row 1 No rules were satisfie
8. NE EXPRESS Creating a new knowledge base Step 1 Click on New from the menu Step 2 Enter your project name and a description Step 3 Click on Save Talon Computing Rule Engine Express Noname Knowledge Base Noname Knowledge Base Ba 8 alata New Load Save Manage Rule Rule Verify Rules Conditions Actions Project Name Noname Description Cancel RULE ENGINE EXPRESS Loading an existing knowledge base Step 1 Click on Load from the Management menu section Step 2 Select the knowledge file and then click Open Open GO Di Projects TalonComputing RuleEngine gt TalonComputing ConsoleApp RuleEngine App Data aard Search App Data ol Organize New folder SS DN SC Favorites Documents library Arrange by Folder App Data R 7 Libraries Name Date E Computer 4 KNOWLEDGE File 5 einsurance knowledge 12 0 Gi Network L_ insurance knowledge 2 L_ insurance2 knowledge testknowledge J test2 knowledge 09 0 DH Knowledge Base Files knowlec File name RULE ENGINE EXPRESS Saving your knowledge base Step 1 Once you have created your knowledge base or made changes to it click on the Save or Save As button Step 2 Specify the filename for the knowledge base T Save As a OE Qu Projects TalonComputing RuleEngine gt TalonComputing ConsoleApp RuleEngine App Data M Search App_Data
9. Version TALON COMPUTING Rule Engine Express User Manual Talon Computing RULE ENGINE EXPRESS USER MANUAL Talon Computing Table of Contents GEMENG SE GR DE GE N AD EE A DE EG AD Ee 1 Why you should use REX se es EE ne dure Gee 1 Requirements Re EE eat 1 STAGING EE N OE ate OE cede inured aca det 2 WAG ea ae Crates EE EE Cat ah eta aa 2 e E elle 2 Installation dree TI 2 Downloads EE ne nn ed ee ery Ee an ne 2 Pireliase LICENSE EE a Nm ED Re Monet ete 2 Unzip ANG Stal lies Es Ee RE n ER ER de ee 3 Order License KOV 15 tuv t bdkuheke kuulad ie pekubdknati EEN make kem pkad 3 Installing Your LICENSE ER cena a re 4 ele Med 5 Licensing Authority EIERE ss 2025 sesse EE Ge eebe YE EE 6 Rule EE 7 Knowledge Base rule sets and rules su11111s11101110111es1rsstrenernersoersser serena 7 RUIS Engine TEE 23 Tojigelo ide ie EE EE EE AE TE EE 23 LINKING Re 23 Application or web configuration ee ee ee ee RR AA ee ee Re ee 23 KASS OS LR Un ass pad RE RE ee RE ee 24 Sample PROMI ss ses Eed 26 RULE ENGINE EXPRESS INTRODUCTION Welcome to the Talon Computing Rule Engine Express REX user manual This manual will introduce step by step to the engine from installation to how to use it effectively Why you should use REX REX is a lightweight software utility that will help you to decouple your business rules from your application By making use of an independent tool you are able to focus your softwa
10. ce Inputs Add smokes new ObjectType false typeof bool insurance Inputs Add activities new ObjectType gym typeof string run the processor insurance Process process the outputs handle the conclusions Console WriteLine Conclusions foreach RuleOutputs conclusions in insurance Outputs foreach var conclusion in conclusions d Console WriteLine 1 conclusion Key conclusion Value 26 RULE ENGINE EXPRESS Console WriteLine Done Console ReadKey 27
11. ck on Save 17 RULE ENGINE EXPRESS ACTION TYPE DESCRIPTION MODIFY CONCLUSION A modify action allows you to change the value of a variable if a set of conditions are met A conclusion action allows you to make a decision when a particular set of conditions are met Satisfied conclusions are collected when all rules have been executed If no conclusion is returned by the engine then no conditions were satisfied based on the inputs that were provided E pl Q Talon Computing Rule Engine Express C Users Cybear Documents Visual Studio 2013 Projects TalonComputing RuleEngine TalonCom EOSTA Knowledge Base Knowledge Base test rule set EERE Gil BEE B 8 New Load Save Sme Edit Create Remove Edit New Remove Edit Remove Rules Rule Rule Conditions Ed Condition aie EI Rule Action Management Now editing test rule set gt Product Selector gt Age Limit Actions Properties Action Type Modify beg iv Property Value Cancel Save 18 RULE ENGINE EXPRESS Rule set verification Once you have completed the creation of your rule set and rule specifications you may want to verify that you don t have conflicting rules or that your rules cover all scenarios REX provides you with a facility to test your rules against specific input values Step 1 On the Verify menu section click on Configure Variables Configuring the variables lets you assign types to
12. d with the given inputs Sending inputs in row 2 No rules were satisfied with the given inputs Sending inputs in row 3 No rules were satisfied with the given inputs Sending inputs in row 4 Rule 0 rule 1 product platinum Run Tests When the tests have run the results will be displayed in the Test Results area 22 RULE ENGINE EXPRESS RULE ENGINE API Introduction The rule engine has a very simple and easy to use programming interface We will be describing only the classes you reguire to successfully integrate the rule engine into your application We will also illustrate how to use the application programming interface by means of a coded example Linking References The following references should be added to your project when starting to use the rule engine API These references should be located in if you used the default installation location C Program FilesVTalon Computing Talon Computing Rule Engine Express Core Dynamic Link Library TalonComputing Licensing Core dll TalonComputing Licensing CoreModels dll TalonComputing Licensing Hardware dll TalonComputing Licensing Interfaces dll TalonComputing Licensing Utilities dll TalonComputing RuleEngine Core dll TalonComputing RuleEngine Interfaces dll TalonComputing RuleEngine Models dll Application or web configuration Next configure your application with the client distributable key tha
13. ense use the following application to reguest a new license When ordering the license key you need to make use of the application titled TalonComputing DesktopApp LicensingClient exe Talon Computing License Authority Client Es e A A A A IS en comers Talon Computing License Authority Client Important Notice Please complete the following details to reguest a license We will use this information to generate your license and email it to you Please ensure you complete this form only once you have made the necessary payment you will reguire the receipt number after you made the purchase If you have not purchased the license yet please do so by clicking Pay Now I hereby request a license for the period 28 05 2014 to 28 05 2015 For the product None Development Time Period Purchased None H My receipt number after payment is Please license the product to your name Please send my license to email address Step 1 Select the product in this case REX Step 2 Select the development time period purchased If you are trying the product out select the Demo 1 month development option 3 RULE ENGINE EXPRESS Step 3 Next provide the receipt number of your purchase If you are reguesting a demo account specify 0 as the receipt number If you have not purchased a license vet click on the Pay Now button By clicking the Pay Now button your default browser will be
14. he license yet please do so by clicking Pay Now I hereby request a license for the period 28 05 2014 to 28 05 2015 For the product None Development Time Period Purchased None My receipt number after payment is Pay Now Please license the product to your name Please send my license to email address As mentioned in the Order License Key section the License Authority Client is used to reguest a license from Talon Computing Once we receive the reguest made by the application we verify your reguest with your purchase unless you are reguesting a demonstration license You will only be entitled to one demonstration license RULE ENGINE EXPRESS Rule Builder Known as Launch TalonComputing DesktopApp RuleEngine exe Menu Location Talon Computing Talon Computing Rule Engine Express BI Talon Computing Rule Engine Express Noname Eaz Knowledge Base ER BB BEBE BOB LYK ABA N The rule builder application is responsible for creating and maintaining your knowledge bases KNOWLEDGE BASE RULE SETS AND RULES A knowledge base consists of a collection of rule sets A rule set is a collection of rules When applying certain rules in your application you will base it off a particular knowledge base rule set combination i e your application uses the rule engine to apply rules from a specific rule set from a specific knowledge base RULE ENGI
15. ings section in your app config or web config file This is your redistributable client license 3 rex fyour full name expiry date reg This file contains your personal development license This file should be executed to install the necessary settings in your Windows Registry and therefore will reguire administrator privileges APPLICATIONS The installation of REX results in two applications being installed and accessible from the start menu under Talon Computing Talon Computing Rule Engine Express The applications are the Talon Computing Licensing Client and the Talon Computing Rule Builder In addition to these applications the Rule Engine Core files are installed to the location if you used the default installation paths C Program FilesVTalon Computing Talon Computing Rule Engine Express Core RULE ENGINE EXPRESS Licensing Authority Client Known as Launch TalonComputing DesktopApp LicensingClient exe Menu Location Talon Computing Talon Computing Rule Engine Express Talon Computing License Authority Client Es gt A A krai comers Talon Computing License Authority Client Important Notice Please complete the following details to reguest a license We will use this information to generate your license and email it to you Please ensure you complete this form only once you have made the necessary payment you will reguire the receipt number after you made the purchase If you have not purchased t
16. opened and you will be directed to the product page on the Talon Computing website On the website you need to then select and purchase the appropriate development time period that you reguire Step 4 Next supply your full name as this is your personal license for your machine Step 5 Finally specify your email address This is necessary for us to email your license keys to Once you have completed all the fields click on the Send Reguest button You will receive a confirmation message indicating that your reguest has been successfully submitted to our servers thus you will reguire internet access in order to complete the procedure Installing Your License After receiving your license reguest we will verify that what you purchased matches that which you are reguesting If there are no discrepancies we will send you your license bundle In the bundle you will receive three files 1 rex your full name expiry date license This file contains textual description of your license keys and indicates when your license expires This file is for your information only 2 app rex your full name expiry date config This file contains the application configuration setting you need to include in your app config or web config file This should be incorporated as is i e The key lt add key TalonComputing License REX value D5E26CAF2C5E2B05D57ED7C755B1BBC3 gt RULE ENGINE EXPRESS Should be incorporated into your appSett
17. re on providing the engine with a set of inputs and then writing code to handle very specific outcomes The advantage of this is decoupling Your software focuses less on how decisions are made for certain business rules and rather concentrates on handling the desired outcome or decision This frees the developer from hard coding business rules into the code This increases maintainability and productivity in the long run If new logic needs to be added or changed it can be done without necessarily having to make any code changes thereby reducing defects from being introduced into the application Reguirements Currently the only system reguirements that REX needs is Microsoft NET 4 5 When you start using REX in your application you need to simply incorporate the core Dynamic Link Libraries DLL s into your application This will be detailed in later sections RULE ENGINE EXPRESS LICENSING Model Talon Computing licenses REX on an as reduired basis meaning that while you are busy with the development of your application you may need to build and edit your rules If your business rules stay relatively stable there may not be a need to have a license In the event that your business rules do change at some point and you need to maintain or make changes to your business rules you would only need to purchase a license for the minimum period you reduire Redistribution Talon Computing grants you the rights to re distribute the REX
18. t was emailed to you This is the file that has a config file extension 23 RULE ENGINE EXPRESS lt xml version 1 0 encoding utf 8 gt lt configuration gt lt appSettings gt lt add key TalonComputing License REX value D5E26CAF2C5E2B05D5 7ED7C755B1BBC3 gt lt appSettings gt lt configuration gt Classes The primary classes you need to be concerned with are Class Name FileLoader Overview This class facilitates the loading of your knowledge base You only need to use the constructor specifying where to locate your knowledge base Usage FileLoader loader new Fileloader App Data insuran ce knowledge Class Name RuleBaseProcessor Overview This class is the key to the rule engine Construct it using the file loader as a parameter Add some inputs and call the Process method on the instance This will generate a collection of outputs if one or more rules were triggered Usage var processor new RuleBaseProcessor loader 24 RULE ENGINE EXPRESS Class Name Rulelnputs Overview Usage Class Name This class is a specialized Dictionary that allows you to add update an input Initially add inputs using the add method Later you can simply modify the input by changing its value The key identifies the name of the input property The value is comprised of a Tuple identifying Item1 as the input value Item2 as the input type
19. ween two numeric values The lower bound value is exclusive and the upper bound value is inclusive The values must be separated by a comma x gt yandx lt z Variable age Conditional Operator IsBetweenMinExclusive Value 18 34 13 RULE ENGINE EXPRESS Operator Description Definition Example Operator Description Definition Example Operator Description Definition Example IsBetween Determines if a numeric value is between two numeric values inclusively The values must be separated by a comma x gt yandx lt z Variable age Conditional Operator IsBetween Value 18 34 IsEqualTo Determines if a variable is equal to a particular value x y Variable age Conditional Operator IsEgualTo Value 18 IsFalse Determines if a Boolean variable is false x false Variable smokes Conditional Operator IsFalse Value 14 RULE ENGINE EXPRESS Operator Description Definition Example Operator Description Definition Example Operator Description Definition Example IsGreaterThan Determines if a numeric variable is greater than a specific value x gt y Variable age Conditional Operator IsGreaterThan Value 34 IsGeaterThanOrEqualTo Determines if a numeric variable is greater than or equal to a specific value x2y Variable age Conditional Operator IsGreaterThanOrEgualTo Value 34 IsIn Determines if a value is in one of the values specified The
Download Pdf Manuals
Related Search