SQL Server Connector

Authentication Methods

You will need to enter the following details: User ID, Password, Server Name and Catalog Name (this field is optional) as seen below:

You will see this popup on the bottom right of your screen once the authentication has been successful.

Typical use-cases

Most people use SQL Server to manage their day to day business needs. The SQL Server connector allows you to create, update and delete items based upon a table in SQL Server. You can have multiple connectors if you wanted to bring multiple tables of data into your story.

When using the SQL Server connector, you will be able to select a table, which then subsequently gets added to the story, so you can always go to the Data Grid > Resources to see previous SQL Server tables used. 

How to Use the Connector

Once you have created a SQL Server connector, you will be presented with the “Connect” screen (which is standard for all connectors).

You can choose the table that you would like to utilize in the story via the drop-down menu as shown (once connected):

Once the authentication is completed, you can now press “Next” to move to the mapping section of the connector, where you will select the list of data tables, which category you want to import the data into and map the fields in the SQL Server table to the attributes in the SharpCloud story. 

You can view the Source Data, which is the data from the SQL Server and how SharpCloud reads this by clicking on the “View Source Data” button.

You can see we are bringing in the “Items” table and importing it into Category 1. 

You need to nominate an External ID (a unique identifier for each item) in the “External ID”
column. 

A unique number is created for each row in the list which can be used for the External ID. If you are adding or deleting rows in SharePoint List, it is a lot better to bring in your own unique field and nominate that field as the External ID to avoid incorrect data mapping/loss. 

For the other fields, you can either map the column to existing attributes in your story or by selecting “(NEW)” which will create a new attribute/property in your story, and you can select its type. 

Note: For Tag Groups and Categories, these will need to pre-exist before mapping onto those fields – you can access the Story Setup to perform those actions from the top of the screen.

You can provide a filter on the incoming items, for example, to only create items with a “Risk” value of “High” by using the drop-down on the far right as shown below:

For more advanced actions and queries, you can access the underlying SQL queries to discover and edit how you wish the data be imported and perform special functions such as JOIN. To access the SQL, simple use the toggle in the top left that says “Show Advanced SQL”:

Note: Once you edit the SQL, you will not be able to return to the drop-down version of the mapping as there are SQL functions that can be performed here that are not accommodated in the drop-down version.

Once you are happy with the mappings/SQL, press Next to show a preview of what items are going to be created and the additional information:  

You can see the rows in blue are new items that will be created if you click the synchronise button. Modified values/cells (where the item value is different from the source data and SharpCloud) will be shown in orange. 

Synchronise: Press this button to actually commit the changes to the SharpCloud story. If the commit is successful, it will show a summary of the changes made. 

Delete Records from story (Default = true): The default setting for this option is true which meanscdeleted records from your data source (Excel workbook in this case) will also be deleted in.

SharpCloud. E.g., if your data source contains records for items A, B and C, and later the data source only contains A and C, item B will be deleted from SharpCloud.

When you are happy that your connector is transferring the right data in the right way, you can “Publish” it. A published connector cannot be edited anymore and can be run by anyone who has admin access to the story.  

Note: The credentials of the user who published the connector are used to read from the data source and update the story