Difference between revisions of "Archive Types"

Archive Types (view source)

Revision as of 17:27, 12 April 2023

697 bytes added , 17:27, 12 April 2023

no edit summary

Nic

Write, Bureaucrats, Administrators

3,301

edits

@@ Line 1: / Line 1: @@
 == Overview ==
-OdataLink Models have archive types
-These include Live, Developer and Static
+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
-Those in addition to Live exist to improve the refresh rate in scenarios where speed is more important than retrieving latest live data from the source
 === Live ===
-Optimises the model for end user use.
-At all times the latest data is returned.
+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.
+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.
+=== Live (no archive) ===
+When the '''Archive Type''' is set to '''Live (no archive)''', OdataLink will serve data directly from your [[Data Files!data file]].
-Its the slowest for returning data
+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.
-To be used once development is completed
 === Developer ===
-Optimises the model for development.
+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.
-Cached data is returned where the last retrieval was less than 8 hours ago
+The benefit is that it makes refreshes faster but at the cost of not always retrieving the latest data.
-The benefit of this Archive type is that it makes refreshes faster but the downside is your not always retrieving the latest data.
+This is the default when creating a model.
-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.
-Once development is completed switch it back to '''Live'''
 === Static ===
-Optimises the model for historica data that never changes.
-that data to pull blocks of records that will never change.
+When the '''Archive Type''' is set to '''Static''', OdataLink will only query data from your [[Data Files|data file]] once.
+This option is mostly used for data that never changes such as historical data.
-The model only returns the latest data once for the defined parameters and then caches it and only ever returns that cached data going forward.
-Use this option if you wish to report on historical data from previous financial years and append with live data for the current year.
+== Related ==
-=== Related ===
 [[Switch Models Archive Type from Developer to Live]]
 [[Editing a model's details]]