CRM 2013 now allows java script coding on header fields as well as BPF fields. Sometimes we come across with the requirement where we need to write script on the fields existing in the business process flow and not on the form. Same with the fields on header of any form.
When a form displays a business process flow control in the header, additional controls gets added for each attribute that is been displayed in that BPF. These controls hold unique names like:header_process_<attribute name>. So using this control we can write script around these fields.
The Controls displayed in the form header are also accessible and hold unique name like:header_<attribute name>.
We can perform all those operations that we can perform on the attribute added on the form. Below we have mentioned some of the sample scripts around such fields.
- Show/Hide field
We can also show/hide the fields from the BPF same like we do for the other form attributes. Below we have hidden the field based on the value selected on the form.
We can simply use below line of code to show/hide the field from the BPF.
Xrm.Page.getControl(“header_process_parentcontactid”).setVisible(false);
You can use below line of code to show/hide the field from the Header.
Xrm.Page.getControl(“header_leadsourcecode”).setVisible(false);
- Make the field Read only
The field will be read only after applying script on the BPF controls.
Below is a line of code where we have disabled the control from the BPF.
//Check if the control exist on the form
if (Xrm.Page.getControl(“header_process_parentcontactid”) != null) {
//Set the control disabled
Xrm.Page.getControl(“header_process_parentcontactid”).setDisabled(true);
}
The same script you can use to apply to the header fields.
//Check if the control exist on the form
if (Xrm.Page.getControl(“header_leadsourcecode”) != null) {
//Set the control disabled
Xrm.Page.getControl(“header_leadsourcecode”).setDisabled(true);
}
- Filter Lookup
We can also filter on lookup based on another. Below we have written script to filter Existing Contact lookup based on Existing Account selected.
We have selected Fourth Coffee Account in the Existing Account as you can see in below screen shot:
And the Existing Contact lookup will now show only Account associated Contacts in this lookup, where as previously it was showing All the contacts exist in CRM regardless of any condition.
Below is a code snippet which will help you to filter a lookup:
function filterLookup() {
//Check if the control exist on the form
if (Xrm.Page.getControl(“header_process_parentcontactid”) != null) {
// add the event handler for PreSearch Event
Xrm.Page.getControl(“header_process_parentcontactid”).addPreSearch(addFilter);
}
}
function addFilter() {
var accountId = null;
var accountLookup;
var fetchQuery;
try {
//Check if control exist on form
if (Xrm.Page.getControl(“header_process_parentaccountid”) != null && Xrm.Page.getControl(“header_process_parentaccountid”).getAttribute().getValue() != null) {
//Get Account lookup value
accountLookup = Xrm.Page.getControl(“header_process_parentaccountid”).getAttribute().getValue();
//Get the account id
accountId = accountLookup[0].id;
}
//Build fetch
if (accountId != null || accountId != undefined) {
fetchQuery = “<filter type=’and’>” +
“<condition attribute=’statecode’ operator=’eq’ value=’0′ />” +
“<condition attribute=’parentcustomerid’ operator=’eq’ value=’” + accountId + “‘ />” +
“</filter>”;
//add custom filter
Xrm.Page.getControl(“header_process_parentcontactid”).addCustomFilter(fetchQuery);
}
} catch (e) {
Xrm.Utility.alertDialog(“addFilter Error: ” + (e.description || e.message));
}
}
- Get/Set Value
We need to use below method to get/set the value on the BPF fields.
Xrm.Page.getControl(“header_process_descriptions”).getAttribute().getValue();
Xrm.Page.getControl(“header_process_description”).getAttribute().setValue(“Hello World”);
If you want to write a script on the header fields then you can use below line of code for this.
Xrm.Page.getControl(“header_leadsourcecode”).getAttribute().setValue(parseInt(value));
Key Points:
- We can only perform actions like set/get value, show/hide fields, add custom filter etc. but we cannot add event handlers on the BPF fields. For this we need to add the same field on the form and then add event handler on that field.
- As we cannot apply OOB filter lookups on the BPF fields, achieving through scripts is an advantage.