Generate early-bound classes for the Organization service
CrmSvcUtil.exe is a command-line code generation tool for use with Common Data Service. This tool generates early-bound .NET Framework classes that represent the entity data model used by Common Data Service. The code generation tool (CrmSvcUtil.exe) is distributed as part of the Microsoft.CrmSdk.CoreTools NuGet package.
For information about downloading the code generation tool (CrmSvcUtil.exe), see Download tools from NuGet.
Generate entity classes
The CrmSvcUtil.exe tool creates a Microsoft Visual C# or Visual Basic .NET output file that contains strongly-typed classes for entities in your organization. This includes custom entities and attributes. This output file contains one class for each entity, providing early binding and IntelliSense support in Visual Studio to aid you as you write code. The generated classes are partial classes that can be extended with custom business logic in separate files. You can also create extensions to this tool. For more information, see Create Extensions for the Code Generation Tool.
Generate an OrganizationServiceContext class
The tool can also be used to generate a class derived from the OrganizationServiceContext class that acts as an entity container in the entity data model. This service context provides the facilities for tracking changes and managing identities, concurrency, and relationships. This class also exposes a SaveChanges() method that writes inserts, updates, and deletes records in Common Data Service. For more information, see Use OrganizationServiceContext.
Use generated classes
The classes created by the code generation tool are designed to be built into a class library that can be referenced by projects that use Common Data Service. After you have generated the class file using the tool, you should add the file to your Visual Studio project. You must also add references to several assemblies that the generated classes are dependent upon.
The following lists assemblies that must be referenced in your project when you use the generated code file.
These assemblies are part of the Microsoft.CrmSdk.CoreAssemblies NuGet package. Use this Nuget packages to add these assemblies to your Visual Studio project.
Run the code generation tool
The code generation tool takes several parameters that determine the contents of the file that is created. The parameters can be passed in from the command line when you run the tool or in a .NET-connected application configuration file.
CrmSvcUtil.exe tool from the
Tools\CoreTools folder created when you downloaded the tools using the script described in Download tools from NuGet. If you run the tool from another folder location, make sure that a copy of the
Microsoft.Xrm.Sdk.dll assembly is in that same folder.
The following sample shows the format for running the tool from the command line with Common Data Service. To use the interactive login, you can simply provide these options:
CrmSvcUtil.exe /interactivelogin ^ /out:<outputFilename>.cs ^ /namespace:<outputNamespace> ^ /serviceContextName:<serviceContextName> ^ /generateActions
When you run the tool with the
il) option you will open a dialog and be able to specify your login credentials and the server you want to connect with.
You can also specify the parameters you want to pass directly in the command line or via a batch (.bat) file you can run to generate new classes.
CrmSvcUtil.exe ^ /url:https://<organizationUrlName>.api.crm.dynamics.com/XRMServices/2011/Organization.svc ^ /out:<outputFilename>.cs ^ /username:<username> ^ /password:<password> ^ /namespace:<outputNamespace> ^ /serviceContextName:<serviceContextName>
CrmSvcUtil.exe ^ /url:https://myorganization.api.crm.dynamics.com/XRMServices/2011/Organization.svc ^ /out:MyOrganizationSdkTypes.cs ^ /username:you@yourOrg.onmicrosoft.com ^ /password:myp455w0rd ^ /namespace:MyOrg ^ /serviceContextName:MyContext
The examples above uses the carat (
^) character to break up the list of parameters for readability. You can compose the command parameters with arguments using notepad and then paste it into the command line.
- For the
passwordparameters, type the user name and password that is used to sign in to Common Data Service.
- For the
urlparameter, you can look up the correct URL in the web application by selecting Settings, navigating to Customizations, and then choosing Developer Resources. The URL is shown under Organization Service.
To list the supported command-line parameters, use the following command.
The following table lists the code generation tool parameters and a gives a brief description of their use.
||No longer needed||False|
||No longer needed||False|
||The domain to authenticate against when you connect to an on-premises server.||False|
||The URL for the Organization service.||True unless you use
||The file name for the generated code.||True|
||The language to generate the code in. This can be either “CS” or “VB”. The default value is “CS”.||False|
||The namespace for the generated code. The default is the global namespace.||False|
||The user name to use when you connect to the server for authentication.||False|
||The password to use when you connect to the server for authentication.||False|
||The name of the generated organization service context class. If no value is supplied, no service context is created.||False|
||Show usage information.||False|
||Suppress the banner at runtime.||False|
||Generate request and response classes for custom actions.||False|
||When used, a dialog to log into the Common Data Service service is displayed. All other connection related parameters specified on the command line are ignored.||False|
||Contains information, provided as a single string, for connecting to a Common Data Service organization. All other connection related parameters specified on the command line are ignored. For more information see Use connection strings in XRM tooling to connect to Common Data Service.||False|
Use the configuration File
The CrmSvcUtil.exe.config configuration file must be in the same folder as the CrmSvcUtil.exe tool. The configuration file uses the standard key/value pairs in the
appSettings section. However, if you enter a value at the command line, that value will be used instead of the one in the configuration file. Any key/value pairs found in the application configuration file that do not match any of the expected parameters are ignored.
Do not include the
namespace parameters in the configuration file. These must be entered from the command line when the CrmSvcUtil.exe tool is being run.
The following sample shows how to configure the output file and the domain name parameters in the application configuration file using shortcut keys.
<appSettings> <add key="o" value="CrmProxy.cs"/> <add key="d" value="mydomain"/> </appSettings>
To enable tracing when you run the tool, add the following lines to the configuration file:
<system.diagnostics> <trace autoflush="false" indentsize="4"> <listeners> <add name="configConsoleListener" type="System.Diagnostics.ConsoleTraceListener"> <filter type="System.Diagnostics.EventTypeFilter" initializeData="Error" /> </add> </listeners> </trace> </system.diagnostics>
For more information on supported tracing options see Configure tracing for XRM tooling.
Early Bound Generator is a tool that XrmToolbox community. Please see the Developer tools and resources topic for more community developed tools.
The community tools are not a product of Microsoft and does not extend support to the community tools. If you have questions pertaining to the tool, please contact the publisher. More Information: XrmToolBox.