ExportSolutionRequest Class

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that’s needed to export a solution.

For the Web API use the ExportSolution Action.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.ExportSolutionRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ExportSolutionRequest : OrganizationRequest

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class ExportSolutionRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	ExportSolutionRequest()	Initializes a new instance of the ExportSolutionRequest class

Properties

	Name	Description
	ExportAutoNumberingSettings	Gets or sets whether auto numbering settings should be included in the solution being exported. Optional.
	ExportCalendarSettings	Gets or sets whether calendar settings should be included in the solution being exported. Optional.
	ExportCustomizationSettings	Gets or sets whether customization settings should be included in the solution being exported. Optional.
	ExportEmailTrackingSettings	Gets or sets whether email tracking settings should be included in the solution being exported. Optional.
	ExportExternalApplications
	ExportGeneralSettings	Gets or sets whether general settings should be included in the solution being exported. Optional.
	ExportIsvConfig	Gets or sets whether ISV.Config settings should be included in the solution being exported. Optional.
	ExportMarketingSettings	Gets or sets whether marketing settings should be included in the solution being exported. Optional.
	ExportOutlookSynchronizationSettings	Gets or sets whether outlook synchronization settings should be included in the solution being exported. Optional.
	ExportRelationshipRoles	Gets or sets whether relationship role settings should be included in the solution being exported. Optional.
	ExportSales	Gets or sets whether sales settings should be included in the solution being exported. Optional.
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	Managed	Gets or sets whether the solution should be exported as a managed solution. Required.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	SolutionName	Gets or sets the unique name of the solution to be exported. Required.
	TargetVersion	Get or set a value indicating the version that the exported solution will support.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of ExportSolutionResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in ExportSolution message privileges.

Notes for Callers

The properties of this request correspond to the options in the export solution dialog box in the application. The following table describes the settings included with each of the Export* settings.

Setting	Display Name	Description
Organization.CampaignPrefix	Campaign Prefix	Prefix used for campaign numbering.
Organization.CasePrefix	Case Prefix	Prefix to use for all cases throughout Microsoft Dynamics 365.
Organization.ContractPrefix	Contract Prefix	Prefix to use for all contracts throughout Microsoft Dynamics 365.
Organization.InvoicePrefix	Invoice Prefix	Prefix to use for all invoice numbers throughout Microsoft Dynamics 365.
Organization.KbPrefix	Article Prefix	Prefix to use for all articles in Microsoft Dynamics 365.
Organization. OrderPrefix	Order Prefix	Prefix to use for all orders throughout Microsoft Dynamics 365.
Organization.UniqueSpecifierLength	Unique String Length	Number of characters appended to invoice, quote, and order numbers.
Organization.CalendarType	Calendar Type	Calendar type for the system. Set to Gregorian US by default.
Organization.DateFormatCode	Date Format Code	Information about how the date is displayed throughout Microsoft Dynamics 365.
Organization.DateSeparator	Date Separator	Character used to separate the month, the day, and the year in dates throughout Microsoft Dynamics 365.
Organization.MaxAppointmentDurationDays	Max Appointment Duration	Maximum number of days an appointment can last.
Organization.ShowWeekNumber	Show Week Number	Information that specifies whether to display the week number in calendar displays throughout Microsoft CRM.
Organization.TimeFormatCode	Time Format Code	Information that specifies how the time is displayed throughout Microsoft CRM.
Organization.WeekStartDayCode	Week Start Day Code	Designated first day of the week throughout Microsoft Dynamics CRM.
Organization.IsAppMode	Is Application Mode Enabled	Indicates whether loading of Microsoft Dynamics CRM in a browser window that does not have address, tool, and menu bars is enabled.
Organization.AllowUnresolvedPartiesOnEmailSend	Allow Unresolved Address E-mail Send	Indicates whether users are allowed to send e-mail to unresolved parties (parties must still have an e-mail address).
Organization.IgnoreInternalEmail	Ignore Internal E-mail	Indicates whether incoming e-mail sent by internal Microsoft Dynamics CRM users or queues should be tracked.
Organization.MaximumTrackingNumber	Max Tracking Number	Maximum tracking number before recycling takes place.
Organization.RenderSecureIFrameForEmail	Render Secure Frame For E-mail	Flag to render the body of e-mail in the Web form in an IFRAME with the security='restricted' attribute set. This is additional security but can cause a credentials prompt.
Organization.TrackingPrefix	Tracking Prefix	History list of tracking token prefixes.
Organization.TrackingTokenIdBase	Tracking Token Base	Base number used to provide separate tracking token identifiers to users belonging to different deployments.
Organization.TrackingTokenIdDigits	Tracking Token Digits	Number of digits used to represent a tracking token identifier.
Organization.BlockedAttachments	Block Attachments	Prevent upload or download of certain attachment types that are considered dangerous.
Organization.CurrencyFormatCode	Currency Format Code	Information about how currency symbols are placed throughout Microsoft Dynamics CRM.
Organization.CurrencySymbol	Currency Symbol	Currency Symbol
Organization.FullNameConventionCode	Full Name Display Order	Order in which names are to be displayed throughout Microsoft CRM.
Organization.GetStartedPaneContentEnabled	Is Get Started Pane Content Enabled	Indicates whether Get Started content is enabled for this organization.
Organization.IsPresenceEnabled	Presence Enabled	Information on whether IM presence is enabled.
Organization.NegativeFormatCode	Negative Format	Information that specifies how negative numbers are displayed throughout Microsoft CRM.
Organization.NumberFormat	Number Format	Specification of how numbers are displayed throughout Microsoft CRM.
Organization.PricingDecimalPrecision	Pricing Decimal Precision	Number of decimal places that can be used for prices.
Organization.ShareToPreviousOwnerOnAssign	Share To Previous Owner On Assign	Information that specifies whether to share to previous owner on assign.
Organization.IsAutoSaveEnabled	Auto Save Enabled	Information on whether auto save is enabled.
Organization.GlobalHelpUrl	Global Help URL	URL for the web page global help.
Organization.GlobalHelpUrlEnabled	Is Customizable Global Help enabled	Indicates whether the customizable global help is enabled.
Organization.GlobalAppendUrlParametersEnabled	Is AppendUrl Parameters enabled	Indicates whether the append URL parameters is enabled.
Organization.MobileClientMashupEnabled	Is Mobile Client Mashup enabled	Indicates whether the mobile client mashup is enabled.
The XML representing the ISV.Config.
Organization.AllowAutoResponseCreation	Allow Automatic Response Creation	Indicates whether automatic response creation is allowed.
Organization.AllowAutoUnsubscribe	Allow Automatic Unsubscribe	Indicates whether automatic unsubscribe is allowed.
Organization.AllowAutoUnsubscribeAcknowledgement	Allow Automatic Unsubscribe Acknowledgement	Indicates whether automatic unsubscribe acknowledgement e-mail is allowed to send.
Organization.AllowMarketingEmailExecution	Allow Marketing E-mail Execution	Indicates whether marketing e-mails execution is allowed.
Organization.AllowAddressBookSyncs	Allow Address Book Synchronization	Indicates whether background address book synchronization in Microsoft Office Outlook is allowed.
Organization.AllowOfflineScheduledSyncs	Allow Offline Scheduled Synchronization	Indicates whether background offline synchronization in Microsoft Office Outlook is allowed.
Organization.AllowOutlookScheduledSyncs	Allow Scheduled Synchronization	Indicates whether scheduled synchronizations to Outlook are allowed.
Organization.EmailSendPollingPeriod	E-mail Send Polling Frequency	Normal polling frequency used for sending e-mail in Microsoft Office Outlook.
Organization.MinAddressBookSyncInterval	Min Address Synchronization Frequency	Normal polling frequency used for address book synchronization in Microsoft Office Outlook.
Organization.MinOfflineSyncInterval	Min Offline Synchronization Frequency	Normal polling frequency used for background offline synchronization in Microsoft Office Outlook.
Organization.MinOutlookSyncInterval	Min Synchronization Frequency	Minimum allowed time between scheduled Outlook synchronizations.
Organization.TagMaxAggressiveCycles	Auto-Tag Max Cycles	Maximum number of aggressive polling cycles executed for e-mail auto-tagging when a new e-mail is received.
Organization.TagPollingPeriod	Auto-Tag Interval	Normal polling frequency used for e-mail receive auto-tagging in outlook.
Organization.UseInbuiltRuleForDefaultPricelistSelection	Use Inbuilt Rule For Default Pricelist Selection	Flag indicates whether to Use Inbuilt Rule For DefaultPricelist.
Organization.MaxProductsInBundle	Bundle Item Limit	Restrict the maximum no of items in a bundle
Organization.OOBPriceCalculationEnabled	Enable OOB Price calculation	Enable OOB pricing calculation logic for Opportunity, Quote, Order and Invoice entities.
Organization.DiscountCalculationMethod	Discount calculation method	Discount calculation method for the QOOI product.
Organization.MaximumDynamicPropertiesAllowed	Product Properties Item Limit	Restrict the maximum number of product properties for a product family/bundle
Organization.CreateProductsWithoutParentInActiveState	Enable Active Initial Product State	Enable Initial state of newly created products to be Active instead of Draft

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. For the complete sample, see the link later in this topic.


// Export or package a solution
//Export an a solution

ExportSolutionRequest exportSolutionRequest = new ExportSolutionRequest();
exportSolutionRequest.Managed = false;
exportSolutionRequest.SolutionName = solution.UniqueName;

ExportSolutionResponse exportSolutionResponse = (ExportSolutionResponse)_serviceProxy.Execute(exportSolutionRequest);

byte[] exportXml = exportSolutionResponse.ExportSolutionFile;
string filename = solution.UniqueName + ".zip";
File.WriteAllBytes(outputDir + filename, exportXml);

Console.WriteLine("Solution exported to {0}.", outputDir + filename);


' Export or package a solution
'Export an a solution
Dim outputDir As String = "C:\temp\"

Dim exportSolutionRequest As New ExportSolutionRequest()
exportSolutionRequest.Managed = False
exportSolutionRequest.SolutionName = solution.UniqueName

Dim exportSolutionResponse As ExportSolutionResponse =
 CType(_serviceProxy.Execute(exportSolutionRequest), ExportSolutionResponse)

Dim exportXml() As Byte = exportSolutionResponse.ExportSolutionFile
Dim filename As String = solution.UniqueName &amp; ".zip"
File.WriteAllBytes(outputDir &amp; filename, exportXml)

Console.WriteLine("Solution exported to {0}.", outputDir &amp; filename)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.