This illustration shows you how to update an attribute for an entity using SOAP (JScript) or C# (.NET) with the UpdateAttribute message against the CRM 2011 organization service. In this example we are just changing the max length to something other than it's default of 100.
If you need help instantiating a service object in .NET check out this post:
http://mileyja.blogspot.com/2011/04/instantiating-service-object-within.html
I also recommend reviewing this article that lays out how to format up the metadata objects for just about any type of attribute out there. It will help a lot if you want to understand how to update anything besides a string attribute.
http://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.messages.createattributerequest.aspx
To understand how to parse the response please review my post on using the DOM parser.
First in C#:
StringAttributeMetadata stringAttribute = new StringAttributeMetadata
{
// Set base properties
SchemaName = "new_test1",
LogicalName= "new_test1",
DisplayName = new Label("Sample String", 1033),
RequiredLevel = new AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.None),
Description = new Label("String Attribute", 1033),
// Set extended properties
MaxLength = 50
};
// Update an attribute retrieved via UpdateAttributeRequest
UpdateAttributeRequest updateRequest = new UpdateAttributeRequest
{
Attribute = stringAttribute,
EntityName = Contact.EntityLogicalName,
MergeLabels = false
};
// Execute the request.
service.Execute(updateRequest);
If you need help instantiating a service object in .NET check out this post:
http://mileyja.blogspot.com/2011/04/instantiating-service-object-within.html
I also recommend reviewing this article that lays out how to format up the metadata objects for just about any type of attribute out there. It will help a lot if you want to understand how to update anything besides a string attribute.
http://msdn.microsoft.com/en-us/library/microsoft.xrm.sdk.messages.createattributerequest.aspx
Now here is the Jscript nicely formatted by the CRM 2011 SOAP formatter. Available at: http://crm2011soap.codeplex.com/
Now in Jscript:
Now in Jscript:
if (typeof (SDK) == "undefined")
{ SDK = { __namespace: true }; }
//This will establish a more unique namespace for functions in this library. This will reduce the
// potential for functions to be overwritten due to a duplicate name when the library is loaded.
SDK.SAMPLES = {
_getServerUrl: function () {
///<summary>
/// Returns the URL for the SOAP endpoint using the context information available in the form
/// or HTML Web resource.
///</summary>
var OrgServicePath = "/XRMServices/2011/Organization.svc/web";
var serverUrl = "";
if (typeof GetGlobalContext == "function") {
var context = GetGlobalContext();
serverUrl = context.getServerUrl();
}
else {
if (typeof Xrm.Page.context == "object") {
serverUrl = Xrm.Page.context.getServerUrl();
}
else
{ throw new Error("Unable to access the server URL"); }
}
if (serverUrl.match(/\/$/)) {
serverUrl = serverUrl.substring(0, serverUrl.length - 1);
}
return serverUrl + OrgServicePath;
},
UpdateAttributeRequest: function () {
var requestMain = ""
requestMain += "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">";
requestMain += " <s:Body>";
requestMain += " <Execute xmlns=\"http://schemas.microsoft.com/xrm/2011/Contracts/Services\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">";
requestMain += " <request i:type=\"a:UpdateAttributeRequest\" xmlns:a=\"http://schemas.microsoft.com/xrm/2011/Contracts\">";
requestMain += " <a:Parameters xmlns:b=\"http://schemas.datacontract.org/2004/07/System.Collections.Generic\">";
requestMain += " <a:KeyValuePairOfstringanyType>";
requestMain += " <b:key>Attribute</b:key>";
requestMain += " <b:value i:type=\"c:StringAttributeMetadata\" xmlns:c=\"http://schemas.microsoft.com/xrm/2011/Metadata\">";
requestMain += " <c:MetadataId i:nil=\"true\" />";
requestMain += " <c:AttributeOf i:nil=\"true\" />";
requestMain += " <c:AttributeType>String</c:AttributeType>";
requestMain += " <c:CanBeSecuredForCreate i:nil=\"true\" />";
requestMain += " <c:CanBeSecuredForRead i:nil=\"true\" />";
requestMain += " <c:CanBeSecuredForUpdate i:nil=\"true\" />";
requestMain += " <c:CanModifyAdditionalSettings i:nil=\"true\" />";
requestMain += " <c:ColumnNumber i:nil=\"true\" />";
requestMain += " <c:DeprecatedVersion i:nil=\"true\" />";
requestMain += " <c:Description>";
requestMain += " <a:LocalizedLabels>";
requestMain += " <a:LocalizedLabel>";
requestMain += " <a:IsManaged i:nil=\"true\" />";
requestMain += " <a:Label>String Attribute</a:Label>";
requestMain += " <a:LanguageCode>1033</a:LanguageCode>";
requestMain += " </a:LocalizedLabel>";
requestMain += " </a:LocalizedLabels>";
requestMain += " <a:UserLocalizedLabel i:nil=\"true\" />";
requestMain += " </c:Description>";
requestMain += " <c:DisplayName>";
requestMain += " <a:LocalizedLabels>";
requestMain += " <a:LocalizedLabel>";
requestMain += " <a:IsManaged i:nil=\"true\" />";
requestMain += " <a:Label>Sample String</a:Label>";
requestMain += " <a:LanguageCode>1033</a:LanguageCode>";
requestMain += " </a:LocalizedLabel>";
requestMain += " </a:LocalizedLabels>";
requestMain += " <a:UserLocalizedLabel i:nil=\"true\" />";
requestMain += " </c:DisplayName>";
requestMain += " <c:EntityLogicalName i:nil=\"true\" />";
requestMain += " <c:IsAuditEnabled i:nil=\"true\" />";
requestMain += " <c:IsCustomAttribute i:nil=\"true\" />";
requestMain += " <c:IsCustomizable i:nil=\"true\" />";
requestMain += " <c:IsManaged i:nil=\"true\" />";
requestMain += " <c:IsPrimaryId i:nil=\"true\" />";
requestMain += " <c:IsPrimaryName i:nil=\"true\" />";
requestMain += " <c:IsRenameable i:nil=\"true\" />";
requestMain += " <c:IsSecured i:nil=\"true\" />";
requestMain += " <c:IsValidForAdvancedFind i:nil=\"true\" />";
requestMain += " <c:IsValidForCreate i:nil=\"true\" />";
requestMain += " <c:IsValidForRead i:nil=\"true\" />";
requestMain += " <c:IsValidForUpdate i:nil=\"true\" />";
requestMain += " <c:LinkedAttributeId i:nil=\"true\" />";
requestMain += " <c:LogicalName>new_test1</c:LogicalName>";
requestMain += " <c:RequiredLevel>";
requestMain += " <a:CanBeChanged>true</a:CanBeChanged>";
requestMain += " <a:ManagedPropertyLogicalName i:nil=\"true\" />";
requestMain += " <a:Value>None</a:Value>";
requestMain += " </c:RequiredLevel>";
requestMain += " <c:SchemaName>new_test1</c:SchemaName>";
requestMain += " <c:Format i:nil=\"true\" />";
requestMain += " <c:ImeMode i:nil=\"true\" />";
requestMain += " <c:MaxLength>50</c:MaxLength>";
requestMain += " <c:YomiOf i:nil=\"true\" />";
requestMain += " </b:value>";
requestMain += " </a:KeyValuePairOfstringanyType>";
requestMain += " <a:KeyValuePairOfstringanyType>";
requestMain += " <b:key>EntityName</b:key>";
requestMain += " <b:value i:type=\"c:string\" xmlns:c=\"http://www.w3.org/2001/XMLSchema\">contact</b:value>";
requestMain += " </a:KeyValuePairOfstringanyType>";
requestMain += " <a:KeyValuePairOfstringanyType>";
requestMain += " <b:key>MergeLabels</b:key>";
requestMain += " <b:value i:type=\"c:boolean\" xmlns:c=\"http://www.w3.org/2001/XMLSchema\">false</b:value>";
requestMain += " </a:KeyValuePairOfstringanyType>";
requestMain += " </a:Parameters>";
requestMain += " <a:RequestId i:nil=\"true\" />";
requestMain += " <a:RequestName>UpdateAttribute</a:RequestName>";
requestMain += " </request>";
requestMain += " </Execute>";
requestMain += " </s:Body>";
requestMain += "</s:Envelope>";
var req = new XMLHttpRequest();
req.open("POST", SDK.SAMPLES._getServerUrl(), true)
// Responses will return XML. It isn't possible to return JSON.
req.setRequestHeader("Accept", "application/xml, text/xml, */*");
req.setRequestHeader("Content-Type", "text/xml; charset=utf-8");
req.setRequestHeader("SOAPAction", "http://schemas.microsoft.com/xrm/2011/Contracts/Services/IOrganizationService/Execute");
var successCallback = null;
var errorCallback = null;
req.onreadystatechange = function () { SDK.SAMPLES.UpdateAttributeResponse(req, successCallback, errorCallback); };
req.send(requestMain);
},
UpdateAttributeResponse: function (req, successCallback, errorCallback) {
///<summary>
/// Recieves the assign response
///</summary>
///<param name="req" Type="XMLHttpRequest">
/// The XMLHttpRequest response
///</param>
///<param name="successCallback" Type="Function">
/// The function to perform when an successfult response is returned.
/// For this message no data is returned so a success callback is not really necessary.
///</param>
///<param name="errorCallback" Type="Function">
/// The function to perform when an error is returned.
/// This function accepts a JScript error returned by the _getError function
///</param>
if (req.readyState == 4) {
if (req.status == 200) {
if (successCallback != null)
{ successCallback(); }
}
else {
errorCallback(SDK.SAMPLES._getError(req.responseXML));
}
}
},
_getError: function (faultXml) {
///<summary>
/// Parses the WCF fault returned in the event of an error.
///</summary>
///<param name="faultXml" Type="XML">
/// The responseXML property of the XMLHttpRequest response.
///</param>
var errorMessage = "Unknown Error (Unable to parse the fault)";
if (typeof faultXml == "object") {
try {
var bodyNode = faultXml.firstChild.firstChild;
//Retrieve the fault node
for (var i = 0; i < bodyNode.childNodes.length; i++) {
var node = bodyNode.childNodes[i];
//NOTE: This comparison does not handle the case where the XML namespace changes
if ("s:Fault" == node.nodeName) {
for (var j = 0; j < node.childNodes.length; j++) {
var faultStringNode = node.childNodes[j];
if ("faultstring" == faultStringNode.nodeName) {
errorMessage = faultStringNode.text;
break;
}
}
break;
}
}
}
catch (e) { };
}
return new Error(errorMessage);
},
__namespace: true
};
To understand how to parse the response please review my post on using the DOM parser.
Now you can call the SDK.SAMPLES.UpdateAttributeRequest function from your form jscript handler.
Thats all there is to it!
I hope this helps!
Hi Jamie,
ReplyDeleteHave you tried updating list of option set by executing a UpdateAttributeRequest on
PicklistAttributeMetadta ?
I don't seem to get that working at the moment