Editing a model's details: Difference between revisions
No edit summary |
added model settings sections to the content, added references |
||
| Line 14: | Line 14: | ||
# Enter the '''Model Code'''; | # Enter the '''Model Code'''; | ||
#: The ''secret'' code which will form part of the [[OData Feed URLs|OData feed url]]. It must be unique for your [[Account|account]]. Changing it will ''break'' any [[OData Feed URLs|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed. | #: The ''secret'' code which will form part of the [[OData Feed URLs|OData feed url]]. It must be unique for your [[Account|account]]. Changing it will ''break'' any [[OData Feed URLs|OData feed url]] in use. This may be useful if concerned that an [[OData Feed URLs|OData feed url]] has been compromised or sent to the wrong individual. If you decide to change it, note that it must be at most 20 characters long. Only letters, numbers dashes and spaces are allowed. | ||
#; Data File Options | |||
# Tick/untick the '''Consolidation Allowed''' checkbox; | # Tick/untick the '''Consolidation Allowed''' checkbox; | ||
#: Controls whether the '''Consolidation''' OData feed is available or not. | #: Controls whether the '''Consolidation''' OData feed is available or not. | ||
#; Security Options | |||
# Choose the [[Login Types|Login Type]] required to access the data. | # Choose the [[Login Types|Login Type]] required to access the data. | ||
#: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data. | #: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data. | ||
| Line 23: | Line 25: | ||
# Tick/untick the '''Enabled''' checkbox; | # Tick/untick the '''Enabled''' checkbox; | ||
#: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable. | #: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable. | ||
#; Performance Options | |||
# Choose the [[Archive Types|Archive Type]]. | # Choose the [[Archive Types|Archive Type]]. | ||
#: '''Live''' optimises the model for live use. | #: '''Live''' optimises the model for live use. | ||
| Line 28: | Line 31: | ||
#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours | #: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours | ||
#: '''Static''' optimises the model for historica data that never changes. | #: '''Static''' optimises the model for historica data that never changes. | ||
# If using the '''Live''' [[Archive Types|archive types]], you can also configure whether to archive old historical data. You can do so by choosing how the | # If using the '''Live''' [[Archive Types|archive types]], you can also configure whether to archive old historical data. You can do so by choosing how the '''Cut Off Date''' is calculated. | ||
#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints. | #: '''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 to cut off date''' archives any data created prior to the cut off date entered. | ||
| Line 40: | Line 43: | ||
#: These dates will apply when no date filters are applied via the [[OData client]]. | #: These dates will apply when no date filters are applied via the [[OData client]]. | ||
# If applicable, enter the [[Default Page Size]]. | # If applicable, enter the [[Default Page Size]]. | ||
#: This controls the number of records that will be returned for single call for most endpoints. | #: This controls the number of records that will be returned for single call for most endpoints^. | ||
# Click '''Save'''. | # Click '''Save'''. | ||
| Line 47: | Line 50: | ||
: The [[Model Type|Data File Type]] cannot be changed once a model has been created. | : The [[Model Type|Data File Type]] cannot be changed once a model has been created. | ||
: ^In Xero, paginanation is supported by Invoices, Bank Transactions, Credit Notes, Payments, Manual Journals, Quotes and Purchase Orders. [https://developer.xero.com/documentation/best-practices/integration-health/paging/ Xero Reference] | |||
= Related Topic = | = Related Topic = | ||
[[Configuring models]] | [[Configuring models]] | ||