Archive Types: Difference between revisions

(18 intermediate revisions by 3 users not shown)

Line 1:

== Overview ==

~~OdataLink Models have archive types~~

~~These include Live~~, ~~Developer and Static~~

While a super strength of OdataLink is the ability to pull live data, it can come with a performance cost. To mitigate that, OdataLink can archive data in our servers which returns data faster than from the live source. OdataLink has different options for caching depending on your situation. You can control how the archive works by changing the '''Archive Type''' option.

~~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~~

The possible values are:

* Live (with Archive)

* Live (no archive)

* Static

~~=== Live ===~~

~~Optimises the model for end user use.~~

~~At all times the latest data is returned.~~

=== Live (with Archive) ===

~~Its~~ the ~~slowest for returning~~ data

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

~~To be used~~ once development is ~~completed~~

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

~~=== Developer ===~~

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.

~~Optimises the model for development~~.

~~Cached~~ data ~~is returned where the last retrieval was less than 8 hours ago~~

The ~~benefit~~ of ~~this~~ Archive ~~type is that it makes refreshes faster but the downside is your not always retrieving~~ the ~~latest data.~~

It is also possible to configure a '''Cut Off Date''' which will instruct OdataLink to archive all data prior to this date. This increases the performance when pulling large amounts of historical data. The Cut Off Date can either be entered directly, or calculated from number of months or days prior to today.

[[File:archive_cut_off.png|thumb|right|400px|Archive Data Cut Off Date]]

The following options are available to configure the '''Cut Off Date''' for Archiving:

~~This is~~ the ~~default when creating a model~~.

;Do not archive data by date

:Disables the archiving mechanism except for specific endpoints.

;Archive data prior to cut off date

:Archives any data created prior to the cut off date entered.

;Archive data prior X months

:Archives any data created prior to the cut off date calculated from the number of months entered.

;Archive data prior X days

:Archives any data created prior to the cut off date calculated from the number of days entered.

~~Once development~~ is ~~completed switch~~ it ~~back to~~ '''~~Live~~'''

It is also possible to configure it so that OdataLink '''polls for changes'''. For more on polling, see [[Configure OdataLink to poll for changes]].

~~=== Static~~

It may also be important to configure the [[Archive Paging]] option, which can force paging by month or year.

~~Optimises~~ the ~~model for historica data that never changes~~.

~~that data to pull blocks of records that will never change.~~

~~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.~~

=== Live (no archive) ===

~~Use this option if you wish~~ to ~~report on historical~~ data from ~~previous financial years and append with live~~ data ~~for the current year~~.

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 recommended for those that need maximum security. It does come at the cost that some endpoints will be particularly slow.

~~To change an~~ archive type ~~see~~ [[Editing a model's details]]

=== Static ===

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.

== Change Logs ==

:'''2026-05-01'''

:The '''Developer''' archive type has been phased out in favour of a '''Developer Option''' can be turned on as part of the '''Live (with archive)''' archive type. This was done to simplify the archive type and allow you to toggle the developer setting without losing other configuration options.

== Related ==

[[Changing a model's Archive Type from Developer to Live]]

[[Editing a model's details]]

@@ Line 1: / Line 1: @@
 == Overview ==
-OdataLink Models have archive types
-These include Live, Developer and Static
+While a super strength of OdataLink is the ability to pull live data, it can come with a performance cost. To mitigate that, OdataLink can archive data in our servers which returns data faster than from the live source. OdataLink has different options for caching depending on your situation. You can control how the archive works by changing the '''Archive Type''' option.
-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
+The possible values are:
+* Live (with Archive)
+* Live (no archive)
+* Static
-=== Live ===
-Optimises the model for end user use.
-At all times the latest data is returned.
+=== Live (with Archive) ===
-Its the slowest for returning data
+When the '''Archive Type''' is set to '''Live (with Archive)''', OdataLink will serve data directly from your [[Data Files|data file]].
-To be used once development is completed
+This is the preferred option once you have finished building your reports and development is complete.
-=== Developer ===
+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.
-Optimises the model for development.
-Cached data is returned where the last retrieval was less than 8 hours ago
-The benefit of this Archive type is that it makes refreshes faster but the downside is your not always retrieving the latest data.
+It is also possible to configure a '''Cut Off Date''' which will instruct OdataLink to archive all data prior to this date. This increases the performance when pulling large amounts of historical data. The Cut Off Date can either be entered directly, or calculated from number of months or days prior to today.
+[[File:archive_cut_off.png|thumb|right|400px|Archive Data Cut Off Date]]
+The following options are available to configure the '''Cut Off Date''' for Archiving:
-This is the default when creating a model.
+;Do not archive data by date
+:Disables the archiving mechanism except for specific endpoints.
+;Archive data prior to cut off date
+:Archives any data created prior to the cut off date entered.
+;Archive data prior X months
+:Archives any data created prior to the cut off date calculated from the number of months entered.
+;Archive data prior X days
+:Archives any data created prior to the cut off date calculated from the number of days entered.
-Once development is completed switch it back to '''Live'''
+It is also possible to configure it so that OdataLink '''polls for changes'''. For more on polling, see [[Configure OdataLink to poll for changes]].
-=== Static
+It may also be important to configure the [[Archive Paging]] option, which can force paging by month or year.
-Optimises the model for historica data that never changes.
-that data to pull blocks of records that will never change.
-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.
+=== Live (no archive) ===
-Use this option if you wish to report on historical data from previous financial years and append with live data for the current year.
+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 recommended for those that need maximum security. It does come at the cost that some endpoints will be particularly slow.
-To change an archive type see [[Editing a model's details]]
+=== Static ===
+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.
+== Change Logs ==
+:'''2026-05-01'''
+:The '''Developer''' archive type has been phased out in favour of a '''Developer Option''' can be turned on as part of the '''Live (with archive)''' archive type. This was done to simplify the archive type and allow you to toggle the developer setting without losing other configuration options.
+== Related ==
+[[Changing a model's Archive Type from Developer to Live]]
+[[Editing a model's details]]