Sample: Query connection roles by entity type code (early bound)
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\BusinessDataModel\BusinessManagement\QueryConnectionRolesByEntityTypeCode.cs
SampleCode\VB\BusinessDataModel\BusinessManagement\QueryConnectionRolesByEntityTypeCode.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 use a query to find a connection role for an account entity by specifying an entity type code.
Example
using System;
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;
namespace Microsoft.Crm.Sdk.Samples
{
/// <summary>
/// This sample shows how to find connection roles by object type code.
/// </summary>
public class QueryConnectionRolesByEntityTypeCode
{
#region Class Level Members
/// <summary>
/// Stores the organization service proxy.
/// </summary>
private OrganizationServiceProxy _serviceProxy;
// Define the IDs needed for this sample.
private Guid _connectionRoleId;
#endregion Class Level Members
#region How To Sample Code
/// <summary>
/// This sample creates a role that is not linked to any entity type. All
/// connection roles that apply to all are found and shown. Then the role is
/// linked to the account entity and it is demonstrated that the role only works
/// for accounts at this point, not for all. Subsequently the link to the account
/// entity is removed and it is shown that the role is now applicable to all
/// entities again.
/// </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();
// Define some anonymous types to define the range
// of possible connection property values.
var Categories = new
{
Business = 1,
Family = 2,
Social = 3,
Sales = 4,
Other = 5
};
// Create a Connection Role.
ConnectionRole setupConnectionRole = new ConnectionRole
{
Name = "Example Connection Role",
Category = new OptionSetValue(Categories.Business),
};
_connectionRoleId = _serviceProxy.Create(setupConnectionRole);
setupConnectionRole.Id = _connectionRoleId;
Console.WriteLine("Created {0}.", setupConnectionRole.Name);
// Query for all Connection Roles.
QueryExpression allQuery = new QueryExpression
{
EntityName = ConnectionRole.EntityLogicalName,
ColumnSet = new ColumnSet("connectionroleid", "name"),
Distinct = true,
LinkEntities =
{
new LinkEntity
{
LinkToEntityName =
ConnectionRoleObjectTypeCode.EntityLogicalName,
LinkToAttributeName = "connectionroleid",
LinkFromEntityName = ConnectionRole.EntityLogicalName,
LinkFromAttributeName = "connectionroleid",
LinkCriteria = new FilterExpression
{
FilterOperator = LogicalOperator.And,
// Set a condition to only get connection roles
// related to all entities (object type code = 0).
Conditions =
{
new ConditionExpression
{
AttributeName = "associatedobjecttypecode",
Operator = ConditionOperator.Equal,
Values = { 0 }
}
}
}
}
}
};
EntityCollection results = _serviceProxy.RetrieveMultiple(allQuery);
// Here you could perform operations on all of
// the connectionroles found by the query.
Console.WriteLine("Retrieved {0} unassociated connectionrole instance(s).",
results.Entities.Count);
// Query to find roles which apply only to accounts.
QueryExpression accountQuery = new QueryExpression
{
EntityName = ConnectionRole.EntityLogicalName,
ColumnSet = new ColumnSet("connectionroleid", "name"),
Distinct = true,
LinkEntities =
{
new LinkEntity
{
LinkToEntityName =
ConnectionRoleObjectTypeCode.EntityLogicalName,
LinkToAttributeName = "connectionroleid",
LinkFromEntityName = ConnectionRole.EntityLogicalName,
LinkFromAttributeName = "connectionroleid",
LinkCriteria = new FilterExpression
{
FilterOperator = LogicalOperator.And,
// Set a condition to only get connection roles
// related to accounts (object type code = 1).
Conditions =
{
new ConditionExpression
{
AttributeName = "associatedobjecttypecode",
Operator = ConditionOperator.In,
Values = { Account.EntityLogicalName }
}
}
}
}
}
};
results = _serviceProxy.RetrieveMultiple(accountQuery);
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).",
results.Entities.Count);
// Create a related Connection Role Object Type Code record for
// Account.
ConnectionRoleObjectTypeCode setupAccountConnectionRoleTypeCode
= new ConnectionRoleObjectTypeCode
{
ConnectionRoleId = new EntityReference(
ConnectionRole.EntityLogicalName, _connectionRoleId),
AssociatedObjectTypeCode = Account.EntityLogicalName
};
setupAccountConnectionRoleTypeCode.Id =
_serviceProxy.Create(setupAccountConnectionRoleTypeCode);
Console.Write("Created a related Connection Role Object Type Code");
Console.Write(" record for Account.");
// Run the query to find unassociated connectionroles again.
results = _serviceProxy.RetrieveMultiple(allQuery);
Console.WriteLine(@"Retrieved {0} unassociated connectionrole instance(s).",
results.Entities.Count);
// Run the account-only query again.
results = _serviceProxy.RetrieveMultiple(accountQuery);
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).",
results.Entities.Count);
// Remove the link from account entity.
_serviceProxy.Delete(ConnectionRoleObjectTypeCode.EntityLogicalName,
setupAccountConnectionRoleTypeCode.Id);
Console.WriteLine("Removed link from connectionrole to account entity.");
// Run the query to find unassociated connectionroles again.
results = _serviceProxy.RetrieveMultiple(allQuery);
Console.WriteLine("Retrieved {0} unassociated connectionrole instance(s).",
results.Entities.Count);
// Run the account-only query again.
results = _serviceProxy.RetrieveMultiple(accountQuery);
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).",
results.Entities.Count);
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 any entity records 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 toBeDeleted = true;
if (prompt)
{
// Ask the user if the created entities should be deleted.
Console.Write("\nDo you want these entity records deleted? (y/n) [y]: ");
String answer = Console.ReadLine();
if (answer.StartsWith("y") ||
answer.StartsWith("Y") ||
answer == String.Empty)
{
toBeDeleted = true;
}
else
{
toBeDeleted = false;
}
}
if (toBeDeleted)
{
// Delete all records created in this sample.
_serviceProxy.Delete(ConnectionRole.EntityLogicalName, _connectionRoleId);
Console.WriteLine("Entity record(s) have been deleted.");
}
}
#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();
QueryConnectionRolesByEntityTypeCode app = new QueryConnectionRolesByEntityTypeCode();
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
}
}
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
Namespace Microsoft.Crm.Sdk.Samples
''' <summary>
''' This sample shows how to find connection roles by object type code.
''' </summary>
Public Class QueryConnectionRolesByEntityTypeCode
#Region "Class Level Members"
''' <summary>
''' Stores the organization service proxy.
''' </summary>
Private _serviceProxy As OrganizationServiceProxy
' Define the IDs needed for this sample.
Private _connectionRoleId As Guid
#End Region ' Class Level Members
#Region "How To Sample Code"
''' <summary>
''' This sample creates a role that is not linked to any entity type. All
''' connection roles that apply to all are found and shown. Then the role is
''' linked to the account entity and it is demonstrated that the role only works
''' for accounts at this point, not for all. Subsequently the link to the account
''' entity is removed and it is shown that the role is now applicable to all
''' entities again.
''' </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()
' Define some anonymous types to define the range
' of possible connection property values.
Dim Categories = New With {Key .Business = 1, Key .Family = 2, Key .Social = 3, Key .Sales = 4, Key .Other = 5}
' Create a Connection Role.
Dim setupConnectionRole As ConnectionRole = New ConnectionRole With { _
.Name = "Example Connection Role", .Category = New OptionSetValue(Categories.Business)}
_connectionRoleId = _serviceProxy.Create(setupConnectionRole)
setupConnectionRole.Id = _connectionRoleId
Console.WriteLine("Created {0}.", setupConnectionRole.Name)
' Query for all Connection Roles.
Dim allQuery As QueryExpression = New QueryExpression With { _
.EntityName = ConnectionRole.EntityLogicalName, _
.ColumnSet = New ColumnSet("connectionroleid", "name"), .Distinct = True}
allQuery.AddLink(ConnectionRoleObjectTypeCode.EntityLogicalName, "connectionroleid", "connectionroleid").LinkCriteria() = _
New FilterExpression()
allQuery.LinkEntities(0).LinkCriteria().AddCondition("associatedobjecttypecode", ConditionOperator.Equal, {0})
allQuery.LinkEntities(0).LinkCriteria().FilterOperator = LogicalOperator.And
' Set a condition to only get connection roles
' related to all entities (object type code = 0).
Dim results As EntityCollection = _serviceProxy.RetrieveMultiple(allQuery)
' Here you could perform operations on all of
' the connectionroles found by the query.
Console.WriteLine("Retrieved {0} unassociated connectionrole instance(s).", results.Entities.Count)
' Query to find roles which apply only to accounts.
Dim accountQuery As QueryExpression = New QueryExpression With { _
.EntityName = ConnectionRole.EntityLogicalName, _
.ColumnSet = New ColumnSet("connectionroleid", "name"), .Distinct = True}
accountQuery.AddLink(ConnectionRoleObjectTypeCode.EntityLogicalName, "connectionroleid", "connectionroleid").LinkCriteria = _
New FilterExpression()
accountQuery.LinkEntities(0).LinkCriteria.AddCondition("associatedobjecttypecode", ConditionOperator.In, _
{Account.EntityLogicalName})
accountQuery.LinkEntities(0).LinkCriteria.FilterOperator = LogicalOperator.And
' Set a condition to only get connection roles
' related to accounts (object type code = 1).
results = _serviceProxy.RetrieveMultiple(accountQuery)
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).", results.Entities.Count)
' Create a related Connection Role Object Type Code record for
' Account.
Dim setupAccountConnectionRoleTypeCode As ConnectionRoleObjectTypeCode = _
New ConnectionRoleObjectTypeCode With {.ConnectionRoleId = _
New EntityReference(ConnectionRole.EntityLogicalName, _connectionRoleId), _
.AssociatedObjectTypeCode = Account.EntityLogicalName}
setupAccountConnectionRoleTypeCode.Id = _serviceProxy.Create(setupAccountConnectionRoleTypeCode)
Console.Write("Created a related Connection Role Object Type Code")
Console.Write(" record for Account.")
' Run the query to find unassociated connectionroles again.
results = _serviceProxy.RetrieveMultiple(allQuery)
Console.WriteLine("Retrieved {0} unassociated connectionrole instance(s).", results.Entities.Count)
' Run the account-only query again.
results = _serviceProxy.RetrieveMultiple(accountQuery)
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).", results.Entities.Count)
' Remove the link from account entity.
_serviceProxy.Delete(ConnectionRoleObjectTypeCode.EntityLogicalName, setupAccountConnectionRoleTypeCode.Id)
Console.WriteLine("Removed link from connectionrole to account entity.")
' Run the query to find unassociated connectionroles again.
results = _serviceProxy.RetrieveMultiple(allQuery)
Console.WriteLine("Retrieved {0} unassociated connectionrole instance(s).", results.Entities.Count)
' Run the account-only query again.
results = _serviceProxy.RetrieveMultiple(accountQuery)
Console.WriteLine("Retrieved {0} account-only connectionrole instance(s).", results.Entities.Count)
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 any entity records 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 toBeDeleted As Boolean = True
If prompt Then
' Ask the user if the created entities should be deleted.
Console.Write(vbLf & "Do you want these entity records deleted? (y/n) [y]: ")
Dim answer As String = Console.ReadLine()
If answer.StartsWith("y") OrElse answer.StartsWith("Y") OrElse answer = String.Empty Then
toBeDeleted = True
Else
toBeDeleted = False
End If
End If
If toBeDeleted Then
' Delete all records created in this sample.
_serviceProxy.Delete(ConnectionRole.EntityLogicalName, _connectionRoleId)
Console.WriteLine("Entity record(s) have been deleted.")
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 QueryConnectionRolesByEntityTypeCode()
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
End Class
End Namespace
See Also
Sample code for connection entities
Connection entities
Sample: Query connections by reciprocal roles (early bound)