Editing a model's details: Difference between revisions

Line 14:

# 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 \>Data File Options~~

# Configure the '''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;

##: ~~Controls~~ whether the ~~'''~~Consolidation~~'''~~ OData feed is available or not.

##: 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.

# Configure the Security Options

#: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data.

## Choose the [[Login Types|Login Type]] required to access the data.

#: '''Anonymous''' will not require any credentials when accessing data.

##: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data.

# Tick/untick the '''Firewall Enabled''' checkbox;

##: '''Anonymous''' will not require any credentials when accessing data.

#: Controls whether the Firewall is active and protecting your data via a list of authorised [[IP Addresses]].

## Tick/untick the '''Firewall Enabled''' checkbox;

# Tick/untick the '''Enabled''' checkbox;

##: Controls whether the Firewall is active and protecting your data via a list of authorised [[IP Addresses]].

#: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable.

## Tick/untick the '''Enabled''' checkbox;

#~~;<br \>~~Performance Options

##: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable.

# Choose the [[Archive Types|Archive Type]].

#: '''Live''' optimises the model for live use.

# Configure the Performance Options

#: '''Live (no archive)''' provides access to data without caching any information (worse performance).

## Choose the [[Archive Types|Archive Type]].

#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours

##: '''Live''' optimises the model for live use.

#: '''Static''' optimises the model for historica data that never changes.

##: '''Live (no archive)''' provides access to data without caching any information (worse performance).

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

##: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours

#: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.

##: '''Static''' optimises the model for historica data that never changes.

#: '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.

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

#: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.

##: '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.

#: '''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 to cut off date''' archives any data created prior to the cut off date entered.

# Choose the [[Archive Paging|Archive Paging]].

##: '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.

#: '''Default''': OdataLink will page the date as requested.

##: '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.

#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.

## Choose the [[Archive Paging|Archive Paging]].

#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.

##: '''Default''': OdataLink will page the date as requested.

# Enter a [[Default Date Range]] to control how much data is retrieved.

##: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.

#: These dates will apply when no date filters are applied via the [[OData client]].

##: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.

# If applicable, enter the [[Default Page Size]].

## Enter a [[Default Date Range]] to control how much data is retrieved.

#: This controls the number of records that will be returned on a single call for most endpoints^.

##: These dates will apply when no date filters are applied via the [[OData client]].

#~~;<br \>~~Miscellaneous Options

## If applicable, enter the [[Default Page Size]].

# Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.

##: This controls the number of records that will be returned on a single call for most endpoints^.

#: We recommend leaving this setting as ''(Auto Detect)''.

# Configure the Miscellaneous Options

## Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.

##: We recommend leaving this setting as ''(Auto Detect)''.

# Click '''Save'''.

@@ Line 14: / Line 14: @@
 # 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 \>Data File Options
 # Configure the '''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;
-##: Controls whether the '''Consolidation''' OData feed is available or not.
+##: 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.
+# Configure the Security Options
-#: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data.
+## Choose the [[Login Types|Login Type]] required to access the data.
-#: '''Anonymous''' will not require any credentials when accessing data.
+##: '''Basic''' login will require the username and password of a [[Users|user]] when accessing data.
-# Tick/untick the '''Firewall Enabled''' checkbox;
+##: '''Anonymous''' will not require any credentials when accessing data.
-#: Controls whether the Firewall is active and protecting your data via a list of authorised [[IP Addresses]].
+## Tick/untick the '''Firewall Enabled''' checkbox;
-# Tick/untick the '''Enabled''' checkbox;
+##: Controls whether the Firewall is active and protecting your data via a list of authorised [[IP Addresses]].
-#: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable.
+## Tick/untick the '''Enabled''' checkbox;
-#;<br \>Performance Options
+##: Controls whether all [[OData Feed URLs|OData feed urls]] for this [[Models|model]] are usable.
-# Choose the [[Archive Types|Archive Type]].
-#: '''Live''' optimises the model for live use.
+# Configure the Performance Options
-#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
+## Choose the [[Archive Types|Archive Type]].
-#: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours
+##: '''Live''' optimises the model for live use.
-#: '''Static''' optimises the model for historica data that never changes.
+##: '''Live (no archive)''' provides access to data without caching any information (worse performance).
-# 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.
+##: '''Developer''' optimises the model for development is faster but refreshes are once every 8 hours
-#:  '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.
+##: '''Static''' optimises the model for historica data that never changes.
-#:  '''Archive data prior to cut off date''' archives any data created prior to the cut off date entered.
+## 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.
-#:  '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.
+##:  '''Do not archive data by date''' disables the archiving mechanism except for specific endpoints.
-#:  '''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 to cut off date''' archives any data created prior to the cut off date entered.
-# Choose the [[Archive Paging|Archive Paging]].
+##:  '''Archive data prior X months''' archives any data created prior to the cut off date calculated from the number of months entered.
-#: '''Default''': OdataLink will page the date as requested.
+##:  '''Archive data prior X days''' archives any data created prior to the cut off date calculated from the number of days entered.
-#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.
+## Choose the [[Archive Paging|Archive Paging]].
-#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.
+##: '''Default''': OdataLink will page the date as requested.
-# Enter a [[Default Date Range]] to control how much data is retrieved.
+##: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.
-#: These dates will apply when no date filters are applied via the [[OData client]].
+##: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.
-# If applicable, enter the [[Default Page Size]].
+## Enter a [[Default Date Range]] to control how much data is retrieved.
-#: This controls the number of records that will be returned on a single call for most endpoints^.
+##: These dates will apply when no date filters are applied via the [[OData client]].
-#;<br \>Miscellaneous Options
+## If applicable, enter the [[Default Page Size]].
-# Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.
+##: This controls the number of records that will be returned on a single call for most endpoints^.
-#: We recommend leaving this setting as ''(Auto Detect)''.
+# Configure the Miscellaneous Options
+## Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.
+##: We recommend leaving this setting as ''(Auto Detect)''.
 # Click '''Save'''.