Application Service Guide > Data Integration Service Applications > Web Services
  

Web Services

The Applications view displays web services included in applications that have been deployed to a Data Integration Service. You can view the operations in the web service and configure properties that the Data Integration Service uses to run a web service. You can enable and rename a web service.

Web Service Properties

REST web service and SOAP web service properties include read-only general properties and properties that the Data Integration Service uses when it runs a web service.
When you expand a web service or a REST web service in the top panel of the Applications view, you can access web service operations or resource in the web service.
The Applications view displays read-only general properties for the web services, web service operations, or web services resources. Properties that appear in the view depend on the object type.
The following table describes the read-only general properties for each type of web service and the web service operations or resources:
Property
Description
Name
Name of the selected object. Appears for all objects.
Description
Short description of the selected object. Appears for all objects.
Type
Type of the selected object. Appears for all object types.
Location
The location of the selected object. This includes the domain and Data Integration Service name. Appears for all objects.
URL
URL used to connect to the web service. Appears for web services.
The following table describes the configurable web service properties for web services:
Property
Description
Startup Type
Determines whether the web service is enabled to run when the application starts or when you start the web service.
Trace Level
Level of error messages written to the run-time web service log. Choose one of the following message levels:
  • - OFF. The DTM process does not write messages to the web service run-time logs.
  • - SEVERE. SEVERE messages include errors that might cause the web service to stop running.
  • - WARNING. WARNING messages include recoverable failures or warnings. The DTM process writes WARNING and SEVERE messages to the web service run-time log.
  • - INFO. INFO messages include web service status messages. The DTM process writes INFO, WARNING and SEVERE messages to the web service run-time log.
  • - FINE. FINE messages include data processing errors for the web service request. The DTM process writes FINE, INFO, WARNING and SEVERE messages to the web service run-time log.
  • - FINEST. FINEST message are used for debugging. The DTM process writes FINEST, FINE, INFO, WARNING and SEVERE messages to the web service run-time log.
  • - ALL. The DTM process writes FINEST, FINE, INFO, WARNING and SEVERE messages to the web service run-time log.
Default is INFO.
Request Timeout
Maximum number of milliseconds that the Data Integration Service runs an operation mapping before the web service request times out. Default is 3,600,000.
Maximum Concurrent Requests
Maximum number of requests that a web service can process at one time. Default is 10.
Sort Order
Sort order that the Data Integration Service to sort and compare data when running in Unicode mode.
Enable Transport Layer Security
Indicates that the web service must use HTTPS. If the Data Integration Service is not configured to use HTTPS, the web service will not start.
The following table contains properties unique to REST web services:
Property
Description
Is Authentication Required
Enables basic authentication for the REST web service. Basic authentication requires a user name and a password from web service requests. Default is disabled.
Input Precision
Maximum number of characters that the Data Integration Service parses in the request message. The web service request fails when the request message exceeds the input precision. Default is 10,000.
Output Precision
Maximum number of characters that the Data Integration Service generates for the response message. The Data Integration Service truncates the response message when the response message exceeds the output precision. Default is 3,000.
The following table contains properties unique to SOAP web services:
Property
Description
Enable WS-Security
Enables the Data Integration Service to validate the user credentials and verify that the user has permission to run each web service operation. SOAP web services only.
Optimization Level
The optimizer level that the Data Integration Service applies to the object. Enter the numeric value that is associated with the optimizer level that you want to configure. You can enter one of the following numeric values:
  • - 0. The Data Integration Service does not apply optimization.
  • - 1. The Data Integration Service applies the early projection optimization method.
  • - 2. The Data Integration Service applies the early projection, early selection, push-into, and predicate optimization methods.
  • - 3. The Data Integration Service applies the cost-based, early projection, early selection, push-into, predicate, and semi-join optimization methods.
DTM Keep Alive Time
Number of milliseconds that the DTM instance stays open after it completes the last request. Web service requests that are issued against the same operation can reuse the open instance. Use the keep alive time to increase performance when the time required to process the request is small compared to the initialization time for the DTM instance. If the request fails, the DTM instance terminates.
Must be an integer. A negative integer value means that the DTM Keep Alive Time for the Data Integration Service is used. 0 means that the Data Integration Service does not keep the DTM instance in memory. Default is -1.
SOAP Output Precision
Maximum number of characters that the Data Integration Service generates for the response message. The Data Integration Service truncates the response message when the response message exceeds the SOAP output precision. Default is 200,000.
SOAP Input Precision
Maximum number of characters that the Data Integration Service parses in the request message. The web service request fails when the request message exceeds the SOAP input precision. Default is 200,000.

Web Service Operation and Resource Properties

Configure the settings that the Data Integration Service uses when it runs a web service operation or a web service resource.
The following tables describes the configurable property for a SOAP web service operation or a REST web service resource:
Property
Description
Result Set Cache Expiration Period
The number of milliseconds that the result set cache is available for use. If set to -1, the cache never expires. If set to 0, result set caching is disabled. Changes to the expiration period do not apply to existing caches. If you want all caches to use the same expiration period, purge the result set cache after you change the expiration period. Default is 0.

Enabling a Web Service

Enable a web service so that you can start the web service. Before you can start a web service, the Data Integration Service must be running and the web service must be enabled.
    1. Select the Data Integration Service in the Navigator.
    2. In the Application view, select the web service that you want to enable.
    3. In Web Service Properties section of the Properties view, click Edit.
    The Edit Properties dialog box appears.
    4. In the Startup Type field, select Enabled and click OK.

Renaming a Web Service

Rename a web service to change the service name of a web service. You can rename a web service when the web service is stopped.
    1. Select the Data Integration Service in the Navigator.
    2. In the Application view, select the web service that you want to rename.
    3. Click Actions > Rename Web Service.
    The Rename Web Service dialog box appears.
    4. Enter the web service name and click OK.