Manual Chapter : Advanced Customization Using Templates

Applies To:

Show Versions Show Versions

BIG-IP APM

  • 16.0.1, 16.0.0
Manual Chapter

Advanced Customization Using Templates

About Advanced Customization view

Through the Advanced Customization view, you can directly edit PHP, CSS, JavaScript, and HTML to control the display and function of web and client pages in Access Policy Manager. You can use the built-in editor to edit files, or you can copy and paste with an editing application of your choice.

Editing files in Advanced Customization view

Edit files in Advanced Customization to configure settings not easily set using General Customization.
  1. On the Main tab, click
    Access
    Profiles / Policies
    Customization
    Advanced
    .
    The Customization tool appears in Advanced Customization view, displaying the
    Form Factor: Full/Mobile Browser
    settings in the left pane.
  2. Select the resource type folder for
    Access Profiles
    ,
    Per Request Policies
    , or
    Webtops
    .
  3. Navigate through the folder hierarchy to find the file you want to edit, and click it.
    For example, you can edit any of the files associated with Logon pages, Logout, Ending pages, Decision pages, Messages pages, or OAuth Authorization pages that are used in the access profile or per-request policy. Or, edit the files associated with Webtops.
    The file appears in the built-in editor pane, with simple syntax highlighting.
  4. Make the changes you require to the file. You can make changes in the editor screen, or you can edit in an external editor using copy and paste commands for your operating system.
    • To save a draft of your changes without applying them, click the
      Save Draft
      button.
    • To discard any changes saved with the
      Save Draft
      button, click
      Revert
      , and follow the instructions on the confirmation dialog box.
  5. After you customize settings, click the
    Save
    icon at the top of the Customization tool.

Files for access profiles in Advanced Customization

You can customize the following files for access profiles in Advanced View. The files may differ depending on whether you created the access profile or per-request policy with the
Customization Type
set to
Modern
or
Standard
. In that case, separate tables are provided for Modern and Standard.

Common - Modern

Files
Location
Description
user-common.css
Customization Settings
Access Profiles
access_profile
Common
The CSS code that controls the look and feel for every page in the policy.
user-common.js
Customization Settings
Access Profiles
access_profile
Common
Common Javascript file that is loaded for every page in the policy including various versions of the Logout Page (instead of Request Blocked). This page is not intended to contain sensitive information.

Common - Standard

Files
Location
Description
apm_full.css
Customization Settings
Access Profiles
access_profile
Common
The CSS and PHP code that controls the look and feel for pages on a web browser.
header.inc
Customization Settings
Access Profiles
access_profile
Common
Specifies the page header content for access profile pages on all devices.
apm_mobile.css
Customization Settings
Access Profiles
access_profile
Common
The layout properties for access policy pages on any mobile device that is not a PocketPC.
javascript_disabled.inc
Customization Settings
Access Profiles
access_profile
Common
Specifies content that is displayed if scripts are not supported, or are disabled in the user's browser.
footer.inc
Customization Settings
Access Profiles
access_profile
Common
The include that specifies the footer text line.
apm_mobile_ppc.css
Customization Settings
Access Profiles
access_profile
Common
The CSS that controls the look and feel for pages on a PocketPC device.
apm_edge.css
Customization Settings
Access Profiles
access_profile
Common
The CSS that controls the look and feel for BIG-IP Edge Client® pages.

Logout or Ending Deny - Modern

Files
Location
Description
user-logout.js
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The JavaScript code executed when a user logs out.
user-logout.css
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The layout properties of the logout page.
request_blocked.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML code used when a request was blocked.

Logout or Ending Deny - Standard

Files
Location
Description
access_notfound.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML, JavaScript, and PHP code that presents a page when access is not granted.
request_blocked.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML, JavaScript, and PHP code that presents a page when a request is blocked.
urlfilter_blocked.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML, JavaScript, and PHP code that presents a page when an URL filter has blocked a page.
my.acl.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML, JavaScript, and PHP code that presents a page when the access to a page is denied for one of several reasons, including by an ACL.
logout.inc
Customization Settings
Access Profiles
access_profile
Logout
or
Ending Pages
Deny
The HTML, JavaScript, and PHP code that presents a page when the user logs out. The file includes several options for different logout reasons.

Logon Pages - Standard and Modern

Files
Location
Description
http_401.inc
Customization Settings
Access Profiles
access_profile
Access Policy
Logon Pages
logon_page
The page that appears when an HTTP 401 error (unauthorized) occurs.
user-logon.css
Customization Settings
Access Profiles
access_profile
Access Policy
Logon Pages
logon_page
The layout properties of the logon page.
view.inc
Customization Settings
Access Profiles
access_profile
Access Policy
Logon Pages
logon_page
Specifies the customization of VMware View logon page
user-logon.js
Customization Settings
Access Profiles
access_profile
Access Policy
Logon Pages
logon_page
The Javascript that is executed when users logon.
citrix_challenge.inc
Customization Settings
Access Profiles
access_profile
Access Policy
Logon Pages
logon_page
The message that displays during a Citrix logon issue.

Files for webtops in Advanced Customization

You can customize the following files for webtops in Advanced View. The files differ depending on whether the webtop was created for a policy with the
Customization Type
set to
Modern
or
Standard
.

Webtops - Modern

Files
Location
Description
user-webtop.js
Advanced Customization Settings
Webtops
webtop
The JavaScript code that specifies how the webtop page is dynamically created.
user-webtop.css
Advanced Customization Settings
Webtops
webtop
The CSS that controls the look and feel for the webtop screen.
hometab.inc
Advanced Customization Settings
Webtops
webtop
The JavaScript code that controls the look and feel for the Home tab.

Webtops - Standard

Files
Location
Description
desktopClass.js.inc
Advanced Customization Settings
Webtops
webtop
The JavaScript code that specifies how the webtop page is dynamically created.
webtop_popup.css
Advanced Customization Settings
Webtops
webtop
The CSS that controls the look and feel for the webtop popup screen.
webtop_help.inc
Advanced Customization Settings
Webtops
webtop
The HTML code on the webtop page that provides the link to the webtop help page.
sna_container_ui.js.inc
Advanced Customization Settings
Webtops
webtop
The Javascript code for the user interface for standalone network access such as if the popup was blocked, network access failed to start, installation required, or auto-start not supported.
sapptun.js.inc
Advanced Customization Settings
Webtops
webtop
The Javascript code for the user interface for the application tunnel for network access.
hometab.inc
Advanced Customization Settings
Webtops
webtop
The JavaScript code that controls the look and feel for the Home tab.

About advanced customization templates

Access Policy Manager advanced customization templates provide code and images for customizing pages. With the templates and the instructions provided for them, you can walk through step-by-step instructions and produce pages with a unique look-and-feel using features that are frequently requested.
For downloading APM advanced customization templates, refer to the DevCentral page.
For APM Advanced Customization examples with Modern Template for BIG-IP version 15.1 and above, refer the APM Advanced Customization Examples with Modern Template page.