T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
SOAP client

Functions

 callSoapOperation args
 This function calls a SOAP service. You can use the options described below. More...
 
 deployShmemVariable partname servicename value
 Sets a service specific shared memory variable on the server. More...
 
 existsShmemVariable partname servicename
 Test if a service specific shared memory variable exists on the server. More...
 

Detailed Description

Function Documentation

◆ callSoapOperation()

T4X::SOAP::CLIENT::callSoapOperation   args  

This function calls a SOAP service. You can use the options described below.

Parameters
-service: the name of the service
-envelope: SOAP message as xml string
-httpheader: (optional) list of strings containing name / value pairs separated by ":", i. e. ["name1: value1" "name2: value2" ...]
-userid: (optional) user ID for authentication
-password: (optional) password for authentication
-soapendpoint: (optional) endpoint URL, if an endpoint different from the one in the WSDL is to be used
-logchannel: (optional) log channel to be used for the call
Returns
a list containing
  1. the SOAP response as an XML string
  2. the HTTP header data
  3. the HTTP status code and
  4. the SOAP content type
If the response contains attachments, the file names of the attachments are included in the SOAP response in the form of an entry <xop:Include href="file://FILEPATH" xmlns:xop="http://www.w3.org/2004/08/xop/include"/> with FILEPATH specifying the path of the corresponding file.

Call the service specified by -service with the request specified by -envelope. Other parameters are optional. Please note that before a SOAP service can be called successfully, the WSDL and if necessary the schema descriptions it relies on must be deployed with deployShmemVariable WSDL and deployShmemVariable SCHEMA respectively as shown in the source generated by wsdl2t4x.

References SYSUtils::getServerId(), rcwd(), tpco_closeSrvSession(), tpco_connectTo(), tpco_scanHEX16(), tpco_sendECMD(), tpco_shmdelete(), tpco_shmexists(), tpco_shmget(), tpco_uncompressB64Str(), and tpwrite().

◆ deployShmemVariable()

T4X::SOAP::CLIENT::deployShmemVariable   partname servicename value  

Sets a service specific shared memory variable on the server.

Parameters
partname: the part name of the variable; the complete variable name is SYS.APPSRV.SOAP2.$partname.$servicename as stated below. Currently part names WSDL and SCHEMA are used to provide WSDL and SCHEMA files for a SOAP service.
servicename: upppercase service name
value: variable value
Returns
OK (0) / ERROR (1)

Set shared memory variable SYS.APPSRV.SOAP2.$partname.$servicename to $value on the server.

References tpco_closeSrvSession(), tpco_connectTo(), tpco_shmset(), and tpwrite().

◆ existsShmemVariable()

T4X::SOAP::CLIENT::existsShmemVariable   partname servicename  

Test if a service specific shared memory variable exists on the server.

Parameters
partname: the part name of the variable; the complete variable name is SYS.APPSRV.SOAP2.$partname.$servicename as stated below. Currently part names WSDL and SCHEMA are used to provide WSDL and SCHEMA files for a SOAP service.
servicename: upppercase service name
Returns
true if the variable exists; false otherwise

Test existence of the SYS.APPSRV.SOAP2.$partname.$servicename shared memory variable.

References tpco_closeSrvSession(), tpco_connectTo(), tpco_shmexists(), and tpwrite().