Run Time Properties for Services

Property

Description

Stateless

Specifies whether or not Integration Server is required to maintain state information for this service for the duration of the client session. Select True if the service is a self-contained, atomic unit of work and does not need access to state information. This reduces the number of server resources it consumes at run time. Select False if the service is part of a multi-service transaction or if you are unsure of its state requirements.

The default is False.

Cache results

Indicates whether Integration Server stores the service results in a local cache for the time period specified in the Cache expire property. After the service executes, the server places the entire pipeline contents into a local cache. When subsequent requests for the service provide the same set of input values, the server returns the cached results instead of invoking the service again. Select True to cache the service results. Select False if you do not want to cache service results. Cache results for stateless services only.

The default is False.

Note:

Caching is only available for data that can be written to the repository. Because XML nodes cannot be written to the repository, they cannot be cached.

Note:

This property relates specifically to the caching of service results described in About Service Caching. This property does not affect caching that is performed by the services in the pub.cache folder.

Cache expire

Specifies the amount of time that the pipeline contents stay in memory after they are cached. If you enable the Cache results property, type an integer in this field representing the number of minutes you want a result to remain cached. The expiration timer begins when the server initially caches the results. The server does not restart the expiration timer each time it retrieves the results from cache. The minimum cache expiration time is one minute.

Note:

Reset cache

Click Reset to clear the cached results for this service.

Note:

Prefetch

Determines whether Integration Server automatically refreshes a cached result when it expires by re-executing the service using the same inputs. To automatically refresh this service's cached results, set Prefetch to True. (Prefetch can consume a substantial amount of server memory; consult your Server Administrator before using this option.)

The cache may not be refreshed at the exact time specified in Cache expire. It may vary from 0 to 15 seconds, according to the cache sweeper thread. For details, see the watt.server.cache.flushMins setting in Integration Server.

Note:

Prefetch activation

Specifies the minimum number of times that a cached result must be accessed (hit) with the same inputs in order for the server to prefetch results when it expires. If you enable Prefetch, you must specify an integer representing the minimum number of hits a cached result must receive to be eligible for prefetch. (Entries that do not receive the minimum number hits are released from memory.)

Note:

The cache may not be refreshed at the exact time the last hit fulfills the Prefetch Activation requirement. It may vary from 0 to 15 seconds, according to the cache sweeper thread. For details, see the watt.server.cache.flushMins setting in Integration Server.

Note:

Execution locale

Specifies the locale in which this service will be executed.

HTTP URL Alias

Specifies an alias for the path portion of the URL used to invoke a service. The path portion of the URL consists of the invoke directive and the fully qualified service name.

Pipeline debug

Determines whether Integration Server automatically saves or restores the pipeline after the service executes. This option is useful for testing and debugging the service.

Select...

To...

None

Run the service without saving or restoring the pipeline. This is the default.

Save

Save the entire pipeline contents to a file when the service executes.

Restore (Override)

To restore the pipeline from a file when the service executes.

Restore (Merge)

To merge the pipeline with one from a file when the service executes.

When this option is selected and the input parameters in the file match the input parameters in the pipeline, the values defined in the file are used in the pipeline. If there are input parameters in the pipeline that are not matched in the file, the input parameters in the pipeline remain in the pipeline.

Note:

The options you select can be overwritten at run time by the value of the watt.server.pipeline.processor property, set in the server configuration file. This property specifies whether to globally enable or disable the Pipeline debug feature. The default enables the Pipeline debug feature on a service-by-service basis. For more information on setting properties in the server configuration file, see webMethods Integration Server Administrator’s Guide.

Note:

When using MTOM streaming for SOAP attachments, messageContext variables and/or XOPObject fields will not be available in the saved pipeline. A messageContext variable is used by many pub.soap services to hold the SOAP message on which the service acts. XOPObject fields are Objects that use the com.wm.util.XOPObject Java wrapper type. For more information about MTOM Streaming, see the Web Services Developer’s Guide.

Default xmlFormat

The default XML format for XML documents received by the service.

Note:

You can specify the default XML format for flow services and Java services only. The Default xmlFormat property is not available for C/C++ services, .NET services, or web service connectors.

Select...

To...

<blank>

Specify that Integration Server obtains the default XML format from the watt.server.http.xmlFormat server configuration parameter. This is the default.

For more information about the watt.server.http.xmlFormat server configuration parameter, see webMethods Integration Server Administrator’s Guide.

bytes

Specify that Integration Server uses a byte array as the default XML format. Integration Server passes the XML document directly to the service as a byte array without parsing the XML. Integration Server places the byte array in the input pipeline of the target service in a variable named xmlBytes.

enhanced

Specify that Integration Server uses a node parsed by the enhanced XML parser as the default XML format. Integration Server parses the XML automatically using the enhanced XML parser. Integration Server uses the default options specified for enhanced XML parsing on the Settings > Enhanced XML Parsing page in Integration Server Administrator. Integration Server passes the XML document to the target service as a node that implements the w3c.com.Node interface. Integration Server places the node in the input pipeline of the target service in a variable named node.

Note:

Integration Server writes the XML document to a cache during parsing only if caching is configured for enhanced XML parsing. Integration Server uses BigMemory while parsing only if caching is configured and BigMemory is enabled for use with enhanced XML parsing. For more information about configuring a cache andBigMemory for XML parsing, see webMethods Integration Server Administrator’s Guide.

node

Specify that Integration Server uses a node parsed by the legacy XML parser as the default XML format. Integration Server parses the XML automatically using the legacy parser and passes it to the target service as a node. Integration Server places the node in the input pipeline of the target service in a variable named node

stream

Specify that Integration Server uses an InputStream as the default XML format. Integration Server passes the XML document directly to the service as an XML stream without parsing the XML. Integration Server places the XML stream in the input pipeline of the target service as an InputStream named xmlStream.