Archive Paging: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| 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. | ||
Revision as of 22:04, 3 November 2024
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.
How to Configure the Paging By setting
Archive Paging setting can be found within "Performance Options" in Model Settings.
- Navigate to Manage Models
- Click on View button corresponding to the model that you need to configure.
- Under Settings Tab, click on Edit Model button.
- Configure Archive Paging setting under Performance Options.
For more detailed instructions on how to configure your model, please refer to Model Configurations.
Understanding the Paging By Setting to improve Performance
The possible values are:
- Default
- By Month
- By Year
Default
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.
By Month
When the Paging is set to By Month, OdataLink to query the data one month at a time.
By Year
When the Paging is set to By Year, OdataLink to query the data one year at a time.
Recommendations
Recommendations for MYOB
MYOB's API is more designed to handle small volume of data. Because of this, using the By Year or By Month option can provide a lot of performance gains.
We recommend you use the By Year if you have 2,000 transactions per year and require 3 or more years of data.
We recommend you use the By Month if you have 1,000 transactions per month and require multiple months of data.
In our tests, pulling 20,000 transactions across 10 years from MYOB took:
- 11 minutes with the legacy 'Default' option
- 4.5 minutes with the 'By Month' option
- 3.5 minutes with the 'By Year' option.
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 detailed instructions on how to configure your model.
Recommendations for Xero
Xero's API is very well structured to handle large volumes of data.
However, Xero have introduced limits to the number of transactions that can be requested at a single time. If you need to report on more than 100,000 transactions, then using the By Month or By Year option is recommended.
These options will ensure that each request stay below the 100,000 transactions cap.
See Editing a model's details for detailed instructions on how to configure your model.
See Xero High Volume threshold limits on the Xero API site for further information.