About the Entity and Collection Configuration Web Service

This Web Service lets you create and manage entities, collections, and filter rules.

Overview

The Entity and Collection Configuration Web Service is a WS-I compliant SOAP/HTTP Web service that also supports the wrapped-document/literal pattern of binding. The service is declared in sconfig.wsdl.

To view the WSDL document for the service, issue the following command: 
http://host:<port>endeca-server/ws/sconfig/dataDomain?wsdl
where host and port represent the host and port of Oracle Endeca Server, and dataDomain is the name of the data domain for which entities, collections, or filter rules will be managed.
The service's version is listed in one of its namespaces included in the WSDL, as shown in the following example (the version in this example may not match the version of the service you have installed): 
xmlns:v3_0="http://www.endeca.com/endeca-server/sconfig/3/0"
In this example, 3 is the major version; 0 is the minor version. If more than one minor version is supported, it is listed in its own namespace in the WSDL document.

For reference information on the operations and for schema elements, see the Oracle Endeca Server API References.

Operation description

A request to the Entity and Collection Configuration Web Service depends on the operation. The operations perform actions on entities, collections, and filter rules.

The effect of an Entity and Collection Configuration Web Service request that contains put operations is to add entities, collections, or filter rules for this data domain. After creation, each entity, collection, or filter rule is represented as a single logical record in the Endeca data domain. The on-disk storage of these records means that they persist across restarts of the Endeca data domain, as they are loaded into the Dgraph process at start-up time.

Request

The input to the Entity and Collection Configuration Web Service depends on the operation used. For example, it can include a key and an EQL statement that defines an entity, for put operations; it can include the key only, for deleteEntities operation; or it can include the definition of the entity, for validate operations.

Any request to the Entity and Collection 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 request may be run against either the latest version of the index files inside the transaction, or against the pre-transaction version of the index files:
    • To run a 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 Entity and Collection Configuration Web Service return data.

If the operation returns data, the response 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 Entity and Collection Configuration Web Service.