Вы находитесь на странице: 1из 8

10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Configure OData V2 Receiver


Adapter
Send feedback

Configure the OData receiver adapter by understanding the adapter parameters.

Remember
This component or some of its features might not be available in the Cloud Foundry environment. For more
information on the limitations, refer to SAP Note 2752867 .

OData receiver adapter supports externalization. To externalize the parameters of this adapter
choose Externalize and follow the steps mentioned in Externalize Parameters of an Integration Flow.

Note
OData adapter does not support $format in query options.

OData adapter supports sending error response in exception subprocess. The error response body will
be part of expression ${in.body}.

OData services response code is captured in the camelhttpresponsecodeheader.

Connection

Field Description

Address URL of the OData V2 service that you want to connect to.

Proxy Type The type of proxy you want to use for establishing connection with OData V2
service.

Currently, you can choose between Internet (default) and On-Premise.

Location ID Location ID that you have configured in the cloud connector installed on your
system.
Enabled only if you choose Proxy
Type as On-Premise.

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 1/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Authentication
Authentication method that you want to use for connecting to the OData V2
service. Currently, you can choose between

None

Basic

Principal Propagation

Client Certificate

The following options are enabled only if you choose Proxy


Type as Internet

OAuth2 Client Credentials: Use this a grant type to access web


resources by authorizing the client application to perform required
actions on behalf of an user.

OAuth2 SAML Bearer Assertion: If you have chosen this option, the
identity of the user associated with the sender application is
forwarded from the sender account to the receiver account.

Credential Name Credential name of the credentials that you have deployed inSecurity
Material section of (Operations View) .
Enabled only if you
choose Authentication as Basic, OAuth2
Client Credentials, or OAuth2 SAML
Bearer Assertion.

Private Key Alias Enter the private key alias that enables the system to fetch the private key
from keystore for authentication.
Note
This option is enabled only if you
Restriction
select client certificate authentication. The values true and false are not supported for this field.

CSRF Protected Keep this option selected (default setting). It ensures that your integration
flow is protected against Cross-Site-Request-Forgery, a kind of attack where
a malicious party can perform harmful actions by masquerading as the
logged in user

Processing

Field Description

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 2/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Operation Details
The operation that you want to perform on
resource.

Note
For non-GET operations, if the server
code, the same response code is acce

Resource Path Choose Select to launch the Model Oper


table Model Operation for fields and des
wizard.

Note
You can also specify the Resou
using a header or a property (w
like ${header.resourcePath
however, XPath expressions ar
parameter.

Navigation entities in the resou

Note
When you use this adapter with the Up
the following format when specifying th
parameter: EntitySetName(key=va

Example (for EntitySetName=Product)

Product(productId='001')

Query Options Query options that you are passing as a p


service.
Enabled for Query(GET) andRead(GET)operations.

Fields Fields in the entity that you are performing


Model Operation wizard, the input for this
Enabled
for Create(POST), Merge(MERGE),Patch(PATCH)andUpdate(PUT)operations.

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 3/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Enable Batch Processing


Select to perform multiple operations in on
service in the $batch mode.

Note
$batch mode is not supported for GET

Custom Query Options Additional query options that are not avail
Operationwizard.

Content Type Type of content that you are sending to th

Available only for Merge(MERGE)andPatch(PATCH)operation.

Content Type Encoding Encoding type used for sending content to

Available only for Merge(MERGE)andPatch(PATCH)operation.

Page Size Maximum number of records that should b

The value is set to Empty by default.

If no value is set, then Server-side pagina


considered.

If a value is entered, Client-side paginatio


provided.

Note
It is recommended to leave the value E

Timeout (in min) Maximum time the adapter should wait fo


OData V2 service.

HEADER DETAILS Request Headers : Provide the | (Pipe) s


request headers that has to be sent to the

If the value * is entered, all the message h


request headers and will be forwarded.

Response Headers : Provide the | (Pipe)


response headers. The received header v
message/exchange headers.

If the value * is entered, all the HTTP resp


converted to message/exchange headers

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 4/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Metadata Details OData receiver adapter makes a $metada


call. Not all headers or query parameters
If your service needs some headers (for e
a customer authorization header to invoke
then you can provide the same in the requ
parameters.

Request headers provide comma separat


sent to $metadata call. Custom query par
query parameters, separated by & in case

Process in Pages is a checkbox that is enabled only when you are performing the Query(GET) operation. By
selecting Process in Pages, you enable the adapter to process messages. The size of a message is defined by the
value that you specify in Page Size.

IMPORTANT: You should select the Process in Pages checkbox if you are using the adapter in a Local Integration
Process that is invoked by a Looping Process Call step.

In the Looping Process Call, select Expression Type as Non-XML, Condition Expressionas ${property.
<receiver.name>.<channel.name>.hasMoreRecords} contains 'true', and Maximum Number of
Iterations as 999.

This option is not enabled for Content Enricher.

Note
You can pass custom HTTP headers to OData receiver if you have defined the header in content modifier or
script element and the element is placed before OData receiver adapter in an integration flow.

Modeling Operation
This adapter provides a wizard for modeling operations easily. It is recommended that you use this wizard to ensure
that the operation does not contain any errors. The wizard can also fetch the Externalized parameters that are
maintained under the Connectiondetails of the OData V2 outbound adapter.

There are two main steps in this wizard:

1. Connect to System: In this step, you provide the details required for connecting to the web service that you
are accessing.

2. Select Entity and Define Operation: In this step, you select the operation you want to perform and the entity
on which you want to perform the operation on. After selecting the entity, you also select the fields, filtering

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 5/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

and sorting conditions.

3. Configure Filter & Sorting: This step is available only for data fetch operations, where you can define the
order in which the records are fetched in the response payload and filter for the fields that you require.

Connect to System

Field Description

Connection Source You can choose between Remote and EDMX.

If you choose Remote, you have to manually specify all the details like address and
authentication details.

If you choose Local EDMX File, you select the service definition EDMX file which
contains all these details that you specified manually when you selected Remote.

Local EDMX File Choose Select to select the EDMX service schema. You can also manually upload it
from your local file system.
Enabled only if you
select Connection
Source as Local EDMX File.

Address URL of the service that you want to access. If you are connecting to an on-premise
system, enter the Virtual Host in your Cloud Connector installation.

Proxy Type Type of proxy that you want to use to connect to the service.

Enabled only if you


select Connection
Source as Remote.

Location ID Location ID that you have configured in the Cloud Connector installation.

Enabled only if you select Proxy


Type as On-Premise.

Authentication Only Basic authentication is supported. You can deploy credentials in (Operations
View) and provide the Credential Name or provide the Username and Password.

Select Entity & Define Operation

Field Description

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 6/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Operation Select the operation that you want to perform.

The adapter supports Function Import for functions which return entity or collection of entities. Below return
types are not supported:

Complex types

Collection of complex types

Simple types

Collection of simple types

Void

Function Import can also be consumed in the $batch mode.

Sub- Sub-levels of the entity that you want to access. For example, if you want to access the field Description in
Levels the entity Products, and the field is located at Category Products Description, you select the Sub
Levels as 3 since the field you want to access is at the third level.

Select Entity that you want to perform the operation on.


Entity

Fields Fields associated with the entity that you want to perform the operation on.

Top Specifies the top 'n' number of entries to be fetched.

For more information, see Top System Query Option ($top) in OData V2 URI Conventions

Skip Specifies the top 'n' number of entries to be skipped and the rest of the entries are fetched.

For more information, see Skip System Query Option ($skip) in OData V2 URI Conventions .

This step is available only for data fetch operations, Query(GET) and Read(GET).

Configure Filter & Sorting

Field Description

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 7/8
10/9/2019 Configure OData V2 Receiver Adapter - SAP Help Portal

Field Description

Filter Select the field that you want to use as reference for filtering, choose the operation (ex: Less Than or Equal),
By and provide a value.

Note
The IN operation is available under filtering when editing the query manually. This operation is not available
in the Query Modelling wizard.

The IN operator should be used in lower case in the query. Example:

Example
https://<hostname>/odata/v2/User?$filter=userId in 'ctse1','mhuang1','flynch1'

For more information, see Customized Operators

Sort Select the field that you want to use as sorting parameter and choose Ascending orDescending order.
By

https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/c5c2e38e0c87472e996dfda04920bfc4.html 8/8