Following from my recent post, I thought I’d release the option set enumeration generator I have been using as well.
I am aware that several existing CrmSvcUtil extensions as well as the unextended CrmSvcUtil generate option set enumerations but this one has several key advantages:
- Enumerations are generated as members of the entity classes, not global options sets. This allows copies of global option sets per attribute that uses the global option set.
- Duplicate enumeration options are handled by appending the value of the item, not an arbitrary counter. Appending a counter can actually cause bugs that are incredibly difficult to track down if another duplicate instance is added in between two existing duplicates – effectively changing the key/value pair combination without updating dependent code.
- Enumerations are generated and consistently named for Option Set, Boolean, State and Status attribute types. Enumerations are referred to in the form “[Entity Schema Name].[Attribute Logical Name]Values” in all cases.
Download the CrmSvcUtil extension at codeplex: CrmSvcUtil Generate Option Set Enums.
To use the extension:
- Copy GenerateOptionSetEnums.dll into the directory containing CrmSvcUtil.exe
- Run CrmSvcUtil with the following parameters:
CrmSvcUtil.exe ^ /codecustomization:"GenerateOptionSetEnums.CodeCustomizationService, GenerateOptionSetEnums" ^ /codewriterfilter:"GenerateOptionSetEnums.FilteringService, GenerateOptionSetEnums" ^ /url:http://servername/orgname/XRMServices/2011/Organization.svc ^ /out:Enumerations.cs ^
The baseTypes parameter is optional and can be used to override the base types for entity classes which is needed if you have previously generated the wrapper classes with an extension (eg. Microsoft.Xrm.Client.CodeGeneration.CodeCustomization).
To use the generated option set enumerations:
Contact contact = new Contact(); contact.Attributes[Contact.firstnameAttribute] = "Michael"; contact.Attributes[Contact.lastnameAttribute] = "Palmer"; contact.EducationCode = new OptionSetValue((int)Contact.gendercodeValues.Male);