Skip to main content

Providing HTML to the front end

You can write a CGI plugin to extend the Front-end to provide static HTML to users.

The Front-end executes the CGI plugin to retrieve the static HTML. The CGI plugin receives information on the user that is triggering the plugin.

To set the plugin point, type the name of the plugin in the PSF PLUGIN field on the Modules > Front-end (PSF) page.

The shipped plugin, psf-plugin.py, located in the \<instance>\plugin\healthcheck\ directory, provides HTML content for the Health check monitor.

Write a custom Front-end HTML plugin

Requirements

The CGI plugin is a console executable, which accepts information on standard input and writes results to standard output. See Writing plugins for general requirements.

Execution points

The Bravura Security Fabric CGI program, psf, invokes a plugin to add HTML content to the main menu. Each time the menu page is displayed, the plugin executes. It does not run when a user is yet to be authenticated. See CGI plugin sequence of events for the general sequence of events.

Input

Input passed into the plugin is as follows:

"" "" = {
  "action" = "PRINT-FORM|PROCESS-FORM" # The action of the CGI
  "cginame" = "psf" # The CGI running the plugin
  "html" = "" # unused
  "requester" = "<profile ID>" # The user requesting the page
        
  "user" = "<profile ID>" # The user requesting the page
  "tags" "" = {
    "<tag ID>" = "<tag value>" # 0 or more
    "LANG" = "en-us"
    "PS_LOCK_DIR" = "F:\\Locks\\"
  }
}

For example:

"" "" = {
  "action" = "PRINT-FORM"
  "cginame" = "psf"
  "html" = ""
  "requester" = "crysta.soria"
  "user" = "crysta.soria"
  "tags" "" = {
    "LANG" = "en-us"
    "PS_LOCK_DIR" = "F:\\Locks\\"
  }
}

Output

The output returns static information that is presented to the user. The static HTML is added to the end of the self-service options.

Output passed from the plugin is as follows:

"" "" = {
   "html" = "<static HTML>"
      # The HTML to include on the self-service options page
}

The value for HTML key content must be written as one line.

For example:

"" "" = {
   "html" = "<strong>Message of the day</strong><br>Please review new HR policies"
}
In this section: