Skip to main content

HTML block

The HTML block allows you to include all kinds of HTML content. For example, you could present:

  • Announcements
  • Policy information
  • On-screen help
  • Links to Intranet, Extranet or other systems
  • Embedded YouTube videos
  • Helpdesk support
  • Surveys
  • Dynamically generated HTML content based on information in the database

This is an example of an HTML block:

Screenshot_2016-06-30_13_48_41.png

Custom HTML content is not covered by your technical support agreement. Please follow the below usage guidelines.

Usage guidelines

Please observe these guidelines:

  • Use it primarily for simple content or for embedded iframes. Eg, instructional text with simple formattings such as bold, italics, and bulleted and numbered lists
  • Do not embed content that includes a <script> tag - these will likely not work and could introduce security vulnerabilities
  • Custom HTML content is not covered by your technical support contract
  • Avoid using inline styles - try to use class references where possible. This will help ensure consistency with changes to color themes and future styling updates
  • Always check your content on mobile-first
  • Do not include HTML tables - these are not responsive
  • If embedding iframes please understand the limitations of iframes such as restricted memory
  • Do not embed apps that use angular.js

The HTML content can be provided in one of 4 ways:

  1. Static HTML. The HTML is stored in an Application Message (use pMessageName).
  2. Dynamic HTML. The HTML is provided by a function (use pHtmlFunction)
  3. HTML from a static URL. The HTML is loaded at run-time from a static URL (use pSrcHref)
  4. HTML from a dynamic URL. The HTML is loaded at run-time from a dynamically-derived URL (use pSrcHrefFunction)

The block has the following parameters:

Property Example Usage Description

Raw HTML

 Some <strong>bold</strong> HTML The static HTML in option 1 above
HTML provider function

my_package_pkg.html_function

 A PL/SQL function that retrieves the HTML dynamically as per option 2 above. See Dynamic HTML function.
URL https://www.applaudsolutions.com The static URL as per option 3 above.
URL provider function my_package_pkg.href_function A PL/SQL function that retrieves the URL dynamically as per option 4 above. See Dynamic URL function.
CSS selector body The selector gets a fragment of the URL's HTML. Only used with HTML from a URL
Remove inline styles Checked Unchecked If checked this cleans any inline styles so that the HTML inherits the page's styling. Only used with HTML from a URL.
Show border Checked Unchecked If checked this draws a visual border around the content to show it's embedded. Only used with HTML from a URL.

Dynamic HTML function

The HTML function must be a PL/SQL function with this signature:

FUNCTION html_function (p_function_id IN number ,p_function_name IN varchar2 ,p_function_parameters IN varchar2 ,p_object_id IN number ,p_obj_name IN varchar2 ,p_keys IN xxas_com_keys_type) RETURN varchar2;

The block's properties are passed in for your convenience. The function should return the raw HTML as a varchar2.

Dynamic URL function

This PL/SQL function must have this signature:

FUNCTION getFwkBodyURLFromKeys (p_keys in xxas_com_keys_type) RETURN VARCHAR2;

This function only accepts the p_keys parameter. The function should return the URL as a varchar2.

Sections in this article