OData Query Builder Connector for SAP solutions

Content Type: Module
Categories: SAP Connector

Overview

Allow you to construct an OData query in a microflow from its basic components without needing to construct the query string in an HTTP compliant way, and without needing to know all the details of constructing OData queries.

Documentation

Introduction

The OData Query Builder widgets from the App Store allow you to construct an OData query in a microflow from its basic components without needing to construct the query string in an HTTP compliant way, and without needing to know all the details of constructing OData queries.

How to Build Your Query

Starting Your Query

All query microflows begin with a Start action, which specifies the location of the OData service and the Collection name you are querying. This returns an object which is used by all the other actions to add more OData parameters to the query.

Creating a Filter

You can filter your results by comparing it with a single value held as the attribute of an object (Filter object) or with several values held as an attribute in a list of objects (Filter list).

You can use several filters in your query by combining them with a Join action.

Counting Items Returned

You can either just return a count of the number of objects found by your query, using the Count action, or return the count in addition to the returned objects using the Count Inline action.

Returning Associated Objects

You can expand your query to include objects which are associated with the objects found by your query by using the Expand action.

Sorting Your Objects

You can sort the objects which are returned by your query using the Order By action.

Returning a Subset of Objects

You can limit the number of object returned by your query by using the Top action to return a specific number of objects, and the Skip action to return objects which are not at the top of the list of items found by the query.

Creating the Query String

All query microflows end with the Build String action which takes the object to which the OData Query Builder actions have been added, and returns a string which is the OData query.

Read More

More information about OData queries can be found in the following documents:

Releases

Version: 1.1.5
Framework Version: 8.18.10
Release Notes: Updated to Mendix v8.18.10
Version: 1.1.4
Framework Version: 8.15.1
Release Notes: - Bug fix in 'AddJoin' action
Version: 1.1.3
Framework Version: 8.15.1
Release Notes: Updated filter actions to check for attribute type for adding quote.
Version: 1.1.2
Framework Version: 8.15.1
Release Notes: Upgraded Mendix Studio Pro version to 8.15.1
Version: 1.1.1
Framework Version: 8.9.0
Release Notes: remove unused libraries
Version: 1.1.0
Framework Version: 8.9.0
Release Notes: Following improvements has been done 1. Providing format in query as optional. 2. Added NOT operation. 3. Added Date support in filter query. 4. Added two parameters options for filter. 5. Supported Functions in filter query $filter=substringof('Alfreds', CompanyName) $filter=endswith(CompanyName, 'Futterkiste') $filter=startswith(CompanyName, 'Alfr') $filter=length(CompanyName) eq 19 $filter=indexof(CompanyName, 'lfreds') eq 1 $filter=substring(CompanyName, 1) eq 'lfreds Futterkiste' $filter=tolower(CompanyName) eq 'alfreds futterkiste' $filter=toupper(CompanyName) eq 'ALFREDS FUTTERKISTE' $filter=trim(CompanyName) eq 'Alfreds Futterkiste' $filter=concat(City, '_ABC') eq 'Berlin_ABC' $filter=day(BirthDate) eq 8 $filter=hour(BirthDate) eq 0 $filter=minute(BirthDate) eq 0 $filter=month(BirthDate) eq 12 $filter=second(BirthDate) eq 0 $filter=year(BirthDate) eq 1948 $filter=round(Freight) eq 32 $filter=floor(Freight) eq 32 $filter=ceiling(Freight) eq 33 $filter=isof('NorthwindModel.Order') $filter=isof(ShipCountry, 'Edm.String') 6. Functions not supported $filter=substring(CompanyName, 1, 2) eq 'lf' $filter=concat(concat(City, ', '), Country) eq 'Berlin, Germany' $filter=replace(CompanyName, ' ', '') eq 'AlfredsFutterkiste'
Version: 1.0.0
Framework Version: 7.23.3
Release Notes: Initial release for OData Query Builder Connector for SAP solutions. Limitation: - There is no NOT operation - There are other operators that also need two parameters - You cannot put constants into filters - You can put elements in the wrong order and end up with meaningless queries (there is no checking whether you have a meaningful query when you build the string so you need to catch errors when you call the OData function) - You can leave the required parameters empty and this will also cause runtime errors.