Understanding the Configurator XML Interface

This chapter provides an overview of the Advanced Configurator XML interface and discusses:

• Resquest-response.

• Elements and attributes.

• Retrieving model information.

• Updating a configuration.

Request-Response

The COPXMLServlet translates COP XML to COP Java calls, and COP Java returns to COP XML. The servlet is installed with Advanced Configurator. If you installed Advanced Configurator in the default directory, the COPXMLServlet is in this file:

.\bea\weblogic81\config\Calico\applications\Calico\WEB-INF\lib\advisor.jar 

You post a request to, and receive a response from, the servlet at COPXML on the computer where you installed the Configurator; for example, to post directly to the application server, use an URL like this:

http://MyComputer:7777/copxml 

The COPXMLServlet and COP XML do not mimic the COP Java API. Instead, in one round trip, the COPXMLServlet:

• Bundles all of the requests included in the COP XML HTTP POST request.

• Makes all of the necessary COP Java calls required to process the requests.

• Processes everything that is returned by the COP, bundles it, and returns it in a single COP XML HTTP POST response.

Elements and Attributes

The COP XML request may include these elements:

CONFIGURATION 
	DECISION_POINTS 
	CHOICES 
		CH
		EVCH
	CONTROL_DATA 
		ATTR 
		DP 
			ATTR 
	NUMERIC_VALUES 
	EXTERN_VARS
		EV
	VIOLATIONS 

The Configurator XML interface lets you retrieve information about a model, including:

• Model name, version, and compile version, using attributes of the CONFIGURATION element.

• Error messages for an invalid element name, attribute name, or attribute value; omitting an attribute; or an abnormal processing error.

• A set of decision points, using the ALL attribute of the DECISION_POINTS element.

The CONFIGURATION element is required. Other elements are optional. Attributes of elements further specify the request. The COP XML response can include other elements and attributes, but is similar to the request.

The COP XML request-response pair can:

• Retrieve information about a model.

• Update a configuration (interactive mode).

• Retrieve information about a configuration (interactive mode).

• Create, update, save, or retrieve a configuration (batch mode).

• Change the order status of a configuration.

Retrieving Model Information

The Configurator XML interface lets you retrieve information about a model, including:

• Model name, version, and compile version.

• Error messages for an invalid request, or an abnormal processing error.

• A list of decision points.

See Also

Retrieving Model Information

Updating a Configuration Interactively

The Configurator XML interface lets you update a configuration interactively by making choices or entering values for an external variable, that is, by:

• Selecting a domain member for a single-select decision point.

• Selecting one or more domain members for a multi-select decision point.

• Entering one or more values for an external variable.

See Also

Updating a Configuration

Retrieving Configuration Information

The Configurator XML interface lets you retrieve this information about a configuration:

• Total price.

• Choices.

• Domain member data, including:

  • Domain members for all, or selected decision points.

  • Constraint violation explanations for decision points.

  • Value of domain member attributes.

  • Delta prices for domain members.

  • Changes that occurred between two versions of the configuration.

  • Class name for domain members.

  • State, and quantity of domain members.

• Whether a decision point is multi-select.

• Constraint violation explanations for the configuration.

• Numeric values.

The Configurator XML interface also lets you:

• Sort domain members that are returned by the COP.

• Filter domain members that are returned by the COP.

See Also

Retrieving Configuration Information

Copying a Configuration

The Configurator XML interface lets you copy a configuration.

See Copying a Configuration.

Using Batch Configuration Mode

The Configurator XML interface lets you create, update, save and/or retrieve configurations in batch mode.

See Using Batch Configuration Mode.

Changing the Order Status of a Configuration

The Configurator XML interface lets you change the order status of a configuration.

See Changing the Order Status of a Configuration.

COP.dtd

COP.dtd defines which XML elements and attributes the Configurator XML interface can use to send requests to, and return responses from, the COP Java interface. COP.dtd also defines which elements and attributes the COP may use to save and restore configurations.

Studying the COP.dtd may help you better understand the COP XML that is used by the Configurator XML interface. An annotated version is located in \bea\weblogic81\config\CalicoDomain\applications\CalicoApp\Web-inf\dtd.

Element-Attribute Trees

COP XML is defined by the COP.dtd. This means that some of its elements and attributes are not used by the Configurator XML interface, but are used by the COP to save and restore configurations.

COP XML may be viewed as a tree of elements, with some elements having attributes. Studying these element-attribute trees—especially trees that have only those elements and attributes that may be used in a request or response—may help you better understand the COP XML that is used by the Configurator XML interface.

See Also

Element-Attribute Trees