Extension of the CrmSvcUtil to allow more custom creation of early bound types
C#
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
CodeGenerator
Lib
.gitignore
ExtendedSvcUtil.sln
README.md

README.md

Dynamics.ExtendedSvcUtil

Extension of the CrmSvcUtil to allow more custom creation of early bound types. Latest version can be downloaded here.

Synopsis

This tool extends the CrmSvcUtil to provide the following features:

  • Individual class files for entities
  • Individual class files for option sets or group option set files by associated entity
  • Ability to choose what entities you want to export
  • Only creates option sets for the entities you are exporting
  • Apply friendly names to entites, attributes and option sets
  • Export lists of attribute names to remove magic strings
  • Run ad-hoc and include in a build process

It utilises the CrmSvcUtil to achieve this as this. The version of the CrmSvcUtil used at time of writing this was the version included with CRM 2016. But the DLL can be rebuilt to work with older versions if required.

How to use

Latest stable version of the DLL can be downloaded here. Otherwise you must take a copy of the source locally and build it.

To configure to suit your specific needs within the application config you will see a sample schemaDefinition section. This has 2 sub sections for entities and option sets that allow you to specify the configuration for each. For example:

  <schemaDefinition entitiesFolder="..\EntityFiles" enumsFolder="..\EntityFiles" groupOptionSetsByEntity="true" exportAttributeNames="true">
    <entities>
      <!-- Attributes="all/specified" -->
      <entity name="adx_conference" friendlyName="Conference">
        <attributes>
          <attribute name="adx_name" friendlyName="Name" />
        </attributes>
      </entity>
      <entity name="adx_event" friendlyName="Meeting">
        <attributes>
          <attribute name="icm_arrangedby" friendlyName="ArrangedBy" />
        </attributes>
      </entity>
    </entities>
    <optionSets>
      <optionSet name="adx_event_adx_eventtype" friendlyName="Meeting_MeetingType" entity="adx_event" />
      <optionSet name="icm_adx_event_icm_arrangedby" friendlyName="Meeting_ArrangedBy" entity="adx_event" />
    </optionSets>
  </schemaDefinition>

The main points to note:

  • If an entity appears in the list it will be exported to a cs file.
  • All option sets used by an entity in the list will be exported
  • If you choose to utilise groupOptionSetsByEntity all option sets will be grouped into an entity file called "Entity.Enums.cs"
  • If you exclude groupOptionSetsByEntity then all option sets will be exported to individual cs files
  • If you chose to utilise exportAttributeNames all attributes will be exported to an entity file called "Entity.Attributes.cs"
  • Use the friendlyName attribute to rename your entity/attribute/optionset
  • 1 large overall file is still exported as specified in the out parameter of CrmSvcUtil.

A sample command line use is:

CrmSvcUtil /url:http://[url]/[org]/XrmServices/2011/Organization.svc /out:sdk.cs /namespace:Namespace.Crm.Models /codewriterfilter:CodeGenerator.CodeWriterFilter,CodeGenerator /namingservice:CodeGenerator.NamingService,CodeGenerator /codecustomization:CodeGenerator.CodeCustomizationService,CodeGenerator

License

MIT Licence