BIG-IP Access Policy Manager Customization
BIG-IP Access Policy Manager Customization
BIG-IP Access Policy Manager Customization
Customization
Version 11.6
Table of Contents
Table of Contents
Legal Notices.....................................................................................................7
Acknowledgments.............................................................................................9
3
Table of Contents
4
Table of Contents
5
Table of Contents
6
Legal Notices
Publication Date
This document was published on October 20, 2014.
Publication Number
MAN-0387-03
Copyright
Copyright 2014, F5 Networks, Inc. All rights reserved.
F5 Networks, Inc. (F5) believes the information it furnishes to be accurate and reliable. However, F5 assumes
no responsibility for the use of this information, nor any infringement of patents or other rights of third
parties which may result from its use. No license is granted by implication or otherwise under any patent,
copyright, or other intellectual property right of F5 except as specifically described by applicable user
licenses. F5 reserves the right to change specifications at any time without notice.
Trademarks
AAM, Access Policy Manager, Advanced Client Authentication, Advanced Firewall Manager, Advanced
Routing, AFM, Application Acceleration Manager, Application Security Manager, APM, ARX, AskF5,
ASM, BIG-IP, BIG-IQ, Cloud Extender, CloudFucious, Cloud Manager, Clustered Multiprocessing, CMP,
COHESION, Data Manager, DevCentral, DevCentral [DESIGN], DNS Express, DSC, DSI, Edge Client,
Edge Gateway, Edge Portal, ELEVATE, EM, Enterprise Manager, ENGAGE, F5, F5 [DESIGN], F5 Certified
[DESIGN], F5 Networks, F5 SalesXchange [DESIGN], F5 Synthesis, f5 Synthesis, F5 Synthesis [DESIGN],
F5 TechXchange [DESIGN], Fast Application Proxy, Fast Cache, FirePass, Global Traffic Manager, GTM,
GUARDIAN, iApps, IBR, iCall, Intelligent Browser Referencing, Intelligent Compression, IPv6 Gateway,
iControl, iHealth, iQuery, iRules, iRules OnDemand, iSession, L7 Rate Shaping, LC, Link Controller,
LineRate, LineRate Systems [DESIGN], Local Traffic Manager, LROS, LTM, Message Security Manager,
MobileSafe, MSM, OneConnect, Packet Velocity, PEM, Policy Enforcement Manager, Protocol Security
Manager, PSM, Real Traffic Policy Builder, SalesXchange, ScaleN, SDAC (except in Japan), SDC, Signalling
Delivery Controller, Solutions for an application world, Software Designed Applications Services, SSL
Acceleration, StrongBox, SuperVIP, SYN Check, TCP Express, TDR, TechXchange, TMOS, TotALL,
Traffic Management Operating System, Traffix (except Germany), Traffix [DESIGN] (except Germany),
Transparent Data Reduction, UNITY, VAULT, vCMP, VE F5 [DESIGN], Versafe, Versafe [DESIGN],
VIPRION, Virtual Clustered Multiprocessing, WebSafe, and ZoneRunner, are trademarks or service marks
of F5 Networks, Inc., in the U.S. and other countries, and may not be used without F5's express written
consent.
All other product and company names herein may be trademarks of their respective owners.
Patents
This product may be protected by one or more patents indicated at:
http://www.f5.com/about/guidelines-policies/patents
RF Interference Warning
This is a Class A product. In a domestic environment this product may cause radio interference, in which
case the user may be required to take adequate measures.
FCC Compliance
This equipment has been tested and found to comply with the limits for a Class A digital device pursuant
to Part 15 of FCC rules. These limits are designed to provide reasonable protection against harmful
interference when the equipment is operated in a commercial environment. This unit generates, uses, and
can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual,
may cause harmful interference to radio communications. Operation of this equipment in a residential area
is likely to cause harmful interference, in which case the user, at his own expense, will be required to take
whatever measures may be required to correct the interference.
Any modifications to this device, unless expressly approved by the manufacturer, can void the user's authority
to operate this equipment under part 15 of the FCC rules.
Standards Compliance
This product conforms to the IEC, European Union, ANSI/UL and Canadian CSA standards applicable to
Information Technology products at the time of manufacture.
8
Acknowledgments
In the following statement, "This software" refers to the Mitsumi CD-ROM driver: This software was
developed by Holger Veit and Brian Moore for use with 386BSD and similar operating systems. "Similar
operating systems" includes mainly non-profit oriented systems for research and education, including but
not restricted to NetBSD, FreeBSD, Mach (by CMU).
This product includes software developed by the Apache Group for use in the Apache HTTP server project
(http://www.apache.org/).
This product includes software licensed from Richard H. Porter under the GNU Library General Public
License ( 1998, Red Hat Software), www.gnu.org/copyleft/lgpl.html.
This product includes the standard version of Perl software licensed under the Perl Artistic License ( 1997,
1998 Tom Christiansen and Nathan Torkington). All rights reserved. You may find the most current standard
version of Perl at http://www.perl.com.
This product includes software developed by Jared Minch.
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit
(http://www.openssl.org/).
This product includes cryptographic software written by Eric Young (eay@cryptsoft.com).
This product contains software based on oprofile, which is protected under the GNU Public License.
This product includes RRDtool software developed by Tobi Oetiker (http://www.rrdtool.com/index.html)
and licensed under the GNU General Public License.
This product contains software licensed from Dr. Brian Gladman under the GNU General Public License
(GPL).
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
This product includes Hypersonic SQL.
This product contains software developed by the Regents of the University of California, Sun Microsystems,
Inc., Scriptics Corporation, and others.
This product includes software developed by the Internet Software Consortium.
This product includes software developed by Nominum, Inc. (http://www.nominum.com).
This product contains software developed by Broadcom Corporation, which is protected under the GNU
Public License.
This product contains software developed by MaxMind LLC, and is protected under the GNU Lesser General
Public License, as published by the Free Software Foundation.
This product includes Intel QuickAssist kernel module, library, and headers software licensed under the
GNU General Public License (GPL).
This product includes software licensed from Gerald Combs (gerald@wireshark.org) under the GNU General
Public License as published by the Free Software Foundation; either version 2 of the License, or any later
version. Copyright 1998 Gerald Combs.
This product includes software developed by Daniel Stenberg. Copyright 1996 - 2012, Daniel Stenberg,
(daniel@haxx.se). All rights reserved.
Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby
granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
USE OR OTHER DEALINGS IN THE SOFTWARE.
10
BIG-IP Access Policy Manager: Customization
Except as contained in this notice, the name of a copyright holder shall not be used in advertising or otherwise
to promote the sale, use or other dealings in this Software without prior written authorization of the copyright
holder.
This product includes software developed by Thomas Williams and Colin Kelley. Copyright 1986 - 1993,
1998, 2004, 2007
Permission to use, copy, and distribute this software and its documentation for any purpose with or without
fee is hereby granted, provided that the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting documentation. Permission to modify the
software is granted, but not the right to distribute the complete modified source code. Modifications are to
be distributed as patches to the released version. Permission to distribute binaries produced by compiling
modified sources is granted, provided you
1. distribute the corresponding source modifications from the released version in the form of a patch file
along with the binaries,
2. add special version identification to distinguish your version in addition to the base release version
number,
3. provide your name and address as the primary contact for the support of your modified version, and
4. retain our contact information in regard to use of the base software.
Permission to distribute the released version of the source code along with corresponding source modifications
in the form of a patch file is granted with same provisions 2 through 4 for binary distributions. This software
is provided "as is" without express or implied warranty to the extent permitted by applicable law.
This product contains software developed by Google, Inc. Copyright 2011 Google, Inc.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
This product includes software developed by Jeremy Ashkenas and DocumentCloud, and distributed under
the MIT license. Copyright 2010-2013 Jeremy Ashkenas, DocumentCloud.
This product includes gson software, distributed under the Apache License version 2.0. Copyright
2008-2011 Google Inc.
This product includes Boost libraries, which are distributed under the Boost license
(http://www.boost.org/LICENSE_1_0.txt).
This product includes jxrlib software, copyright 2009 Microsoft Corp. All rights reserved. Distributed
under the new BSD license.
This product includes software developed by Computing Services at Carnegie Mellon University
(http://www.cmu.edu/computing/).
This product includes libmagic software, copyright Ian F. Darwin 1986, 1987, 1989, 1990, 1991, 1992,
1994, 1995. Software written by Ian F. Darwin and others; maintained 1994- Christos Zoulas.
This product contains OpenLDAP software, which is distributed under the OpenLDAP v2.8 license
(BSD3-like).
11
Acknowledgments
This product includes node-uuid software, copyright 2010-2012, Robert Kieffer, and distributed under
the MIT license.
This product includes opencsv software, which is distributed under the Apache 2.0 license.
This product includes owasp-jave-encoder software, copyright 2014, Jeff Ichnowski, and distributed
under the New BSD license.
12
Chapter
1
Customization Basics
Basic
Basic customization provides a limited set of options intended for quick modification of the objects that
are most commonly displayed to users. It can be used to customize and localize common text labels and
captions for objects. It can also be used to configure the basic look and feel for pages.
General
General customization enables configuration of a few additional objects and provides many more options
for customizing objects, such as:
The size, color, and placement of forms and screens.
The look and feel of objects with more opportunities to replace images.
Text on the screen, including headers and footers.
Messages, including installation and error messages.
Any text or image that can be configured from visual policy editor, can also be configured using the
general customization GUI.
Advanced
Advanced customization provides for any customization that can be effected using Cascading Style
Sheets (CSS) and HTML.
14
BIG-IP Access Policy Manager: Customization
15
Customization Basics
Figure 4: UI template
Settings (color, font, text, and so on) for the header and footer can be defined in access profile customization.
Settings for the location and alignment of the content area can also be defined in access profile customization.
Settings for an object that is displayed in the Contents area can be defined in customization of the object.
The UI page structure can be changed using advanced customization. It is possible to provide per-page
headers or footers or to completely omit the header, the footer, or both.
16
BIG-IP Access Policy Manager: Customization
SAML resources
Access profiles and the objects that they contain can be customized. Access profile objects are specific to
the particular access profile and are not available for reuse in other access profiles.
Common
These settings affect any UI page that displays when the access profile runs. The settings affect text,
such as headers and footers and commonly used messages, and look and feel.
Logout
Settings are available to specify an image and text for a page that displays on logout, when access is
denied, when a new session must be started, and so on.
Logon Pages
Settings are available for logon page-type actions (logon page, HTTP 401 response, HTTP 407 response,
VMware View logon) that are included in the access policy (directly or through the inclusion of a macro).
Settings affect the text and look and feel for the specific object.
Message Pages
Settings are available for each specific Message Box action included in the access policy. The settings
affect the text and look and feel for the specific object.
Decision Pages
Settings are available for each specific Decision Box action included in the access policy. The settings
affect the text and look and feel for the specific object.
Ending Pages
Settings are available for an Ending Deny page and affect the text and look and feel for the page.
17
Chapter
2
General Customization
Name Description
Page alignment Alignment of the contents against the body if the width of the contents (Page
width) is less than 100%.
Page background color Background color of the page; corresponds to CSS body {
background-color: #XXXXX }.
Page width (px or %) Width of the header, footer, and contents tables.
20
BIG-IP Access Policy Manager: Customization
Name Description
Font family Font used on page; corresponds to CSS * { font-family: }
(comma-separated)
Headline font size (px) Corresponds to CSS font-size of headlines
Text font size (px) Corresponds to CSS font-size of all other (non-headline) elements
Name Description
Form cell width (px or Maximum width of the form cell.
%)
Image cell width (px Maximum width of the image cell, or empty area if no image is provided. This
or %) setting has no effect if Page layout is set to Form Center.
Main table Background color of the contents table. Overrides Page background color in
background color General Page Style Settings. Corresponds to CSS table#main_table {
table_background_color: #XXXXXX } .
Page layout Location of the form cell: left, right, or center. When set to Form Left or Form
Right and an image is specified, it displays opposite the form. When set to Form
Center, whether an image is specified or not, no image displays. (Access policy
items that support images are affected, including logon page, decision box, and
message box.)
21
General Customization
The form cell is on the left. The image cell is opposite the form cell. The form cell and the image cell each
fill 50% of the width of the content area.
Name Description
Disconnect icon Image for disconnect button, 48 x 48 pixels or smaller.
Header background color Corresponds to CSS table#page_header {
background-color: #XXXXXX }.
Header left image (Full Size) Corporate logo image, 80 x 80 pixels or smaller.
Header left image (Mobile Devices Corporate logo image, 32 x 32 pixels or smaller.
Size)
22
BIG-IP Access Policy Manager: Customization
Name Description
Footer font size (px) Corresponds to CSS table#page_footer { font-size: . }
Name Description
Default image Image to display in the image cell.
Image left margin Left margin of the image.
(px)
Image right margin Right margin of the image.
(px)
Image top margin Top margin of the image.
(px)
Side image alignment Horizontal alignment of the image within the image cell.
Name Description
Form alignment Alignment of the form within the form cell.
Form background color Background color for the form. Corresponds to CSS table#main_table
table#credentials_table{ background-color:
%[form_background_color] }
Form height (px, %, or Specifies the height of the form; when specified as %, it is a percentage of the
auto) height of the form cell.
Form left margin (px) Left margin of the form.
Form right margin (px) Right margin of the form.
Form top margin (px) Top margin of the login form.
Form width (px or %) Specifies width of the form width; when specified as %, it is a percentage of the
width of the form cell.
23
General Customization
Name Description
Field alignment Alignment of the fields against the form.
Field width (%) Width of the input, password, and select fields as a percentage of the form width.
Header Alignment of the header in the form.
alignment
Label alignment Alignment of labels to the corresponding input fields.
Label position Position of field labels: above or to the left of their respective fields.
Label width (%) Specifies a uniform width for field labels as a percentage of the form width.
24
BIG-IP Access Policy Manager: Customization
25
General Customization
To select an image from the image browser to associate with an image for advanced customization, click
the button next to the current (or default) image name, and select Replace.
Note: These properties can also be updated from the visual policy editor. The same file is updated whether
personalizing the logon page from general customization or the visual policy editor.
26
BIG-IP Access Policy Manager: Customization
Figure 9: Logon Page customization of fields, language, and text in the visual policy editor (partial
view)
27
General Customization
Figure 10: Logon Page customization of language and text in the General Customization view
Name Description
Front Image Customization
Form Header Text Text that displays above the form.
Input Field #n Values Localized text for any input field (number 1 to 5) of type select or radio. (Input
types are specified in the visual policy editor), Values and text are defined in
this format "value1=>text1;value2=>text2", and so on. For example:
server1=>Corporate;server2=>Finance;server3=>Sales The values and text
must be defined in the visual policy editor for the field before you can customize
the text.
Note: From the customization interface, personalize the text fields (Corporate,
Finance, Sales) only.
Logon Page Input Field Text that is displayed on the logon page for each of the logon page agents,
# (1-5) defined in the Logon Page Agent screen area.
Logon Button Caption of form submit button.
New Password Prompt Text displayed when requesting a new Active Directory password.
Password and Password Error message displayed for password entries that do not match one another.
Verification do not
Match
28
BIG-IP Access Policy Manager: Customization
Name Description
Save Password Text displayed adjacent to the check box that allows users to save their
Checkbox passwords in the logon form. This field is used only in the secure access client,
and not in the web client.
Verify Password Prompt Text displayed next to password confirmation field when a new Active Directory
password is requested.
29
Chapter
3
Coding Tips and Examples
Important: Customization uses the same UI templates for all languages. Therefore, F5 recommends that
when you customize UI templates, you reuse customization variables for localized texts. Otherwise, you
risk creating localization conflicts.
Important: F5 recommends that when you customize UI templates, you do not delete or modify PHP code.
To replace a main table with your div, on the logon page for example, replace <table id="main_table"
class="logon_page"> with your <table id="cust-main" class="cust-logn-page">.
32
BIG-IP Access Policy Manager: Customization
Coding recommendations
With advanced customization, you can partially or completely replace the default structure for pages. To
avoid unexpected problems however, follow these recommendations when editing .css and .inc files.
.css file
Do not change existing CSS definitions but add your own with different names (IDs). Otherwise,
you run the risk that other non-customized pages will be misrendered.
In your new code, reuse existing customization variables (%[variable_name]) rather than creating
new ones; doing so prevents localization conflicts.
Do not change PHP code.
.inc file
In most cases, you can safely replace the code in .inc files.
Updating a .css file with additional code to customize a logon page table
The first line of the code for the existing logon page table is: <table id="main_table"
class="logon_page">. Retain that code and add code for a div or a table that you want to use instead.
For example, the code for a new table might start like this: <table id="cust-main"
class="cust-logn-page">.
Name Description
apm_full.css File that contains all CSS for desktop browsers; also contains this PHP:
apmCssCustomizationReg - array with variables that come from general
customization data.
parsedVersionMajor and parsedVersionMinor - versions of Mozilla,
used to fix specific issues with CSS .
apm_mobile.css File that contains all CSS for mobile browsers. If you want mobile pages to look
exactly the same as full browser pages, you can replace the contents of
apm_mobile.css contents with the contents of apm_full.css.
footer.inc The include file that specifies the footer text line.
apm_edge.css File contains all CSS for BIG-IP Edge Client pages.
javascript_disabled.inc File that is included with every page and displayed only when the browser does
not support JavaScript.
header.inc File that specifies the page header content for access profile pages on all devices.
The file includes this PHP:
viewport_data contents of meta name id="viewport".
33
Coding Tips and Examples
Name Description
label_position position of labels against corresponding input fields (see
general customization Access Profile/Common/Layout Settings)
page_layout position of input cell (see Access Profile/Common/Layout
Settings)
page_image_default default image cell image (see Access
Profile/Common)
header_logo corporate logo
The file includes JavaScript: setViewport() function that changes scale
basing on orientation.
apm_mobile_ppc.css Styles for old Windows mobile device.
Name Description
my.acl.inc ACL denied page if user tries to access prohibited URL.
urlfilter_blocked.inc Secure Web Gateway (SWG) access denied page if user tries to access prohibited
URL.
access_notfound.inc The HTML, JavaScript, and PHP code that presents a page when access is not
granted.
logout.inc Default logout page.
Name Description
logon.inc Customization of logon page.
http_401.inc Customization of HTTP 401 error (unauthorized) page.
view.inc Customization of VMware View logon page.
Name Description
decision_box.inc Specifies the layout for the HTML that appears in a decision box.
34
BIG-IP Access Policy Manager: Customization
Name Description
message_box.inc Specifies the layout for the HTML that appears in a message box.
Name Description
my.acl.inc ACL denied page if user tries to access prohibited URL.
urlfilter_blocked.inc Secure Web Gateway (SWG) access denied page if user tries to access prohibited
URL.
access_notfound.inc The HTML, JavaScript, and PHP code that presents a page when access is not
granted.
logout.inc Default logout page.
Name Description
hometab.inc Not applicable; file pop up.
webtop_popup.css Pop up file CSS.
webtop_help.inc Help file for webtop.
desktopClass.js.inc Main JavaScript file for webtop.
Name
Images names (image00 through image09) are fixed; they are only placeholders. An image name, for
example image00, does not correspond to a location on a page or to an image that is already used in the
UI. The numerals, 00, do not indicate order or precedence. The image name can used as a variable in
the code for a parent object in the Advanced Customization view. This code specifies image00 as a
variable: <img src="%[image00]"/>.
Value
Image values provide file paths and the file names for image files. To use the image, the value can be
copied from the setting in the General Customization view into the code in the Advanced Customization
view. A default value /public/images/my/tr.gif indicates that a customized image has not been
specified.
35
Coding Tips and Examples
Figure 11: Advanced Customization Images settings for some customization objects
36
BIG-IP Access Policy Manager: Customization
37
Coding Tips and Examples
Note: This example includes tasks to complete in the General Customization view before you update the
code and code changes to make in the Advanced Customization view.
38
BIG-IP Access Policy Manager: Customization
Note: Message Box is the default name for a message box item. You might see a different name, or
names if the access policy includes multiple message boxes; expand one of them.
The image is now available for use in advanced customization of the message box item.
39
Coding Tips and Examples
Note: Message Box is the default name for a message box item. You might see a different name, or
names if the access policy includes multiple message boxes; expand one of them.
3. Click message_box.inc.
Code displays in the Advanced Customization Editor.
4. Scroll down to this code.
5. After the first table row open tag (<tr>), remove this line of code.
The code that checks the page layout and specifies the image cell is removed.
6. Before the last table row close tag (</tr>), remove this line of code.
Code that checks the page layout and specifies the image cell is removed.
7. Before the last table row close tag (</tr>), insert this line of code, replacing nn with the image number.
You can now verify the result of this customization from a browser by trying to access a virtual server in
which this access profile is specified.
40
BIG-IP Access Policy Manager: Customization
Note: An image stored in the Common settings for an access profile can be used in the advanced
customization of any access policy page provided that you use the image value instead of the image name
to specify the src attribute for the image.
41
Coding Tips and Examples
1. From the General Customization view, expand the Access Profiles folder.
Folders for each access profile display.
2. Expand the folder for an access profile.
3. Expand the Common folder.
A list of settings displays.
4. Click the Advanced Customization Images setting.
Image names and values display in the right pane.
5. Click the value for one of the images.
If not already updated for use in advanced customization, the value is /public/images/my/tr.gif.
A pulldown menu icon displays.
6. Click the pulldown menu icon and click Replace.
A popup screen displays images.
7. To choose an image, click it; then click Change.
The popup screen closes. A new value displays for the image.
8. Press Enter to finalize the change and click Save.
9. Click the value for the image again; copy the value in the field and paste it into a text file.
The value should be something like this:
/public/images/customization/Common/ProfileName_general_ui/image00_en.png. You
need to know the value when you perform advanced customization.
The image is now available for use in advanced customization of the message box item.
<table id="page_header">
<tr >
<td id="header_leftcell"><img src='<?=$GLOBALS["header_logo"]?>'/></td>
<td id="header_rightcell"><? if( !empty( $GLOBALS["header_show_disconnect_button"] ) ){
?><button id="disconnect" onclick="javascript: /*
window.onbeforeunload=window.document.onbeforeunload=window.document.body.onbeforeunload=null;
*/ if(top.F5_HT_logOut){ F5_HT_logOut(); }else{ window.location.href='/my.logout.php3';
}"><img src="%[disconnect_icon]"/><span>%[disconnect_text]</span></button><?} if( !empty(
$GLOBALS["webtop_header_message"] ) ){?><span id="webtop_header_message"><img
src='<?=$GLOBALS["fw_header_icon"]?>'
id='fw_header_icon'><?=$GLOBALS["webtop_header_message"]?></span><?}?></td>
</tr>
</table>
42
BIG-IP Access Policy Manager: Customization
6. After the table close tag (</table>), insert this line of code.
43
Coding Tips and Examples
Note: Logon Page is the default name for a logon page item. You might see a different name, or
names if the access policy includes multiple logon pages; expand one of them.
3. Click logon.inc.
Code displays in the Advanced Customization Editor area of the screen.
4. Scroll to the end of the file to this code.
}
--></script>
</td>
<? if( $GLOBALS["page_layout"] == "form_left" ){
?><td id="main_table_image_cell"><img src="<? print('%[front_image]'); ?>"></td><?
} ?>
</tr>
</table>
</body>
</html>
5. After the table close tag (</table>), insert this line of code.
Figure 17: Logon page with custom image after the form
44
BIG-IP Access Policy Manager: Customization
45
Chapter
4
Advanced Customization Using Templates
48
Chapter
5
The Customization Tool
You can use the Customization tool inside the BIG-IP admin console, or click Popout to open it in a separate
browser window.
After you personalize settings, remember to click the Save icon to apply your changes.
General Customization
This view provides a tree structure for configuration elements, and more detailed methods to configure
and customize objects.
Advanced Customization
This view provides direct access to PHP, CSS, JavaScript, and HTML files that you can edit to control
the display and function of web and client pages in Access Policy Manager.
The General and Advanced Customization views provide two form factors, that you can use to customize
different access policy features.
Full/Mobile browser
Use this mode to configure pages that are viewed in a web browser or on a mobile device.
Branding
Customization controls the look of the user interface, such as fonts, images, colors, and general layout.
50
BIG-IP Access Policy Manager: Customization
Text
Customization provides personalization for the text and messages that appear for each language specified
in an access profile.
51
Chapter
6
Configuring Settings in Basic Customization View
Webtop items
Specifies settings for the display of resources (app tunnels, remote desktops, network access tunnels,
webtop links, and portal access resources) on the full webtop.
Webtop links
Specifies display settings that apply to all resources on the full webtop.
After you customize settings, click Save to save the new customization settings. To return to the original
settings and discard your changes, click Revert.
54
BIG-IP Access Policy Manager: Customization
55
Configuring Settings in Basic Customization View
56
BIG-IP Access Policy Manager: Customization
Link color A color, selected from a color Indicates the color for links on the webtop.
chooser
Image An image or icon The image appears on the full webtop. Select an image
from the list, or click Upload New Image to add a
new image.
Show Statistics on or off Show or hide statistics in the remote connection popup
While Connected screen for the application tunnel or the network access
tunnel.
57
Configuring Settings in Basic Customization View
58
Chapter
7
Personalizing Client Appearance in General View
60
BIG-IP Access Policy Manager: Customization
61
Personalizing Client Appearance in General View
62
BIG-IP Access Policy Manager: Customization
63
Chapter
8
Personalizing Access Profile Appearance Settings
66
BIG-IP Access Policy Manager: Customization
Headline font size (px) A pixel value, for example 18px. Indicates the pixel size for heading items
on pages displayed by the access profile.
Text font size (px) A pixel value, for example 14px. Indicates the pixel size for text items on
pages displayed by the access profile.
67
Personalizing Access Profile Appearance Settings
68
BIG-IP Access Policy Manager: Customization
Form left margin Left margin, in pixels, of the main login page Specifies the left margin of the
(px) form, for example 24px. login form.
Form right margin Right margin, in pixels, of the main login page Specifies the right margin of the
(px) form, for example 24px. login form.
Form top margin Top margin, in pixels, of the main login page Specifies the top margin of the
(px) form, for example 24px. login form.
Form width (px or Form width in pixels or as a percentage of the Specifies the login form width
%) form frame, for example 250px or 50%. within the login frame.
69
Personalizing Access Profile Appearance Settings
70
BIG-IP Access Policy Manager: Customization
71
Personalizing Access Profile Appearance Settings
72
Chapter
9
Personalizing Webtop Appearance Settings in General View
74
BIG-IP Access Policy Manager: Customization
75
Personalizing Webtop Appearance Settings in General View
76
BIG-IP Access Policy Manager: Customization
77
Personalizing Webtop Appearance Settings in General View
shrink
Specifies the hometab shrink element.
78
BIG-IP Access Policy Manager: Customization
url
Specifies the hometab URL box
element.
home
Specifies the home link and text
element.
logout
Specifies the logout link and image
element.
79
Personalizing Webtop Appearance Settings in General View
80
Chapter
10
Personalizing Images for Resources in Advanced View
82
Chapter
11
Localizing Messages and Images in General View
8. After you customize settings, click the Save icon at the top of the Customization tool.
Note: Use an HTML editor to edit the HTML code for the framework installation. The code appears
unformatted and without line breaks in the Customization tool.
1. On the Main tab, click Access Policy > Customization > General.
The Customization tool appears in General Customization view, displaying Form Factor: Full/Mobile
Browser settings.
84
BIG-IP Access Policy Manager: Customization
85
Localizing Messages and Images in General View
86
BIG-IP Access Policy Manager: Customization
87
Localizing Messages and Images in General View
The Customization tool appears in General Customization view, displaying Form Factor: Full/Mobile
Browser settings.
2. In the left pane, click the Text tab.
A navigation tree displays in the left pane.
3. In the left pane, expand the folders and navigate to Customization Settings > Access Profiles >
name_of_access_profile > Logout and click General.
4. At the top right of the Customization settings pane, select the Language for which to customize
localization messages for full and mobile browsers.
5. Customize the settings for the logout elements.
6. After you customize settings, click the Save icon at the top of the Customization tool.
88
BIG-IP Access Policy Manager: Customization
89
Localizing Messages and Images in General View
90
BIG-IP Access Policy Manager: Customization
91
Localizing Messages and Images in General View
92
BIG-IP Access Policy Manager: Customization
93
Localizing Messages and Images in General View
94
BIG-IP Access Policy Manager: Customization
95
Localizing Messages and Images in General View
8. After you customize settings, click the Save icon at the top of the Customization tool.
96
Chapter
12
Localizing Webtops in General View
Localizing webtops
Localize webtops to configure images, text, and layout for a webtop in a specific language.
1. On the Main tab, click Access Policy > Customization > General.
The Customization tool appears in General Customization view, displaying Form Factor: Full/Mobile
Browser settings.
2. In the left pane, click the Text tab.
A navigation tree displays in the left pane.
3. In the left pane, expand the folders and navigate to Customization Settings > Access Profiles >
name_of_access_profile > Common.
4. At the top right of the Customization settings pane, select the Language for which to customize
localization messages for full and mobile browsers.
5. Click Page Header Settings to provide a customized disconnection message.
6. Click Page Footer Settings to provide a customized footer for access profile pages.
7. Click Other Settings to configure the following settings.
Option Description
JavaScript disabled warning Specifies the warning when JavaScript is not enabled in the
browser.
New session link Specifies the link text to start a new session.
New session text Specifies the text that appears before the new session link.
8. After you customize settings, click the Save icon at the top of the Customization tool.
98
BIG-IP Access Policy Manager: Customization
99
Localizing Webtops in General View
Routing table change caused Text Specifies the error displayed when a change to the client
disconnect error message routing table causes the session to stop and the client to be
disconnected.
Secure connection stopped Text Specifies the message displayed when the secure connection
message is stopped by the client. Check the log files for more specific
information.
Toolbar text Text Specifies the text that appears in the webtop toolbar.
100
BIG-IP Access Policy Manager: Customization
101
Localizing Webtops in General View
102
BIG-IP Access Policy Manager: Customization
103
Localizing Webtops in General View
104
BIG-IP Access Policy Manager: Customization
105
Localizing Webtops in General View
106
Chapter
13
Localizing Captions for Resources in General View
Localizing captions
Localize webtops to configure captions and descriptions for resources on a full webtop in a specific language.
1. On the Main tab, click Access Policy > Customization > General.
The Customization tool appears in General Customization view, displaying Form Factor: Full/Mobile
Browser settings.
2. In the left pane, click the Text tab.
A navigation tree displays in the left pane.
3. Select the resource type folder for App Tunnels, Network Access, Remote Desktops, Portal Access,
or Webtop Links.
4. Select the resource name.
5. At the top right of the Customization settings pane, select the Language for which to customize the
caption and description for full and mobile browsers.
6. Type a Caption to provide a label for the resource on the full webtop.
7. Type a Detailed Description to provide a detailed description for the resource in the full webtop.
8. After you customize settings, click the Save icon at the top of the Customization tool.
108
Chapter
14
Changing Customized Properties in Advanced View
5. After you customize settings, click the Save icon at the top of the Customization tool.
110
BIG-IP Access Policy Manager: Customization
message_box.inc Customization Settings > Access Specifies the layout for the HTML that
Profiles > access_profile > Access appears in a message box.
Policy > Message Pages >
message_box
access_notfound.inc Customization Settings > Access The HTML page that appears when
Profiles > access_profile > Access access cannot be established.
Policy > Ending Pages > ending
logout.inc Customization Settings > Access The HTML page that appears when
Profiles > access_profile > Access session logout occurs for one of several
Policy > Ending Pages > ending reasons.
my.acl.inc Customization Settings > Access The HTML page that appears when
Profiles > access_profile > Access access is denied because of a login
Policy > Ending Pages > ending failure or ACL issue.
Macro pages Customization Settings > Access Macros can include any of the logon
Profiles > access_profile > page, decision page, and message page
Macros > macro customization files as listed here.
111
Changing Customized Properties in Advanced View
112
Chapter
15
Customizing the APM logon page
The header logo is now the new image that you uploaded in the Customization screen.
114
Index
Index
A Advanced View
files for access profiles 110
access policy files for webtops 112
customizing page appearance 71 app tunnel
decision page settings 94 basic settings 55
logon page settings 28, 93
personalizing 71
access policy items
B
settings 71 basic customization
access policy pages access profile 54
properties 71 app tunnel 55
access profile network access 56
14 portal access 58
AAA error settings 90 remote desktop 56
basic settings 54 webtop link 57
branding settings for fonts 21, 67 webtop settings 57
branding settings for form 23, 69 Basic customization
branding settings for form elements 24, 69 starting 54
branding settings for general page style 20, 66 Basic Customization view 54
branding settings for image 23, 68 BIG-IP Edge Client
branding settings for layout 21, 68 branding 6061
branding settings for page footers 23, 68 localization 62, 7172
branding settings for page headers 22, 67 localizing webtop settings 100
browser framework settings 85 webtop settings 100
customizing appearance 66 branding
dynamic configuration error settings 92 customizing access profiles 66
enpoint security settings 86 customizing for BIG-IP Edge Client 60
general error settings 89 customizing for logout pages 70
installation error settings 91 customizing for webtops 74
logout page settings 88 customizing front login page image 71
personalizing 66 for BIG-IP Edge Client 61
resource error settings 91 settings for advanced customization images 25, 70, 80,
settings for advanced customization images 25, 70, 80, 9496
9496 settings for appearance 20, 66
unknown error settings 92 settings for fonts 21, 67
access profile pages settings for form 23, 69
customizing appearance 66 settings for form elements 24, 69
activity section settings for image 23, 68
webtop setting 101 settings for layout 21, 68
advanced customization settings for page footers 23, 68
configuring a UI template 16 settings for page headers 22, 67
Advanced Customization
editing CSS 110
editing JavaScript 110 C
editing PHP 110
Citrix
advanced customization images
browser setting for full webtop 106
setting for pages 25, 70, 80, 9496
installer settings for full webtop 106
Advanced Customization Images
settings for full webtop 105
storage options 36
common pages
usage 3536
localizing 84
advanced customization view
common page styles
files for access profiles 3435
customizing settings 54
Advanced Customization view
connectivity status
editing CSS 32
setting icons 74
editing JavaScript 32
contents area
editing PHP 32
settings that affect 20
advanced view
CSS files
editing files 110
for access profiles 3335, 110
115
Index
116
Index
117
Index
118