Written by

Sr Application Development Analyst at The Ohio State University Wexner Medical Center

Question Scott Roth · Nov 20, 2024

Documentation Issues

Who do we report Documentation issues to?

Since moving to the new format, when searching for things within the documentation I get a blank screen with no results.

When I type in my search criteria, I can see it trying to find results but does not return results.

This does not seem like it is limited to a certain Web Browser, as I have seen this happen in Chrome and Edge

Thanks

Scott

Product version: IRIS 2024.1

Discussion (0)0

Add reply

Comments

Enrico Parisi · Nov 20, 2024

In the documentation site (every page?) there is a "Feedback" blue button on the right of the page, click on it...

0 0

Timothy Leavitt Nov 20, 2024 to Enrico Parisi

It looks like the page is so broken that Scott probably doesn't see the "Feedback" button.

I've submitted feedback on Scott's behalf with a link to this post.

0 0

Alexander Pettitt · Nov 20, 2024

Searching for ConvertDateTime works for me and gives 6 results.
https://docs.intersystems.com/results.html?docs%5Bquery%5D=ConvertDateTime

0 0

Scott Roth Nov 20, 2024 to Alexander Pettitt

Tried the link and got the same results...

0 0

Ben Spead Nov 20, 2024 to Scott Roth

@Scott Roth - what browser are you using? Can you try in an incognito browser to bypass any cookies or settings which could be impacting behavior? (I am not able to replicate your results)

0 0

Scott Roth Nov 20, 2024 to Ben Spead

I tried Private Browsing and reset the cookie settings for the site, but I still got the same result with Edge.

0 0

Ben Spead Nov 20, 2024 to Scott Roth

Does it fail in any browser other than Edge? I can't get Edge to fail (nor Chrome not Chrome incognito).

Just trying to figure out what might be different for you.

0 0

Scott Roth Nov 20, 2024 to Ben Spead

Fails in Chrome as well...

0 0

Robert Leff · Nov 20, 2024

I have created a JIRA titled DOCS-14349 to track this issue.

0 0

Ben Spead Nov 20, 2024 to Robert Leff

@Scott Roth - you are in good hands :) Thanks @Robert Leff!!

0 0

Sammy Lee · Nov 20, 2024

@Scott Roth Thank you for letting us know. Since this search issue seems to be affecting most of your available browsers, our team will take a closer look at the issue at our earliest convenience. Just for our information, does this issue occur on both links attached below and only when searching for IRIS2024.1 content?

https://docs.intersystems.com/irislatest/csp/docbook/Doc.Results.cls
https://docs.intersystems.com/results.html
@Robert Leff @Ben Spead @Timothy Leavitt Thank you for looking into this!

0 0

Scott Roth Nov 20, 2024 to Sammy Lee

I went to previous versions of the documentation, and the search did not work there either.

0 0

Sammy Lee Nov 20, 2024 to Scott Roth

Thanks for confirming. When you inspect the page, does console tab display any errors?

0 0

Scott Roth Nov 20, 2024 to Sammy Lee

When I open developer tools on the page, I am seeing the following.

Uncaught TypeError: Cannot read properties of null (reading 'classList' at hidelefttocbottom (docview.min.js:3:15344) at docview.min.js:3:18107
Uncaught TypeError: Failed to execute 'observe' on 'MutationObserver': parameter 1 is not of type 'Node'. at algolia-common.min.js:2:8179

0 0

David Hockenbroch Nov 20, 2024 to Scott Roth

For what it's worth, I get the error about the MutationObserver too, but my results still display correctly. (Is Magneto messing with Cerebro again over there?)

0 0

Marc Mundt Nov 20, 2024 to Scott Roth

In Developer Tools, can you try the "Disable Cache" option and then reload the page?

This screenshot is from Firefox, but Chrome also has this option in the Network tab.

0 0

Marc Mundt Nov 20, 2024 to Marc Mundt

And in the Developer Tools "Network" tab, do any of the requests return HTTP codes other than 200?

0 0

Sammy Lee Nov 20, 2024 to Scott Roth

It looks like these error messages aren't affecting the operation of the search. Once the issue is replicated on our end, we'll take a closer look into this. Apologies for any inconvenience this may have caused.

0 0

David Hockenbroch Nov 20, 2024 to Sammy Lee

@Sammy Lee
@Marc Mundt
I'm able to replicate some of this behavior if I use the developer tools in Edge, go to the network tab, and use Network Request Blocking to block *algolia*. The issue might be with the XHR requests there.

@Scott Roth
In Edge, if you bring up the developer tools, go to the network tab, and in the filter buttons, click on XHR, then start typing in the search box, do you see errors there? (GIF shows what some good requests look like, followed by what errors might look like.)

0 0

Scott Roth Nov 20, 2024 to David Hockenbroch

Several errors were shown with similar URLs

0 0

Sammy Lee Dec 6, 2024 to Scott Roth

Hi Scott,

We were able to reproduce the issue you had with an invalid search API key on our end that causes the same blank search page you attached.
Could you send a screenshot when you view the page source of your blank search page?
The functional page on our end currently displays the following:

0 0

Scott Roth Dec 6, 2024 to Sammy Lee

<!DOCTYPE html><htmllang="en"dir="ltr"><head><!-- OneTrust Cookies Consent Notice start for intersystems.com --><scriptsrc="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js"type="text/javascript"charset="UTF-8"data-domain-script="8d5650d9-35f0-4aec-8e1f-9fa3682325e6" ></script><scripttype="text/javascript">functionOptanonWrapper(){ }
</script><!-- OneTrust Cookies Consent Notice end for docs.intersystems.com --><!-- Google Tag Manager --><script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
newDate().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-T38JKJG');</script><!-- End Google Tag Manager --><!-- serverID = A-1 --><scripttype="text/javascript"src="https://docs.intersystems.com/irislatest/csp/docbook/jquery-3.6.0.min.js"></script><title>Search InterSystems Documentation</title><metaHTTP-EQUIV="Content-Type"CONTENT="text/html; charset=utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="twitter:title"content="Search InterSystems Documentation"><metaproperty="og:image:width"content="1200"><metaproperty="og:image:height"content="630"><metaname="image"property="og:image"content="https://docs.intersystems.com/irislatest/csp/docbook/Intersystems_optlsy.jpg"><metaname="twitter:image"content="https://docs.intersystems.com/irislatest/csp/docbook/Intersystems_optlsy.jpg"><metaname="description"content="Search InterSystems Documentation"><metaname="og:description"content="Search InterSystems Documentation"><metaname="twitter:description"content="Search InterSystems Documentation"><metaclass="swiftype"name="ST-ContentSource"data-type="string"content="Documentation"/><metaclass="swiftype"name="ST-ContentType"data-type="string"content="Documentation"/><metaclass="swiftype"name="ST-Product"data-type="string"content="Health Connect"/><metaclass="algolia"name="ALG-AppID"data-type="string"content="EP91R43SFK"/><metaclass="algolia"name="ALG-Index"data-type="string"content="docs"/><metaclass="algolia"name="ALG-SearchKey"data-type="string"content="709759d92d99a5cf927e90c965741389"/><metaclass="algolia"name="ALG-Product"data-type="string"content="product:'Health Connect'"/><metaclass="algolia"name="ALG-Version"data-type="string"content="version:'2024.3'"/><script>var ALGOLIA_INSIGHTS_SRC = "https://cdn.jsdelivr.net/npm/search-insights@2.0.3";

  !function(e,a,t,n,s,i,c){e.AlgoliaAnalyticsObject=s,e[s]=e[s]||function(){
  (e[s].queue=e[s].queue||[]).push(arguments)},i=a.createElement(t),c=a.getElementsByTagName(t)[0],
  i.async=1,i.src=n,c.parentNode.insertBefore(i,c)
  }(window,document,"script",ALGOLIA_INSIGHTS_SRC,"aa");

aa('init',
{ appId: 'EP91R43SFK', apiKey: '709759d92d99a5cf927e90c965741389', } 
);
</script><metaclass="algolia"name="ALG-ProductFacets"data-type="string"content="Health Connect"/><metaclass="algolia"name="ALG-VersionFacets"data-type="string"content="2024.3"/><metaname="robots"content="noindex,nofollow"><metaname="st:robots"content="noindex,nofollow"><metahttp-equiv="X-UA-Compatible"content="IE=edge,chrome=1" /><!-- Google Analytics --><scripttype="text/plain"class="optanon-category-C0002">
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*newDate();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-30918-1', 'auto');
ga('send', 'pageview');
</script><!-- End Google Analytics --><linkhref="https://fonts.googleapis.com/icon?family=Material+Icons&display=block"rel="stylesheet" /><linkrel="stylesheet"class="basestylesheet"id="resultsredesign"type="text/css"href="https://docs.intersystems.com/irislatest/csp/docbook/algolia/algoliaredesignstyles.css"><linkrel="stylesheet"class="extrastylesheet"id="lightstylesheet"type="text/css"href="https://docs.intersystems.com/irislatest/csp/docbook/algolia/algolialight.css"></head><body><aclass="ac-skip-main"href="#main"data-swiftype-index="false">Skip to main content</a><!-- Google Tag Manager (noscript) --><noscript><iframesrc="https://www.googletagmanager.com/ns.html?id=GTM-T38JKJG"height="0"width="0"style="display:none;visibility:hidden"></iframe></noscript><!-- End Google Tag Manager (noscript) --><divid="content-outer"><divid="content-inner"><headerdata-swiftype-index="false"><headerdata-swiftype-index="false"><divid="banner"class="search-algolia"><divid="bannerleft"><ahref="https://docs.intersystems.com"><imgid="docslogo"src="https://docs.intersystems.com/irislatest/csp/docbook/doc-logo.svg"alt="InterSystems: Creative data technology"height="71"width="263"></a></div><divid="bannerright"><navid="sitesmenulist"data-swiftype-index="false"aria-label="menu of other InterSystems websites"><ulclass="top-menu"><li><ahref="https://learning.intersystems.com/"target="_top">Learning</a></li><liclass="activesite"><ahref="https://docs.intersystems.com"target="_top">Documentation</a></li><li><ahref="https://community.intersystems.com/"target="_top">Community</a></li><li><ahref="https://openexchange.intersystems.com/"target="_top">Open Exchange</a></li><li><ahref="https://globalmasters.intersystems.com/"target="_top">Global Masters</a></li><li><ahref="https://www.intersystems.com/support-learning/learning-services/certification-program/"target="_top">Certification</a></li><li><ahref="https://partner.intersystems.com/"target="_top">Partner Directory</a></li></ul></nav></div></div><!-- end of banner --><noscript><linkrel="stylesheet"id="noscriptstylesheet"type="text/css"href="https://docs.intersystems.com/irislatest/csp/docbook/noscriptstyles.css"></noscript><noscript><divclass="noscriptbanner"data-swiftype-index="false"><p>Sorry, your browser does not support JavaScript or JavaScript is disabled. Please enable JavaScript or use another browser to have a better experience.</p></div></noscript></header><noscript><linkrel="stylesheet"id="noscriptstylesheet"type="text/css"href="https://docs.intersystems.com/irislatest/csp/docbook/noscriptstyles.css"></noscript><noscript><divclass="noscriptbanner"data-swiftype-index="false"><p>Sorry, your browser does not support JavaScript or JavaScript is disabled.<strong> Please enable JavaScript or use another browser to search.</strong></p></div></noscript></header><mainclass="resultsmain"><divid="filtering"class="demo"><mainclass="homeTab container"><divclass="container-wrapper"><sectionclass="container-filters"></section></div><sectionclass="main-wrapper"></section></main><mainclass="resultsTab container"><divclass="container-wrapper"><sectionclass="container-filters"><divclass="container-header"><h2>Search</h2><divdata-layout="desktop"><divid="clear-refinements-desktop"></div></div><divdata-layout="mobile"><divclass="ais-Stats"id="stats-mobile"></div></div></div><asideclass="container-body"><divclass="widget"><divclass="ais-Menu"id="main_category_contentTypeFilterWidget"
          ></div></div><divclass="widget"><divclass="ais-Menu"id="main_category_productFilterWidget"
          ></div></div><divclass="widget"><divclass="ais-Menu"id="main_category_versionFilterWidget"
          ></div></div><divclass="widget"><divclass="ais-Menu"id="main_category_extraTagsFilterWidget"
          ></div></div></aside></section><divdata-layout="mobile"class="container-filters-footer"><divclass="container-filters-footer-button-wrapper"><divclass="ais-ClearRefinements"id="clear-refinements-mobile"
          ></div></div><divclass="container-filters-footer-button-wrapper"><divclass="ais-Stats"id="stats-bottom"></div></div></div></div><articleclass="bannerandresults"style="width:calc(100%-500px)"><divclass="resultstopspace"><divid="bannerright"class="demo"><divclass="searchWidget widget"id="main"tabindex=-1><divclass="searchWidgetPreview"><divclass="ais-SearchBox-wrapper"id="search-wrapper"><divclass="ais-SearchBox"id="search-input"></div><divid="voicesearch-input"></div></div></div><divclass="absolute bottom-0 text-center w-full flex flex-col"
      ></div></div></div><divid="darkmodeparent"style="float: right;"><labelclass="switch"id="darkmodebutton" ><inputtype="checkbox"class="checkbox"onclick="togglestylesheetresults()"><spanclass="slider round"><imgclass="sun"src="https://docs.intersystems.com/irislatest/csp/docbook/newIcon-sun_star.svg"><imgclass="moon"src="https://docs.intersystems.com/irislatest/csp/docbook/newIcon-moon_darkmode.svg"></span></label></div></div><sectionclass="container-results"><headerclass="container-header container-options no-title"><divid="hitsPerPage"></div><divid="stats-top"></div></header><divstyle="display: flex;"><sectionclass="hits"><divclass="hitsWidgetWrapper widget"><div><div><div><divid="search-results"></div></div></div></div><divclass="absolute bottom-0 text-center w-full flex flex-col"
          ></div></div></section></div><divclass="container-footer"><navdata-widget="pagination"><divclass="ais-Panel"><divclass="ais-Panel-body"><div><divid="pagination"></div></div></div></div></nav></div></section></article></main><asidedata-layout="mobile"class="resultsTab container-filters-button"
      ><buttonclass="base primary filters-button"onclick="window.openFiltering()"
      ><iclass="mr-1 materialIcons">filter_list</i>&nbsp;Filters
      </button></aside></div><!-- end of content-inner --><aclass="gotofeedback"target="blank"href="Doc.Feedback.cls">Feedback<spanclass="ac-visually-hidden">Opens in a new tab</span></a><footerdata-swiftype-index="false"><divclass="flexdiv"><!-- container for footerleft & footerright --><divclass="flexleft">&copy; 2024 InterSystems Corporation, Cambridge, MA. All rights reserved.</div><divclass="flexright"><span><Ahref="https://www.intersystems.com/privacy-policy/"target="_blank"rel="noopener">Privacy<spanclass="ac-visually-hidden">Opens in a new tab</span></A>
 &amp; <Ahref="https://www.intersystems.com/noticesterms-conditions/"target="_blank"rel="noopener">Terms<spanclass="ac-visually-hidden">Opens in a new tab</span></A></span><Ahref="https://www.intersystems.com/guarantee/"target="_blank"rel="noopener">Guarantee<spanclass="ac-visually-hidden">Opens in a new tab</span></A><Ahref="https://www.intersystems.com/accessibility/"target="_blank"rel="noopener">Accessibility<spanclass="ac-visually-hidden">Opens in a new tab</span></A><divclass="cookie-settings-footer"><!-- OneTrust Cookie Settings button start --><aid="ot-sdk-btn"class="ot-sdk-show-settings">Cookies Settings</a><!-- OneTrust Cookie Settings button end --><ahref="https://docs.intersystems.com/website-cookies.html">Cookie List</a></div></div></div><!-- end of container for footerleft & footerright --><divclass="footerbottom"><div>Last content update: 2024-12-05 08:14:24PM</div></div><!-- end of footerbottom --><scriptsrc="https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.29.4/moment.min.js"></script><scriptsrc="https://cdn.jsdelivr.net/npm/algoliasearch@4.14.2/dist/algoliasearch-lite.umd.js"integrity="sha256-dImjLPUsG/6p3+i7gVKBiDM8EemJAhQ0VvkRK2pVsQY="crossorigin="anonymous"></script><scriptsrc="https://cdn.jsdelivr.net/npm/instantsearch.js@4.49.1/dist/instantsearch.production.min.js"></script></footer></div><!-- end of content-outer --><scriptsrc="https://docs.intersystems.com/irislatest/csp/docbook/docview.min.js"></script><scriptsrc="https://docs.intersystems.com/irislatest/csp/docbook/algolia-common.min.js"></script></body><scriptsrc="https://docs.intersystems.com/irislatest/csp/docbook/algolia/index.min.js"></script></html>

0 0

Sammy Lee Dec 12, 2024 to Scott Roth

Hi Scott,

Both the API search key and the index name from your HTML looks fine, so it may not be an search configuration problem. I've made some adjustments to the API configuration for testing purpose, so let me know if that changes anything. Since the search is failing on multiple browser with cache and cookies cleared/disabled, and JavaScript enable, it's an interesting situation. This may be an environment-specific issue so I have a few more questions to get more insights if that's okay.
1. Are there any proxy or firewall being used at the moment? This may affect the API calls. I would try connecting to a different wifi and use the ISC VPN to see if that makes a difference.

2. What version of Chrome/Edge are you using?

3. When using the search bar on a page, does it show the a preview drop down of matched results or just nothing?

4. What's the information listed when you go to the Network tab > Payload?

0 0

Scott Roth Dec 12, 2024 to Sammy Lee

More than likely there is a Firewall in place that every call we make outside of the Medical Center goes through.

Using a Personal laptop which is not owned by OSU, I was able to see type ahead search results and return search results from the Documentation page.

Edge - Version 131.0.2903.86 (Official build) (64-bit)
Chrome - Version 114.0.5735.199 (Official Build) (64-bit)

0 0

Sammy Lee Dec 13, 2024 to Scott Roth

It may be helpful to get in contact with the IT team at the Medical Center to add 'https://ep91r43sfk-dsn.algolia.net/' endpoints used by the search engine platform, Algolia, to a whitelist to allow for traffic. Another option is to use a VPN, if applicable and secure, to bypass certain firewall rules.
Algolia currently only supports the two latest version of Chrome, Edge, Firefox, and Safari. The latest stable released version for Chrome is 131.0.6778.109, so it may be helpful to do an upgrade as well.

0 0