Difference between revisions of "Editing a model's details"
Jump to navigation
Jump to search
m |
|||
| (34 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
By editing a [[Models|model's]] details, you will be able to configure it's '''Name''' and '''Model Code'''. | By editing a [[Models|model's]] details, you will be able to configure it's '''Name''' and '''Model Code'''. | ||
= Steps = | = Steps = | ||
| Line 7: | Line 8: | ||
# Click on '''Models''' on the menu in the left-hand side; | # Click on '''Models''' on the menu in the left-hand side; | ||
# Find the [[Models|model]] you want to work on and click '''View'''; | # Find the [[Models|model]] you want to work on and click '''View'''; | ||
# Select the '''Settings''' tab; | |||
# Click on the '''Edit Model''' button; | # Click on the '''Edit Model''' button; | ||
# Enter the '''Model Name'''; | # Enter the '''Model Name'''; | ||
#: This is the display name of the [[Models|model]] and is only used within the OdataLink website. | #: This is the display name of the [[Models|model]] and is only used within the OdataLink website. | ||
# 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. | #: 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 | ||
#: '''Basic''' login will require the username and password of a [[Users|user]]. | #; ''Note: The [[Model Type|Data File Type]] cannot be changed once a model has been created.'' | ||
#: '''Anonymous''' will not require any credentials. | # Tick/untick the '''Consolidation Allowed''' checkbox; | ||
#: Controls whether the '''Consolidation''' OData feed is available or not. | |||
#; Security Options | |||
# 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. | |||
#: '''Anonymous''' will not require any credentials when accessing data. | |||
# Tick/untick the '''Firewall Enabled''' checkbox; | |||
#: Controls whether the Firewall is active and protecting your data via a list of authorised [[IP Addresses]]. | |||
# 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]]. | |||
#: '''Live''' optimises the model for live use. | |||
#: '''Live (no archive)''' provides access to data without caching any information (worse performance). | |||
#: '''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. | |||
# 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. | |||
#: '''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. | |||
# Choose the [[Archive Paging|Archive Paging]]. | |||
#: '''Default''': OdataLink will page the date as requested. | |||
#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files. | |||
#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files. | |||
# Enter a [[Default Date Range]] to control how much data is retrieved. | |||
#: These dates will apply when no date filters are applied via the [[OData client]]. | |||
# If applicable, enter the [[Default Page Size]]. | |||
#: This controls the number of records that will be returned on a single call for most endpoints^. | |||
# Click '''Save'''. | # Click '''Save'''. | ||
=== Notes === | |||
: ^In Xero, Paginanation is supported by some, but not all, endpoints. [https://developer.xero.com/documentation/best-practices/integration-health/paging/ Xero Reference]. | |||
: For a comprehensive list of Xero endpoints that support pagination, please refer to [[Default Page Size]]. | |||
= Related Topic = | = Related Topic = | ||
[[Configuring models]] | [[Configuring models]] | ||
Latest revision as of 02:06, 24 March 2025
By editing a model's details, you will be able to configure it's Name and Model Code.
Steps
To edit's a model's details, follow these steps.
- Click on Models on the menu in the left-hand side;
- Find the model you want to work on and click View;
- Select the Settings tab;
- Click on the Edit Model button;
- Enter the Model Name;
- This is the display name of the model and is only used within the OdataLink website.
- Enter the Model Code;
- The secret code which will form part of the OData feed url. It must be unique for your account. Changing it will break any OData feed url in use. This may be useful if concerned that an 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
- Note: The Data File Type cannot be changed once a model has been created.
- Tick/untick the Consolidation Allowed checkbox;
- Controls whether the Consolidation OData feed is available or not.
- Security Options
- Choose the Login Type required to access the data.
- Basic login will require the username and password of a user when accessing data.
- Anonymous will not require any credentials when accessing data.
- Tick/untick the Firewall Enabled checkbox;
- Controls whether the Firewall is active and protecting your data via a list of authorised IP Addresses.
- Tick/untick the Enabled checkbox;
- Controls whether all OData feed urls for this model are usable.
- Performance Options
- Choose the Archive Type.
- Live optimises the model for live use.
- Live (no archive) provides access to data without caching any information (worse performance).
- 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.
- If using the Live 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.
- 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.
- Choose the Archive Paging.
- Default: OdataLink will page the date as requested.
- By Month: OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.
- By Year: OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.
- Enter a Default Date Range to control how much data is retrieved.
- These dates will apply when no date filters are applied via the OData client.
- If applicable, enter the Default Page Size.
- This controls the number of records that will be returned on a single call for most endpoints^.
- Click Save.
Notes
- ^In Xero, Paginanation is supported by some, but not all, endpoints. Xero Reference.
- For a comprehensive list of Xero endpoints that support pagination, please refer to Default Page Size.