{"id":18899,"date":"2019-06-07T11:42:02","date_gmt":"2019-06-07T11:42:02","guid":{"rendered":"https:\/\/www.inogic.com\/blog\/?p=18899"},"modified":"2020-05-27T11:07:37","modified_gmt":"2020-05-27T11:07:37","slug":"execute-action-with-columnsetcomplextype-type-parameter-using-xrm-webapi-online-execute-in-dynamics-365-crm-v9-0","status":"publish","type":"post","link":"https:\/\/www.inogic.com\/blog\/2019\/06\/execute-action-with-columnsetcomplextype-type-parameter-using-xrm-webapi-online-execute-in-dynamics-365-crm-v9-0\/","title":{"rendered":"Execute Action with ColumnSet(ComplexType) type parameter Using Xrm.WebApi.online.execute in Dynamics 365 CRM V9.0"},"content":{"rendered":"

Introduction<\/strong><\/h2>\n

Microsoft has introduced\u00a0Xrm.WebApi.online.execute<\/strong>\u00a0to execute an action in Dynamics CRM version 9.0. In our last blog we have seen how to Execute action using Xrm.WebApi.online.execute in Dynamics CRM<\/a>. In this blog we will see how to execute action with \u201cColumnSet<\/strong><\/a>(ComplexType)<\/strong>\u201d type property.<\/p>\n

Here we are executing \u201cGenerateQuoteFromOpportunity<\/strong>\u201d action for sample purpose as this action contains the \u201cColumnSet<\/strong><\/a>(ComplexType)<\/strong>\u201d type parameter.<\/p>\n

Properties of ColumnSet<\/a>(ComplexType) parameter:<\/strong><\/p>\n

\"xrm\"<\/p>\n

For these properties we need to add another getMetadata method as shown in the below example.<\/p>\n

Syntax: <\/strong><\/p>\n

Xrm.WebApi.online.execute(request).then(successCallback, errorCallback);<\/p>\n

successCallback:<\/strong> This function call is for when is action executed successfully.<\/p>\n

errorCallback:<\/strong> This function call is for when there is any error while executing action. It returns an error as result in string format.<\/p>\n

Given below is the example of how to write the function to execute \u201cGenerateQuoteFromOpportunity<\/strong>\u201d action:<\/p>\n

Generate Parameters:<\/u><\/strong><\/p>\n

\/**<\/p>\n

* This function generates quote from opportunity using GenerateQuoteFromOpportunity action<\/p>\n

* @param formContext<\/p>\n

* @param opportunityID<\/p>\n

*\/<\/p>\n

function executeAction(executionContext) {<\/p>\n

let functionName = “executeAction”;<\/p>\n

var opportunityID = null;<\/p>\n

var formContext = null;<\/p>\n

try {<\/p>\n

debugger;<\/p>\n

\/\/Get form context<\/p>\n

formContext = executionContext.getFormContext();<\/p>\n

\/\/Get opportunity id<\/p>\n

opportunityID = !isValid(executionContext.getFormContext().data)<\/p>\n

|| !isValid(executionContext.getFormContext().data.entity)<\/p>\n

|| !isValid(executionContext.getFormContext().data.entity.getId)<\/p>\n

? null : executionContext.getFormContext().data.entity.getId();<\/p>\n

\/\/Set parameters<\/p>\n

var GenerateQuoteFromOpportunityReq = function (OpportunityId, ColumnSetVal) {<\/p>\n

this.OpportunityId = { “guid”: OpportunityId };<\/p>\n

this.ColumnSet = {<\/p>\n

“AllColumns”: ColumnSetVal,<\/p>\n

“getMetadata”: function () {<\/p>\n

return {<\/p>\n

boundParameter: null,<\/p>\n

operationType: 0,<\/p>\n

operationName: “GenerateQuoteFromOpportunity”,<\/p>\n

parameterTypes: {<\/p>\n

“AllColumns”: {<\/p>\n

“typeName”: “Edm.Boolean”, \/\/Primitive Type<\/p>\n

“structuralProperty”: 1<\/p>\n

}<\/p>\n

}<\/p>\n

}<\/p>\n

}<\/p>\n

};<\/p>\n

this.getMetadata = function () {<\/p>\n

return {<\/p>\n

boundParameter: null,<\/p>\n

parameterTypes: {<\/p>\n

“OpportunityId”: {<\/p>\n

“typeName”: “Edm.Guid”, \/\/Primitive Type<\/p>\n

“structuralProperty”: 1<\/p>\n

},<\/p>\n

“ColumnSet”: {<\/p>\n

“typeName”: “mscrm.ColumnSet”, \/\/Complex Type<\/p>\n

“structuralProperty”: 2<\/p>\n

}<\/p>\n

},<\/p>\n

operationType: 0,<\/p>\n

operationName: “GenerateQuoteFromOpportunity”<\/p>\n

};<\/p>\n

};<\/p>\n

};<\/p>\n

var generateQuoteFromOpportunityReq = new GenerateQuoteFromOpportunityReq(opportunityID, true);<\/p>\n

}<\/p>\n

Execute Action:<\/u><\/strong><\/p>\n

Xrm.WebApi.online.execute(generateQuoteFromOpportunityReq).then(function (result) {<\/p>\n

\/\/Validate result<\/p>\n

if (!isValid(result) || !isValid(result[“responseText”])) {<\/p>\n

return;<\/p>\n

}<\/p>\n

else {<\/p>\n

\/\/get result in JSON object<\/p>\n

var resultJson = JSON.parse(result[“responseText”]);<\/p>\n

\/\/Validate JSON<\/p>\n

if (isValid(resultJson)) {<\/p>\n

\/\/Validating the attributes<\/p>\n

if (!isValid(Xrm) || !isValid(Xrm.Navigation)) { return; }<\/p>\n

\/\/openAlertDialog<\/p>\n

Xrm.Navigation.openAlertDialog({ confirmButtonLabel: “Ok”, text: “Quote with ID: ” + resultJson.quoteid + ” is generated successfully. ” });<\/p>\n

}<\/p>\n

}<\/p>\n

}, function (error) {<\/p>\n

throwError(functionName, error);<\/p>\n

});<\/p>\n

} catch (error) {<\/p>\n

throwError(functionName, error);<\/p>\n

}<\/p>\n

}<\/p>\n

On success it returns a promise object with specific attributes.<\/p>\n

In above example we have used \u2018AllColums\u2019 property of \u201cColumnSet<\/strong><\/a>(ComplexType)<\/strong>\u201d parameter. In the same way we can use \u2018Columns\u2019 parameter. We just need to set \u201cEdm.String<\/strong>\u201d as typename<\/strong> in getMetadata <\/strong>method.<\/p>\n

Conclusion<\/strong><\/h2>\n

In this blog, we have seen how we can execute action with \u201cColumnSet<\/strong><\/a>(ComplexType)<\/strong>\u201d type parameter using Xrm.WebApi.online.execute in Dynamics 365 CRM V9.0.<\/p>\n

\"Click2Clone-One-Click-Productivity-App-to-Copy_clone-Dynamics-365_CRM-Records\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

Introduction Microsoft has introduced\u00a0Xrm.WebApi.online.execute\u00a0to execute an action in Dynamics CRM version 9.0. In our last blog we have seen how to Execute action using Xrm.WebApi.online.execute in Dynamics CRM. In this blog we will see how to execute action with \u201cColumnSet(ComplexType)\u201d type property. Here we are executing \u201cGenerateQuoteFromOpportunity\u201d action for sample purpose as this action contains\u2026 Read More »<\/a><\/span><\/p>\n","protected":false},"author":13,"featured_media":23725,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"om_disable_all_campaigns":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[65],"tags":[1813],"class_list":["post-18899","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-webapi","tag-web-api"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/18899","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/users\/13"}],"replies":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/comments?post=18899"}],"version-history":[{"count":0,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/posts\/18899\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media\/23725"}],"wp:attachment":[{"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/media?parent=18899"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/categories?post=18899"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.inogic.com\/blog\/wp-json\/wp\/v2\/tags?post=18899"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}