Dynamics CRM 2011 : Perform JScript Validations on Entity Form Before Execution of Special Events

In many development scenarios there is a requirement to perform Jscript validations on entity form before the execution of special events by clicking on the entity form buttons i.e. Activate, Deactivate, Lead Qualify, Resolve Case, Cancel Case  etc. You can use the step by step guidelines below to overcome this scenario. You may also reffer to the table at bottom of this guide for a list of record saved event model values.

[Instructions]

1. Create a new JScript web resource or you can use existing JScript web resource, copy the following Jscript code in the web resource. Make sure to replace <Value> in code line wod_SaveEventVal = <Value>; with the event mode value as per required. For record saved event model values you can refer to the table at the bottom of the guide.

[Jscript: Code]

// Use the following function on Form Save Event,

// CRM will pass the execution context in function paramter prmContext

function FrmOnSave(prmContext) {

// Local variable to store value indicating how the save event was initiated by the user.

var wod_SaveMode, wod_SaveEventVal;

// Change the Save Event Value as per required Save Event

wod_SaveEventVal = <Value>;

if (prmContext != null && prmContext.getEventArgs() != null) {

wod_SaveMode = prmContext.getEventArgs().getSaveMode();

// 1 will pass on Recalculate button click

if (wod_SaveMode == wod_SaveEventVal) {

// Write your validation code here

alert("Write your validation code here");

// Use the code line below only if validation is failed then abort function save event

prmContext.getEventArgs().preventDefault();

}

}

}

2. Open Entity Form (Settings->Customization->Customize the System->Entities-> <Entity> ->Forms->Main)

3. Click on Form Properties button, add Jscript web resource library if not already added. In Event Handlers section select OnSave in event field, click on Add button enter FrmOnSave value in function* field and make sure to check Enabled and Pass execution context as first parameter checkboxes.

4. Save Form and Publish entity customizations.

[Table: Entity Record Saved Event Mode Values]

The following table describes the values returned for different ways entity records saved by the user. The save event will be called only for the actions that required form save.

Entity	Event Mode	Value
Activities	Save as Completed	58
Activities	Close Activity Note 2	5
Activities	To Opportunity Note 2	5
Activities	To Case Note 2	5
Activities	To Lead Note 2	5
All	Save Note 2	1
All	Save and Close	2
All	Deactivate	5
All	Reactivate	6
Article	Submit	10
Article	Approve	12
Article	Reject	11
Article	Unpublish	13
Campaign Activity	Close Campaign Activity	5
Campaign Activity	Distribute Campaign Activity	4
Campaign Response	Convert Campaign Response (Create new lead or Create new record for a customer)	54
Campaign Response	Convert Campaign Response (Convert Existing Lead -> Qualify)	16
Campaign Response	Convert Campaign Response (Convert Existing Lead-> Disqualify)	15
Campaign Response	Close Response	5
Case	Resolve Case	5
Case	Cancel Case	40
Case	Reactivate Case	6
Contract	Invoice Contract	38
Contract	Copy Contract	39
Contract	Recalculate Note 2	1
Contract	Hold Contract	31
Contract	Renew Contract	34
Contract	Cancel Contract	33
E-mail	Send	7
Goal	Recalculate	66
Goal	Close Goal	5
Invoice	Invoice Paid	57
Invoice	Cancel Invoice	27
Invoice	Recalculate	1
Invoice	Get Products	44
Invoice	Lock Pricing	52
Lead	Qualify	16
Lead	Disqualify	15
Opportunity	Close as Won Note 2	5
Opportunity	Close as Lost Note 2	5
Opportunity	Recalculate Opportunity Note 2	1
Order	Create Invoice	19
Order	Fullfill Order	56
Order	Cancel Order	26
Order	Recalculate Note 2	1
Order	Get Product	43
Order	Lock Pricing	50
Product	Convert to Kit	35
Product	Convert to Product	36
Queue	Approve E-mail Note 1	4
Queue	Reject E-mail Note 1	4
Quote	Recalculate Note 2	1
Quote	Get Products	28
Quote	Activate Quote	29
Quote	Create Order	17
Quote	Revise	24
Quote	Close Quote	25
User	Approve E-mail Note 1 & Note 2	4
User	Reject E-mail Note 1 & Note 2	4
User	Change Business Unit Note 1	4
User or Team Owned Entities	Assign	47

Special Notes Information
1. Event modes having ^{Notes 1} means that system invoke the Save Form event after the execution of the event, so any validations written in the FrmOnSave Jscript method will be executed after the execution of event.

2. Event modes having ^{Notes 2} means that the Save Event Mode values are duplicated with other buttons Save Event Mode values.


Files Download Link:

1. Table in Excel Sheet format: https://skydrive.live.com/?cid=06f61fc8aa6032c9&id=6F61FC8AA6032C9%21136#

2. JScript code file: https://skydrive.live.com/?cid=06f61fc8aa6032c9&sc=documents&uc=2&id=6F61FC8AA6032C9%21135#