Академический Документы
Профессиональный Документы
Культура Документы
Table of Contents
1
1.1
SOAP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2
WSDL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
1.1.3
XML Schema. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.1.4
UDDI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2
2.1
Connection operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
2.2
2.1.1
ping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.2
logon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.1.3
logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Project operations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.2.1
runTask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.2.2
getTaskStatusByRunID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.2.3
getTaskLogs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Error reporting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
When an external application calls into SAP HANA Cloud Integration through web services, the application acts as
a web service client accessing a web services server.
Web service clients call the published web services, pass in the appropriate parameters, and receive the results.
1.1
SAP HANA Cloud Integration web services are compliant with JAX-WS and Web Services Interoperability (WS-I)
Basic Profile 1.0, and support several Java web services technologies.
Technology
Description
SOAP
WSDL
XML Schema
1.1.1
SOAP
SAP HANA Cloud Integration supports the Simple Object Access Protocol (SOAP).
SOAP is an industry standard from the World Wide Web Consortium (WC3.org) used to invoke network resources
using XML over HTTP, HTTPS, and other standard protocols. SAP HANA Cloud Integration supports SOAP over
HTTP and HTTPS protocols.
1.1.2
WSDL
Web Services Description Language (WSDL) is a subset of XML used as a transport mechanism for XML
messages.
The WSDL file generated by the software includes elements (such as services, bindings, ports, and operations)
that support the use of the SOAP protocol. Each element uses a name that the software provides.
This table shows the elements in a WSDL file, and describes how those elements are used in the SAP HANA Cloud
Integration WSDL file.
Element Name
Description
definition
Root element.
service
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Element Name
Description
port
Defines a specific web service endpoint that a client can access. Each port
has a unique name and a specific address used for binding. The software
defines a single port that contains the operations.
portType
operation
message
type
Defines the data types used in messages sent to and from a web service.
1.1.2.1
Access the WSDL file by making web service client calls to it using your HCI URL.
Use the information in the WSDL file provided by SAP HANA Cloud Integration to create an application that can
access tasks.
To view the WSDL file so that you can create your application, open a browser window and navigate to:
http://<hci_url>/DSoD/webservices?wsdl
Example
http://integration.ondemand.com/DSoD/webservices?wsdl
Note that the primary WSDL contains only a readable listing of the available web service operations. A secondary,
imported WSDL defines the XML schema of the services:
http://<hci_url>/DSoD/webservices?wsdl=SoapGateway.wsdl
Example
http://hcids.us1.hana.ondemand.com/DSoD/webservices?wsdl=SoapGateway.wsdl
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
1.1.3
XML Schema
WSDL uses XML Schemas to define input and output message formats.
XML Schema formats are defined in the types element of the WSDL file.
1.1.4
UDDI
UDDI is a method of publishing comments and other reference information about jobs to an external web site.
SAP HANA Cloud Integration does not publish information to a UDDI web site because most web service users
work behind enterprise firewalls.
1.2
The tools you use to develop your web services client are your choice and the exact steps in using those tools
vary, but these basic steps apply as a simple overview to all development projects for web services clients.
Context
To use a published web service, you must first know the URL of the target WSDL.
The primary SAP HANA Cloud Integration WSDL file is located at:
http://<hci_host>:<port>/DSoD/webservices?wsdl
Procedure
1.
Import the software's WSDL into your development environment to create a web services client application.
The incorporated web services appear in the hierarchy of your development.
2.
3.
Write the code to call any of the jobs or services provided by the ports.
4.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
SAP HANA Cloud Integration provides a WSDL file with a single service definition.
It is possible to create multiple service definitions in a WSDL, but many web service implementations do not
support more than one service definition. To avoid that limitation, the software creates only one service.
2.1
Connection operations
The SAP HANA Cloud Integration WSDL defines connection operations that belong to web services.
The software supports the following Connection operations:
Operation
Description
ping
logon
logoff
2.1.1
ping
Request message
Table 1: ping elements
Element
Type
Description
SessionID
xs:string
If a session ID is not specified in the request message, the ping operation returns an error message that the
server is available but no ID was specified.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Response message
Table 2: pingResponse elements
Element
Type
Description
Message
xs:string
For more information about the structure of the ping request and response messages, refer to the SAP HANA
Cloud Integration WSDL.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
2.1.2
logon
The logon operation provides basic user authentication and returns a valid web services session ID.
Web service logon operations are logged in the SAP HANA Cloud Integration security log.
Request message
Table 3: logonRequest elements
Element
Type
Description
orgName
xs:string
userName
xs:string
password
xs:string
The password.
isProduction
xs:boolean
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Response message
Table 4: logonResponse elements
Element
Type
Description
SessionID
xs:string
Possible values
Description
Authorization
Basic
<authorization>
orgName
Alphanumeric characters
dsodEnv
PRODUCTION
SANDBOX
SOAPAction
function=logon
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Note
When using HTTP-based authentication to log on to the SAP HANA Cloud Integration web services from a SAP
Data Services job, you must still include the logonRequest element in the message body because SAP Data
Services does not support an empty mapping. Instead, specify a null value for each element of the
logonRequest message.
For more information about the structure of the logon request and response messages, refer to the SAP HANA
Cloud Integration WSDL.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
2.1.3
logout
The logout operation logs the user out of the system and destroys the specified session.
Web service logout operations are logged in the SAP HANA Cloud Integration security log.
Request message
Table 6: logout elements
Element
Type
Description
SessionID
xs:string
Response message
Table 7: logoutResponse elements
Element
Type
Description
LogoutMessage
xs:string
For more information about the structure of the logout request and response messages, refer to the SAP HANA
Cloud Integration WSDL.
10
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
2.2
Project operations
The SAP HANA Cloud Integration WSDL defines project operations that allow you to execute tasks and retrieve
execution status information.
The software supports the following Project operations:
Operation
Description
runTask
getTaskStatusByRunID
Returns the status of the task execution with the specified run ID.
getTaskLogs
Retrieves the trace, monitor, or error log for the task execution with the
specified run ID.
Access restrictions
The roles of the user that created the web services session determines whether the project services have access
to the sandbox or production repository.
Table 8: Repository access for project services
User role
Sandbox
Production
Integration developer
Yes
No
Production operator
No
Yes
Administrator
Yes
Yes
No
No
Note
The role-based repository access is additive. That is, if the user is assigned both the Integration developer
and Production operator roles, the project services will be able to access both repositories.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
11
SOAP header
All project services may be accessed only by specifying a valid web services session ID obtained from the logon
operation. The session ID must be specified in the SOAP header of the web service request.
Table 9: SOAP header elements
Element
Type
Description
SessionID
xs:string
2.2.1
runTask
The runTask operation executes a task in either the sandbox or production repository.
Request message
Table 10: runTaskRequest elements
Element
Type
Description
taskName
xs:string
agentName
xs:string
globalVariables
xs:sequence
Response message
Table 11: runTaskResponse elements
Element
Type
Description
RunID
xs:string
For more information about the structure of the runTask request and response messages, refer to the SAP
HANA Cloud Integration WSDL.
12
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
2.2.2
getTaskStatusByRunID
The getTaskStatusByRunID operation retreives the status of a task execution with a specified run ID.
To prevent server overload, the getTaskStatusByRunID operation should be called only using a fixed time
overload.
Request message
Table 12: taskStatusRequest elements
Element
Type
Description
runID
xs:int
Response message
Table 13: taskStatusResponse elements
Element
Type
Description
taskStatusRequest
JobID
xs:string
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
13
Element
Type
Description
statusCode
xs:string
TASK:IMPORTED
TASK:RUNNING
TASK:SUCCESS
TASK:ERROR
TASK:QUEUEING
TASK:TERMINATED
TASK:TERMINATED_FAILED
TASK:UNKNOWN
statusMsg
xs:string
startTime
xs:string
endTime
xs:string
executionTime
xs:double
For more information about the structure of the getTaskStatusByRunID request and response messages, refer
to the SAP HANA Cloud Integration WSDL.
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
2.2.3
getTaskLogs
The getTaskLogs operation retrieves the trace, monitor, or error logs for a task execution with a specified run ID.
Request message
Table 14: taskLogsRequest elements
Element
Type
Description
runID
xs:int
14
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Element
Type
Description
base64Encode
xs:boolean
traceLog
tns:LogType
monitorLog
tns:LogType
errorLog
tns:LogType
Type
Description
getLog
xs:boolean
pageNum
xs:int
Response message
Table 16: taskLogsResponse elements
Element
Type
Description
traceLog
tns:LogContent
monitorLog
tns:LogContent
errorLog
tns:LogContent
Type
Description
maxPage
xs:int
pageNum
xs:int
isJobRunning
xs:boolean
messageLines
xs:string
For more information about the structure of the getTaskLogs request and response messages, refer to the SAP
HANA Cloud Integration WSDL.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
15
Related Information
Accessing the WSDL file [page 4]
Access the WSDL file by making web service client calls to it using your HCI URL.
16
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
Error reporting
In addition to the output message for each web services operation, the SAP HANA Cloud Integration returns a
fault message when an error occurs.
Fault message
Table 18: WebFaultException elements
Element
Type
Description
faultCode
xs:string
faultString
xs:string
Connection:Authentication
Services:Authorization
Services:Server
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
17
Accessibility
The information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a
binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does
not apply in cases of wilful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.
Gender-Neutral Language
As far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales
person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not
exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.
Internet Hyperlinks
The SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not
warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages
caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency
(see: http://help.sap.com/disclaimer).
18
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
PUBLIC
2014 SAP SE or an SAP affiliate company. All rights reserved.
19
www.sap.com/contactsap