Template of the custom user interface file

You must use the provided template to customize user interfaces.

The following templates are XML files to help you create the custom user interface file for the landlord and tenants on your DataPower® Gateway. These templates conform to the store:///schemas/dp-user-interface.xsd schema.

Template for the landlord

The following template is for the landlord. The difference between the files for the landlord and a tenant is the custom CLI prompt.
  • The landlord uses the %s value.
  • A tenant uses the %p value.
<User-Interface xmlns="http://www.datapower.com/schemas/user-interface/1.0">

<!-- Markup for the CLI prompt -->
<CustomPrompt>%s</CustomPrompt>

<!-- Markup for GUI custom messages -->
  <MarkupBanner type="pre-login" foreground-color="red" background-color="blue">
    GUI pre-login message
  </MarkupBanner>
  <MarkupBanner type="post-login" foreground-color="blue" background-color="yellow">
    GUI post-login pop up message
  </MarkupBanner>
  <MarkupBanner type="system-banner" location="header" foreground-color="green" background-color="red">
    GUI system message - header
  </MarkupBanner>
  <MarkupBanner type="system-banner" location="footer" foreground-color="blue" background-color="yellow">
    GUI system message - footer
  </MarkupBanner>

 <!-- If the following markup was outside of comments, the file would not
      conform to the schema. Cannot define multiple system messages as the
      header or footer.
  <MarkupBanner type="system-banner">
    GUI system message - header and footer
  </MarkupBanner>
 -->

<!-- Markup for CLI custom messages -->
  <TextBanner type="pre-login">
    CLI pre-login message
  </TextBanner>
  <TextBanner type="post-login">
    CLI post-login message
  </TextBanner>
  <TextBanner type="system-banner">
    CLI system message
  </TextBanner>
</User-Interface>

Template for a tenant

The following template is for a tenant. The difference between the file for a tenant and the landlord is the custom CLI prompt.
  • A tenant uses the %p value.
  • The landlord uses the %s value.
<User-Interface xmlns="http://www.datapower.com/schemas/user-interface/1.0">

<!-- Markup for the CLI prompt -->
<CustomPrompt>%p</CustomPrompt>

<!-- Markup for GUI custom messages -->
  <MarkupBanner type="pre-login" foreground-color="red" background-color="blue">
    GUI pre-login message
  </MarkupBanner>
  <MarkupBanner type="post-login" foreground-color="blue" background-color="yellow">
    GUI post-login pop up message
  </MarkupBanner>
  <MarkupBanner type="system-banner" location="header" foreground-color="green" background-color="red">
    GUI system message - header
  </MarkupBanner>
  <MarkupBanner type="system-banner" location="footer" foreground-color="blue" background-color="yellow">
    GUI system message - footer
  </MarkupBanner>

 <!-- If the following markup was outside of comments, the file would not
      conform to the schema. Cannot define multiple system messages as the
      header or footer.
  <MarkupBanner type="system-banner">
    GUI system message - header and footer
  </MarkupBanner>
 -->

<!-- Markup for CLI custom messages -->
  <TextBanner type="pre-login">
    CLI pre-login message
  </TextBanner>
  <TextBanner type="post-login">
    CLI post-login message
  </TextBanner>
  <TextBanner type="system-banner">
    CLI system message
  </TextBanner>
</User-Interface>