Difference between revisions of "Archive Types"

From OdataLink
Jump to navigation Jump to search
Line 12: Line 12:
=== Live ===
=== Live ===


When the '''Archive Type''' is set to '''Live''', OdataLink will serve data directly from your [[Data Files!data file]].
When the '''Archive Type''' is set to '''Live''', OdataLink will serve data directly from your [[Data Files|data file]].


This is the preferred option once you have finished building your reports and development is complete.
This is the preferred option once you have finished building your reports and development is complete.


Some endpoints which cannot be edited, such as [[Xero Accounting Endpoint: JournalsAccrual]] and [[Xero Accounting Endpoint: JournalsCash]] will get cached in an encrypted archive to speed up refreshes. This only applies to endpoints whose data never changes.
Some endpoints which cannot be edited, such as [[Xero Accounting Endpoint: JournalsAccrual|JournalsAccrual]] and [[Xero Accounting Endpoint: JournalsCash|JournalsCash]] will get cached in an encrypted archive to speed up refreshes. This only applies to endpoints whose data never changes.




=== Live (no archive) ===
=== Live (no archive) ===


When the '''Archive Type''' is set to '''Live (no archive)''', OdataLink will serve data directly from your [[Data Files!data file]].
When the '''Archive Type''' is set to '''Live (no archive)''', OdataLink will serve data directly from your [[Data Files|data file]].


This is option is only recommend for those that need maximum security. It does come at the cost that some endpoints will be particularly slow.
This is option is only recommend for those that need maximum security. It does come at the cost that some endpoints will be particularly slow.

Revision as of 18:31, 12 April 2023

Overview

To speed up the time it takes to refresh data, OdataLink's models include an archive. You can control how the archive works by changing the Archive Type option.

The possible values are:

  • Live
  • Live (no archive)
  • Developer
  • Static


Live

When the Archive Type is set to Live, OdataLink will serve data directly from your data file.

This is the preferred option once you have finished building your reports and development is complete.

Some endpoints which cannot be edited, such as JournalsAccrual and JournalsCash will get cached in an encrypted archive to speed up refreshes. This only applies to endpoints whose data never changes.


Live (no archive)

When the Archive Type is set to Live (no archive), OdataLink will serve data directly from your data file.

This is option is only recommend for those that need maximum security. It does come at the cost that some endpoints will be particularly slow.


Developer

When the Archive Type is set to Developer, OdataLink will be optimised for developing reports. In this mode, Live data will only be served once every 8 hours. If a refresh takes place within 8 hours of the last refresh, it will instead served cached data stored in an encrypted archive.

The benefit is that it makes refreshes faster but at the cost of not always retrieving the latest data.

This is the default when creating a model.

This is the preferred option when building reports. It should be changed to Live or Live (no archive) once development is complete.


Static

When the Archive Type is set to Static, OdataLink will only query data from your data file once.

This option is mostly used for data that never changes such as historical data.


Related

Changing a model's Archive Type from Developer to Live

Editing a model's details