8.7.1 Configure DynamicWSConfig.xml File
For each third-party web service that must be accessed using the OFSAAI Web services
framework and the operations to be invoked, corresponding entries are to be made in the
DynamicWSConfig.xml
template file.
The variable <WebServer> denotes any one of the application servers, that is, WebSphere, WebLogic, or Tomcat.
The DynamicWSConfig.xml
file is available in the <OFSAAI
Installation Directory>/EXEWebService/ <WebServer>/ROOT/conf
directory.
This file can be placed in any directory that is accessible by the application and this
location must be specified in the web.xml file, as WSCONFIGFILE parameter.
The DynamicWSConfig.xml
template file is in the <WebServer
Deployment Path>/ EXEWebService.ear/EXEWebService.war/conf
directory.
This template is as follows:
<XML>
<WEBSERVICES>
<WEBSERVICE CODE="$CODE"
ENDPOINT="$ENDPOINT" TARGETNAMESPACE="$TARGETNAMESPACE" XMLNS_XSD="$XMLNS_XSD"
ENCODINGSTYLE="$ENCODINGSTYLE" SERVICENAME="$SERVICENAME"
PORTTYPENAME="$PORTTYPENAME" SESSION_MAINTAIN_PROPERTY="$SESSION_MAINTAIN_PROPERTY"
USERNAME="$USERNAME"
PASSWORD="$PASSWORD" STYLE="$WEBSERVICESTYLE"
STUBIMPLEMENTATION="$STUBIMPLEMENTATION">
<OPERATION CODE="$CODE" NAME="$NAME" SOAPACTION="$SOAPACTION" STYLE="$STYLE"
PACKAGENAME="$PACKAGENAME">
<INPUT ORDER="$ORDER" PARAMNAME="$PARAMNAME" ARGTYPE="$ARGTYPE"
CLASSNAME="$CLASSNAME"/>
<OUTPUT PARAMNAME="$PARAMNAME" RETURNTYPE="$RETURNTYPE"
CLASSNAME="$CLASSNAME"/>
</OPERATION>
</WEBSERVICE>
</WEBSERVICES>
</XML>
The DynamicWSConfig.xml
file has the placeholders as shown in the
following table. These have to be updated depending on the web service chosen and the
mode of accessing it. For each Web service to be accessed, the entire webservice tag in
the DynamicWSConfig.xml
file must be repeated. The placeholders
tabulated as follows must be set per the parameters published in the third party wsdl
files (webservices) to be accessed. The stub class specified must implement the
"com.iflex.Oracle Reveleus.execution.webservice.EXEWebIF" interface.
Attributes of WEBSERVICE tag
Placeholder | Description |
---|---|
$CODE | A unique number within the XML file and cannot be 999 or 0. |
$ENDPOINT | soap: address location in the wsdl: service name tag of the wsdl file. |
$TARGETNAMESPACE | The attribute value for the targetNamespace of the wsdl: definitions tag. |
$XMLNS_XSD | The attribute value for the xmlns:s of the wsdl:definitions tag |
$ENCODINGSTYLE | The attribute value for the xmlns:soapenc of the wsdl:definitions tag. |
$SERVICENAME | Name of the service found under the wsdl:service name tag of the wsdl file. |
$PORTTYPENAME | wsdl port type name as mentioned in the wsdl file. |
$SESSION_MAINTAIN_PROPERTY | This can be given as "" also. |
$USERNAME | User name to access web services. Enter "" if no user name is required. |
$PASSWORD | The password to access the web services. Enter "" if no password is required. |
$WEBSERVICESTYLE | This can take either "rpc" in case of DII mode of invoking web services or "stub" in case of static mode. This is a mandatory parameter. |
$STUBIMPLEMENTATION | Fully qualified class name (package name.classname). |
Attributes of OPERATION tag
Ensure that the OPERATION tag attributes are repeated for each of the OPERATION tags.
Placeholder | Description |
---|---|
$CODE | It must be unique within the Webservice tag. |
$NAME | The name of the Function that is to be called by the wsdl file. |
$SOAPACTION | The URL for the Operation to access. This is associated with the Operation tag of the wsdl file. |
$STYLE | This can take "rpc" if the web services invoking is in DII mode or "stub" if it is in static mode. This is a mandatory parameter. |
$PACKAGENAME | Represents the JAXB package of the input object. |
Attributes of the INPUT tag
Placeholder | Description |
---|---|
$ORDER | The sequential number of the INPUT tag. It must start from 0. This is in line with the input order of the arguments that the API accepts which is called by this operation. |
$PARAMNAME | The input parameter name to be called by the wsdl file. |
$ARGTYPE | Input Parameter Data Type. If the input argument type is a complex object, specify $ARGTYPE as "xmlstring". |
$CLASSNAME | Represents the class name of the input object parameter. |
Attributes of OUTPUT tag
Placeholder | Description |
---|---|
$PARAMNAME | The output parameter name to be returned by the web service. |
$RETURNTYPE | Output parameter Data Type. If the web service response is a complex object, then specify $RETURNTYPE as "object". |
$CLASSNAME | Represents the class name of the output object parameter. |
Adding web.xml Entries
This step is optional and required only if the web application server used is Tomcat. In case of any other application server, skip and proceed with next step.
- Navigate to the
$FIC_HOME/webroot/WEB-INF/
and edit theweb.xml
file. Set parameter value DOCSERVICEAPP to EXEWebServiceAXIS. - Navigate to the
<OFSAAI Installation Directory>/EXEWebService/<WebServer>/ROOT/WEB-INF/
and edit theweb.xml
file as follows: