Adding models: Difference between revisions

Line 31:

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

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

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

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

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

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

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

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

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

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

@@ Line 31: / Line 31: @@
 #: '''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.
-# 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 (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.
-# Choose the [[Archive Paging|Archive Paging]].
+# If using the '''Live (with archive)''' [[Archive Types|'''archive types''']], you can also configure whether OdataLink polls for changes.
-#: '''Default''': OdataLink will page the date as requested.
+#:  '''Turning Polling On''' will allow OdataLink to poll of changes to provide live data in the most optimal manner.
-#: '''By Month''': OdataLink will page the data one calendar month at a time. This may increase the performance for VERY LARGE data files.
+#:  Set the '''Sensitivity''' in months to control the date range used when polling.
-#: '''By Year''': OdataLink will page the data one calendar year at a time. This may increase the performance for LARGE data files.
+#:  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]].