Sample: Dump attribute picklist metadata to a file
Applies To: Dynamics CRM 2013
This sample code is for Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. Download the Microsoft Dynamics CRM SDK package. It can be found in the following location in the download package:
SampleCode\CS\Metadata\Attributes\DumpPicklistInfo.cs
SampleCode\VB\Metadata\Attributes\DumpPicklistInfo.vb
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the sample and helper code.
Demonstrates
This sample shows how to write out all the entity metadata to an XML file. It uses the RetrieveAllEntitiesRequest message.
The following sample creates a new file at \Entities\bin\Debug\AttributePicklistValues.xml. You can open this file in Microsoft Office Excel to see a tabular report. This is useful to look up the valid values for each picklist. This information can also be found in the “EntityName Entity OptionSet Attribute Metadata” topic for each entity.
Example
using System;
using System.Linq;
using System.Xml.Linq;
using System.ServiceModel;
using System.ServiceModel.Description;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Xml;
using System.IO;
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
// found in the SDK\bin folder.
using Microsoft.Xrm.Sdk;
using Microsoft.Xrm.Sdk.Query;
using Microsoft.Xrm.Sdk.Metadata;
using Microsoft.Xrm.Sdk.Client;
using Microsoft.Xrm.Sdk.Messages;
// This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
// found in the SDK\bin folder.
using Microsoft.Crm.Sdk.Messages;
namespace Microsoft.Crm.Sdk.Samples
{
/// <summary>
/// This sample shows how to retrieve and write out all the option set values:
/// picklist, state and status attribute types.
/// </summary>
public class DumpPicklistInfo
{
#region Class Level Members
/// <summary>
/// Stores the organization service proxy.
/// </summary>
OrganizationServiceProxy _serviceProxy;
// Create storage for new attributes being created
public List<AttributeMetadata> addedAttributes;
// Specify which language code to use in the sample. If you are using a language
// other than US English, you will need to modify this value accordingly.
// See https://msdn.microsoft.com/en-us/library/0h88fahh.aspx
public const int _languageCode = 1033;
// Define the IDs/variables needed for this sample.
public int _insertedStatusValue;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// </summary>
/// <param name="serverConfig">Contains server connection information.</param>
/// <param name="promptForDelete">When True, the user will be prompted to delete all
/// created entities.</param>
public void Run(ServerConnection.Configuration serverConfig, bool promptForDelete)
{
try
{
// Connect to the Organization service.
// The using statement assures that the service proxy will be properly disposed.
using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig))
{
// This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes();
#region How to dump attribute info
RetrieveAllEntitiesRequest request = new RetrieveAllEntitiesRequest()
{
EntityFilters = EntityFilters.Attributes,
RetrieveAsIfPublished = true
};
// Retrieve the MetaData.
RetrieveAllEntitiesResponse response = (RetrieveAllEntitiesResponse)_serviceProxy.Execute(request);
// Create an instance of StreamWriter to write text to a file.
// The using statement also closes the StreamWriter.
// To view this file, right click the file and choose open with Excel.
// Excel will figure out the schema and display the information in columns.
String filename = String.Concat("AttributePicklistValues.xml");
using (StreamWriter sw = new StreamWriter(filename))
{
// Create Xml Writer.
XmlTextWriter metadataWriter = new XmlTextWriter(sw);
// Start Xml File.
metadataWriter.WriteStartDocument();
// Metadata Xml Node.
metadataWriter.WriteStartElement("Metadata");
foreach (EntityMetadata currentEntity in response.EntityMetadata)
{
if (currentEntity.IsIntersect.Value == false)
{
// Start Entity Node
metadataWriter.WriteStartElement("Entity");
// Write the Entity's Information.
metadataWriter.WriteElementString("EntityLogicalName", currentEntity.LogicalName);
if (currentEntity.IsCustomizable.Value == true)
metadataWriter.WriteElementString("IsCustomizable", "yes");
else
metadataWriter.WriteElementString("IsCustomizable", "no");
#region Attributes
// Write Entity's Attributes.
metadataWriter.WriteStartElement("Attributes");
foreach (AttributeMetadata currentAttribute in currentEntity.Attributes)
{
// Only write out main attributes.
if (currentAttribute.AttributeOf == null)
{
// Start Attribute Node
metadataWriter.WriteStartElement("Attribute");
// Write Attribute's information.
metadataWriter.WriteElementString("LogicalName", currentAttribute.LogicalName);
metadataWriter.WriteElementString("Type", currentAttribute.AttributeType.Value.ToString());
if (currentAttribute.GetType() == typeof(PicklistAttributeMetadata))
{
PicklistAttributeMetadata optionMetadata = (PicklistAttributeMetadata)currentAttribute;
// Writes the picklist's options
metadataWriter.WriteStartElement("Options");
// Writes the attributes of each picklist option
for (int c = 0; c < optionMetadata.OptionSet.Options.Count; c++)
{
metadataWriter.WriteStartElement("Option");
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options[c].Value.Value.ToString());
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options[c].Label.UserLocalizedLabel.Label.ToString());
metadataWriter.WriteEndElement();
}
metadataWriter.WriteEndElement();
}
else if (currentAttribute.GetType() == typeof(StateAttributeMetadata))
{
StateAttributeMetadata optionMetadata = (StateAttributeMetadata)currentAttribute;
// Writes the picklist's options
metadataWriter.WriteStartElement("Options");
// Writes the attributes of each picklist option
for (int c = 0; c < optionMetadata.OptionSet.Options.Count; c++)
{
metadataWriter.WriteStartElement("Option");
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options[c].Value.Value.ToString());
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options[c].Label.UserLocalizedLabel.Label.ToString());
metadataWriter.WriteEndElement();
}
metadataWriter.WriteEndElement();
}
else if (currentAttribute.GetType() == typeof(StatusAttributeMetadata))
{
StatusAttributeMetadata optionMetadata = (StatusAttributeMetadata)currentAttribute;
// Writes the picklist's options
metadataWriter.WriteStartElement("Options");
// Writes the attributes of each picklist option
for (int c = 0; c < optionMetadata.OptionSet.Options.Count; c++)
{
metadataWriter.WriteStartElement("Option");
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options[c].Value.Value.ToString());
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options[c].Label.UserLocalizedLabel.Label.ToString());
if (optionMetadata.OptionSet.Options[c] is StatusOptionMetadata)
metadataWriter.WriteElementString("RelatedToState", ((StatusOptionMetadata)optionMetadata.OptionSet.Options[c]).State.ToString());
metadataWriter.WriteEndElement();
}
metadataWriter.WriteEndElement();
}
// End Attribute Node
metadataWriter.WriteEndElement();
}
}
// End Attributes Node
metadataWriter.WriteEndElement();
#endregion
// End Entity Node
metadataWriter.WriteEndElement();
}
}
// End Metadata Xml Node
metadataWriter.WriteEndElement();
metadataWriter.WriteEndDocument();
// Close xml writer.
metadataWriter.Close();
}
#endregion How to dump attribute info
Console.WriteLine("Done.");
//DeleteRequiredRecords(promptForDelete);
}
}
// Catch any service fault exceptions that Microsoft Dynamics CRM throws.
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
{
// You can handle an exception here or pass it back to the calling method.
throw;
}
}
/// <summary>
/// Deletes/Reverts the record that was created/changed for this sample.
/// <param name="prompt">Indicates whether to prompt the user to delete
/// the records created in this sample.</param>
/// </summary>
public void DeleteRequiredRecords(bool prompt)
{
bool deleteRecords = true;
if (prompt)
{
Console.WriteLine(
"\nDo you want these entity records to be deleted? (y/n)");
String answer = Console.ReadLine();
deleteRecords = (answer.StartsWith("y") || answer.StartsWith("Y"));
}
if (deleteRecords)
{
}
}
#endregion How To Sample Code
#region Main
/// <summary>
/// Standard Main() method used by most SDK samples.
/// </summary>
/// <param name="args"></param>
static public void Main(string[] args)
{
try
{
// Obtain the target organization's Web address and client logon
// credentials from the user.
ServerConnection serverConnect = new ServerConnection();
ServerConnection.Configuration config = serverConnect.GetServerConfiguration();
DumpPicklistInfo app = new DumpPicklistInfo();
app.Run(config, false);
}
catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);
Console.WriteLine("Message: {0}", ex.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
catch (System.TimeoutException ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine("Message: {0}", ex.Message);
Console.WriteLine("Stack Trace: {0}", ex.StackTrace);
Console.WriteLine("Inner Fault: {0}",
null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);
}
catch (System.Exception ex)
{
Console.WriteLine("The application terminated with an error.");
Console.WriteLine(ex.Message);
// Display the details of the inner exception.
if (ex.InnerException != null)
{
Console.WriteLine(ex.InnerException.Message);
FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe
= ex.InnerException
as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;
if (fe != null)
{
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);
Console.WriteLine("Message: {0}", fe.Detail.Message);
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText);
Console.WriteLine("Inner Fault: {0}",
null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");
}
}
}
// Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
// SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
finally
{
Console.WriteLine("Press <Enter> to exit.");
Console.ReadLine();
}
}
#endregion Main
}
}
Imports System.ServiceModel
Imports System.ServiceModel.Description
Imports System.Xml.Serialization
Imports System.Xml
Imports System.IO
' These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Xrm.Sdk
Imports Microsoft.Xrm.Sdk.Query
Imports Microsoft.Xrm.Sdk.Metadata
Imports Microsoft.Xrm.Sdk.Client
Imports Microsoft.Xrm.Sdk.Messages
' This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly
' found in the SDK\bin folder.
Imports Microsoft.Crm.Sdk.Messages
Namespace Microsoft.Crm.Sdk.Samples
''' <summary>
''' This sample shows how to retrieve and write out all the option set values:
''' picklist, state and status attribute types.
''' </summary>
Public Class DumpPicklistInfo
#Region "Class Level Members"
''' <summary>
''' Stores the organization service proxy.
''' </summary>
Private _serviceProxy As OrganizationServiceProxy
' Create storage for new attributes being created
Public addedAttributes As List(Of AttributeMetadata)
' Specify which language code to use in the sample. If you are using a language
' other than US English, you will need to modify this value accordingly.
' See https://msdn.microsoft.com/en-us/library/0h88fahh.aspx
Public Const _languageCode As Integer = 1033
' Define the IDs/variables needed for this sample.
Public _insertedStatusValue As Integer
#End Region ' Class Level Members
#Region "How To Sample Code"
''' <summary>
''' </summary>
''' <param name="serverConfig">Contains server connection information.</param>
''' <param name="promptForDelete">When True, the user will be prompted to delete all
''' created entities.</param>
Public Sub Run(ByVal serverConfig As ServerConnection.Configuration, ByVal promptForDelete As Boolean)
Try
' Connect to the Organization service.
' The using statement assures that the service proxy will be properly disposed.
_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig)
Using _serviceProxy
' This statement is required to enable early-bound type support.
_serviceProxy.EnableProxyTypes()
' #Region "How to dump attribute info"
Dim request As New RetrieveAllEntitiesRequest() With {
.EntityFilters = EntityFilters.Attributes,
.RetrieveAsIfPublished = True}
' Retrieve the MetaData.
Dim response As RetrieveAllEntitiesResponse = CType(_serviceProxy.Execute(request), RetrieveAllEntitiesResponse)
' Create an instance of StreamWriter to write text to a file.
' The using statement also closes the StreamWriter.
' To view this file, right click the file and choose open with Excel.
' Excel will figure out the schema and display the information in columns.
Dim filename As String = String.Concat("AttributePicklistValues.xml")
Using sw As New StreamWriter(filename)
' Create Xml Writer.
Dim metadataWriter As New XmlTextWriter(sw)
' Start Xml File.
metadataWriter.WriteStartDocument()
' Metadata Xml Node.
metadataWriter.WriteStartElement("Metadata")
For Each currentEntity As EntityMetadata In response.EntityMetadata
If currentEntity.IsIntersect.Value = False Then
' Start Entity Node
metadataWriter.WriteStartElement("Entity")
' Write the Entity's Information.
metadataWriter.WriteElementString("EntityLogicalName", currentEntity.LogicalName)
If currentEntity.IsCustomizable.Value = True Then
metadataWriter.WriteElementString("IsCustomizable", "yes")
Else
metadataWriter.WriteElementString("IsCustomizable", "no")
End If
' #Region "Attributes"
' Write Entity's Attributes.
metadataWriter.WriteStartElement("Attributes")
For Each currentAttribute As AttributeMetadata In currentEntity.Attributes
' Only write out main attributes.
If currentAttribute.AttributeOf Is Nothing Then
' Start Attribute Node
metadataWriter.WriteStartElement("Attribute")
' Write Attribute's information.
metadataWriter.WriteElementString("LogicalName", currentAttribute.LogicalName)
metadataWriter.WriteElementString("Type", currentAttribute.AttributeType.Value.ToString())
If currentAttribute.GetType() Is GetType(PicklistAttributeMetadata) Then
Dim optionMetadata As PicklistAttributeMetadata = CType(currentAttribute, PicklistAttributeMetadata)
' Writes the picklist's options
metadataWriter.WriteStartElement("Options")
' Writes the attributes of each picklist option
For c As Integer = 0 To optionMetadata.OptionSet.Options.Count - 1
metadataWriter.WriteStartElement("Option")
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options(c).Value.Value.ToString())
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options(c).Label.UserLocalizedLabel.Label.ToString())
metadataWriter.WriteEndElement()
Next c
metadataWriter.WriteEndElement()
ElseIf currentAttribute.GetType() Is GetType(StateAttributeMetadata) Then
Dim optionMetadata As StateAttributeMetadata = CType(currentAttribute, StateAttributeMetadata)
' Writes the picklist's options
metadataWriter.WriteStartElement("Options")
' Writes the attributes of each picklist option
For c As Integer = 0 To optionMetadata.OptionSet.Options.Count - 1
metadataWriter.WriteStartElement("Option")
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options(c).Value.Value.ToString())
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options(c).Label.UserLocalizedLabel.Label.ToString())
metadataWriter.WriteEndElement()
Next c
metadataWriter.WriteEndElement()
ElseIf currentAttribute.GetType() Is GetType(StatusAttributeMetadata) Then
Dim optionMetadata As StatusAttributeMetadata = CType(currentAttribute, StatusAttributeMetadata)
' Writes the picklist's options
metadataWriter.WriteStartElement("Options")
' Writes the attributes of each picklist option
For c As Integer = 0 To optionMetadata.OptionSet.Options.Count - 1
metadataWriter.WriteStartElement("Option")
metadataWriter.WriteElementString("OptionValue", optionMetadata.OptionSet.Options(c).Value.Value.ToString())
metadataWriter.WriteElementString("OptionDescription", optionMetadata.OptionSet.Options(c).Label.UserLocalizedLabel.Label.ToString())
If optionMetadata.OptionSet.Options(c).GetType() Is GetType(StatusOptionMetadata) Then
Dim statusOptionMetadata As StatusOptionMetadata = CType(optionMetadata.OptionSet.Options(c), StatusOptionMetadata)
metadataWriter.WriteElementString("RelatedToState", (statusOptionMetadata.State.ToString()))
End If
metadataWriter.WriteEndElement()
Next c
metadataWriter.WriteEndElement()
End If
' End Attribute Node
metadataWriter.WriteEndElement()
End If
Next currentAttribute
' End Attributes Node
metadataWriter.WriteEndElement()
'#End Region
' End Entity Node
metadataWriter.WriteEndElement()
End If
Next currentEntity
' End Metadata Xml Node
metadataWriter.WriteEndElement()
metadataWriter.WriteEndDocument()
' Close xml writer.
metadataWriter.Close()
End Using
'#End Region ' How to dump attribute info
Console.WriteLine("Done.")
'DeleteRequiredRecords(promptForDelete);
End Using
' Catch any service fault exceptions that Microsoft Dynamics CRM throws.
Catch fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
' You can handle an exception here or pass it back to the calling method.
Throw
End Try
End Sub
''' <summary>
''' Deletes/Reverts the record that was created/changed for this sample.
''' <param name="prompt">Indicates whether to prompt the user to delete
''' the records created in this sample.</param>
''' </summary>
Public Sub DeleteRequiredRecords(ByVal prompt As Boolean)
Dim deleteRecords As Boolean = True
If prompt Then
Console.WriteLine(vbLf & "Do you want these entity records to be deleted? (y/n)")
Dim answer As String = Console.ReadLine()
deleteRecords = (answer.StartsWith("y") OrElse answer.StartsWith("Y"))
End If
If deleteRecords Then
End If
End Sub
#End Region ' How To Sample Code
#Region "Main"
''' <summary>
''' Standard Main() method used by most SDK samples.
''' </summary>
''' <param name="args"></param>
Public Shared Sub Main(ByVal args() As String)
Try
' Obtain the target organization's Web address and client logon
' credentials from the user.
Dim serverConnect As New ServerConnection()
Dim config As ServerConnection.Configuration = serverConnect.GetServerConfiguration()
Dim app As New DumpPicklistInfo()
app.Run(config, False)
Catch ex As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault)
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp)
Console.WriteLine("Code: {0}", ex.Detail.ErrorCode)
Console.WriteLine("Message: {0}", ex.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
Catch ex As TimeoutException
Console.WriteLine("The application terminated with an error.")
Console.WriteLine("Message: {0}", ex.Message)
Console.WriteLine("Stack Trace: {0}", ex.StackTrace)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is ex.InnerException.Message, "No Inner Fault", ex.InnerException.Message))
Catch ex As Exception
Console.WriteLine("The application terminated with an error.")
Console.WriteLine(ex.Message)
' Display the details of the inner exception.
If ex.InnerException IsNot Nothing Then
Console.WriteLine(ex.InnerException.Message)
Dim fe As FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault) = TryCast(ex.InnerException, FaultException(Of Microsoft.Xrm.Sdk.OrganizationServiceFault))
If fe IsNot Nothing Then
Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp)
Console.WriteLine("Code: {0}", fe.Detail.ErrorCode)
Console.WriteLine("Message: {0}", fe.Detail.Message)
Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText)
Console.WriteLine("Inner Fault: {0}", If(Nothing Is fe.Detail.InnerFault, "No Inner Fault", "Has Inner Fault"))
End If
End If
' Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,
' SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.
Finally
Console.WriteLine("Press <Enter> to exit.")
Console.ReadLine()
End Try
End Sub
#End Region ' Main
End Class
End Namespace
See Also
RetrieveAllEntitiesRequest
RetrieveAllEntitiesResponse
Customize entity metadata
Extend the metadata model
Customize entity attribute metadata