SyncSpider platform allows you to connect your local databases with any other SyncSpider supported app/platfrom/system by using our SyncSpider local app.
Here is the list of all tools we are supporting at the moment.
Or, you can simply request and up-vote new integration modules to be developed here.
We are constantly expending the database's we support. At this moment, you can easily connect Active Directory, Firebird, Microsoft Access 200-2007 (mdb), Microsoft Access ab 2010 (accdb), Microsoft SQL Server, MySQL 3.51, MySQL 5.2, MySQL 8.0, and Oracle.
To connect your local database, we will go trough the following steps:
- Install SyncSpider local app and connect it to your database
- Connect SyncSpider local with SyncSpider cloud platform
- Create custom Integration template (Custom templates section)
- Create API token
- Create Entities
Install SyncSpider local app and connect it to your database
First step is installing SyncSpider local app. Download the latest version, and install it.
Next step is connecting your database and setting up the profile.
Note: By using different profiles you can connect various databases you have on your computer with one SyncSpider local installation. One profile can be connected to one database.
To configure, first open this application and click on ‘profiles’ at the upper right side as shown.
Select ‘new profile’ from the drop-down list, give the Name you want and select the connection type you need.
We are creating ‘Microsoft SQL Server’ connection type here as an example.
Enter the driver, server, user id, password and database details, and click SAVE.
If the configuration was successful, you'll see the message ‘profile was saved successfully’.
Now, close this dialog.
Note: You won't be able to save the profile successfully if you don't have Microsoft ODBC driver.
In case you don't, SyncSpider will notify you and give you a download link, or you can simply google Microsoft ODBC driver, and then install it.
Connect SyncSpider local with SyncSpider cloud platform
Now, we need to connect our SyncSpider local (and your database) with SyncSpider cloud app.
Click on ‘properties’ located on the top-right corner of the local app screen.
Now we need to enter the API token and your Module/Template ID.
Next steps ("Create API token" and "Create Custom Integration template") will show you how to get your API token and CIT ID.
Create API token (get API-Token for your Local app)
For the API token, we will go to the web app and click on User / Account section, then select Profile.
There you will find the API section, click on it.
Then name your API token and click Create.
Now simply copy your API token so you can paste it to connection dialog in Local SyncSpider app like shown below.
Leave the Local app opened, and get back to SyncSpider web app to get your Module/Template ID
Create Custom Integration Template (CIT) ( get the Module/Template ID)
Since there is a lot of different use cases and databases, you will have to create your own custom Integration template.
Log in to your SyncSpider dashboard and then click Custom templates
Then, click on ADD INTEGRATION TEMPLATE.
Enter a suitable name and description for the template.
Here, we are keeping the visibility to owner company itself.
Select the integration type as ‘API’ and click on ‘configure’.
Note: You can set visibility of your Custom Integration Template in 3 different ways:
- My company - only visible to your company, the company in which you are creating custom integration template
- Specific companies - if you have an agency account, here you can select which one of your sub-accounts (sub-companies) can see this template
- Public - you can request this custom integration template to be public, so that every SyncSpider user can access your DB or your CRM, ERP, CMS etc. One we make your CIT public, you won't be able to change it anymore.
Next screen will give you the option to add data types, but will we come back to this later.
For the next step, we will only need the ID of your Custom Integration Template (CIT), it is shown on the URL of your CIT
Copy the ID of your CIT to paste it in SyncSpider local connection dialog (in the shown case its 261), like shown below:
-> Tick-mark ‘ACTIVE’ under Auto-Sync.
-> Click ‘Test Connection’.
-> After your get the pop up "API was successfully tested!", close the pop up and click ‘SAVE’.
Now, close this dialog. You should see the notification that AUTO-sync is active like below - indicating that connection is valid.
Creating Entities is essential for connecting your database with SyncSpider.
Entities are noting more than a collection of attributes you want to send/receive with any external system via SyncSpider platform.
e.g. Customer can be an Entity. While Name, Email, Phone number could all be its attributes.
Let us now create your first Entity.
Click on Entities located on the upper left-side of your local SyncSpider app. This will open a new screen with the details to be configured.
Then, click on Create located on the upper left side. Then you will get the option to chose the profile for which you want to create Entities.
Since this is your first database you are creating, you will only have one Profile to select. But, in the future, you may connect more databases and have multiple Profiles to choose.
SyncSpider local will automatically pull all tables from your databases and present them in the dialog, like shown below:
Name your Entity in the Entity name field.
Now, select the table from which you need to get the data, the fields from the table will be visible in the ‘preview’ section.
In our example, we are adding Customers entity. Click the plus sing to add the selected table.
Once you have added your Entity, you will be able to select the desired columns from your table, we call them Attributes.
Simply click the check box to select all the attributes you want to synchronize.
TIP: You can also enter the Attr. Name, this will later on help you and other users to know which Attribute is present with column.
e.g. In our example shown below, our database table is showing the FullName attribute as T_NAM, so we have added the the Attribute name to be FullName. This will help all users connecting to better understand the mapping.
Usually, SyncSpider will automatically read all your Attributes (table columns) types, and attribute options. In case it does not, or you want to change it, we are giving you this option as well.
It is important to select and mark proper attribute types to avoid errors.
The attribute type can be changes by just selecting it and choosing the type you need.
You can also create Options attributes
If needed, you can also enter the ‘time-stamp-column; if you have one.
Next to time stamp, it make sense to put a Sync-Between interval, (which could be your office hour) to save resources.
The next option which can be selected is the ‘sync-interval’ option. You can select the interval time you want to sync your data.
TIP: This strongly depends on your needs, but we always advise not to over do it, because this transfer of data is what is being counted in your plan.
Initially, when we run the sync, SyncSpider local will send all the data to be synchronized. Later on, on every 5 minutes (if we have selected 5 minute interval), SyncSpider local will send only the data which had changes - or new data.
Additional sync feature
You would be able to see the ‘ext’ option beside the ‘time-stamp-col’. This option offers extended settings for time stamp for a unique column in which data needs to be monitored.
It is recommended not to use this much as it would require the creation of a new database to monitor it and that would make the system slow.
Selecting the Sync-Direction
The next option to set up is the ‘Sync-Direction’ where you have to select the suitable one from the drop-down list .
In our case, first we are selecting Local to SySp - to send all local data to SyncSpider web app.
Now, click on Save’ located on the top right of the app screen. Then select Save ALL (all entitites will be uploaded).
It will take some time saving, we are sending everything via API to SyncSpider web.
Then you'll be promoted to test the query and show the results in Exel file
We recommend to do so, just to check the results. Once the data has been exported to exel as well, you'll get a success notification:
Click OK to close it.
Export content feature
We are also giving you the export content feature.
Once you click it, you will see all the export options:
This can be useful for many different uses. You might want to count and later comare your data, export JSON file etc.
We can start syncing the file now, but before that, some changes are required to be done in the custom template we create.
Go to SyncSpider web app and click on the template to configure. You can now see the entity name as well as the fields which were mapped from the local database.
The template status should change to ‘active’ for data sync.
Note : Whenever you make a change in the template or in the local database, the status of the template needs to be deactivated and then it has to be done. After making those changes, the ‘save all’ option has to be clicked once again in the local database to save the changes as well as to keep the data-sync intact.
We can now create a task to start using this function.
Step 19 :
Click on ‘create a task’ and the next screen appears.
Select the new integration which was added to it, enter the name and description and click on ‘next’.
You can see the ‘API’ . Copy it and then go to ‘ SyncSpider local app’ and click on the ‘entity is not active’ message. It will open and ask to enter the API key. Paste the key here and select’ entity active for sync . Click on ‘finish’.
Select the ‘source integration’ and click on next.
Select the target integration. Here, as an example, we have selected the synced data to send to ‘FreshSales’, you can select any app of your choice, enter the integration name, description and click ‘next’.
Enter the ‘domain name’ and API Key and click ‘finish’. You can find more about generating an API key on Freshsales here.
Select the target integration (data which needs to be synced) and click on ‘next’.
Now, it will ask the time-duration to keep the data from the source file which we made ready. This data gets saved on SyncSpider for 1 day so that no issue arises. After one day, the data gets deleted automatically. You don’t need to make any changes in it. Click ‘next’.
Now, it will ask about the unique identifier for Freshsales. It could be contact id or email id. Select the suitable one. In most of the cases, email id would be better as they are unique. Click ‘next’.
Map the suitable fields. You can also add ‘new’ fields which you need and map them here. For the FreshSales example here, you can add them on it, refresh the destination schema on SyncSpider and then view the added fields.
For example, ‘customer type’ is one of the custom fields here, to make the changes in it, we click the settings (gear icon) and find some options to select. Selecting the ‘use source value’ allows to use the same settings as in the source data, and for the customer field column, click on the down arrow which shows the sync that would take place. Click ‘done’.
After mapping the necessary fields, click on ‘next’. Enter the task name, activate the task and set the email notifications if you want to send it to anyone and then the trigger for the task, which will be API Event trigger as we have configured this integration accordingly.
Go back to the local SyncSpider app and click on ‘full sync now’. Now, go back to the web app, refresh the page, start the task and it will get executed.
Note : All the fields which you need must have the data, atleast some of them. Or else, it will be considered as an empty field and get skipped.
The data thus, gets synced and one can send data from the local database of SyncSpider to the SyncSpider windows app.
"To send data from SyncSpider windows app to local database",
Here are the steps:
In the SyncSpider local app, enter the entity name, change the ‘sync direction’ to ‘SySp to local’, select the table and the required fields.
We need to disable the custom template created for the previous integration. Go to the web app of SyncSpider and disable the previously created template temporarily.
Go to the local windows SyncSpider app and click on ‘save all’.
Now, click on the web app and start to ‘create a task’ for the data sync.
As this is the other way round, we select the source as Freshsales and click on ‘next’.
Select the target integration, the new entity name entered in the local database, enter the integration name, description and copy the API key to the local database and click on ‘next’.
Enable the custom template now to take the process further. It will now ask about the unique identifier. By default, it will be the email id, click on ‘next’.
Next, it will ask about the filters, which we will keep as it is and go to ‘mapping’ thereafter.
After mapping the fields, click on ‘next’. It will now ask about the data expiry time settings, which we will leave as it is and the other options and click on ‘next’.
Next , we need to set the task settings- name, task activation, email notifications and task trigger- task succeeded event or schedule(whichever suits). Thus, this task will be triggered after the previous task if task succeeded event is selected. Click ‘Finish’.
After syncing the data in the local data base, one can start the task and the data from Freshsales will be displayed on the local SyncSpider database.
Thus, we have connected Local windows database with SyncSpider via SyncSpider windows app.
This is just of the features offered by SyncSpider.
To check the list of the tools and features we support, please click here.
If you don't see your favorite tool on our list, please take the time and send us a request here to create an integration for you OR Up-vote it if it's already on the list :)
We develop the integrations based on the requests and up-votes :)
If you got any questions or need assistance, feel free to contact our support team via the chat widget on our site and within SyncSpider app.