About the Configuration Web Service

The Configuration Web Service provides an interface that allows ergonomic interaction with both the Oracle Endeca Server configuration and record schema.

Overview

The Configuration Web Service allows you to manipulate schema and configuration. The service is declared in its WSDL document, which you can access at this URL: http://localhost:<port>/ws/config/DataStore?wsdl, similar to other packaged Web services. The host and port represent the Oracle Endeca Server, and the DataStore is the name of the data store created on the server.

Operation description

A request to the Configuration Web Service consists of a configTransaction element, which contains a series of operations that read the configuration and schema and also update it. Operations can be combined arbitrarily in a single service request; each of the operations can appear at most once. The operations perform actions on PDRs (Property Description Records), DDRs (Dimension Description Records), groups, the GCR (Global Configuration Record), and on XML configuration documents.

The effect of a Configuration Web Service request that contains put operations is to add attributes, XML configuration documents, or the Global Configuration Record to the Oracle Endeca Server data store:
  • If a record with the specified key already exists in the data store, it is replaced.
  • If a record does not exist, it is created.

Request

The input to the Configuration Web Service depends on the operation used. It can include attribute schema records (PDRs and DDRs), Global Configuration Record, groups, and a set of XML configuration documents.

Any request to the Configuration Web Service can contain an optional element OuterTransactionId that specifies the ID of an outer transaction (if it has been started by the Transaction Web Service). The following statements describe the interaction of configuration requests with outer transactions:
  • If an outer transaction has been started by the Transaction Web Service, the configuration request may be run against either the latest version of the data files inside the transaction, or against the pre-transaction version of the data files:
    • To run a configuration request against the latest version, the OuterTransactionId element in your request must specify the ID issued by the Transaction Web Service when the transaction was started. This element must be the first element specified in your request.
    • To run against the published version (it could be the version published prior to the outer transaction, or the version published after the outer transaction has been committed or rolled back), the OuterTransactionId element must be empty or omitted.

It is incorrect to specify an outer transaction ID when an outer transaction is not in progress. All configuration requests with incorrectly specified outer transaction IDs fail with a SOAP fault.

Response

Not all operations in the Configuration Web Service return data.

If the operation returns data, the response to the Configuration Web Service is a results element, within which each of the submitted operations produces an element showing its own results.

If any operation does not succeed, the whole Web service transaction returns a SOAP fault and none of the operations are applied. An operation may not succeed if an outer transaction has been started by a Transaction Web Service, but an incorrect ID has been specified within a request sent to the Configuration Web Service.