NewXmlConfigParameters

An instance of NewXmlConfigParameters is passed into the CreateConfigurationFromXML method. It provides the necessary information to create a configuration from existing XML.

Constructors

NewXmlConfigParameters()

NewXmlConfigParameters(ConfigHeader header, string lineItemXml, int? lineItemId = null)

The NewXmlConfigParameters class is derived from the ParametersBase class and requires the following arguments to be passed into its constructor.

Properties

Data Type	Property	Description
String	LineItemXml	Returns or sets the configuration XML to use as the basis for the new configuration.
Int?	LineItemId	Returns or sets the configuration number to load.
AutoUpdateConfigurationType	AutoUpdateConfiguration	Specifies whether the configuration should be automatically evaluated, executing rules and applying their effects upon creation of the configuration. The default behavior is to auto-execute rules; this is in contrast to the Web UI where the rules do not fire automatically when loading XML (because it runs under the assumption that when given XML, it's loading a saved configuration) Valid values include: None All
ConfigContextProperty[]	ContextProperties	Returns or sets the context properties (Inbound Properties) passed into the configurator to be evaluated during initialization.
String	UILanguage	Returns or sets the language culture to use in the configuration. The designation may be a specific culture (e.g. en-US, nl-NL, es-MX) or a neutral culture (e.g., en, nl, es). If omitted, or NULL, the default of 'en-US' will be used.
String	FormattingCulture	Returns or sets the default culture to use when formatting values in the configuration. The designation may be a specific culture (e.g. en-US, nl-NL, es-MX) or a neutral culture (e.g., en, nl, es). If omitted, or NULL, the default of 'en-US' will be used.
ConfigChange[]	Changes	Returns or sets and array of changes to make to the configuration.
Bool	IndividualizeChanges	If true, an implied instance of `UpdateConfigurationChange` is executed between each change and the configuration will be updated and recalculated between each change. If false, the configuration will not be updated between changes, improving performance but potentially introducing problems with rules logic.

Inheritance

ConfigParameters

The ConfigParameters class represents contextual information needed by the integration libraries for the Web Configurator Service.

Constructors

ConfigParameters()

ConfigParameters(ConfigHeader header)

Properties

Data Type	Property	Description
ConfigHeader	Header	Returns or sets the header (type and id) of the record in the host system being configured.

Inheritance

ParametersBase

The ParametersBase class is the base class for the parameters types that are passed in to various methods on the service. All parameters-derived types have the parameters listed below.

Properties

Data Type	Property	Description
bool	OmitConfigurationXmlFromResult	Returns or sets whether or not the configuration xml should be omitted from the result object. In general, the various methods that interact with the service will cause the configuration XML to be returned to the caller each time. It can be bandwidth and processing intensive to recreate the XML for each call. By setting this property to True, those steps will be skipped resulting in less data being transmitted and less server-side processing.
OperationsBehaviors	OperationBehaviors	This property is used to provide additional contextual behaviors to the service call. Provide an instance of the OperationBehaviors class with properties set to identify whether the configuration should be saved (via the Stateless services) or whether a StateGraph should be returned with the result of the web service call.
DiagnosticOutput	DiagnosticOutput	Specifies the type of diagnostic information that should be returned as a result of the service call. Available values include: None RulesExecuted RulesMessages RulesChanges This provides access to the rules that were executed along with their associated messages and changes. If set to a value other than None, the DiagnosticData property of the various Result objects will be populated.
bool	ValidateRequiredProperties	Returns or sets a value indicating whether the configuration should be validated for required Property values. The default value is true.