Difference between revisions of "Consolidation OData Feed"

Jump to navigation Jump to search
no edit summary
(added information on Standard templates and consolidation endpoints)
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Overview ==
== Overview ==


'''Consolidation Endpoints''' are specialised endpoints that allow you to pull all data from [[Data Files|data files]] assigned to the [[Models|model]] as a single feed.
'''Consolidation OData Feeds''' are specialised feeds that allow you to pull data from multiple [[Data Files|data files]] assigned to the [[Models|model]] as a single feed.


They assist with the consolidation process by removing the need to append data from multiple data file specific end points into the one table in Power Query
They assist with the consolidation process by removing the need to append data from multiple data files into one table in Power Query.


The consolidation [[Endpoints]] created by  [[Models|model]] are the same as those for individual data files. Both include a Data File ID


'''Note''' that consolidation endpoints must be enabled in order to be used.  See [[Enabling / disabling OData access to the consolidation endpoints for the model|enabling access to the consolidation endpoints for the model]] for more information.
== Differences in the Consolidation OData Feed ==


For the most part, the [[Endpoints]] access via a consolidation odata feed work the same as those for individual [[Data Files|data files]]. Both include a DataFiles fields including a DataFileID.


== Standard OdataLink Templates ==
There are some slight differences, however.


Standard OdataLink templates utilize '''Consolidation''' Feeds to extract data.
The Consolidation OData feed includes additional [[Function Endpoints|specialised functions]]. These functions are present for functions that include IDs as parameters, such as BudgetID, TrackingCategoryID, etc. Since IDs are specific to a single [[Data Files|Data File]], an additional DataFile parameter must be included. These specialised functions are those whose name ends with the word DataFile (e.g. BudgetAmounts vs BudgetAmountsDataFile).
 
 
[[File:standard_template_odata_feed_error.png|300px|thumb]]
== OdataLink Report Templates require Consolidation OData Feeds ==
 
[https://odatalink.com/templates/ Standard OdataLink Report Remplates] we create are typically designed and require '''Consolidation''' OData Feeds to extract data as they make use of the [[#Differences in the Consolidation OData Feed|specialised functions mentionned in 'Differences in the Consolidation OData Feed']]


Since Consolidation feeds are available for both '''single-organisation''' and '''multi-organisation accounts''', using Consolidation feeds in the standard templates ensure that they are '''compatible''' with all accounts.
Since Consolidation feeds are available for both '''single-organisation''' and '''multi-organisation accounts''', using Consolidation feeds in the standard templates ensure that they are '''compatible''' with all accounts.


The consolidation endpoint functions contain a company field ('''DataFile ID''') as a parameter, which is not available in standard company endpoints.
Using any OData feed other than '''Consolidation''' OData Feed can result in errors while refreshing the Standard report template.


Thus, using a '''Company Odata Feed''' instead of '''Consolidation''' will result in errors while refreshing the report.
 
== Enable Consolidation OData Feed for a [[Models|Model]] ==
 
Consolidation OData Feed must be enabled in order to be used.
 
Please refer to [[Enabling / disabling OData access to the consolidation OData feeds for the model|Enabling access to the Consolidation OData Feed for the model]] to enable Consolidation OData Feed.




Line 30: Line 41:
Consolidate
Consolidate


Consolidated End Points
Consolidation OData Feed
 
Consolidation End Points


Consolidate Xero Organisations
Consolidate Xero Organisations
3,572

edits

Navigation menu