pfx-odata2:read | Pricefx Knowledge Base

Gets/lists entities from the external system.

Properties

Option	Type	Default	Description
`connection`	String		Defines a connection to the target system. Another way to define the connection is to specify the `serviceUrl`, `username` and `password` options (see below).
`serviceUrl`	String		Defines the URL of the target system. Use if the connection is not specified.
`username`	String		Defines the username for authentication. Use if the connection is not specified.
`password`	String		Defines the password for authentication. Use if the connection is not specified.
`entity`	String		Defines the entity type.
`id`	String		Defines the entity identifier. Mandatory for the update/delete methods. Optional for the read method.
`$select`	String	*	Specifies a subset of the entity properties that should be returned back. If not specified, all properties are selected. It is a comma-separated list. E.g. `$select=Id,ProductName,NetPrice`
`$filter`	String		A predicate expression that selects only entities which match the expression. E.g. `$filter=NetPrice le 200 and NetPrice gt 3.5` Logical operators: `eq`, `ne`, `gt`, `ge`, `lt`, `le`, `and`, `or`, `not` Arithmetic operators: `add`, `sub`, `mul`, `div`, `mod` Grouping operators: `()`
`$orderby`	String		Determines what values are used to order a collection of selected entities. E.g. `$orderby=NetPrice asc,ProductName desc`
`$skip`	Integer		Defines the number of records to skip (from the beginning). If defined, the selected collection skips the first N entities and returns just the remaining subset.
`$top`	Integer		Defines the number of records to include (from the beginning). If defined, just the first N entities from the selected collection are selected.
`$inlinecount`	String	none	Supported values are: `allpages` – The response must contain the count of all selected entities after applying the `$filter` option. The count is returned as a header with the key `PfxOpenData2.$inlinecount`. `none` – The response must not contain the count in the response.

Examples

Search for entities and load them into Pricefx:

XML

<route id="sap4hana-list-with-connection">
    <from uri="timer:in?repeatCount=1&delay=5000"/>
    <to uri="pfx-odata2://read?entity=A_CreditMemoRequest&$select=CreditMemoRequest,TransactionCurrency,TotalNetAmount,CreditMemoRequestType,PricingDate,CreditMemoRequestDate&$filter=TransactionCurrency eq 'USD' and OverallSDProcessStatus eq 'A'&$orderby=CreditMemoRequest desc&$top=1&$skip=0&connection=cognitus"/>
    <to uri="pfx-api:loaddata?objectType=P&connection=aperture-labs&mapper=pfimcore354"/>
</route>

Authenticate using serviceUrl and credentials in URI:

XML

<route id="sap4hana-list-with-properties-connection-details">
    <from uri="timer:in?repeatCount=1&delay=5000"/>
    <to uri="pfx-odata2://read?entity=A_CreditMemoRequest&$select=CreditMemoRequest,TransactionCurrency,TotalNetAmount,CreditMemoRequestType,PricingDate,CreditMemoRequestDate&$filter=TransactionCurrency eq 'USD' and OverallSDProcessStatus eq 'A'&$orderby=CreditMemoRequest desc&$top=1&$skip=0&serviceUrl={{sap.url}}&username={{sap.username}}&password={{sap.password}}"/>
    <to uri="pfx-api:loaddata?objectType=P&connection=aperture-labs&mapper=pfimcore354"/>
</route>

Search for an entity defined by a single ID:

XML

<route id="sap4hana-get">
    <from uri="timer:in?repeatCount=1&delay=5000"/>
    <setHeader headerName="PfxOpenData2.id"><constant>60000001</constant></setHeader>
    <to uri="pfx-odata2://read?entity=A_CreditMemoRequest&connection=cognitus"/>
    <to uri="pfx-api:loaddata?objectType=P&connection=aperture-labs&mapper=pfimcore354"/>
</route>

Search for an entity defined by a composite ID:

XML

<route id="sap4hana-get-with-composite-id">
    <from uri="timer:in?repeatCount=1&delay=5000"/>
    <setHeader headerName="PfxOpenData2.id"><groovy>['CreditMemoRequest':'60000001','CreditMemoRequestItem':'10']</groovy></setHeader>
    <to uri="pfx-odata2://read?entity=A_CreditMemoRequestItem&connection=cognitus"/>
    <to uri="pfx-api:loaddata?objectType=P&connection=aperture-labs&mapper=pfimcore354"/>
</route>

Batch read and upload to Pricefx:

XML

<route id="sap4hana-batch-read" autoStartup="true">
    <from uri="timer:in?repeatCount=1&delay=5000"/>
    <!-- Read with option '$inlinecount=allpages' that returns count of all records along with first batch -->
    <to uri="pfx-odata2://read?entity=A_CreditMemoRequest&$skip=0&$top=0&$inlinecount=allpages&connection=cognitus"/>
    <log message="Detected [${headers['PfxOpenData2.$inlinecount']}] records." />
 
    <!-- Set batch size -->
    <setHeader headerName="$top"><constant>4</constant></setHeader>
 
    <loop doWhile="true">
        <groovy>headers['PfxOpenData2.$inlinecount'] > (exchange.getProperty('CamelLoopIndex', 0, Integer) + 1) * headers.$top.toInteger()</groovy>
        <setHeader headerName="$skip"><groovy>exchange.getProperty('CamelLoopIndex', 0, Integer) * headers.$top.toInteger()</groovy></setHeader>
        <log message="Batch [#${exchangeProperty.CamelLoopIndex}]. Fetching [${header.$top}] elements form index [${header.$skip}]. "/>
        <to uri="pfx-odata2://read?entity=A_CreditMemoRequest&connection=cognitus"/>
        <log message="Processing ${body}"/>
        <to uri="pfx-api:loaddata?objectType=P&connection=aperture-labs&mapper=pfimcore354"/>
    </loop>
 
    <log message="Job done. Fetched [${headers['PfxOpenData2.$inlinecount']}] in [${exchangeProperty.CamelLoopIndex} + 1)] batches with size [${header.$top}]."/>
 
</route>