Database Connections

Who can use this feature?

The Database Connections can be used by those with the Builder subscription plan.

For more details, see our pricing comparison matrix.

The Database Connections can be used to connect the Squirrel project to an external InfoBurst database.

There are two different Database connections:

  • Database Query - queries the referenced database and returns the selected query.

  • Database Writeback - writes back to the selected query and updates the information based on an insertion

To add a connector to your project open the CONNECTIONS drawer in the object browser, select the appropriate entry from the dropdown box, and click the plus button:

The connection will appear in the CONNECTIONS drawer of the object browser. Select it to access its properties in the property panel.

Common Database Connector Properties – Credentials

An Infoburst URL and login credentials are required to use the Database connectors. These can be obtained from the Infoburst webpage, as well as the URL port.

Database Login Credentials

The 'Infoburst URL' is used to access followed by a port to identify the specific environment.

After entering the URL, all that is needed is a 'Username' and 'Password'.

All three of the credential fields can be bound to cells in the spreadsheet.


Mapping the data to the spreadsheet

After connecting to the database, the DATA MAPPING properties will populate which is where you can define the cache or cache query to be brought into Squirrel.


Database Query

The Database Query DATA MAPPING properties will populate a list of the existing caches within the connected database. After making a selection, the dropdown will outline the number of caches selected.

The selected query will populate below the dropdown to bind its location to the spreadsheet. The Destination field will appear to bind the query to an area in the spreadsheet for the data to populate at runtime.

Max Rows will determine if there is a limit on the number of rows returned from the database.

If the database contains parameters defined in the SQL code, a PARAMETER sub-drawer will populate in the DATA MAPPING drawer.


Database Writeback

The Database Writeback DATA MAPPING properties will populate a list of the existing cache queries within the connected database. After making a selection, a sub-drawer will populate labeled META DATA.

If the database contains parameters defined in the SQL code, a PARAMETER sub-drawer will populate in the DATA MAPPING drawer.

The FALLBACK STATEMENT drawer defines a "backup" writeback that will execute only if the initial writeback statement fails. The property panel layout is the same as the original Writeback Statement.

The QUERY ON SUCCESS drawer is used to run a query if either of the above writeback statements succeeds.


Triggering the connection

Like most connections, the properties panel has a USAGE drawer that provides control of the connector's triggers.

  • Refresh on Load - as described, the connection will trigger and the data will be brought through to the spreadsheet on the load of the project. This can be previewed in Debug and Preview modes.

  • Refresh on Interval - defines an Interval that the connection will refresh. When selected, an input will populate where a period of seconds can be defined for the connection to refresh.

  • Refresh on Cell Changes - sets the trigger to refresh on the change of another cell. This property utilizes Conditional Logic. For more information on Conditional Logic and its uses, see this article.

Last updated

Logo

Copyright © 2019 - 2024 InfoSol Ltd. All rights reserved.