Difference between revisions of "Consolidation OData Feed"

m
changes as per suggested by Nic and Jeff
m (Ash moved page Consolidation Endpoints to Consolidation OData Feed: retiring older terminology - consolidation endpoint.)
m (changes as per suggested by Nic and Jeff)
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 all your [[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 file specific end points 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
The Consolidation [[Endpoints]] created by [[Models|model]] are the same as those for individual [[Data Files|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.




== OdataLink Report Templates ==
== OdataLink Report Templates require Consolidation OData Feeds ==
[[File:standard_template_odata_feed_error.png|250px|thumb]]
Standard OdataLink Report templates require '''Consolidation''' OData Feeds to extract data.


Standard OdataLink Report templates utilize '''Consolidation''' Feeds to extract data.  
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 OData feed includes additional [[Function Endpoints|'''Functions''']]. These functions include ID parameters, such as BudgetID, TrackingCategoryID, etc.
 
Since these ID parameters are specific to a single [[Data Files|Data File]], Standard templates include additional syntax to specify the DataFile IDs of all datafiles assigned to a model.


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.
Thus, using any OData feed other than '''Consolidation''' OData Feed will result in errors while refreshing the Standard report template.
 
 
== Enable Consolidation OData Feed for a [[Models|Model]] ==


The consolidation endpoint functions contain a company field ('''DataFile ID''') as a parameter, which is not available in standard company endpoints.
'''Consolidation OData Feed''' must be enabled from Model Settings in order to be used'''.  


Thus, using a '''Company Odata Feed''' instead of '''Consolidation''' will result in errors while refreshing the report.
Please refer to [[Enabling / disabling OData access to the consolidation endpoints for the model|Enabling access to the Consolidation OData Feed for the model]] to enable Consolidation OData Feed.




Line 30: Line 38:
Consolidate
Consolidate


Consolidated End Points
Consolidation OData Feed
 
Consolidation End Points


Consolidate Xero Organisations
Consolidate Xero Organisations
Write
268

edits