CMS Plugins: How-to locate CMS ‘plugin request URLs'
- CMS Plugins: How-to locate CMS "plugin request URLs"
- Steps to gather the CMS Plugin Request URL from HAR file
- Steps to gather the CMS Plugin Request URL from Browser
- What if no Request URL is found?
With the CMS plugins, you may need to locate the plugin request URLs to troubleshoot issues that can come up. We have listed the steps for two different methods to do so below.
Steps to gather the CMS Plugin Request URL from a HAR file
Steps to locate and check the request URL by creating a HAR file on the Editing Page in the CMS you are running into issues with seeing the plugin data.
- Create a HAR file following this documentation: How to create a HAR file?
- Open the file with a HAR file reader like this one HAR Analyzer
- Once the file is open in the HAR file reader then use the keyboard commands Ctrl+F or Command+F in your browser to search for:
"https://my2.siteimprove.com/overlay/cms/cmspage" for plugins using the old plugin UI or
"https://contentassistant.eu.siteimprove.com/cms/poll" for plugins using the new plugin UI.
This should be the 'plugin request.' - Select that request and the request URL should be located under the request tab.
- In the request URL, like the one below, the URL that the plugin is requesting data on should come up after the parameter "?url=" and before the next parameter starting with "&" (in this case "&token").
For example, in the request URL below, the URL we are trying to locate data for in the Siteimprove platform would be:
http://kmor.siteimprovedemo.com/about-us/
Example request URL:
https://my2.siteimprove.com/overlay/cms/cmspage?url=http://kmor.siteimprovedemo.com/about-us/&token=d3757668606f46fb8a13ad8ab23f3d8e
Steps to gather the CMS Plugin Request URL from Browser
The steps below can be performed to gather the plugin request URL for troubleshooting. We’ve listed steps for Chrome and Firefox, but you can do the same thing with Safari or IE with pretty much the same steps.
Instructions in Chrome
- In the CMS, navigate to the editing/authoring page with the issue.
- Open the Chrome Developer Tools using one of the following options:
a. Right-click the mouse and select “Inspect.”
b. Go under the Chrome settings area, icon with 3 dots in the upper-right-hand corner, and select More Tools > Developer Tools.
- Select the Network Tab in the Dev Tool area and look for an entry that starts with “cmspage?url=” or “poll?token=” and select that entry. You may need to refresh the page to see this.
- To the right of the request you selected, make sure that the “Headers” tab is selected. You should see an entry for “Request URL” that looks something like one of the URLs below:
https://my2.siteimprove.com/overlay/cms/cmspage?url=http://kmor.siteimprovedemo.com/about-us/&token=d3757668606f46fb8a13ad8ab23f3d8e
or
https://contentassistant.eu.siteimprove.com/cms/poll?token=d3757668606f46fb8a13ad8ab23f3d8e&url=http://kmor.siteimprovedemo.com/about-us/
The URL in-between “?url=” and before the next parameter starting with "&" is the URL we are requesting data from in the Siteimprove platform.
That would be http://kmor.siteimprovedemo.com/about-us/ in the example above.
Instructions in Firefox
- In the CMS, navigate to the editing page with the issue.
- Open the Firefox Developer Tools using one of the following options:
a. Right-click the mouse and select “Inspect Element.”
b. Go under the Firefox settings area, icon with 3 lines in the upper-right-hand corner, and select Web Developer > Inspector.
- Select the Network Tab in the Dev Tool area and look for an entry that starts with "cmspage?url=" or "poll?token=" under the "File" column and select that entry. You may need to refresh the page to see this
- To the right of the entry for "cmspage?url=" or "poll?token=" make sure that the "Headers" tab is selected.
You should see an entry for “Request URL” that looks something like one of the URLs below.
https://my2.siteimprove.com/overlay/cms/cmspage?url=http://kmor.siteimprovedemo.com/about-us/&token=d3757668606f46fb8a13ad8ab23f3d8e
or
https://contentassistant.eu.siteimprove.com/cms/poll?token=d3757668606f46fb8a13ad8ab23f3d8e&url=http://kmor.siteimprovedemo.com/about-us/
The URL in-between “?url=” and before the next parameter starting with "&" is the URL we are requesting data from in the Siteimprove platform.
That would be http://kmor.siteimprovedemo.com/about-us/ in the example above.
What if no Request URL is found?
If you cannot locate the "https://my2.siteimprove.com/overlay/cms/cmspage" or "https://contentassistant.eu.siteimprove.com/cms/poll" requests, then you can search also for "overlay" using the keyboard commands Ctrl+F or Command+F in your browser to find the plugin overlay javascript request. The request would contain URLs like the following:
- https://cdn.siteimprove.net/cms/overlay-v1.js
- https://cdn.siteimprove.net/cms/overlay.js
- https://cdn.siteimprove.net/cms/overlay-latest.js?ver=2.0.0
If that exists, this tells you that the plugin overlay is installed and exists. There may be a number of reasons that the other requests from the plugin are not displaying:
- It may be that you are just not on an editing/authoring page in the CMS when the HAR file was created and are on the dashboard or somewhere else in the CMS so you are not seeing a request URL. Only editing or authoring pages in the CMS will make these requests.
- It could also mean that there is a filter setup under the Network tab of your browser's developer tools so that not all the network requests display. See more on filtering the Network tab of your browser’s developer tools under the resources below as you may need to adjust this with your browser or try a different browser.
- That the request URL is being blocked. Pop-up blockers, Ad-blockers, browser extensions, CORS (Cross-Origin Resource Sharing) policies, or other network setups on the site end can sometimes block the plugin requests.
That the configuration of the plugin is incorrect, so the plugin overly displays but it is not making requests. Review installation documentation to confirm steps were not missed.
Did you find it helpful? Yes No
Send feedback