iBSP Administrative Services for iWay Explorer - iwae

Use the following URL to access the iBSP administrative services for iWay Explorer:

http://localhost:port/admin/iwae.ibs

where:

localhost

Is the host machine where iWay Service Manager is installed. The default value is localhost.

port

Is the SOAP port where iWay Business Service Provider is listening. The default port is 9000.

The following methods are available:

GETADAPTERINFO

Use this method to retrieve detailed information about an installed adapter. The name of the adapter target is the only parameter that is required for this method.

GETTARGETINFO

Use this method to retrieve a list of available target systems for an adapter. The name of the adapter target is the only parameter that is required for this method.

SETTARGETINFO

Use this method to add or update an adapter target. SETTARGETINFO accepts one parameter and the SOAP request uses the following format:

<SETTARGETINFO xmlns="urn:schemas-iwaysoftware-com:dec2002:iwse:af">
<target>
<action>new</action>
<tid></tid>
<target></target>
<name>iway1</name>
<description>production server1</description>
<descriptor>
<option title="">
<group title="">
<param label="User" name="user" required="true" type="" value=""/>
<param label="PWD" name="password" required="true" type="" value=""/>
<param label="Conn" name="conn" required="true" type="" value=""/>
</group>
</option>
</descriptor>
</target>
</SETTARGETINFO>

GETTARGET

Use this method to retrieve a particular instance of an adapter target. GETTARGET accepts one parameter and the SOAP request uses the following format:

<GETTARGET xmlns="urn:schemas-iwaysoftware-com:dec2002:iwse:af">
<tid>1000</tid>
<descriptor>
<option title="">
<group title="">
<param label="User" name="user" required="true" type="string" value=""/>
<param label="PWD" name="password" required="true" type="string" value=""/>
<param label="Conn" name="conn" required="true" type="string" value=""/>
</group>
</option>
</descriptor>
<duration>2147483647</duration>
</GETTARGET>

RELEASETARGET

Use this method to release a particular adapter target instance. The session ID (sid) that represents the instance of the target is the only parameter that is required for this method.

GETCOMPONENT

Use this method to retrieve a list container or contained elements. GETCOMPONENT accepts one parameter and the SOAP request uses the following format:

<GETCOMPONENT>
<sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
<component location="BASEAPP.SIEBEL.CalcAdd" name="BASEAPP.SIEBEL.CalcAdd"/>
</GETCOMPONENT>

GETSCHEMA

Use this method to retrieve XML request, response, or event schema. GETSCHEMA accepts one parameter and the SOAP request uses the following format:

<GETSCHEMA>
<sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
<component location="BASEAPP.SIEBEL.CalcAdd" name="BASEAPP.SIEBEL.CalcAdd"/>
</GETSCHEMA>

GETCOMPONENTTREE

Use this method to retrieve a list container or contained elements. GETCOMPONENTTREE accepts one parameter and the SOAP request uses the following format:

<GETCOMPONENTTREE>
<sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
<component location="BASEAPP.SIEBEL.CalcAdd" name="BASEAPP.SIEBEL.CalcAdd"/>
</GETCOMPONENTTREE>

GETWSEINFO

Use this method to retrieve the current Web service engine information. GETWSEINFO accepts no parameters.

SETWSEINFO

Use this method to add or update a Web service. SETWSEINFO accepts one parameter and the SOAP request uses the following format:

<SETWSEINFO xmlns="urn:schemas-iwaysoftware-com:dec2002:iwse:af">
   <ibsrepository>...</ibsrepository>
</SETWSEINFO>

ADDWS

Use this method to add a Web service. ADDWS accepts one parameter and the SOAP request uses the following format:

<ADDWS>
   <sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
   <component location="BASEAPP.SIEBEL.CalcAdd"
    name="BASEAPP.SIEBEL.CalcAdd"/>
   <svcname>newService</svcname>
   <svcdesc>service description</svcdesc>
   <licname>abcdefg</licname>
   <mthname>newMethod</mthname>
   <mthdesc>method description</mthdesc>
</ADDWS>

ADDWS2

Use this method to add a Web service based on a WSDL definition. ADDWS2 accepts four parameters and the SOAP request uses the following format:

<ADDWS2>
   <svcname>newService</svcname>
   <svcdesc>service description</svcdesc>
   <licname>abcdefg</licname>
   <wsdl>http://yankees.ibi.com:1000/IVP/iwayivp.ibs?wsdl</wsdl>
</ADDWS2>

GENIBS

Use this method to generate a .ibs file and associated XML files. GENIBS accepts an array of license names. An asterisk (*) character implies all licenses.

GETINTERACTION

Use this method to retrieve the detailed information of the interaction. GETINTERACTION accepts one parameter and the SOAP request uses the following format:

<GETINTERACTION>
   <sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
   <location>BASEAPP.SIEBEL.CalcAdd</location>
   <interactionstr>Convert XDR</interactionstr>
</GETINTERACTION>

RUNINTERACTION

Use this method to execute a specific interaction. RUNINTERACTION accepts one parameter and the SOAP request uses the following format:

<RUNINTERACTION>
   <sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
   <location>BASEAPP.SIEBEL.CalcAdd</location>
   <interactionstr>Convert XDR</interactionstr>
   <command>run</command>
   <interaction>...</interaction>
</RUNINTERACTION>

ADDPORT

Use this method to add a port (document definition + dispostion). ADDPORT accepts one parameter and the SOAP request uses the following format:

<ADDPORT>
   <sid>98BCF26A9E7DA546618CBD0CD8EBE00B</sid>
   <component name="ccc" location="ccc"/>
   <name>p2</name>
   <description>first port</description>
   <disposition>file:///c:\tmp\xxx.xml</disposition>
   <channel>c1</channel>
</ADDPORT>

EXPORTTARGET

Use this method to export an adapter target with its connection information and persistent data. The target system name (target) and target instance name (name) are the only parameters that are required for this method.

IMPORTTARGET

Use this method to import an adapter target with its connection information and persistent data. IMPORTTARGET accepts one parameter and the SOAP request uses the following format:

<IMPORTTARGET>
   <targetinstance>
   <target></target>
   <name>iway1</name>
   <description>production server1</description>
   <repositoryid>Wsomeid</repositoryid>
   <exporttime>2004-02-03T18:04:05Z</exporttime>
   <contents>PGRlc2NyaXB0b...3I+PG9wdGlvbiB</contents>
   </targetinstance>
</IMPORTTARGET>

iWay Software