THIS ARTICLE IS EXTRACTED FROM OUR SYNC INSTALLATION GUIDE PDF – PLEASE REFER TO THE INSTALLATION FOR FULL CONTEXT AND REFERENCE
If you have data source rows that you wish to make continuously available to the app, the best way is to make use of Sync’s Hosted GET support.
You need to create your desired data source tables in the SyncData database, naming the tables by the External Id you have assigned to the matching Data Source in our platform.
Once set up, the app will directly request rows from the SyncData database table, bypassing the need to have rows on our platform altogether.
Within the Sync application, a data source REST API is exposed with a single on GET function which accepts a data source request and generates a response containing the specified SyncData database tables, where external id is the table name.
This API is accessible on the configured https://{IP Address/Domain Name}/api/v1/datasources.
In order to take advantage of this, add a Hosted GET connector within the Platform for each data source as follows:
- Login to the Platform
- Navigate to Connected Data -> Data Sources and click the settings link on the target data source.
- Ensure that you have set the External Id field with a value – this MUST match the name of the table you’ve created in the SyncData database.
- Mouse over Add Connector and select Hosted GET
- Enter the connector details as per the screenshot below (enter your own Sync installation’s data sources target URL) and click Save.
If you are setting up many data sources with Hosted GET connectors, then you may want to set the Global Hosted GET URL found in the Menu -> Organisation Setup page.
Set this to be the Sync API endpoint and then on all Hosted GET connectors, instead of filling in the “Target GET URL” rather just to the “Use Global Hosted GET URL” option.
IMPORTANT NOTES
- Each platform Data Source External Id must match that of the SyncData table’s name.
- Columns in the data source must follow the same order as the columns in the related table.