[MGNLUI-5067] DOC: How to define datasource for ContentApp and ContentSubApp Created: 07/Mar/19  Updated: 02/Sep/19  Resolved: 29/Jul/19

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: Datasource, app-configuration, content-app, new-UI-framework, new-data-binding
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-4986 DOC: SubAppDescriptor API Closed
relates to MGNLUI-5230 DOC: AppDescriptor API Closed
dependency
depends upon MGNLUI-4987 DOC: datasource (key concept) Closed
depends upon MGNLUI-4988 DOC: datasource (API) Closed
documentation
documents MGNLUI-4470 Allow definition of DataSource in Con... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 12, UI Framework 2
Story Points: 2

 Description   

Summary

Explain how to define the datasource property for a content app. This should be done at both the app and subapp levels.

IMPORTANT NOTE

To define the datasource property with AppDescriptor and SubAppDescriptor, you have to use the following classes respectively:

  • info.magnolia.ui.contentapp.configuration.ContentAppDescriptor
  • info.magnolia.ui.contentapp.configuration.ContentSubAppDescriptor

Refer to the new Data source definition page in the description of the datasource property at https://documentation.magnolia-cms.com/display/DOCS61/App+descriptor+-+6+UI and https://documentation.magnolia-cms.com/display/DOCS61/Subapp+descriptor+-+6+UI.



 Comments   
Comment by Ashraf Khamis [ 29/Jul/19 ]

Added datasource as a property of:

App descriptor (https://documentation.magnolia-cms.com/display/DOCS61/App+descriptor+-+6+UI#Appdescriptor-6UI-Appdescriptorproperties)

  • Connects the app to a data source. For this to work, you have to use the info.magnolia.ui.contentapp.configuration.ContentAppDescriptor class.

Subapp descriptor (https://documentation.magnolia-cms.com/display/DOCS61/Subapp+descriptor+-+6+UI#Subappdescriptor-6UI-Subappdescriptorproperties)

  • Connects the subapp to a data source. For this to work, you have to use the info.magnolia.ui.contentapp.configuration.ContentSubAppDescriptor class. If no value is specified, the subapp will inherit the app data source.

And linked to Data source definition (https://documentation.magnolia-cms.com/display/DOCS61/Data+source+definition).

Reviewed by Sasha and Roman.

Generated at Mon Feb 12 09:22:53 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.