T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
T4X::SOA Namespace Reference

Functions

 encryptString4PipeProtocol strCredential
 puts #!! around the string if not already there, which prevents the input string from being written to the logfiles More...
 
 executeTCSOACall TcSoaUrl strCommand
 call a TCSOA service T4x JAVA TCSOA adapter based on the input in the ::StatusInfo array content, that was filled via the T4X::TC::MAPPING::storeReverseMappingAttribute function. More...
 
 extendClassPath args
 Extends the JVM class path used by the SOA pipe server. More...
 
 extendJVMArgs args
 Extends the JVM args used by the SOA pipe server. More...
 
 getConnectionParameters
 get Teamcenter connection parameter, used internally only for use with TCSOA adapter More...
 
 importSSLCertificate hostname ?port? ?password?
 Imports an untrusted SSL certificate from an HTTPS server into the certificate store of the current VM (see JAVA_HOME) More...
 
 performEBSCall serviceURL xmlPayload soapParameters userName password ?headerPayload?
 Special SOAP function to call a Oracle EBS service (sets UsernameToken authentication) More...
 
 performGenericWebServiceCall serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?
 call a SOAP web service via the T4EA JAVA SOAP adapter More...
 
 performGenericWebServiceCall2 serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?
 call a SOAP web service via the T4EA JAVA SOAP adapter More...
 
 performGenericWebServiceCallFireAndForget serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?
 asynchronously call a SOAP web service via the T4EA JAVA SOAP adapter (does not wait for response) More...
 
 performSAPBAPICall serviceURL xmlPayload userName password
 Special SOAP function to call a SAP BAPI exported as a web service (sets some special values and parses the result) More...
 
 performSAPESCall serviceURL xmlPayload userName password
 Special SOAP function to call a SAP Enterprise Service (sets SOAP parameters and parses the result) More...
 
 setClassPath classPathAsAList
 Sets the JVM class path used by the SOA pipe server. More...
 
 setIdleTimeout timeout
 Sets the idle timeout used by the SOA pipe server. More...
 
 setInitialJavaHeapSize initialJavaHeapSizeInMegaBytes
 Defines the JVM min heap size used by the SOA pipe server. More...
 
 setJavaDataModel dataModel
 Defines the JVM data model used by the SOA pipe server (32 or 64 bit) More...
 
 setMaximumJavaHeapSize maximumJavaHeapSizeInMegaBytes
 Defines the JVM max heap size used by the SOA pipe server. More...
 
 setProxy host ?port? ?userName? ?password? ?domain?
 sets proxy connection data (and unsets proxy if host is empty) More...
 
 setTimeout timeout
 Sets the timeout used by the SOA pipe server. More...
 

Variables

 soaJavaServer
 Internal variable storing information on the SOAP client pipe. More...
 
 tcsoaJavaServer
 Internal variable storing information on the TCSOA client pipe. More...
 

Detailed Description

===================================================

            Siemens Product Lifecycle Management Software Inc.
            All Rights Reserved.

Project: T4X File t4x_soa_functions.sd Functions:

Function Documentation

◆ encryptString4PipeProtocol()

T4X::SOA::encryptString4PipeProtocol   strCredential  

puts #!! around the string if not already there, which prevents the input string from being written to the logfiles

Returns
the wrapped input string
Parameters
strCredentialthe input string

Referenced by getConnectionParameters(), importSSLCertificate(), performGenericWebServiceCall2(), performGenericWebServiceCallFireAndForget(), and setProxy().

◆ executeTCSOACall()

T4X::SOA::executeTCSOACall   TcSoaUrl strCommand  

call a TCSOA service T4x JAVA TCSOA adapter based on the input in the ::StatusInfo array content, that was filled via the T4X::TC::MAPPING::storeReverseMappingAttribute function.

Returns
list of OK and result or list of ERROR and message
Parameters
TcSoaUrlURL of the Teamcenter server, including port and application address
strCommandT4x specific command

References T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ extendClassPath()

T4X::SOA::extendClassPath   args  

Extends the JVM class path used by the SOA pipe server.

Parameters
args(JVM class path args to be extended)
Returns
none

References T4X::JAVASERVER::extendClassPath().

◆ extendJVMArgs()

T4X::SOA::extendJVMArgs   args  

Extends the JVM args used by the SOA pipe server.

Parameters
args(JVM args to be extended)
Returns
none

References T4X::JAVASERVER::extendJVMArgs().

◆ getConnectionParameters()

T4X::SOA::getConnectionParameters

get Teamcenter connection parameter, used internally only for use with TCSOA adapter

Returns
a list of user, password, group and role

References encryptString4PipeProtocol(), T4X::CORE::getSessionLogChannel(), tpco_closeSrvSession(), tpco_connectTo(), tpco_decrypt(), and tpwrite().

◆ importSSLCertificate()

T4X::SOA::importSSLCertificate   hostname ?port? ?password?  

Imports an untrusted SSL certificate from an HTTPS server into the certificate store of the current VM (see JAVA_HOME)

Returns
Status OK or list of ERROR and message
Parameters
hostnamename of the SSL host to load the certificate from
portSSL port (defaults to 443)
passwordpassword for the local Java VM certificate store (defaults to "changeit")

20110728 us: ported to T4x9 and PIPE2

References T4X::JAVASERVER::activateFor(), encryptString4PipeProtocol(), T4X::JAVASERVER::execute(), and T4X::CORE::getSessionLogChannel().

◆ performEBSCall()

T4X::SOA::performEBSCall   serviceURL xmlPayload soapParameters userName password ?headerPayload?  

Special SOAP function to call a Oracle EBS service (sets UsernameToken authentication)

Returns
list of OK and result or list of ERROR and message
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
soapParametersadditional SOAP parameters to pass
userNameuser name for authentication
passwordfor authentication
headerPayloadSOAP header payload, e.g. for the responsibilities (defaults to empty)

References T4X::CORE::getSessionLogChannel(), performGenericWebServiceCall(), and tpwrite().

◆ performGenericWebServiceCall()

T4X::SOA::performGenericWebServiceCall   serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?  

call a SOAP web service via the T4EA JAVA SOAP adapter

Returns
list of OK and result or list of ERROR and message (first 200 characters of fault detail)
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
soapParametersadditional SOAP parameters to pass (optional - default -> EMPTY)
userNameuser name for authentication (optional - default -> EMPTY)
passwordfor authentication (optional - default -> EMPTY)
headerPayloadSOAP header payload (optional - default -> EMPTY)

References T4X::CORE::getSessionLogChannel(), performGenericWebServiceCall2(), and tpwrite().

Referenced by performEBSCall(), performSAPBAPICall(), and performSAPESCall().

◆ performGenericWebServiceCall2()

T4X::SOA::performGenericWebServiceCall2   serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?  

call a SOAP web service via the T4EA JAVA SOAP adapter

Returns
list of OK and result or list of ERROR and message including the complete fault detail
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
soapParametersadditional SOAP parameters to pass (optional - default -> EMPTY)
userNameuser name for authentication (optional - default -> EMPTY)
passwordfor authentication (optional - default -> EMPTY)
headerPayloadSOAP header payload (optional - default -> EMPTY)

References T4X::JAVASERVER::activateFor(), encryptString4PipeProtocol(), T4X::JAVASERVER::execute(), T4X::CORE::getSessionLogChannel(), and tpwrite().

Referenced by performGenericWebServiceCall().

◆ performGenericWebServiceCallFireAndForget()

T4X::SOA::performGenericWebServiceCallFireAndForget   serviceURL xmlPayload ?soapParameters? ?userName? ?password? ?headerPayload?  

asynchronously call a SOAP web service via the T4EA JAVA SOAP adapter (does not wait for response)

Returns
list of OK or list of ERROR and message
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
soapParametersadditional SOAP parameters to pass (optional - default -> EMPTY)
userNameuser name for authentication (optional - default -> EMPTY)
passwordfor authentication (optional - default -> EMPTY)
headerPayloadSOAP header payload (optional - default -> EMPTY)

References T4X::JAVASERVER::activateFor(), encryptString4PipeProtocol(), T4X::JAVASERVER::execute(), T4X::CORE::getSessionLogChannel(), and tpwrite().

◆ performSAPBAPICall()

T4X::SOA::performSAPBAPICall   serviceURL xmlPayload userName password  

Special SOAP function to call a SAP BAPI exported as a web service (sets some special values and parses the result)

Returns
list of OK and result or list of ERROR and message
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
userNameuser name for authentication
passwordfor authentication

References T4X::CORE::getSessionLogChannel(), performGenericWebServiceCall(), and tpwrite().

◆ performSAPESCall()

T4X::SOA::performSAPESCall   serviceURL xmlPayload userName password  

Special SOAP function to call a SAP Enterprise Service (sets SOAP parameters and parses the result)

Returns
list of OK and result or list of ERROR and message
Parameters
serviceURLthe URL of the Enterprise Service
xmlPayloadthe XML payload to pass (inside the SOAP body tag)
userNameuser name for authentication
passwordfor authentication

References T4X::CORE::getSessionLogChannel(), performGenericWebServiceCall(), and tpwrite().

◆ setClassPath()

T4X::SOA::setClassPath   classPathAsAList  

Sets the JVM class path used by the SOA pipe server.

Parameters
classPathAsAList
Returns
none

References T4X::JAVASERVER::setClassPath().

◆ setIdleTimeout()

T4X::SOA::setIdleTimeout   timeout  

Sets the idle timeout used by the SOA pipe server.

Parameters
timeout
Returns
none

References T4X::JAVASERVER::setIdleTimeout().

◆ setInitialJavaHeapSize()

T4X::SOA::setInitialJavaHeapSize   initialJavaHeapSizeInMegaBytes  

Defines the JVM min heap size used by the SOA pipe server.

Parameters
initialJavaHeapSizeInMegaBytes
Returns
none

References T4X::JAVASERVER::setInitialJavaHeapSize().

◆ setJavaDataModel()

T4X::SOA::setJavaDataModel   dataModel  

Defines the JVM data model used by the SOA pipe server (32 or 64 bit)

Parameters
dataModel(either 32 or 64)
Returns
none

References T4X::JAVASERVER::setJavaDataModel().

◆ setMaximumJavaHeapSize()

T4X::SOA::setMaximumJavaHeapSize   maximumJavaHeapSizeInMegaBytes  

Defines the JVM max heap size used by the SOA pipe server.

Parameters
maximumJavaHeapSizeInMegaBytes
Returns
none

References T4X::JAVASERVER::setMaximumJavaHeapSize().

◆ setProxy()

T4X::SOA::setProxy   host ?port? ?userName? ?password? ?domain?  

sets proxy connection data (and unsets proxy if host is empty)

Returns
OK
Parameters
hostname or IP of the HTTP proxy host
portport of the proxy on the proxy host
userNameoptional proxy user name
passwordoptional proxy user password
domainoptional domain of the proxy user

References T4X::JAVASERVER::activateFor(), encryptString4PipeProtocol(), T4X::JAVASERVER::execute(), and T4X::CORE::getSessionLogChannel().

◆ setTimeout()

T4X::SOA::setTimeout   timeout  

Sets the timeout used by the SOA pipe server.

Parameters
timeout
Returns
none

References T4X::JAVASERVER::setTimeout().

Variable Documentation

◆ soaJavaServer

soaJavaServer
static

Internal variable storing information on the SOAP client pipe.

◆ tcsoaJavaServer

tcsoaJavaServer
static

Internal variable storing information on the TCSOA client pipe.