Skip to main content

Sitecore GQL not showing template in auto suggestion while using GQL playground

Hi Team,

We all work with GraphQL playground which was new some years back and we were all learning, today i am going to share a scenario which you might face too, So you can get the answer or solution handy with this blog post

Scenario

There are many of our components and code calling GQL, All works fine, but one scenario where it kept showing "Unknown type", There was nothing fancy there and same query and same expectations but it was failing, Below are details of it.

So, The context is i created a template, and also created items from that template.

Now, I had to write GQL just expose those content because our another downstream system will consume that data and use it.

But when i wrote simple query, it kept giving me "Unknown type" error and i was little clueless, Here is what is kept showing.


 Troubleshooting

1) I double checked, If template "RecurringScript" exists with same name in Sitecore

2) I renamed the template just to try but it did not work too

3) Out of the clue i tried searching for some other template and they were showing fine

4) I cleared cache and tried

Solution

Well, to resolve this, It is important how these templates schema is being generated, So first thing what i did was to understand how GQL schemas gets generated

By default schema configuration looks like below in your showconfig.aspx

If you see, the instruction are in place that read the templates on given paths, Now in my case the folder was created outside of whole structure (for some internal purpose).

There are two things you can do here

1) You can define you whole custom schema configuration with your custom paths and your personal GQL Playground endpoint and patch it

2) There is also an option, so if you create any template under "User Defined" folder, It will be considered in schema and you will be able to query normally

To cut the story short, anything that you defined in "AddIncludedPath" configurations, From those locations it will try to generate schema for templates and then you can query them.

So, for my needs, i moved my folder into "User Defined" folder (the folder which i moved had "RecurringScript" template inside it) and restarted the environment.

and now because i moved the folder which had my template into "User Defined" folder and because my GQL schema has that configuration to read from that folder, the error was resolved and i was able to hit the query just fine

Conclusion

GQL is full extensible, you can patch your own schema configuration and give different folder path for your needs, In my next blog i will explain a scenario which could exists in your existing set up too and it might break your components for you too.

For above change, i had one question to Sitecore, What if i want to exclude the paths, so if i have more path in exclusion and less path in inclusion, Having "AddExcludedPath" will help in those scenarios

And Sitecore has taken it as feature request and the tracking number for that request is "DEVEX-2997"

Labels:

Comments

  1. sheetalDecember 20, 2024 at 2:43 AM

    I’ve faced similar issues when working with GraphQL. It’s frustrating when you know the query is correct, but the schema still gives you an "Unknown type" error. It’s always useful to check if the type is actually defined in the GraphQL schema.
    Dust Collector
    Industrial Dust Removal

    ReplyDelete
  2. prachiDecember 20, 2024 at 2:45 AM

    I encountered the same issue once when the schema wasn’t fully loaded in the playground. Make sure all types are exposed and available before running queries, especially when dealing with dynamically created content like templates.
    Manual Dust Collector
    paint booth

    ReplyDelete
  3. dikshaDecember 20, 2024 at 2:45 AM

    This is really helpful! I struggled with the same error when integrating new fields from templates into our existing schema. It turned out that I had missed adding a new type definition for the items I wanted to expose.
    Industrial Dust Collector india
    Pollution Control Equipments india

    ReplyDelete
  4. Nishi8171December 20, 2024 at 2:45 AM

    Great explanation. Another thing that can cause this error is when you try to query fields or types that are not yet registered in the GraphQL schema or might be conditionally exposed depending on your environment.
    Centrifugal Blowers india
    Shrink Packing machine Delhi

    ReplyDelete
  5. somyaDecember 20, 2024 at 2:45 AM

    Interesting post! I had the same problem when trying to integrate a downstream system with GraphQL. In my case, the types were missing from the schema because I forgot to publish them after defining them in the template.
    Axial Flow Fans in delhi
    Dust Collector Manufacturer

    ReplyDelete
  6. gautamDecember 20, 2024 at 2:45 AM

    This issue can sometimes occur due to circular dependencies in the schema. Be sure to check that the types are defined in the right order and that they don’t depend on each other in ways that could break the schema generation process.
    Axial Flow Fans manufactrurer
    Invest in Brands

    ReplyDelete

Post a Comment

Popular posts from this blog

One or more exceptions occurred while processing the subscribers to the 'item:creating' event

I was recently installing the packages from one of the QA environment to my local Sitecore instance, "Media library package" to be precise, And it started giving me this below error One or more exceptions occurred while processing the subscribers to the 'item:creating' event Looking at the sitecore logs, it gave me more info on the context and the actual inner exception was following Solution: 'Name' should consist only of letters, digits, dashes or underscore Now it was evident that some of my file names were violating the naming rule, I could see in the log just before exception from where the installer stopped creating items, and that file name had round braces "(" and ")" at the end of it, with my surprise I was able to create the item with those name in the content tree, but below was the solution for it, Solution I am using SC 9.0.1 and in that Go to Sitecore.Marketing.config file residing in "App_Config\Sitecore\Mar...
9 comments
Read more

401.1 Unauthorized with windows authentication error code 0xc000006d

How many of you have faced this hosting issue when you do everything what it takes to run the site with windows authentication but still you are getting the same error again and again? If you think you also have faced the same issue and you tired of reading MSDN KBs for it and still have not found the issue (If KB has solved the issue, well and good, if not you can try this trick),Please Read below Typical scenario In typical hosting with IIS, i did every possible things like enabling windows authentication, changing it in web.config, configuring connection pool, authorization rules, it asks me for window authentication login and despite of entering correct credentials it always fails and keeps on asking for login, and when pressed cancel it gives 401.1 with 0xc000006d error code Solution (Which worked for me at-least after trying for almost 6-9 hrs) You need to change the Loop Back Check in registry so that it allows the host names which you are giving in url are allowed and au...
2 comments
Read more

Zero to Hero - A real life RCA of exact issue in Sitecore Managed Cloud environment

Hello All, The purpose of today's post is to share a real life burning and escalated scenario which was new to me and how did I approach it and how big the escalations were and what was the outcome Sitecore's goodwill was at stack not because Sitecore is not capable of handling it but just because our environment was Sitecore Managed Cloud, and any issue that comes if its infra, back end code, front end code will be first pointed as Sitecore issue and that is where our consultancy and experience will play a role to prove that it is not Sitecore issue.  Issue we faced Out of the blue our site started giving "504 Gateway Time-out", and it was reported that almost everyone is getting this error, but when we used to browse the site, everything looked good and never 504. 504 Gateway Time-out error tells that, That the request went to Content Delivery servers of Sitecore from gateway, but gateway did not get response in time from those CDs and hence it gave time out error. ...
2 comments
Read more