Consolidation OData Feed - Revision history

Nic at 23:22, 12 November 2024

2024-11-12T23:22:05Z

← Older revision		Revision as of 18:22, 12 November 2024
Line 12:		Line 12:
	There are some slight differences, however.		There are some slight differences, however.

	The Consolidation OData feed includes additional [[Function Endpoints\|~~'''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).		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).

Nic at 23:19, 12 November 2024

2024-11-12T23:19:49Z

← Older revision		Revision as of 18:19, 12 November 2024
Line 5:		Line 5:
	They assist with the consolidation process by removing the need to append data from multiple data files into 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.

	For the most part, the [[Endpoints]] access via a consolidation ~~OData~~ feed ~~are~~ the same as those for individual [[Data Files\|data files]]. Both include a Data File ID.
			== 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.

			There are some slight differences, however.

			The Consolidation OData feed includes additional [[Function Endpoints\|'''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).


Line 11:		Line 18:
	== OdataLink Report Templates require Consolidation OData Feeds ==		== OdataLink Report Templates require Consolidation OData Feeds ==

	Standard OdataLink Report ~~templates~~ require '''Consolidation''' OData Feeds to extract data.		[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 OData feed includes additional [[Function Endpoints\|'''Functions''']]. These functions include ID parameters, such as BudgetID, TrackingCategoryID, etc.~~		Using any OData feed other than '''Consolidation''' OData Feed can result in errors while refreshing the Standard report template.

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

	~~Thus, using~~ any OData feed other than '''Consolidation''' OData Feed ~~will~~ result in errors while refreshing the Standard report template.

Nic at 23:03, 12 November 2024

2024-11-12T23:03:13Z

← Older revision		Revision as of 18:03, 12 November 2024
Line 1:		Line 1:
	== Overview ==		== Overview ==

	'''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.		'''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 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\|data files]]. Both include a Data File ID.		For the most part, the [[Endpoints]] access via a consolidation OData feed are the same as those for individual [[Data Files\|data files]]. Both include a Data File ID.

Nic at 23:00, 12 November 2024

2024-11-12T23:00:25Z

← Older revision		Revision as of 18:00, 12 November 2024
Line 24:		Line 24:
	== Enable Consolidation OData Feed for a [[Models\|Model]] ==		== Enable Consolidation OData Feed for a [[Models\|Model]] ==

	~~'''~~Consolidation OData Feed~~'''~~ must be enabled ~~from Model Settings~~ in order to be used~~'''~~.		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.		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.

Ash: changed enabling/disabling consolidation... link to the redirected page

2024-11-12T06:10:31Z

changed enabling/disabling consolidation... link to the redirected page

← Older revision		Revision as of 01:10, 12 November 2024
Line 26:		Line 26:
	'''Consolidation OData Feed''' must be enabled from Model Settings in order to be used'''.		'''Consolidation OData Feed''' must be enabled from Model Settings in order to be used'''.

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

Ash at 06:08, 12 November 2024

2024-11-12T06:08:54Z

← Older revision		Revision as of 01:08, 12 November 2024
Line 8:		Line 8:


			[[File:standard_template_odata_feed_error.png\|300px\|thumb]]
			== OdataLink Report Templates require Consolidation OData Feeds ==

	~~== 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 require '''Consolidation''' OData Feeds to extract data.

Ash: changes as per suggested by Nic and Jeff

2024-11-12T06:07:50Z

changes as per suggested by Nic and Jeff

← Older revision		Revision as of 01:07, 12 November 2024
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

Ash: Ash moved page Consolidation Endpoints to Consolidation OData Feed: retiring older terminology - consolidation endpoint.

2024-11-12T05:31:09Z

Ash moved page Consolidation Endpoints to Consolidation OData Feed: retiring older terminology - consolidation endpoint.

← Older revision	Revision as of 00:31, 12 November 2024
(No difference)

Ash at 00:52, 29 October 2024

2024-10-29T00:52:30Z

← Older revision		Revision as of 19:52, 28 October 2024
Line 10:		Line 10:


	== ~~Standard~~ OdataLink Templates ==		== OdataLink Report Templates ==

	Standard OdataLink templates utilize '''Consolidation''' 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.		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.

Ash: added information on Standard templates and consolidation endpoints

2024-10-29T00:40:16Z

added information on Standard templates and consolidation endpoints

← Older revision		Revision as of 19:40, 28 October 2024
Line 8:		Line 8:

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


			== Standard OdataLink Templates ==

			Standard OdataLink 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 endpoint functions contain a company field ('''DataFile ID''') as a parameter, which is not available in standard company endpoints.

			Thus, using a '''Company Odata Feed''' instead of '''Consolidation''' will result in errors while refreshing the report.


	== Related Topics ==		== Related Topics ==

	:[[Endpoints]]		:[[Endpoints]]
			:[https://odatalink.com/templates/ OdataLink Report Templates]


	== Key Words ==		== Key Words ==