WebService

This WebService transport node allows the Service Definition Framework to make outbound webservice calls.

Note: Webservice SDF component is deprecated and will be removed in the future version. It is recommended that you do not use the WebServices SDF component to invoke WebServices. Instead, create a custom API to invoke WebServices.
Note: WebServices cannot be used to call APIs in backward compatibility mode. Also, outbound WebService calls using the Service Builder do not support HTTPS protocol.

Configuration properties

The following are the properties of this node:

  • Configurable depending on your app server:
    • Oracle WebLogic
    • IBM® Websphere
    • JBoss

For IBM WebSphere®,


Pass -D websphere-java2wsdl-style=<rpc|document> in the ear command line

For JBoss,


Pass -D jboss-java2wsdl-style=<rpc|document> in the ear command line.

For Oracle WebLogic, use document literal.

For JBoss based on variable

Build Ear.sh documentation where it talks about style of coding

Oracle WebLogic and IBM Websphere are supported and parameterizable and the other supported for document literal.
Note: For more information on JBoss deprecation, see Deprecated components in Sterling Order Management System Software.
Table 1. WebServices configuration properties
Property Description
General Tab
URL Enter the URL to which the message is to be posted. For example, http://localhost:7001/smcfsejb/services
Target Object URN Enter the web service's resource name. For example, yantrawebservice
Are Sterling Order Management System Software Webservice Check this box to indicate that this service is calling a Sterling Order Management System Software Webservice.

If you check this box, the parameter name defaults to apiString and the Parameter Name text box on this tab is disabled.
Parameter Name Enter the name of the document parameter.
Encoding Style URI Enter the name of the encoding you want to use. For example, http://schemas.xmlsoap.org/soap/encoding/
Method Name Enter the name of the method you want to invoke.
Is Secure If this field is selected, the message is encrypted when being posted to the URL specified.
Trust Store If Is Secure is selected, enter the trust store for storing server side digital certificates. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Trust Store Passwd If Is Secure is selected, enter the password to access the trust store.
Key Store Type If Is Secure is checked, set this value to JKS (Java™ Key Store).
Key Store If Is Secure is selected, enter the key store for storing client side digital certificates. If you are using variables instead of the full path names ensure that the variable is defined in the <INSTALL_DIR>/properties/customer_overrides.properties file.
Key Store Passwd If Is Secure is selected, enter the password to access the key store.
SOAPActionURI Enter the URI used by this attribute to invoke the required outbound web service. For example, http://tempuri.org/PricingEngineGold/Service1/PricingEngineFunc can be a valid input URI.
Arguments Tab
Argument Name The name of the parameter to be passed to the Webservice method.
Argument Value The value of the parameter to be passed to the Webservice method.

Connection properties

The following are the WebServices node's connection properties:

Table 2. WebServices connection properties
Connection Node Connection Rules
Can be the first node after the start node Only for services invoked synchronously
Can be placed before
  • Any transport node except for FTP or File I/O
  • Any other component node
Can be placed after
  • Start node
  • Any synchronous transport node
  • Any other component node
  • Any asynchronous transport node (except for FTP or File I/O); use a Pass-through node to connect them
Passes data unchanged Transport nodes do not modify data