Difference between revisions of "Odata Overview"
From SmartWiki
Michael Reid (talk | contribs) |
Michael Reid (talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | What is OData? | + | |
| + | ==What is OData?== | ||
| + | |||
OData is described in the following article: [https://en.wikipedia.org/wiki/Open_Data_Protocol] | OData is described in the following article: [https://en.wikipedia.org/wiki/Open_Data_Protocol] | ||
==How does it work== | ==How does it work== | ||
| − | + | SmartSimple provides OData V4 services. These can be consumed by OData clients such as MS Excel, MS SQL server, SaleForce, or used though another API such as .NET. | |
| + | |||
| + | ==SmartSimple Entities Exposed to OData Services== | ||
| + | |||
| + | Currently Reports are the only entities exposed through Odata. In the future other entities may be added. Reports were chosen for the following reasons: | ||
| + | |||
| + | # Easier to control security and data format like fields and fieldname, any end user can perform this task | ||
| + | # Most clients consume ready only data anyway | ||
| + | # Data relationships are handled in SS, external client does not need to understand underlying data relationships | ||
| + | #Easy to implement as no need to configure OData service and metadata enpoints(these are required by OData protocol), it is handled by SS report engine automaticaly | ||
| + | # More flexible as SS user are able to create dummy tables (like SQL views) by combining tables , applying formulas and aggregations | ||
| + | # Filtering ans ordering are pre-defined in SS report, eliminate SQL injection vulnerability | ||
| + | |||
| + | |||
| + | ==Where is my OData services endpoint ?== | ||
| + | |||
| + | https://mysmartsimpleurl/OData/V4/Services.svc/ How to setup in SS ? | ||
| + | |||
| + | 1. Create a new user and set access to "web access" | ||
| + | |||
| + | 2. Set a password 3. Edit report in neo builder and enable OData checkBox | ||
| + | |||
| + | 4. Done How to connect from Salesforces ? I will add more details with screen shots How to connect from MSExcel ? | ||
| + | |||
| + | I will add more details with screen shots | ||
Revision as of 14:57, 22 November 2016
Contents
What is OData?
OData is described in the following article: [1]
How does it work
SmartSimple provides OData V4 services. These can be consumed by OData clients such as MS Excel, MS SQL server, SaleForce, or used though another API such as .NET.
SmartSimple Entities Exposed to OData Services
Currently Reports are the only entities exposed through Odata. In the future other entities may be added. Reports were chosen for the following reasons:
- Easier to control security and data format like fields and fieldname, any end user can perform this task
- Most clients consume ready only data anyway
- Data relationships are handled in SS, external client does not need to understand underlying data relationships
- Easy to implement as no need to configure OData service and metadata enpoints(these are required by OData protocol), it is handled by SS report engine automaticaly
- More flexible as SS user are able to create dummy tables (like SQL views) by combining tables , applying formulas and aggregations
- Filtering ans ordering are pre-defined in SS report, eliminate SQL injection vulnerability
Where is my OData services endpoint ?
https://mysmartsimpleurl/OData/V4/Services.svc/ How to setup in SS ?
1. Create a new user and set access to "web access"
2. Set a password 3. Edit report in neo builder and enable OData checkBox
4. Done How to connect from Salesforces ? I will add more details with screen shots How to connect from MSExcel ?
I will add more details with screen shots
