Write
272
edits
Difference between revisions of "Archive Paging"
m
no edit summary
m |
m |
||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
Paging By option configures OdataLink to request data paged '''By Month, By Year or as default''' option provided by Xero or MYOB. | |||
You can control how the paging works by changing the '''Paging By''' option. | |||
You can control how the paging works by changing the ''' | |||
[[File:model_performance_options.png|thumb|right|400px]] | [[File:model_performance_options.png|thumb|right|400px]] | ||
== | == How to Configure the Paging By setting == | ||
Archive Paging setting can be found within "Performance Options" in Model Settings. | Archive Paging setting can be found within "Performance Options" in Model Settings. | ||
| Line 20: | Line 18: | ||
== | == Understanding the '''Paging By''' Setting to improve Performance == | ||
The possible values are: | The possible values are: | ||
* Default | * Default | ||
| Line 29: | Line 27: | ||
=== Default === | === Default === | ||
When the ''' | 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. | 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 34: | ||
=== By Month === | === By Month === | ||
When the ''' | When the '''Paging''' is set to '''By Month''', OdataLink to query the data one month at a time. | ||
=== By Year === | === By Year === | ||
When the ''' | When the '''Paging''' is set to '''By Year''', OdataLink to query the data one year at a time. | ||
| Line 61: | Line 59: | ||
We strongly recommend you test the different option and choose the one that provides the best performance for your MYOB data file. | 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 70: | ||
These options will ensure that each request stay below the 100,000 transactions cap. | 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. | 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. | ||