Level 3

Solved

Structured Data Implementation

Forum|Forum|3 years ago
March 10, 2022
3 replies
3990 views

Hi All,

We are planning add structured data on AEM pages and exploring options in AEM as well as looking for best practices to implement in AEM. Please provide your inputs.

This post is no longer active and is closed to new replies. Need help? Start a new post to ask your question.

Best answer by Siva_Sogalapalli

You can try multiple ways:

Option 1 : Add new text area filed called in page properties and where content author can directly add the json LD script. You can also add check box to enable or disable structured data (optional)

something like as shown below.

If the script is configured and enabled then load the script within <head> {propertes.jsonldscript} </head> something like this.
Challenge: Content authors should have knowledge about script and make sure they are adding proper script.

Option 2: As @briankasingli mentioned, you can even try with Experience Fragments.

Create a custom component - Author configure required content at dialog level & BE logic to generate JSON-LD script dynamically based on data configured by author & store the script at node level
Create new path field at page properties level - author can browser script path/experience fragments path at page properties level.
BE logic to read the script location & load the script with in <head> tag.

Hope this helps you.

Nitin_laad

Community Advisor

@sonur1 You can create structured data using the content fragment model in AEM.

below are some references you should refer to get better clarity on CFs and accordingly you can make a decision on your use case.

https://experienceleague.adobe.com/docs/experience-manager-64/assets/fragments/content-fragments.html?lang=en

https://experienceleague.adobe.com/docs/experience-manager-learn/sites/content-fragments/content-fragments-delivery-feature-video-use.html?lang=en

https://one-inside.com/aem-content-fragments-vs-experience-fragments/

S

SonuR1Author

Level 3

Thanks for the reply @nitin_laad

Yea, content fragment is one of the options where we can define the fields required for structured data. Once we take the input from authors, Do you suggest to generate the JSON-LD programatically and store at node level?

Nitin_laad

Community Advisor

Hi @sonur1 You can easily get json from content fragment using model.json selector.

ex -

http://localhost:4502/content/we-retail/language-masters/en/manchester-airport/jcr:content/root/responsivegrid/contentfragment.model.json

JSON Exporter for Content Services | Adobe Experience Manager

Adobe Experience Manager Content Fragments Support in Assets HTTP API | Adobe Experience Manager

I do not know your use case hence not sure why are you exploring JSON-LD.

BrianKasingli

Community Advisor and Adobe Champion

My input is, you can use a Experience Fragments strategy to add reusable-structured-data in your AEM pages.

S

SonuR1Author

Level 3

Thanks for the reply @briankasingli

May be I've the same question with experience fragments as well 🙂 Do we need to develop custom component to store JSON LD script?

As per my understanding, we need to add JSON-LD script with in <head> tag at the page level. So I'm looking for options how we can provide feature for authors where can they can just add data and backend generate script and load at the page level.

1. We want to avoid authors to take care of the script if possible.

2. exploring options as shown in below example where authors do not worry about the script.

https://simplifiedsearch.net/structured-data-generator/

3. Is there a way integrate API to generate Script dynamically.

4. If we can generate script dynamically or in the worst case assume author takes care of preparing script. in this case, what is the best options to load the script at the page level. etc..

E

egirl

"As per my understanding, we need to add JSON-LD script with in <head> tag at the page level. "

JSON-LD can be in head or body. Perhaps AEM has it's own peculiarity as to where it needs to go though?

You can also manually add it into the freeform area in the meta data area if you have that configured, but that would be for manually adding it, not automating.

Siva_Sogalapalli

Accepted solution

Community Advisor

You can try multiple ways:

Option 1 : Add new text area filed called in page properties and where content author can directly add the json LD script. You can also add check box to enable or disable structured data (optional)

something like as shown below.

If the script is configured and enabled then load the script within <head> {propertes.jsonldscript} </head> something like this.
Challenge: Content authors should have knowledge about script and make sure they are adding proper script.

Option 2: As @briankasingli mentioned, you can even try with Experience Fragments.

Create a custom component - Author configure required content at dialog level & BE logic to generate JSON-LD script dynamically based on data configured by author & store the script at node level
Create new path field at page properties level - author can browser script path/experience fragments path at page properties level.
BE logic to read the script location & load the script with in <head> tag.

Hope this helps you.

V

VaibhavCh7

Hi @siva_sogalapalli ,
In my case i have a breadcrumb component which will generate breadcrumb. I need to add JSON-LD schema to some pages and the data in that schema will be dynamic, means whenever you open any page from that page who need to pick up your breadcrumb data.(url and title, max 3). I need to fetch the url and title from breadcrumb and need to pass it to the schema.

I am not sure how to get the data from breadcrumb and pass to schema.
and where that schema i should add?

I don't want to make the changes in existing code or component.
Is there any way to do it

@sonur1 @egirl is your query resolve?

Sign up

Login with SSO

Login to the community

Login with SSO

Scanning file for viruses.

This file cannot be downloaded