CreateConfigurationFromModel

Method

CreateConfigurationFromModel(NewModelConfigParameters parameters)

If using the provided Contracts DLL, this method is called by using the overloaded CreateConfiguration method and passing in an instance of NewModelConfigParameters.

This method creates a new configuration for the specified header record in the integration system and initiates the Configurator session. The configuration is appended to any configurations that may already exist for the specified header.

CreateConfigurationFromModel provides a convenient mechanism for creating the default configuration for the specified Series/Model combination.

Parameters

The CreateConfigurationFromModel() method requires a parameters parameter of type NewModelConfigParameters.

NewModelConfigParameters

An instance of NewModelConfigParameters is passed into the CreateConfigurationFromModel method. It provides the necessary information to create a configuration from a specified Series/Model.

Constructors

NewModelConfigParameters()

NewModelConfigParameters(ConfigHeader header, string seriesId, string modelId, int? lineItemId = null)

NewModelConfigParameters(ConfigHeader header, string seriesId, string modelId, string modelVariantId, int? lineItemId = null)

Properties

Data Type	Property	Description
string	SeriesId	Returns or sets the Series ID for the new configuration.
string	ModelId	Returns or sets the Model ID for the new configuration.
string	ModelVariantId*	Returns or sets the model variant ID (if applicable) for the new configuration.
int?	LineItemId	Returns or sets the line item id for the new configuration.
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.
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.

*modelVarianttId is only passed into the constructor if model variants are used in the configuration.

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.

Returns

CreateConfigurationResult

An instance of CreateConfigurationResultis returned by the CreateConfigurationFromCopy, CreateConfigurationFromModel, and CreateConfigurationFromXML methods. It does not contain any unique properties.

Inheritance

ConfigurationResult

The returned ConfigurationResult object contains general information about the configuration. It is a base class inherited many of the "result" objects, such as SaveConfigurationResult or CreateConfigurationResult.

Properties

Data Type	Property	Description
ConfigHeader	Header	Returns or sets the Config Header (ID + entity type).
ConfigurationResultCode	ResultCode Possible Values: Success Failure	Returns or sets whether the operation was successful and without errors.
ConfigurationResultMessage[]	ResultMessages	Returns or sets resulting messages from the configuration action.
ConfigurationFailureCode	FailureCode Possible Values: None SiteUnderMaintenance CompatEngineNotInitialized ServiceDisabled InvalidArgument InvalidOperation	In the event the ResultCode is Failure, returns a code identifying the type of failure
int	LineItemId	Returns or sets the line item id of the configuration. This is valid when the ConfigResult instance is a result of the IWebConfig.SaveConfiguration() or the IWebConfig.FixConfiguration() methods, otherwise the value is -1.
Configuration	Configuration	Returns or sets a Configuration object containing various properties relating to the current configuration. This will only ever be assigned if the Configuration is relevant to the operation that was executed.
ConfigurationStateGraphBase	StateGraph	Returns or sets a StateGraph object containing various properties relating to the current configuration. This will only ever be assigned if the ConfigParameters.OperationBehaviors.StateGraphParameters property is provided on the request.
DiagnosticData	DiagnosticData	Returns the DiagnosticData associated with the operation. This will only ever be assigned if theConfigParameters.DiagnosticOutput property is provided on the request.
SessionContext	SessionContext	Returns a SessionContext object containing server-side properties that pertain to the current configuration session.