External Content Properties: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
With the External Content presentation object you can show content from some other website or web portal. The External Content presentation object uses html's iframe element to embed the websites. Using the External Content presentation object enables integrating multiple Web applications into a single UI.
External Content component can be used to show content from other webpages, such as from Microsoft Sharepoint or other content management systems, enabling to integrate multiple web applications into the single UI. The External Content component uses the HTML ''iframe'' element to embed the content.


== Properties Tab ==
== Settings ==
The following properties can be set on the Properties tab:
Following properties can be set on the Properties tab:
* '''Name''': Name of the External Content presentation object.
* '''Name''': Name of the External Content component.
* '''Description''': Description for the External Content presentation object.
* '''Description''': Description for the External Content component.
* '''External Content URL''': The URL of the external page you want to embed in QPR UI. You can also use a relative path (e.g. "/examples/test.html"), if the page you want to embed is accessible by the same protocol, host, and port as QPR UI.
* '''External Content URL''': The URL of the external page you want to embed. You can also use a relative path (e.g. "/examples/test.html"), if the page you want to embed is accessible by the same protocol, host, and port.


== Accessing Context Variables in the External Webpage ==
== Passing Variables in Url==
See [[HTML Properties#Setting Context Variables in HTML code|Using setSessionVariable in HTML code]].
You can pass context variable values in the iframe url using the variable tags. Example:


The external webpage must be referenced using the same server name and port as QPR UI, so that these javascript functions can be called. This is because of web browsers security features ([https://en.wikipedia.org/wiki/Same-origin_policy same origin policy]).
'''<nowiki>http(s)://SERVERNAME/ExternalPresentationObjects/ExternalPresentationObject1#variable1=<#variable1>&variable2=<#variable2></nowiki>'''


There is a test page available in the QPR UI where the functioning of these variables can be tested: '''/ui/examples/test.html'''.
== Web Browser Security Considerations ==
 
Some websites prevent themselves to be embedded into other websites using iframe. In those cases, the component will be left blank (in Chrome and Firefox) or there may be an error message "This content cannot be displayed in a frame". The way to workaround the issue is to have '''X-Frame-Options''' HTTP response header changed in the embedded website (more information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).
These functions interact only with the session context - not the external presentation object's effective context. To use presentation object's effective context in the external webpage, continue reading to the next chapter.
 
== Passing effective context in the url==
To access the external presentation object's effective context, you can pass context variable values in the iFrame url using the '''{#variableName}''' syntax. Example:
 
'''<nowiki>http(s)://SERVERNAME/ExternalPresentationObjects/ExternalPresentationObject1#variable1={#variable1}&variable2={#variable2}</nowiki>'''
 
If the variable references appear after the hash mark (#), the external web page is not refreshed when the context variables values change. In the external web page, url changes can be monitored through '''onhashchange''' javascript event of the '''window''' object. The following example registers a function that is called when the url changes:
<pre>
window.onhashchange = function() {
  var iFrameUrl = window.location.href;
  var listOfParameters = iFrameUrl.substr(iFrameUrl.indexOf("#") + 1));
}
</pre>
 
== Web browser security considerations ==
Some websites prevent themselves to be embedded into other websites using iFrame. In those cases, the external content presentation object will be left blank (in Chrome and Firefox) or there may be an error message "This content cannot be displayed in a frame" (in Internet Explorer). The way to workaround the issue is to have '''X-Frame-Options''' HTTP response header changed in the embedded website (more information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).
{{MDBTutorialExternalContent}}
 
[[Category: QPR UI]]

Latest revision as of 10:07, 13 December 2021

External Content component can be used to show content from other webpages, such as from Microsoft Sharepoint or other content management systems, enabling to integrate multiple web applications into the single UI. The External Content component uses the HTML iframe element to embed the content.

Settings

Following properties can be set on the Properties tab:

  • Name: Name of the External Content component.
  • Description: Description for the External Content component.
  • External Content URL: The URL of the external page you want to embed. You can also use a relative path (e.g. "/examples/test.html"), if the page you want to embed is accessible by the same protocol, host, and port.

Passing Variables in Url

You can pass context variable values in the iframe url using the variable tags. Example:

http(s)://SERVERNAME/ExternalPresentationObjects/ExternalPresentationObject1#variable1=<#variable1>&variable2=<#variable2>

Web Browser Security Considerations

Some websites prevent themselves to be embedded into other websites using iframe. In those cases, the component will be left blank (in Chrome and Firefox) or there may be an error message "This content cannot be displayed in a frame". The way to workaround the issue is to have X-Frame-Options HTTP response header changed in the embedded website (more information: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=External_Content_Properties&oldid=19618"