SAP OData microservice connector for Sesam.io powered apps.
Supports:
- SAP OData v2
- Odata v4
- Basic Authentication
- OAuth Token Authentication with refresh
- OAuth2 Authentication with refresh
- JSON streaming of response messages
- Snapshot paging
- Dynamic URL query handling
- Delta import
SERVICE_URL - base url to the Odata Service API
AUTH_TYPE - Authentication method ("basic", "token" or "oauth2")
LOG_LEVEL - Default 'INFO'. Ref: https://docs.python.org/3/howto/logging.html#logging-levels
USERNAME - Username to authenticate with the Odata Service
PASSWORD - Password to authenticate with the Odata Service
{
"_id": "sap-odata-source",
"type": "system:microservice",
"docker": {
"environment": {
"AUTH_TYPE": "basic",
"LOG_LEVEL": "INFO",
"PASSWORD": "$SECRET(sap-password)",
"SERVICE_URL": "https://<service_url>/odata/v2/",
"USERNAME": "$SECRET(sap-username)"
},
"image": "sesamcommunity/sap-odata-source:<version>",
"port": 5000
},
"verify_ssl": true
}
TOKEN_URL - URL to fetch authentication token
TOKEN_REQUEST_HEADERS - JSON formatted headers supplied by customer
TOKEN_REQUEST_BODY - JSON formatted body supplied by customer
{
"Authorization": "Basic <JWT to authenicate with TOKEN_URL>",
"user-agent": "sap-odata-source/x.y.z"
}
{
"grant_type": "client_credentials",
"scope": {
"userId": "<userId>",
"companyId": "<companyId>",
"userType": "<userType>",
"resourceType": "<resourceType>"
}
}
OAuth2 authentication is a two step process:
- Fetch assertion key using private key supplied by customer:
ASSERTION_URL - URL to fetch assertion key
ASSERTION_REQUEST_HEADERS - JSON formatted headers (Default: {"Content-Type": "application/x-www-form-urlencoded"})
CLIENT_ID - Supplied by customer
USER_ID - Supplied by customer
PRIVATE_KEY - Secret to authenticate with assertion service
- Fetch authentication token using assertion key:
TOKEN_URL - URL to fetch authentication token
TOKEN_REQUEST_HEADERS - JSON formatted headers (Default: {"Content-Type": "application/x-www-form-urlencoded"})
COMPANY_ID - Supplied by customer
GRANT_TYPE - Supplied by customer (ex: "urn:ietf:params:oauth:grant-type:saml2-bearer")
{
"_id": "sap-odata-source",
"type": "system:microservice",
"docker": {
"environment": {
"ASSERTION_URL": "<assertion url>",
"AUTH_TYPE": "oauth2",
"CLIENT_ID": "<client id>",
"COMPANY_ID": "<company id>",
"GRANT_TYPE": "<grant type>",
"LOG_LEVEL": "INFO",
"PRIVATE_KEY": "$SECRET(private-key)",
"SERVICE_URL": "<service url>",
"TOKEN_URL": "<token url>",
"USER_ID": "<user id>"
},
"image": "sesamcommunity/sap-odata-source:<version>"
"port": 5000
},
"verify_ssl": true
}
Default since property for which to evaluate delta import is lastModifiedDateTime.
Supply since_property=<last modified date property> in pipe.source.url to override the default:
"url": "PerPerson?since_property=<last modified date property>"
{
"_id": "sap-odata-source-perperson",
"type": "pipe",
"source": {
"type": "json",
"system": "sap-odata-source",
"is_since_comparable": true,
"supports_since": true,
"url": "PerPerson"
},
"transform": {
"type": "dtl",
"rules": {
"default": [
["copy", "*"],
["add", "_id", "_S.personIdExternal"],
["add", "rdf:type",
["ni", "successfactors", "PerPerson"]
]
]
}
}
}
{
"d": {
"results": [
{
"__metadata": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "test01",
"placeOfBirth": null,
"lastModifiedDateTime": "/Date(1587072082000+0000)/",
"lastModifiedBy": "adminPM",
"createdDateTime": "/Date(1587072082000+0000)/",
"dateOfBirth": "/Date(166838400000)/",
"perPersonUuid": "F674BA4105E24E299485FD660935F2DF",
"createdOn": "/Date(1587079282000)/",
"lastModifiedOn": "/Date(1587079282000)/",
"countryOfBirth": null,
"createdBy": "adminPM",
"personId": "467",
"personalInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personalInfoNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/emergencyContactNav"
}
},
"personEmpTerminationInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personEmpTerminationInfoNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/phoneNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/employmentNav"
}
},
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/countryOfBirthNav"
}
},
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personRerlationshipNav"
}
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/nationalIdNav"
}
},
"userAccountNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/userAccountNav"
}
},
"personTypeUsageNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personTypeUsageNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/emailNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/homeAddressNavDEFLT"
}
}
},
{
"__metadata": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')",
"type": "SFOData.PerPerson"
},
"personIdExternal": "test01_d0",
"placeOfBirth": null,
"lastModifiedDateTime": "/Date(1587072081000+0000)/",
"lastModifiedBy": "adminPM",
"createdDateTime": "/Date(1587072081000+0000)/",
"dateOfBirth": "/Date(293760000000)/",
"perPersonUuid": "61C27B6410744754A1BE0FC843454AC3",
"createdOn": "/Date(1587079281000)/",
"lastModifiedOn": "/Date(1587079281000)/",
"countryOfBirth": null,
"createdBy": "adminPM",
"personId": "468",
"personalInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personalInfoNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/emergencyContactNav"
}
},
"personEmpTerminationInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personEmpTerminationInfoNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/phoneNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/employmentNav"
}
},
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/countryOfBirthNav"
}
},
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personRerlationshipNav"
}
},
"nationalIdNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/nationalIdNav"
}
},
"userAccountNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/userAccountNav"
}
},
"personTypeUsageNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personTypeUsageNav"
}
},
"emailNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/emailNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/homeAddressNavDEFLT"
}
}
}
]
}
}
[
{
"__metadata": {
"type": "SFOData.PerPerson",
"uri": "https://<service_url>/odata/v2/PerPerson('test01')"
},
"countryOfBirth": null,
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/countryOfBirthNav"
}
},
"createdBy": "adminPM",
"createdDateTime": "2020-04-16T21:21:22+0000",
"createdOn": "2020-04-16T23:21:22+0000",
"dateOfBirth": "1975-04-16T00:00:00+0000",
"emailNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/emailNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/emergencyContactNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/employmentNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/homeAddressNavDEFLT"
}
},
"lastModifiedBy": "adminPM",
"lastModifiedDateTime": "2020-04-16T21:21:22+0000",
"lastModifiedOn": "2020-04-16T23:21:22+0000",
"nationalIdNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/nationalIdNav"
}
},
"perPersonUuid": "F674BA4105E24E299485FD660935F2DF",
"personEmpTerminationInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personEmpTerminationInfoNav"
}
},
"personId": "467",
"personIdExternal": "test01",
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personRerlationshipNav"
}
},
"personTypeUsageNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personTypeUsageNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/personalInfoNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/phoneNav"
}
},
"placeOfBirth": null,
"userAccountNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01')/userAccountNav"
}
}
},
{
"__metadata": {
"type": "SFOData.PerPerson",
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')"
},
"countryOfBirth": null,
"countryOfBirthNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/countryOfBirthNav"
}
},
"createdBy": "adminPM",
"createdDateTime": "2020-04-16T21:21:21+0000",
"createdOn": "2020-04-16T23:21:21+0000",
"dateOfBirth": "1979-04-24T00:00:00+0000",
"emailNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/emailNav"
}
},
"emergencyContactNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/emergencyContactNav"
}
},
"employmentNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/employmentNav"
}
},
"homeAddressNavDEFLT": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/homeAddressNavDEFLT"
}
},
"lastModifiedBy": "adminPM",
"lastModifiedDateTime": "2020-04-16T21:21:21+0000",
"lastModifiedOn": "2020-04-16T23:21:21+0000",
"nationalIdNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/nationalIdNav"
}
},
"perPersonUuid": "61C27B6410744754A1BE0FC843454AC3",
"personEmpTerminationInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personEmpTerminationInfoNav"
}
},
"personId": "468",
"personIdExternal": "test01_d0",
"personRerlationshipNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personRerlationshipNav"
}
},
"personTypeUsageNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personTypeUsageNav"
}
},
"personalInfoNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/personalInfoNav"
}
},
"phoneNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/phoneNav"
}
},
"placeOfBirth": null,
"userAccountNav": {
"__deferred": {
"uri": "https://<service_url>/odata/v2/PerPerson('test01_d0')/userAccountNav"
}
}
}
]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent