Using Batch Configuration Mode

The Configurator XML interface lets you configure and/or save configurations in batch mode.

The batch request is processed separately from other elements in the request. In addition, it supersedes any other elements included in the same request. Therefore, if the batch attribute is included in the request and its value is true, then the only operation performed during that post to the servlet will be the batch configuration processing. Any other elements/attributes in the request will be ignored.

Click to jump to top of pageClick to jump to parent topicElements and Attributes

The COP XML request must include these attributes to process a configuration in batch mode.

CONFIGURATION batch
	CONFIG_XML

The batch attribute indicates whether this is a batch request. Valid values are true/false.

The COP XML response may include these elements and attributes to return information about a batch configuration.

CONFIG_XML isValid wasSaved
	VIOLATIONS
		EXPLANATION
	Component/CompoundConfiguration

isValid indicates if the configuration was valid. Values are true/false.

The method wasSaved indicates if the configuration was saved. Values are true/false.

The VIOLATIONS element contains an EXPLANATION element for every violation in the configuration. Each EXPLANATION element contains the why help for that particular violation.

See Also

Configuring a Component

Configuring a Compound Configuration

Click to jump to top of pageClick to jump to parent topicConfiguring a Component

To configure a component configuration in batch mode the CONFIG_XML element in the request may include these elements and attributes to contain the information about the configuration: 

Component name comment solutionId id
	CONFIGURATION COMPILE_VERSION SOLVE_DATE MODEL_ID MODEL_VERSION
		ATTRIBUTE_SET
			ATTRIBUTE name
		CH DM DP QTY ST TY
		EVCH DP TY VAL
		NUM NM TP VAL

The COP XML response may include these elements and attributes to return information about a component configuration.

Component name comment solutionId id configCode
	CONFIGURATION COMPILE_VERSION XML_GENERATED_DATE SOLVE_DATE MODEL_ID MODEL_VERSION
		ATTRIBUTE_SET
			ATTRIBUTE name
		CH DM DP QTY ST TY
		EVCH DP TY VAL
		NUM NM TP VAL

Note that the request and response are essentially identical and are the product of a call to the calico.configurator.cop.Component.toXML method.

Click to jump to top of pageClick to jump to parent topicConfiguring a Compound Configuration

To configure a compound configuration in batch mode the CONFIG_XML element in the request may include these elements and attributes to contain the information about the configuration: 

CompoundConfiguration name type version owner comment solutionId id
	Components
		ConfigurableComponent name component comment id violation
			CONFIGURATION COMPILE_VERSION SOLVE_DATE MODEL_ID MODEL_VERSION
				ATTRIBUTE_SET
					ATTRIBUTE name
				CH DM DP QTY ST TY
				EVCH DP TY VAL
				NUM NM TP VAL
	Connections
		Connection id name ref comment component ReverseConnection
			Structure
				ConnectedComponent id component name

The COP XML response may include these elements and attributes to return information about a compound configuration. 

CompoundConfiguration name type version owner comment solutionId id configCode
	Components
		ConfigurableComponent name component comment id violation
			CONFIGURATION COMPILE_VERSION XML_GENERATED_DATE SOLVE_DATE MODEL_ID MODEL_VERSION
				ATTRIBUTE_SET
					ATTRIBUTE name
				CH DM DP QTY ST TY
				EVCH DP TY VAL
				NUM NM TP VAL
	Connections
		Connection id name ref comment component ReverseConnection
			Structure
				ConnectedComponent id component name

Note that the request and response are virtually identical and are the product of a call to the method calico.cms.runtime.CompoundConfiguration.toXML.

Click to jump to top of pageClick to jump to parent topicSaving a Configuration

The COPXML request to save a component/compound configuration in batch mode is the same as the request to configure with the addition of a saveConfig attribute on the CONFIGURATION element.

Valid values for the saveConfig attribute are:

ALWAYS

Always saves the configuration.

VALID

Only saves the configuration if it is valid.

The COPXML response from a request to save a component/compound configuration in batch mode contains the same structure as the response to a configure request.

Click to jump to top of pageClick to jump to parent topicRetrieving a Configuration

The COPXML request must include these attributes to retrieve the XML for a configuration in batch mode. 

CONFIGURATION configId solutionId configXml validate

Attributes are:

configId

Specifies the id of the configuration that you want to retrieve.

solutionId

Indicates the solution for the configuration.

configXml

Indicates that this is a retrieve operation.

validate

Indicates to validate the configuration before generating the response.

The COPXML response contains the same structure as the response to a configure request. Please refer to appropriate configure section for details.