Sample: Retrieve records from an intersect table
Applies To: Dynamics CRM 2013
This sample code is 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\GeneralProgramming\Queries\RetrieveRecordsFromAnIntersectTable.cs
SampleCode\VB\GeneralProgramming\Queries\RetrieveRecordsFromAnIntersectTable.vb
Requirements
For more information about the requirements for running the sample code provided in this SDK, see Use the sample and helper code.
Example
This sample shows how to retrieve records from an intersect table:
using System;
using System.Text;
using System.Linq;
using System.Xml.Linq;
using System.ServiceModel;
// 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.Client;
using Microsoft.Xrm.Sdk.Query;
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>
/// Demonstrates how to retrieve records from an intersect table.
/// </summary>
public class RetrieveRecordsFromAnIntersectTable
{
#region Class Level Members
private Guid _userId;
private Guid _roleId;
private OrganizationServiceProxy _serviceProxy;
#endregion Class Level Members
#region How-To Sample Code
/// <summary>
/// This method first connects to the Organization service. Afterwards,
/// records are retrieved from the systemuserroles intersect table via three
/// methods: Query Expression, Fetch, and LINQ.
/// </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();
CreateRequiredRecords();
#region Retrieve records from an intersect table via QueryExpression
//Create Query Expression.
QueryExpression query = new QueryExpression()
{
EntityName = "role",
ColumnSet = new ColumnSet("name"),
LinkEntities =
{
new LinkEntity
{
LinkFromEntityName = Role.EntityLogicalName,
LinkFromAttributeName = "roleid",
LinkToEntityName = SystemUserRoles.EntityLogicalName,
LinkToAttributeName = "roleid",
LinkCriteria = new FilterExpression
{
FilterOperator = LogicalOperator.And,
Conditions =
{
new ConditionExpression
{
AttributeName = "systemuserid",
Operator = ConditionOperator.Equal,
Values = { _userId }
}
}
}
}
}
};
// Obtain results from the query expression.
EntityCollection ec = _serviceProxy.RetrieveMultiple(query);
// Display results.
for (int i = 0; i < ec.Entities.Count; i++)
{
Console.WriteLine("Query Expression Retrieved: {0}", ((Role)ec.Entities[i]).Name);
}
#endregion
#region Retrieve records from an intersect table via Fetch
// Setup Fetch XML.
StringBuilder linkFetch = new StringBuilder();
linkFetch.Append("<fetch version=\"1.0\" output-format=\"xml-platform\" mapping=\"logical\" distinct=\"true\">");
linkFetch.Append("<entity name=\"role\">");
linkFetch.Append("<attribute name=\"name\"/>");
linkFetch.Append("<link-entity name=\"systemuserroles\" from=\"roleid\" to=\"roleid\" visible=\"false\" intersect=\"true\">");
linkFetch.Append("<filter type=\"and\">");
linkFetch.Append("<condition attribute=\"systemuserid\" operator=\"eq\" value=\"" + _userId + "\"/>");
linkFetch.Append("</filter>");
linkFetch.Append("</link-entity>");
linkFetch.Append("</entity>");
linkFetch.Append("</fetch>");
// Build fetch request and obtain results.
RetrieveMultipleRequest efr = new RetrieveMultipleRequest()
{
Query = new FetchExpression(linkFetch.ToString())
};
EntityCollection entityResults = ((RetrieveMultipleResponse)_serviceProxy.Execute(efr)).EntityCollection;
// Display results.
foreach (var e in entityResults.Entities)
{
Console.WriteLine("Fetch Retrieved: {0}", e.Attributes["name"]);
}
#endregion
#region Retrieve records from an intersect table via LINQ
// Obtain the Organization Context.
OrganizationServiceContext context = new OrganizationServiceContext(_serviceProxy);
// Create Linq Query.
var roles = (from r in context.CreateQuery<Role>()
join s in context.CreateQuery<SystemUserRoles>() on r.RoleId equals s.RoleId
where s.SystemUserId == _userId
orderby r.RoleId
select r.Name);
// Display results.
foreach (var role in roles)
{
Console.WriteLine("Linq Retrieved: {0}", role);
}
#endregion
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>
/// Creates any entity records that this sample requires.
/// </summary>
public void CreateRequiredRecords()
{
// Retrieve the default business unit needed to create the team.
QueryExpression queryDefaultBusinessUnit = new QueryExpression
{
EntityName = BusinessUnit.EntityLogicalName,
ColumnSet = new ColumnSet("businessunitid"),
Criteria = new FilterExpression()
};
// Execute the request.
queryDefaultBusinessUnit.Criteria.AddCondition("parentbusinessunitid",
ConditionOperator.Null);
BusinessUnit defaultBusinessUnit = (BusinessUnit)_serviceProxy.RetrieveMultiple(
queryDefaultBusinessUnit).Entities[0];
// Get the GUID of the current user.
WhoAmIRequest who = new WhoAmIRequest();
WhoAmIResponse whoResp = (WhoAmIResponse)_serviceProxy.Execute(who);
_userId = whoResp.UserId;
// Instantiate a role entity record and set its property values.
// See the Entity Metadata topic in the SDK documentation to determine
// which attributes must be set for each entity.
Role setupRole = new Role
{
Name = "ABC Management Role",
BusinessUnitId = new EntityReference(BusinessUnit.EntityLogicalName,
defaultBusinessUnit.Id)
};
//Create a role record.
_roleId = _serviceProxy.Create(setupRole);
Console.WriteLine("Created Role.");
// Assign User to Managers role.
AssociateRequest associate = new AssociateRequest()
{
Target = new EntityReference(SystemUser.EntityLogicalName, _userId),
RelatedEntities = new EntityReferenceCollection()
{
new EntityReference(Role.EntityLogicalName, _roleId),
},
Relationship = new Relationship("systemuserroles_association")
};
// Execute the request.
_serviceProxy.Execute(associate);
}
/// <summary>
/// Deletes any entity records and files that were created 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 deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
deleteRecords = (answer.StartsWith("y") || answer.StartsWith("Y") || answer == String.Empty);
}
if (deleteRecords)
{
_serviceProxy.Delete(Role.EntityLogicalName, _roleId);
Console.WriteLine("Entity records have been deleted.");
}
}
#endregion How-To Sample Code
#region Main method
/// <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();
RetrieveRecordsFromAnIntersectTable app = new RetrieveRecordsFromAnIntersectTable();
app.Run(config, true);
}
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 method
}
}
Imports System.Text
Imports System.ServiceModel
' 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.Client
Imports Microsoft.Xrm.Sdk.Query
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>
''' Demonstrates how to retrieve records from an intersect table.
''' </summary>
Public Class RetrieveRecordsFromAnIntersectTable
#Region "Class Level Members"
Private _userId As Guid
Private _roleId As Guid
Private _serviceProxy As OrganizationServiceProxy
#End Region ' Class Level Members
#Region "How-To Sample Code"
''' <summary>
''' This method first connects to the Organization service. Afterwards,
''' records are retrieved from the systemuserroles intersect table via three
''' methods: Query Expression, Fetch, and LINQ.
''' </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()
CreateRequiredRecords()
' #Region "Retrieve records from an intersect table via QueryExpression"
'Create Query Expression.
Dim query As New QueryExpression() With
{
.EntityName = "role",
.ColumnSet = New ColumnSet("name")
}
Dim queryLinkEntity As New LinkEntity With
{
.LinkToEntityName = SystemUserRoles.EntityLogicalName,
.LinkFromAttributeName = "roleid",
.LinkToAttributeName = "roleid"
}
queryLinkEntity.LinkCriteria().AddCondition(
"systemuserid",
ConditionOperator.Equal,
_userId)
queryLinkEntity.LinkCriteria().FilterOperator = LogicalOperator.And
query.LinkEntities().Add(queryLinkEntity)
' Obtain results from the query expression.
Dim ec As EntityCollection = _serviceProxy.RetrieveMultiple(query)
' Display results.
For i As Integer = 0 To ec.Entities.Count - 1
Console.WriteLine("Query Expression Retrieved: {0}",
(CType(ec.Entities(i), Role)).Name)
Next i
' #End Region
' #Region "Retrieve records from an intersect table via Fetch"
' Setup Fetch XML.
Dim linkFetch As New StringBuilder()
linkFetch.Append("<fetch version=""1.0"" " _
& "output-format=""xml-platform"" " _
& "mapping=""logical"" distinct=""true"">")
linkFetch.Append("<entity name=""role"">")
linkFetch.Append("<attribute name=""name""/>")
linkFetch.Append("<link-entity name=""systemuserroles"" " _
& "from=""roleid"" to=""roleid"" " _
& "visible=""false"" intersect=""true"">")
linkFetch.Append("<filter type=""and"">")
linkFetch.Append("<condition attribute=""systemuserid"" " _
& "operator=""eq"" value=""" _
& _userId.ToString() & """/>")
linkFetch.Append("</filter>")
linkFetch.Append("</link-entity>")
linkFetch.Append("</entity>")
linkFetch.Append("</fetch>")
' Build fetch request and obtain results.
Dim efr As New RetrieveMultipleRequest() With
{
.Query = New FetchExpression(linkFetch.ToString())
}
Dim entityResults As EntityCollection =
(CType(_serviceProxy.Execute(efr),
RetrieveMultipleResponse)).EntityCollection
' Display results.
For Each e In entityResults.Entities
Console.WriteLine("Fetch Retrieved: {0}", e.Attributes("name"))
Next e
' #End Region
' #Region "Retrieve records from an intersect table via LINQ"
' Obtain the Organization Context.
Dim context As New OrganizationServiceContext(_serviceProxy)
' Create Linq Query.
Dim roles = ( _
From r In context.CreateQuery(Of Role)() _
Join s In context.CreateQuery(Of SystemUserRoles)() _
On r.RoleId Equals s.RoleId _
Where s.SystemUserId.Equals(_userId) _
Order By r.RoleId _
Select r.Name)
' Display results.
For Each role In roles
Console.WriteLine("Linq Retrieved: {0}", role)
Next role
' #End Region
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>
''' Creates any entity records that this sample requires.
''' </summary>
Public Sub CreateRequiredRecords()
' Retrieve the default business unit needed to create the team.
Dim queryDefaultBusinessUnit As QueryExpression =
New QueryExpression With
{
.EntityName = BusinessUnit.EntityLogicalName,
.ColumnSet = New ColumnSet("businessunitid"),
.Criteria = New FilterExpression()
}
' Execute the request.
queryDefaultBusinessUnit.Criteria.AddCondition("parentbusinessunitid",
ConditionOperator.Null)
Dim defaultBusinessUnit As BusinessUnit =
CType(_serviceProxy.RetrieveMultiple(queryDefaultBusinessUnit).Entities(0),
BusinessUnit)
' Get the GUID of the current user.
Dim who As New WhoAmIRequest()
Dim whoResp As WhoAmIResponse = CType(_serviceProxy.Execute(who),
WhoAmIResponse)
_userId = whoResp.UserId
' Instantiate a role entity record and set its property values.
' See the Entity Metadata topic in the SDK documentation to determine
' which attributes must be set for each entity.
Dim setupRole As Role = New Role With
{
.Name = "ABC Management Role",
.BusinessUnitId = New EntityReference(BusinessUnit.EntityLogicalName,
defaultBusinessUnit.Id)
}
'Create a role record.
_roleId = _serviceProxy.Create(setupRole)
Console.WriteLine("Created Role.")
' Assign User to Managers role.
Dim associate As New AssociateRequest() With
{
.Target = New EntityReference(SystemUser.EntityLogicalName, _userId),
.RelatedEntities = New EntityReferenceCollection() From
{
New EntityReference(Role.EntityLogicalName, _roleId)
},
.Relationship = New Relationship("systemuserroles_association")
}
' Execute the request.
_serviceProxy.Execute(associate)
End Sub
''' <summary>
''' Deletes any entity records and files that were created 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 deleted? (y/n) [y]: ")
Dim answer As String = Console.ReadLine()
deleteRecords = (answer.StartsWith("y") OrElse answer.StartsWith("Y") _
OrElse answer = String.Empty)
End If
If deleteRecords Then
_serviceProxy.Delete(Role.EntityLogicalName, _roleId)
Console.WriteLine("Entity records have been deleted.")
End If
End Sub
#End Region ' How-To Sample Code
#Region "Main method"
''' <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 RetrieveRecordsFromAnIntersectTable()
app.Run(config, True)
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 method
End Class
End Namespace
See Also
IOrganizationService
RetrieveMultiple
FetchExpression
RetrieveMultipleRequest
RetrieveMultiple
Retrieve records for many-to-many relationships using intersect entities
Build queries with FetchXML
Helper code: ServerConnection class