Editing a model's details

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.

7. Tick/untick the Consolidation Allowed checkbox;

   Controls whether the Consolidation OData feed is available or not.

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.

11. 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.

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 for single call for most endpoints.

15. Click Save.

Notes

The Data File Type cannot be changed once a model has been created.

Related Topic

Configuring models