Unknown macro: {next_previous_links}
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Data services are implemented using XML, which means that element names can conflict. Therefore, we use namespaces to uniquely identify the elements defined within a specific web service. Using namespaces for a data service is optional. However, in certain data services, namespaces become necessary. For example, consider a data service with two separate queries using the same set of output mappings. In such situations, you need to use separate namespaces to identify the elements in each query.

Namespaces can be used at different levels for a data service:

Service namespace

The service namespace is used to uniquely identify a web service, which means that this namespace applies to all elements in the data service. In the WSDL that represents the service, the namespace is indicated by the "targetNamespace" attribute. The service namespace can be overridden at the query level and at output result row level as explained below.

 The service namespace can be set using the Create/Edit Data Service window of the management console as shown below.

Dataserviceresultrownamespace

When you define a query for your data service, you can set a namespace for the elements in the query result (output mapping). That is, the Row Namespace applies to all the result rows that you define as output mappings. The example below shows how the row namespace is set for the query result element: Customers.

After setting the row namespace, the Customers element's data type falls under the given namespace. The XML Schema fragment in data types section taken from the service's WSDL is as follows:

Note the following:

  • The row namespace will override the service-level namespace entries that are applicable to the elements in a query result.
  • If you have multiple queries for your data service using the same result row, be sure to use separate namespaces for each query to avoid a conflict.

Namespaces for specific elements in the result

The row namespace applies to all elements in the query result. Alternatively, you can specify namespaces for selected elements (output mappings) in the query result as shown below.

This is how the setting is reflected in the WSDL.

Note the following:

  • The namespace defined for a specific output element will override the service-level namespace entries as well as the row namespace entries that are applicable to the element.
  • If you have a data service query using the same result element multiple times, be sure to use separate namespaces for each element.

Namespaces for complex results

In complex results in data services, the result elements can be arbitrarily nested. These nested elements can have their own namespaces. The example below shows how this is represented in a database file fragment, which has a complex result.

<query id="customersInBostonSQL" useConfig="default">
      <sql>select  * from Customers where city = 'Boston' and country = 'USA'</sql>
      <result defaultNamespace="http://abc.com/nsb" element="customers" rowName="customer">
         <element column="customerName" name="customer-name" xsdType="string"/>
         <element namespace="http://abc.com/nsb" name="contact">
         	<element column="contactLastName" name="contact-last-name" xsdType="string"/>
         	<element column="contactFirstName" name="contact-first-name" xsdType="string"/>
         </element>
         <element column="phone" name="phone" xsdType="string"/>
         <element column="city" name="city" xsdType="string"/>
         <element column="country" name="country" xsdType="string"/>
      </result>
</query>

The WSDL created for the above service is as follows:

The resulted XML of the executed service is as follows:

Namespace inheritance in a data service

There's an inheritance order where a top-level namespace is inherited by its children. In summary, the inheritance is as follows:

  • Service namespace is applied to all aspects of the data service, i.e. results.
  • Result row namespace overrides the service namespace and applies a given namespace for the whole result.
  • Complex result, nested elements override the result row namespace and assign the namespace to all its child elements.
  • A namespace specifically assigned to an element overrides the parent element's namespace and assigns the given namespace to itself.
  • No labels