Editing a model's details: Difference between revisions

No edit summary
Ash (talk | contribs)
mNo edit summary
Line 19: Line 19:
#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.
#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.
#;<br \>{{large|Security Options}}
#;<br \>{{large|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.
Line 27: Line 27:
#: 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.
#;<br \>{{large|Performance Options}}
#;<br \>{{large|Performance Options}}
# Choose the [[Archive Types|Archive Type]].
# Choose the [[Archive Types|'''Archive Type''']].
#: '''Live''' optimises the model for live use.
#: '''Live''' optimises the model for live use.
#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
#: '''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
#: '''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.  
#: '''Static''' optimises the model for historical 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.
# 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.
#:  '''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 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 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.
#:  '''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]].
# Choose the [[Archive Paging|'''Archive Paging''']].
#: '''Default''': OdataLink will page the date as requested.
#: '''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 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.
#: '''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.
# 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]].
# If applicable, enter the [[Default Page Size]].
# If applicable, enter the '''[[Default Page Size]]'''.
#: This controls the number of records that will be returned on a single call for most endpoints^.
#: This controls the number of records that will be returned on a single call for most endpoints^.
#;<br \>{{large|Miscellaneous Options}}
#;<br \>{{large|Miscellaneous Options}}
# Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.
# Choose the [[OData Client Compatibility|'''OData Client Compatibility''']] option required.
#: We recommend leaving this setting as ''(Auto Detect)''.
#: We recommend leaving this setting as ''(Auto Detect)''.
# Click '''Save'''.
# Click '''Save'''.