Archive Paging: Difference between revisions

(12 intermediate revisions by 3 users not shown)

Line 1:

== Overview ==

~~Archive Paging Option configures~~ OdataLink to ~~request~~ data ~~paged '''By Month, By Year or as default''' option provided by~~ Xero or MYOB.

OdataLink gives you the ability to control how your data is requested from Xero or MYOB.

~~To speed up~~ the ~~time it takes~~ to ~~refresh~~ data~~, OdataLink's models include an archive~~.

The Paging By setting of the model allows you to control how the data is paged or sliced into smaller requests.

[[File:model_performance_options.png|thumb|right|400px]]

These smaller requests get chained one after the other and the complete set of data will still be returned.

~~You~~ can ~~control how the paging works by changing the '''Archive Paging''' option~~.

However, because each request handles smaller amounts of data, it can give you performance gain or allow you to download larger sets of data.

The '''Paging By''' setting allows you to request data from MYOB or Xero, paged '''By Month, By Year or by Default'''.

[[~~File~~:~~model_performance_options.png~~|~~thumb|right|400px~~]]

== ~~Navigation~~ ==

''Please note that '''Paging By''' setting may download your data over a '''larger number of calls'''''.

''If you are receiving Timeout errors or Xero daily call limit reached [[HelpID:ODataFeedStatus9004|Error 9004]], please create alternative model architecture to include '''Static Archive''' type to cache larger Historical dataset, or configure Archive by Cut Off Date in [[Archive Types]].''

== How to Configure the Paging By setting for an OdataLink model ==

Archive Paging setting can be found within "Performance Options" in Model Settings.

# Navigate to ~~[https://app.odatalink.com/Models/Manage Manage~~ '''Models''' ]

# Navigate to your OdataLink dashboard and click on '''[[Models]]''' on the left side panel.

# Click on '''View''' button corresponding to the model that you need to configure.

# Under '''Settings''' Tab, click on '''Edit Model''' button.

Line 20:

Line 27:

== ~~Archive~~ Paging ==

== Understanding the Paging By setting ==

The possible values are:

* Default

Line 29:

Line 36:

=== Default ===

When the '''~~Archive~~ Paging''' is set to '''Default ''', OdataLink will request the data as instructed. This is the legacy behaviour of OdataLink. The filters specified will be sent as-is to your data file.

When the '''Paging''' is set to '''Default ''', OdataLink will request the data as instructed. This is the legacy behaviour of OdataLink. The filters specified will be sent as-is to your data file.

While most customers will benefit from using the '''By Month''' or '''By Year''' option, we kept this legacy mechanism for very small data files or for those that use complex queries.

Line 36:

Line 43:

=== By Month ===

When the '''~~Archive~~ Paging''' is set to '''By Month''', OdataLink to query the data one month at a time.

When the '''Paging''' is set to '''By Month''', OdataLink to query the data one month at a time.

=== By Year ===

When the '''~~Archive~~ Paging''' is set to '''By Year''', OdataLink to query the data one year at a time.

When the '''Paging''' is set to '''By Year''', OdataLink to query the data one year at a time.

Line 61:

Line 68:

We strongly recommend you test the different option and choose the one that provides the best performance for your MYOB data file.

See [[Editing a model's details]] for instructions on how to configure your model.

See [[Editing a model's details]] for detailed instructions on how to configure your model.

Line 72:

Line 79:

These options will ensure that each request stay below the 100,000 transactions cap.

See [[Editing a model's details]] for instructions on how to configure your model.

See [[Editing a model's details]] for detailed instructions on how to configure your model.

See [https://developer.xero.com/documentation/api/efficient-data-retrieval#high-volume-threshold-limits Xero High Volume threshold limits] on the Xero API site for further information.

@@ Line 1: / Line 1: @@
 == Overview ==
-Archive Paging Option configures OdataLink to request data paged '''By Month, By Year or as default''' option provided by Xero or MYOB.
+OdataLink gives you the ability to control how your data is requested from Xero or MYOB.
-To speed up the time it takes to refresh data, OdataLink's models include an archive.
+The Paging By setting of the model allows you to control how the data is paged or sliced into smaller requests.
+[[File:model_performance_options.png|thumb|right|400px]]
+These smaller requests get chained one after the other and the complete set of data will still be returned.
-You can control how the paging works by changing the '''Archive Paging''' option.
+However, because each request handles smaller amounts of data, it can give you performance gain or allow you to download larger sets of data.
+The '''Paging By''' setting allows you to request data from MYOB or Xero, paged '''By Month, By Year or by Default'''.
-[[File:model_performance_options.png|thumb|right|400px]]
-== Navigation ==
+''Please note that '''Paging By''' setting may download your data over a '''larger number of calls'''''.
+''If you are receiving Timeout errors or Xero daily call limit reached [[HelpID:ODataFeedStatus9004|Error 9004]], please create alternative model architecture to include '''Static Archive''' type to cache larger Historical dataset, or configure Archive by Cut Off Date in [[Archive Types]].''
+== How to Configure the Paging By setting for an OdataLink model ==
 Archive Paging setting can be found within "Performance Options" in Model Settings.
-# Navigate to [https://app.odatalink.com/Models/Manage Manage '''Models''' ]
+# Navigate to your OdataLink dashboard and click on '''[[Models]]''' on the left side panel.
 # Click on '''View''' button corresponding to the model that you need to configure.
 # Under '''Settings''' Tab, click on '''Edit Model''' button.
@@ Line 20: / Line 27: @@
-== Archive Paging ==
+== Understanding the Paging By setting ==
 The possible values are:
 * Default
@@ Line 29: / Line 36: @@
 === Default ===
-When the '''Archive Paging''' is set to '''Default ''', OdataLink will request the data as instructed. This is the legacy behaviour of OdataLink. The filters specified will be sent as-is to your data file.
+When the '''Paging''' is set to '''Default ''', OdataLink will request the data as instructed. This is the legacy behaviour of OdataLink. The filters specified will be sent as-is to your data file.
 While most customers will benefit from using the '''By Month''' or '''By Year''' option, we kept this legacy mechanism for very small data files or for those that use complex queries.
@@ Line 36: / Line 43: @@
 === By Month ===
-When the '''Archive Paging''' is set to '''By Month''', OdataLink to query the data one month at a time.
+When the '''Paging''' is set to '''By Month''', OdataLink to query the data one month at a time.
 === By Year ===
-When the '''Archive Paging''' is set to '''By Year''', OdataLink to query the data one year at a time.
+When the '''Paging''' is set to '''By Year''', OdataLink to query the data one year at a time.
@@ Line 61: / Line 68: @@
 We strongly recommend you test the different option and choose the one that provides the best performance for your MYOB data file.
-See [[Editing a model's details]] for instructions on how to configure your model.
+See [[Editing a model's details]] for detailed instructions on how to configure your model.
@@ Line 72: / Line 79: @@
 These options will ensure that each request stay below the 100,000 transactions cap.
-See [[Editing a model's details]] for instructions on how to configure your model.
+See [[Editing a model's details]] for detailed instructions on how to configure your model.
 See [https://developer.xero.com/documentation/api/efficient-data-retrieval#high-volume-threshold-limits Xero High Volume threshold limits] on the Xero API site for further information.