Adding models: Difference between revisions

From OdataLink
Jump to navigation Jump to search
← Older editNewer edit →
No edit summary
No edit summary
Line 13: Line 13:
# Override the '''Model Code''' if required.
# Override the '''Model Code''' if required.
#: The ''secret'' code which will form part of the [[OData Feed URLs|OData feed url]]. It must be unique for your [[Account|account]]. 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]]. 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 \>Data File Options
# Choose the [[Model Type|Data File Type]] to which this model will connect.
# Choose the [[Model Type|Data File Type]] to which this model will connect.
#Tick/untick the '''Consolidation Allowed''' checkbox;
#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.
#;<br \>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.
#: '''Anonymous''' will not require any credentials 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|OData feed urls]] for this [[Models|model]] are usable.
#;<br \>Performance Options
# Choose the [[Archive Types|Archive Type]].
# Choose the [[Archive Types|Archive Type]].
#: '''Live''' optimises the model to retrieve live data.
#: '''Live''' optimises the model for live use.
#: '''Developer''' optimises the model when developing to not connect with your data file as often.
#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
#: '''Static''' makes the model only return cached data without connecting to your data file.
#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours
# Enter a '''Default Start Date''' and '''End Date''' to control how much data is retrieved.
#: '''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]].
#: These dates will apply when no date filters are applied via the [[OData client]].
# Ensure the '''Settings Endpoints Allowed''' is unticked unless required.
# If applicable, enter the [[Default Page Size]].
#: See [[Settings Endpoints]] for more information.
#: This controls the number of records that will be returned on a single call for most endpoints^.
# Ensure the '''Firewall Enabled''' is ticked.
#;<br \>Miscellaneous Options
# Ensure the '''Enabled''' checkbox is ticked.
# Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.
#: We recommend leaving this setting as ''(Auto Detect)''.
# Click '''Create Model'''
# Click '''Create Model'''


Revision as of 23:22, 18 June 2025

OdataLink allows you to create as many models as required.


Steps

To add a new model, follow these steps.

  1. Click on Models on the menu in the left-hand side.
  2. Click on the Create Model button.
  3. Enter a Model Name.
    This is the display name of the model and is only used within the OdataLink website.
    OdataLink will automatically generate a model code.
  4. Override the Model Code if required.
    The secret code which will form part of the OData feed url. It must be unique for your account. 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
  5. Choose the Data File Type to which this model will connect.
  6. Tick/untick the Consolidation Allowed checkbox;
    This option controls whether the Consolidation OData feed is available or not.

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

    Performance Options
  10. 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.
  11. 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.
  12. 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.
  13. 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.
  14. 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
  15. Choose the OData Client Compatibility option required.
    We recommend leaving this setting as (Auto Detect).
  16. Click Create Model

Once created, you will be able to configure additional settings, see configuring models for more information.


Related Topic

Configuring models
Models

Retrieved from "https://help.odatalink.com/index.php?title=Adding_models&oldid=4404"