AddSolutionComponentRequest Class

Definition

public ref class AddSolutionComponentRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class AddSolutionComponentRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type AddSolutionComponentRequest = class
    inherit OrganizationRequest

Public NotInheritable Class AddSolutionComponentRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

AddSolutionComponentRequest

Attributes

DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface instance.

The following code example adds the contact entity to a solution that is specified in the SolutionUniqueName property.

/// <summary>
/// Demonstrates adding a solution component to a solution
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
/// <param name="solutionUniqueName">The unique name of the solution</param>
static void AddContactTableToSolution(IOrganizationService service, string solutionUniqueName)
{
      // Retrieve the table definition to get the ID
      RetrieveEntityRequest tableRequest = new()
      {
         LogicalName = "contact"
      };
      var tableResponse = (RetrieveEntityResponse)service.Execute(tableRequest);

      Guid contactTableId = tableResponse.EntityMetadata.MetadataId.Value;

      AddSolutionComponentRequest request = new()
      {
         ComponentType = 1, //Entity is a known component type
         ComponentId = contactTableId,
         SolutionUniqueName = solutionUniqueName
      };

   var response = (AddSolutionComponentResponse)service.Execute(request);

   Console.WriteLine($"Solution Component ID:{response.id}");
}

Remarks

For the Web API use the AddSolutionComponent action.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of AddSolutionComponentResponse class.

Privileges and Access Rights

To perform this action, the caller must have the system administrator or system customizer security role.

Notes for Callers

You can use this message when you know the appropriate ComponentType integer value to use. Most common component types are in the global optionset named componenttype, which is used as the source for the SolutionComponent.ComponentType Choice column. But not all solution components use these types. Some newer component types are not in this list. You can't use this message when you don't know the correct solution component type to use.

Instead of using this message, you should create or update the solution component for a specific solution. When you use this technique, you add the solution component to both the default solution and the specified solution. You can implement the specific-solution technique in two ways.

• Use the SolutionUniqueName parameter on the solution component create and update requests.

• Pass the SolutionUniqueNameoptional parameter to the CreateRequest or UpdateRequest.

For solution components that have a create or update request message that includes the SolutionUniqueName property, passing the unique name of the solution adds the solution component to that solution. The following messages include a SolutionUniqueName property:

• CreateAttributeRequest

• UpdateAttributeRequest

• CreateEntityRequest

• UpdateEntityRequest

• CreateManyToManyRequest

• CreateOneToManyRequest

• UpdateRelationshipRequest

• CreateOptionSetRequest

• UpdateOptionSetRequest

• UpdateOptionValueRequest

• InsertOptionValueRequest

• InsertStatusValueRequest

• OrderOptionRequest

Pass the SolutionUniqueName optional parameter to the CreateRequest or UpdateRequest.

For other solution components, add SolutionUniqueName as a parameter to the OrganizationRequest.Parameters property when you use the CreateRequest or UpdateRequest messages. For more information, Associate a solution component with a solution using an optional parameter

Supported Tables

This message can only be used for tables that represent solution components.

Adding Application Ribbons to a Solution

When you use AddSolutionComponentRequest to add application ribbons to your solution, you must make sure to include the RibbonCustomization solution component that is associated with the active solution. Use the Active Solution.SolutionId (FD140AAE-4DF4-11DD-BD17-0019B9312238) in the query you use to retrieve the RibbonCustomization record.

/// <summary>
/// Demonstrates retrieving ribbon customizations from the active solution
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
static void RetrieveActiveRibbonCustomizationExample(IOrganizationService service)
{
      Guid activeSolutionId = new("FD140AAE-4DF4-11DD-BD17-0019B9312238");

      QueryExpression query = new QueryExpression("ribboncustomization")
      {
         ColumnSet = new ColumnSet("ribboncustomizationid"),
         Criteria = new FilterExpression()
      };
      query.Criteria.AddCondition("entity", ConditionOperator.Null);
      query.Criteria.AddCondition("solutionid", ConditionOperator.Equal, activeSolutionId);

      EntityCollection RibbonCustomizations = service.RetrieveMultiple(query);
      Entity response = RibbonCustomizations.Entities[0];
      Guid id = response.GetAttributeValue<Guid>("ribboncustomizationid");
      Console.WriteLine($"ribboncustomizationid: {id}");
}

Constructors

Properties

Applies to

See also

• AddSolutionComponentResponse