Overview

Archive Locations offers a flexible way to define and manage where historical data is stored. You can define a default Tag Historian Database and also add external options, if necessary.


On this page:

Understanding Archive Location

The Archive Location defines where Tag's data will be archived considering the Historian Tables arrangement. establishing a clear linkage between tags and the storage infrastructure. You can use SQL databases, ScriptClasses, or connections with a Third-Party Historian when configuring the Archive Location. In other words, when you set the Archive Location, you're specifying the storage medium for Tag's data.

By default, FrameworX uses an SQLite database. You have the option to change the default database or add additional databases, in case you need to use different databases.

Configuring The Default Database

You have several options to choose from when defining the default database. In case the default SQLite option does not work for you, you can change it by following the steps below:

  1. Access Historian → Archive Locations.
  2. Click on the gear icon to open the Dialog.
  3. Define the default database configuration, defining Provider, Database, and ServerIP.
  4. Test the database connection. Provide the necessary authentication information and click Test.
  5. Click OK to update the default database.

Available Databases

The next table list all accepted Providers and Databases when configuring the default database.

ProviderDatabases
SQLiteSQLite
Odbc
  • Firebird
  • MSAccess2003
  • MSExcel2003
  • MySql
  • ODBC_DSN
  • ODBC_FileDsn
  • Oracle
  • SQLServer
  • SQLServer_WA
OleDb
  • CSVFile
  • MSAccess2003
  • MSAccess2007
  • MSExcel2003
  • MSExcel2007
  • Oracle
  • SQLServer
  • SQLServer_WA
OracleClientOracle
SqlClient
  • SQLServer
  • SQLServer_WA
PostgreeSQLPostgreeSQL


Add new Archive Location

In case you need additional databases, you can follow the steps below to add and configure them.

  1. Access Historian→ Archive Location.
  2. Click on the plus icon.
  3. On the Dialog, configure the new database. The description of available option is described in the next session.
  4. Click Ok.

Archive location Properties

The table below describes the configuration options available when adding a new Archive Location.

PropertyDescription
Name

A unique name to identify the new Arquive Location.

DescriptionOptional description to provide more context or information.
Store and Forward

If you check this option, FrameworX will store data locally in case of connection failure with the external database. The data is transfer when connection is restablished.

Archive System

The types available to configure the Archive location. Currently, two options ar available:

  • TagProvider: Enables you to use external solutions to archive Tag's data.

  • ScriptClass: For this option, you need to either create a script class or point to existing classes that will define how the data will be handled and stored. For help creating classes, see the Script, Classes and Tasks documentation.

Protocol (Only available if using TagProvider)

Defines the protocol used by the External TagProvider. Currently, you can use the following options:

  • CanaryLabs
  • InfluxDB
  • GEProficy
Station Editor  (Only available if using TagProvider)Configure the connection string to the selected provider and run a test to ensure the setup is correct.

In this section...