Sage CRM Developers Course

1. Sage CRM Developers Course Validation Rules and Table and Entity Level Scripts

2. Looking ahead to the classes • DP01: Introduction to the Development Partner Program • DP02: Entities and the Data Model (Part 1 of 2) • DP03: Entities and the Data Model (Part 2 of 2) • DP04: Implementing Screen Based Rules (Part 1 of 2) • DP05: Implementing Screen Based Rules (Part 2 of 2) • DP06: Screen and User Independent Business Rules • DP07: Workflow (Part 1 of 2) • DP08: Workflow (Part 2 of 2) • DP09: Using the API Objects in ASP Pages (Part 1 of 2) • DP10 : Using the API Objects in ASP Pages (Part 2 of 2) • DP11: Using the Component Manager • DP12: Programming for the Advanced Email Manager • DP13: Using the Web Services API • DP14: Using the Web Services API (Part 2 of 2) • DP15: Coding the Web Self Service COM API (Part 1 of 2) • DP16: Coding the Web Self Service COM API (Part 2 of 2) • DP17: Using the .NET API (Part 1 of 2) • DP18: Using the .NET API (Part 2 of 2)

3. Agenda • Validation Rules • Screen and User Independent Business Rules • Table Level and Entity Level Scripts including future change in support for Detached/Delayed Table Level scripts • Objects Available • Differences between Values() and FormValues() Collections • Availability of Contextual Information • Rollback behaviour

5. Validate Script • What are the Objects Available? Core Jscript Objects Extensibility Module Objects ActiveX Objects • What is the Scope of Effect? • What are the limitations?

6. Complex Rules • Validation Rules can support complex multi-row and inter-table rules • Example Wave Budget Validation Rule var wavebudgetentered = Values('wave_budget'); var myRecordId = CRM.GetContextInfo('Campaigns','camp_campaignid'); var campaignsbudget = CRM.GetContextInfo('Campaigns','camp_budget'); var myRecord = CRM.FindRecord('Waves','wave_campaignid='+myRecordId); var totalwavesbudget = 0 var brokebudgetbyamount = 0; while (!myRecord.eof) { totalwavesbudget += Number(myRecord.wave_budget); myRecord.NextRecord(); } totalwavesbudget += Number(wavebudgetentered); if (totalwavesbudget >campaignsbudget) { brokebudgetbyamount = totalwavesbudget - campaignsbudget; Valid = false; ErrorStr = 'You have broken the campaign budget by ' + brokebudgetbyamount; } else { Valid = true; }

7. Validation Rules and onChangeRules

8. Using Validation Rules for other purposes • Validation on Search Screens Validation rules are checked on submission of a search screen even though in this case no data is being inserted or updated. • For example the code below on the comp_name will ensure that it can't be left blank when searching for companies. if (!Values("comp_name")){Valid = false;ErrorStr = "you must fill in this field";} • Example Validation Log Script The example below only needs to log which fields have changed not every field in the screen so we first need to know what fields are in the screen and then examine each field in turn. To do this I've used the fact that the screen object (EntryGroup block) is an enumerable object. • var ForReading = 1, ForWriting = 2, ForAppending = 8;var TristateUseDefault = -2, TristateTrue = -1, TristateFalse = 0;var mySystemObject = new ActiveXObject("Scripting.FileSystemObject");var myFile = mySystemObject.GetFile("c:/customlogs/TEST.TXT");var myFileTextStream = myFile.OpenAsTextStream(ForAppending, TristateUseDefault);var oldName = "";var myBlock = CRM.GetBlock("CompanyBoxLong");var myE = new Enumerator(myBlock);while (!myE.atEnd()){oldName = CRM.GetContextInfo("company",myE.item());if (oldName != Values(myE.item())){myFileTextStream.WriteLine(oldName +"/"+Values(myE.item())+" changed by "+CurrentUser.user_logon);} myE.moveNext();}myFileTextStream.Close();

9. Table and Entity Level Scripts

10. Four Types of Table/Entity Script • Table Level • Detached Table Level (Deprecated in Sage CRM v7.2) • Developers should remove Detached Table Level scripts. Use Escalation rules and other scripts where possible. • Entity Level • Entity Level with Rollback

11. Objects used in Internal Scripting Main Objects Other Objects EntryGroup block is enumerable and it may provide us within a TableLevel script a simple way of checking if certain fields exist on the screen to see if they have changed value.

12. Entity Level Script Firing Points

13. Values() Usage

14. FormValues() and Values() • The Values() collection • Allows access the data within the fields associated with the EntryBlock (screen) used to build the edit screen for current record. • E.g. editing a company record you would use the CompanyBoxLong screen. • The FormValues() collection • Allows access the data from within the whole of the HTML form submitted. • This means in a screen like the new Company screen when you are actually inserting data to several tables (Company, Person, Address etc) then you can access any of the submitted data. • E.g. So in an InsertRecord event function of an Company Entity script we could access the submitted address information:var strPostCode = FormValues("addr_postcode");

15. Validating Phone Numbers and Email Addresses • We can use an "Entity Level script with Rollback". Entity Level with Rollback scripts can be used when we want to stop an action happening if there is a validation error or other error with the script. • Need to consider • Data Entry • Data Update

16. Table Level Scripts • Example Rule • If the company is reassigned then reassign all opportunities for that company to that new personid. • The GetContextInfo() method returns the originally assigned user and the Values() collection contains the inbound userid data. When they are different, the record has been reassigned. if (CRM.GetContextInfo('Company','comp_primaryuserid') != Values('comp_primaryuserid')) { varmyCompRecordId = CRM.GetContextInfo('company','comp_companyid'); varstrSQL = "oppo_status = 'In Progress' and oppo_primarycompanyid="+myCompRecordId; varmyOppoRecord = CRM.FindRecord('opportunity', strSQL); while (!myOppoRecord.EOF) { myOppoRecord.oppo_assigneduserid = Values('comp_primaryuserid') myOppoRecord.NextRecord(); } myOppoRecord.SaveChanges(); }

17. Rollback & Table Level Scripts • Only Entity Level Scripts can rollback • Values() collection contains the new values • CRM.GetContextInfo() returns the old value • Therefore you are be able to do this... if (Values('data_whatever')==invalidValue) { Valid = false; ErrorStr = CRM.GetTrans('capt_family','capt_code'); Values('data_whatever') = CRM.GetContextInfo('mytable','data_whatever'); }

18. Update of Data not submitted from Screen • The Values() collection can be extended to set a value for a field not in the screen.function UpdateRecord(){// Handle update record actions herevar strCompany = Values("comp_name");Values("comp_name") = strCompany.toUpperCase();Values("comp_mailrestriction") = 'Y';}

19. Insert & PostInsert functions • Two 'Insert' event functions available to you within table level scripts.  • InsertRecord() • InsertRecord() event fires as the record is created but before the database insert, therefore the new unique id for the record is unknown. • PostInsertRecord().  • Have access to the records newly created unique id. • But can’t use • CRM.GetContextInfo('datatable','data_dataid')  • Record is new and is not in context at that moment.  • Neither can we use • Values() collection • Id has not been passed into the system. 

20. Use of the WhereClause • In a PostInsertRecord() function • To obtain the newly created record id. • Use system variable called 'WhereClause'.  • Contains after the creation of the record the literal string 'dataid=value' e.g 'lead_leadid=507'. 

21. Variables & Objects

22. External Triggering of Table Level scripts • Possible to trigger any Table Level script event function • Triggered by • COM API calls • ASP page extensions • Self Service extensions • Windows script • Mail Manager Scripts • SOAP Web Service calls • .NET API calls • Note: Table Level scripts may not be triggered by changes made by Exchange & ERP sync engines

23. ScriptCommonFunctions • In registry • ScriptCommonFunctions • reg key value • utils\myfunctions.js • Put filename you want. Assumed to be in the custompages folder or use path to subfolder. • Functions in the file will be added to every table level script at execution. • Note: May clash with existing ERP integration e.g. Sage 300 ERP

24. Q&A

25. Looking ahead to the classes • DP01: Introduction to the Development Partner Program • DP02: Entities and the Data Model (Part 1 of 2) • DP03: Entities and the Data Model (Part 2 of 2) • DP04: Implementing Screen Based Rules (Part 1 of 2) • DP05: Implementing Screen Based Rules (Part 2 of 2) • DP06: Screen and User Independent Business Rules • DP07: Workflow (Part 1 of 2) • DP08: Workflow (Part 2 of 2) • DP09: Using the API Objects in ASP Pages (Part 1 of 2) • DP10 : Using the API Objects in ASP Pages (Part 2 of 2) • DP11: Using the Component Manager • DP12: Programming for the Advanced Email Manager • DP13: Using the Web Services API • DP14: Using the Web Services API (Part 2 of 2) • DP15: Coding the Web Self Service COM API (Part 1 of 2) • DP16: Coding the Web Self Service COM API (Part 2 of 2) • DP17: Using the .NET API (Part 1 of 2) • DP18: Using the .NET API (Part 2 of 2)