Adding models: Difference between revisions

(23 intermediate revisions by 2 users not shown)

Line 1:

~~ODataLink allows you~~ to create as many [[Models|models]] as required.

For each new report or dashboard, it is best practice to create a separate OdataLink model to manage endpoints, access and availability of the OData Feed.

Odatalink Admin [[Users|Admin users]] can create as many [[Models|models]] as required.

Line 6:

Line 8:

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 ~~ODataLink~~ website.

#: This is the display name of the model and is only used within the OdataLink website.

#: ~~ODataLink~~ will automatically generate a model code.

#: 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 '''~~Login Type~~''' required to access the data.

#;<br \>{{large|Data File Options}}

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

# Choose the [[Model Type|Data File Type]] to which this model will connect.

#: '''Anonymous''' will not require any credentials.

#Tick/untick the '''Consolidation Allowed''' checkbox;

# ~~Ensure~~ the '''Enabled''' checkbox is ~~ticked~~;

#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.

#;<br \>{{large|Security Options}}

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

#: '''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 \>{{large|Performance Options}}

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

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

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

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

# If using the '''Live (with archive)''' [[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.

# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also configure whether OdataLink polls for changes.

#: '''Turning Polling On''' will allow OdataLink to poll of changes to provide live data in the most optimal manner.

#: Set the '''Sensitivity''' in months to control the date range used when polling.

#: You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.

#: For more on information on polling, see [[Configure OdataLink to poll for changes]].

# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also turn on the '''Developer''' option.

#: When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.

# Choose the [[Archive Paging|'''Page By''']] option.

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

#: '''Quarter''': OdataLink will page the data one quarter at a time. This may increase the performance for LARGE data files.

#: '''Year''': OdataLink will page the data one calendar year at a time. This option is provided for SMALLER data files.

#: '''Default''': OdataLink will page the date as requested. This is provided for those that build more complex queries where you do not want OdataLink to page the data by date.

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

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

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

#;<br \>{{large|Miscellaneous Options}}

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

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

# Click '''Create Model'''

@@ Line 1: / Line 1: @@
-ODataLink allows you to create as many [[Models|models]] as required.
+For each new report or dashboard, it is best practice to create a separate OdataLink model to manage endpoints, access and availability of the OData Feed.
+Odatalink Admin [[Users|Admin users]] can create as many [[Models|models]] as required.
@@ Line 6: / Line 8: @@
 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 ODataLink website.
+#: This is the display name of the model and is only used within the OdataLink website.
-#: ODataLink will automatically generate a model code.
+#: 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 '''Login Type''' required to access the data.
+#;<br \>{{large|Data File Options}}
-#: '''Basic''' login will require the username and password of a [[Users|user]].
+# Choose the [[Model Type|Data File Type]] to which this model will connect.
-#: '''Anonymous''' will not require any credentials.
+#Tick/untick the '''Consolidation Allowed''' checkbox;
-# Ensure the '''Enabled''' checkbox is ticked;
+#: This option controls whether the [[Consolidation OData Feed|Consolidation OData feed]] is available or not.
+#;<br \>{{large|Security Options}}
+# 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.
+#: '''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 \>{{large|Performance Options}}
+# Choose the [[Archive Types|Archive Type]].
+#: '''Live''' optimises the model for live use.
+#: '''Live (no archive)''' provides access to data without caching any information (worse performance).
+#: '''Static''' optimises the model for historica data that never changes.
+# If using the '''Live (with archive)''' [[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.
+# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also configure whether OdataLink polls for changes.
+#:  '''Turning Polling On''' will allow OdataLink to poll of changes to provide live data in the most optimal manner.
+#:  Set the '''Sensitivity''' in months to control the date range used when polling.
+#:  You can also configure OdataLink to force a full refresh every so often. While we do not recommend using this option, it is provided for specific fringe cases.
+#:  For more on information on polling, see [[Configure OdataLink to poll for changes]].
+# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also turn on the '''Developer''' option.
+#:  When the '''Developer''' option is turned on, it informs OdataLink that you are in the midst of building you integration. OdataLink will then only make like calls if the archive data is over 8 hours old.
+# Choose the [[Archive Paging|'''Page By''']] option.
+#: '''Month''': OdataLink will page the data one month at a time. This may increase the performance for VERY LARGE data files.
+#: '''Quarter''': OdataLink will page the data one quarter at a time. This may increase the performance for LARGE data files.
+#: '''Year''': OdataLink will page the data one calendar year at a time. This option is provided for SMALLER data files.
+#: '''Default''': OdataLink will page the date as requested. This is provided for those that build more complex queries where you do not want OdataLink to page the data by date.
+# 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]].
+# If applicable, enter the [[Default Page Size]].
+#: This controls the number of records that will be returned on a single call for most endpoints^.
+#;<br \>{{large|Miscellaneous Options}}
+# Choose the [[OData Client Compatibility|OData Client Compatibility]] option required.
+#: We recommend leaving this setting as ''(Auto Detect)''.
 # Click '''Create Model'''