Editing a model's details: Difference between revisions

From OdataLink
Jump to navigation Jump to search
← Older edit
No edit summary
No edit summary
 
(72 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''', '''Model Code''' and whether it is '''Enabled''' or not.
By editing a [[Models|model's]] details, you will be able to configure it's '''Name''' and '''Model Code'''.


; Model Name
: Display name only.
; Model Code
: The ''secret'' code which will form part of the [[OData Feed URLs|OData feed url]]. 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.
; Enabled
: Controls whether all [[OData Feed URLs|OData feed urls]] for this model are useable.


= Steps =
= Steps =
Line 13: Line 7:


# 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 wan to work on and click '''Edit''';
# Find the [[Models|model]] you want to work on and click '''View''';
# Enter the '''Model Name''' and '''Model Code''';
# Select the '''Settings''' tab;
# Click on the '''Edit Model''' button;
# Enter the '''Model Name''';
#: This is the display name of the [[Models|model]] and is only used within the OdataLink website.
# 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.
#;<br \>{{large|Data File Options}}
#:: ''Note: The [[Model Type|Data File Type]] cannot be changed once a model has been created.''
#Tick/untick the '''Consolidation Allowed''' checkbox;
#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.
#;<br \>{{large|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.
#;<br \>{{large|Performance Options}}
# Choose the [[Archive Types|'''Archive Type''']].
#: '''Live (with Archive)''' optimises the model for live use.
#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
#: '''Static''' optimises the model for historical data that never changes.
# If using the '''Live (with archive)''' [[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.
# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also configure whether OdataLink polls for changes.
#:  '''Turning Polling On''' will allow OdataLink to poll of changes to provide live data in the most optimal manner.
#:  Set the '''Sensitivity''' in months to control the date range used when polling.
#:  You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.
#:  For more on information on polling, see [[Configure OdataLink to poll for changes]].
# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also turn on the '''Developer''' option.
#:  When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.
# Choose the [[Archive Paging|'''Page By''']] option.
#: '''Month''': OdataLink will page the data one month at a time. This may increase the performance for VERY LARGE data files.
#: '''Quarter''': OdataLink will page the data one quarter at a time. This may increase the performance for LARGE data files.
#: '''Year''': OdataLink will page the data one calendar year at a time. This option is provided for SMALLER data files.
#: '''Default''': OdataLink will page the date as requested. This is provided for those that build more complex queries where you do not want OdataLink to page the data by date.
# 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^.
#;<br \>{{large|Miscellaneous Options}}
# Choose the [[OData Client Compatibility|'''OData Client Compatibility''']] option required.
#: We recommend leaving this setting as ''(Auto Detect)''.
# Click '''Save'''.
# Click '''Save'''.
=== Notes ===
: ^In Xero, Pagination 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 and MYOB endpoints that support pagination, please refer to [[Default Page Size]].


= Related Topic =
= Related Topic =


[[Configuring models]]
[[Configuring models]]

Latest revision as of 18:10, 2 August 2026

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.

  1. Click on Models on the menu in the left-hand side;
  2. Find the model you want to work on and click View;
  3. Select the Settings tab;
  4. Click on the Edit Model button;
  5. Enter the Model Name;
    This is the display name of the model and is only used within the OdataLink website.
  6. 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.
  7. Tick/untick the Consolidation Allowed checkbox;
    This option controls whether the Consolidation OData feed is available or not.

    Security Options
  8. 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.
  9. Tick/untick the Firewall Enabled checkbox;
    Controls whether the Firewall is active and protecting your data via a list of authorised IP Addresses.
  10. Tick/untick the Enabled checkbox;
    Controls whether all OData feed urls for this model are usable.

    Performance Options
  11. Choose the Archive Type.
    Live (with Archive) optimises the model for live use.
    Live (no archive) provides access to data without caching any information (worse performance).
    Static optimises the model for historical data that never changes.
  12. If using the Live (with archive) 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.
  13. If using the Live (with archive) archive types, you can also configure whether OdataLink polls for changes.
    Turning Polling On will allow OdataLink to poll of changes to provide live data in the most optimal manner.
    Set the Sensitivity in months to control the date range used when polling.
    You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.
    For more on information on polling, see Configure OdataLink to poll for changes.
  14. If using the Live (with archive) archive types, you can also turn on the Developer option.
    When the Developer option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.
  15. Choose the Page By option.
    Month: OdataLink will page the data one month at a time. This may increase the performance for VERY LARGE data files.
    Quarter: OdataLink will page the data one quarter at a time. This may increase the performance for LARGE data files.
    Year: OdataLink will page the data one calendar year at a time. This option is provided for SMALLER data files.
    Default: OdataLink will page the date as requested. This is provided for those that build more complex queries where you do not want OdataLink to page the data by date.
  16. 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.
  17. If applicable, enter the Default Page Size.
    This controls the number of records that will be returned on a single call for most endpoints^.

    Miscellaneous Options
  18. Choose the OData Client Compatibility option required.
    We recommend leaving this setting as (Auto Detect).
  19. Click Save.


Notes

^In Xero, Pagination is supported by some, but not all, endpoints. Xero Reference.
For a comprehensive list of Xero and MYOB endpoints that support pagination, please refer to Default Page Size.

Related Topic

Configuring models

Retrieved from "https://help.odatalink.com/index.php?title=Editing_a_model%27s_details&oldid=4686"