Difference between revisions of "Adding models"
Jump to navigation
Jump to search
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
OdataLink allows you to create as many [[Models|models]] as required. | |||
| Line 6: | Line 6: | ||
To add a new [[Models|model]], follow these steps. | To add a new [[Models|model]], follow these steps. | ||
# Click on '''Models''' on the menu in the left-hand side | # Click on '''Models''' on the menu in the left-hand side. | ||
# Click on the '''Create Model''' button | # Click on the '''Create Model''' button. | ||
# Enter a '''Model Name''' | # Enter a '''Model Name'''. | ||
#: This is the display name of the model and is only used within the | #: This is the display name of the model and is only used within the OdataLink website. | ||
#: | #: OdataLink will automatically generate a model code. | ||
# 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]]. | #: 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. | ||
# Choose the [[Model Login | # Choose the [[Model Type|Data File Type]] to which this model will connect. | ||
#: '''Basic''' login will require the username and password of a [[Users|user]]. | # Choose the [[Login Types|Login Type]] required to access the data. | ||
#: '''Anonymous''' will not require any credentials. | #: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data. | ||
# Ensure the '''Enabled''' checkbox is ticked | #: '''Anonymous''' will not require any credentials when accessing data. | ||
# Choose the [[Archive Types|Archive Type]]. | |||
#: '''Live''' optimises the model to retrieve live data. | |||
#: '''Developer''' optimises the model when developing to not connect with your data file as often. | |||
#: '''Static''' makes the model only return cached data without connecting to your data file. | |||
# Enter a '''Default Start Date''' and '''End Date''' to control how much data is retrieved. | |||
#: These dates will apply when no date filters are applied via the [[OData client]]. | |||
# Ensure the '''Settings Endpoints Allowed''' is unticked unless required. | |||
#: See [[Settings Endpoints]] for more information. | |||
# Ensure the '''Firewall Enabled''' is ticked. | |||
# Ensure the '''Enabled''' checkbox is ticked. | |||
# Click '''Create Model''' | # Click '''Create Model''' | ||
Latest revision as of 17:03, 3 February 2022
OdataLink allows you to create as many models as required.
Steps
To add a new model, follow these steps.
- Click on Models on the menu in the left-hand side.
- Click on the Create Model button.
- 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.
- 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.
- Choose the Data File Type to which this model will connect.
- 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.
- Choose the Archive Type.
- Live optimises the model to retrieve live data.
- Developer optimises the model when developing to not connect with your data file as often.
- Static makes the model only return cached data without connecting to your data file.
- Enter a Default Start Date and End Date to control how much data is retrieved.
- These dates will apply when no date filters are applied via the OData client.
- Ensure the Settings Endpoints Allowed is unticked unless required.
- See Settings Endpoints for more information.
- Ensure the Firewall Enabled is ticked.
- Ensure the Enabled checkbox is ticked.
- Click Create Model
Once created, you will be able to configure additional settings, see configuring models for more information.