Sunteți pe pagina 1din 118

BIG-IP Access Policy Manager:

Customization

Version 11.6
Table of Contents

Table of Contents
Legal Notices.....................................................................................................7
Acknowledgments.............................................................................................9

Chapter 1: Customization Basics...........................................................................................13


Overview: Customization and localization........................................................................14
About basic, general, and advanced customization..............................................14
About language choices........................................................................................14
About localization in the generated UI...................................................................14
About visual policy editor and general customization similarities..........................14
How APM generates UI pages..............................................................................15
About UI page structure........................................................................................16
Which objects can be customized? ......................................................................16
About access profile objects and settings ............................................................17

Chapter 2: General Customization.........................................................................................19


General page style settings for access profiles................................................................20
General page style settings illustration..................................................................20
Font settings for access profiles.......................................................................................21
Layout settings for access profiles...................................................................................21
Layout settings illustration.....................................................................................21
Page header settings for access profiles.........................................................................22
Page footer settings for access profiles...........................................................................23
Image settings for access profiles....................................................................................23
Form settings for access profiles.....................................................................................23
Form settings illustration.......................................................................................24
Form element settings for access profiles........................................................................24
Form element settings illustration..........................................................................25
Advanced customization image settings..........................................................................25
About general customization for logon pages..................................................................26
Logon page field customization illustration............................................................26
Logon page settings..............................................................................................28
About mobile browser support.........................................................................................29

Chapter 3: Coding Tips and Examples..................................................................................31


About advanced customization........................................................................................32
About customization variables.........................................................................................32
About PHP code..............................................................................................................32
About CSS code..............................................................................................................32
Coding recommendations................................................................................................33
Access profile common .css and .inc files.............................................................33

3
Table of Contents

Access profile logout .inc files...............................................................................34


Access profile logon .inc files................................................................................34
Access profile decision box .inc files.....................................................................34
Access profile message box .inc files....................................................................34
Access profile ending page .inc files.....................................................................35
Webtop .css and .inc files......................................................................................35
About advanced customization images............................................................................35
About best practices for advanced customization images...............................................36
Example: Adding an image to an access policy page......................................................37
Uploading images for use in customization...........................................................38
Storing images for advanced customization of a specific page.............................39
Updating message box code with a custom image...............................................39
Example: Adding an image to a profile and a page ........................................................41
Uploading images for use in customization...........................................................41
Storing images for advanced customization of policy pages.................................41
Adding an image in the page header code............................................................42
Adding an image in the logon page code..............................................................43

Chapter 4: Advanced Customization Using Templates........................................................47


About advanced customization templates........................................................................48

Chapter 5: The Customization Tool........................................................................................49


About the Customization tool...........................................................................................50
Starting the Customization tool.............................................................................50
About customization views and form factors....................................................................50

Chapter 6: Configuring Settings in Basic Customization View...........................................53


About Basic Customization view......................................................................................54
Customizing Basic settings...................................................................................54

Chapter 7: Personalizing Client Appearance in General View.............................................59


What is client personalization?.........................................................................................60
Uploading images for use in customization......................................................................60
Personalizing client colors, logos, and icons....................................................................60
Previewing customization changes.......................................................................61
Appearance properties for BIG-IP Edge Client.....................................................61
Localizing screen appearance for BIG-IP Edge Client.....................................................62
Previewing customization changes.......................................................................62
Text properties for BIG-IP Edge Client..................................................................62

Chapter 8: Personalizing Access Profile Appearance Settings..........................................65


What is access profile personalization?...........................................................................66
Personalizing page appearance for common access profile settings..............................66

4
Table of Contents

Previewing customization changes.......................................................................66


General page style settings for access profiles.....................................................66
Font settings for access profiles............................................................................67
Page header settings for access profiles...............................................................67
Page footer settings for access profiles.................................................................68
Layout settings for access profiles........................................................................68
Image settings for access profiles.........................................................................68
Form settings for access profiles...........................................................................69
Form element settings for access profiles.............................................................69
Advanced customization image settings...............................................................70
Personalizing page appearance for access profile logout settings..................................70
Advanced customization image settings...............................................................70
Personalizing page appearance for access policy pages................................................71
Customization settings for access policy items.....................................................71
Localizing messages for BIG-IP Edge Client...................................................................71
Previewing customization changes.......................................................................72
Customization settings for BIG-IP Edge Client localization...................................72

Chapter 9: Personalizing Webtop Appearance Settings in General View..........................73


What is webtop appearance personalization?.................................................................74
Personalizing page appearance for webtops...................................................................74
Webtop network connectivity status icons settings...............................................74
CSS sprite image setting.......................................................................................74
Web Applications Session Timeout settings.........................................................75
Web Applications Hometab settings......................................................................76
Full webtop settings...............................................................................................79
Full webtop popup window setting........................................................................79
Advanced customization image settings...............................................................80

Chapter 10: Personalizing Images for Resources in Advanced View.................................81


What is resource image personalization?........................................................................82
Personalizing resource images........................................................................................82

Chapter 11: Localizing Messages and Images in General View..........................................83


What is full and mobile browser localization?..................................................................84
Localizing messages for common access profile settings...............................................84
Localizing layout and content of the logon page..............................................................84
Framework installation settings.............................................................................85
Endpoint security settings.....................................................................................86
Localizing layout and content of logout pages.................................................................87
Logout component settings...................................................................................88
Localizing error messages...............................................................................................89
General error settings............................................................................................89
AAA error settings.................................................................................................90

5
Table of Contents

Installation error settings.......................................................................................91


Resource error settings.........................................................................................91
Dynamic configuration error settings.....................................................................92
Other configuration error settings..........................................................................92
Localizing logon pages....................................................................................................93
Logon page settings..............................................................................................93
Localizing decision pages................................................................................................94
General decision page settings.............................................................................94
Advanced customization image settings...............................................................94
Localizing message box pages........................................................................................95
Advanced customization image settings...............................................................95
Localizing ending pages..................................................................................................95
Advanced customization image settings...............................................................96

Chapter 12: Localizing Webtops in General View.................................................................97


What is webtop localization?............................................................................................98
Localizing webtops...........................................................................................................98
Webtop form and message settings......................................................................98
BIG-IP Edge Client webtop settings....................................................................100
Settings for showing and hiding information on webtops....................................100
Webtop logout and relaunch settings..................................................................101
Webtop activity section setting............................................................................101
Webtop new session settings..............................................................................101
Webtop web applications session timeout settings.............................................102
Webtop hometab settings....................................................................................103
Full webtop settings.............................................................................................104
Full webtop popup window settings.....................................................................104
Full webtop Citrix logon form settings.................................................................105
Full webtop Citrix installer settings......................................................................106
Full webtop Citrix browser setting.......................................................................106

Chapter 13: Localizing Captions for Resources in General View.....................................107


What is resource caption localization?...........................................................................108
Localizing captions.........................................................................................................108

Chapter 14: Changing Customized Properties in Advanced View....................................109


About Advanced Customization view.............................................................................110
Editing files in Advanced View............................................................................110

Chapter 15: Customizing the APM logon page...................................................................113


Overview: Customizing the logon page..........................................................................114
Customizing a logo on the logon screen.............................................................114

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

Export Regulation Notice


This product may include cryptographic software. Under the Export Administration Act, the United States
government may consider it a criminal offense to export this product from the United States.
Legal Notices

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.

Canadian Regulatory Compliance


This Class A digital apparatus complies with Canadian ICES-003.

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

This product includes software developed by Bill Paul.


This product includes software developed by Jonathan Stone.
This product includes software developed by Manuel Bouyer.
This product includes software developed by Paul Richards.
This product includes software developed by the NetBSD Foundation, Inc. and its contributors.
This product includes software developed by the Politecnico di Torino, and its contributors.
This product includes software developed by the Swedish Institute of Computer Science and its contributors.
This product includes software developed by the University of California, Berkeley and its contributors.
This product includes software developed by the Computer Systems Engineering Group at the Lawrence
Berkeley Laboratory.
This product includes software developed by Christopher G. Demetriou for the NetBSD Project.
This product includes software developed by Adam Glass.
This product includes software developed by Christian E. Hopps.
This product includes software developed by Dean Huxley.
This product includes software developed by John Kohl.
This product includes software developed by Paul Kranenburg.
This product includes software developed by Terrence R. Lambert.
This product includes software developed by Philip A. Nelson.
This product includes software developed by Herb Peyerl.
This product includes software developed by Jochen Pohl for the NetBSD Project.
This product includes software developed by Chris Provenzano.
This product includes software developed by Theo de Raadt.
This product includes software developed by David Muir Sharnoff.
This product includes software developed by SigmaSoft, Th. Lockert.
This product includes software developed for the NetBSD Project by Jason R. Thorpe.
This product includes software developed by Jason R. Thorpe for And Communications, http://www.and.com.
This product includes software developed for the NetBSD Project by Frank Van der Linden.
This product includes software developed for the NetBSD Project by John M. Vinopal.
This product includes software developed by Christos Zoulas.
This product includes software developed by the University of Vermont and State Agricultural College and
Garrett A. Wollman.
This product includes software developed by Balazs Scheidler (bazsi@balabit.hu), which is protected under
the GNU Public License.
This product includes software developed by Niels Mueller (nisse@lysator.liu.se), which is protected under
the GNU Public License.
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

Overview: Customization and localization


Customization Basics

Overview: Customization and localization


Customization and localization are ways to change the text and the language that users see, and to change
the appearance of the user interface for Access Policy Manager.

About basic, general, and advanced customization


The Customization tool provides three types of customization.

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.

About language choices


The set of languages that are available for use in an access policy is specified in the access profile. When
customizing access profile objects, the accepted languages for the access profile are available for selection.
When customizing resource objects, the languages for all access profiles are also available for selection.

About localization in the generated UI


Access profile objects and resource objects can have different language settings from one another. If it is
available, the language of the user session is selected for use in the UI; otherwise, the default language for
the access profile is selected.

About visual policy editor and general customization similarities


Some access policy items can be customized using either the visual policy editor or the Customization tool.
After changes are made and saved in one (the visual policy editor, for example), updates are available to
view in the other (the Customization tool); the reverse is also true.

14
BIG-IP Access Policy Manager: Customization

Message Box customization


It is possible to choose a language and to specify message and link text for the Message Box in either user
interface.

Figure 1: Visual policy editor Message Box customization

Figure 2: General customization for Message Box

How APM generates UI pages


Access profile objects and resource objects (customized independently from an access profile) are the same
in terms of semantics and structure. Each object has a basic group of customization settings. An access
profile, however, has more than one group of customization settings. Customized UI page generation works
similarly, in that the process takes an object, adds customization settings to it, and produces XML. Then,
it adds a UI page template to the XML data to create a UI page.

15
Customization Basics

Figure 3: Process for creating a customized UI page

About UI page structure


The UI page structure is always the same when using basic or general customization. It includes three areas:
header, footer, and content.

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.

Which objects can be customized?


Resource objects can be customized and reused in any access profile with an access policy that assigns
resources. The following resource objects can be customized:
Network access resources
Remote desktops
Webtops
Webtop links
Portal access resources
App tunnels

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.

About access profile objects and settings


When performing customization, an access profile includes common settings, and settings for some of the
objects that are included in the access policy.

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

General page style settings for access


profiles
Font settings for access profiles
Layout settings for access profiles
Page header settings for access profiles
Page footer settings for access profiles
Image settings for access profiles
Form settings for access profiles
Form element settings for access profiles
Advanced customization image settings
About general customization for logon pages
About mobile browser support
General Customization

General page style settings for access profiles


The table lists settings for customizing general page style in the General Customization view. Style sheet
(CSS) settings are available for customization in the Advanced Customization view.

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.

General page style settings illustration


The figure shows the result of setting page alignment to right and page width to 50% in the general page
style settings for an access profile.

Figure 5: Access profile page general customization result

20
BIG-IP Access Policy Manager: Customization

Font settings for access profiles


The table lists font settings for general page style customization. The style sheet (CSS) settings that are
mentioned are available for customization in the Advanced Customization view.

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

Layout settings for access profiles


The table lists settings for customizing page layouts from the general customization view. Style sheet (CSS)
settings are available for customization in the Advanced Customization view.

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.)

Layout settings illustration


This figure shows the proportions of a page with these page layout settings:
Page layout - Form left
Image cell width - 50%
Form cell width - 50%

21
General Customization

Figure 6: Access profile page layout default settings

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.

Page header settings for access profiles


The table lists settings for customizing the page header style from the general customization view. Style
sheet (CSS) settings are available for customization in the Advanced Customization view.

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

Page footer settings for access profiles


You can customize the following settings for the page footer style with the Customization tool. Style sheet
(CSS) settings are available for customization in the Advanced Customization view.

Name Description
Footer font size (px) Corresponds to CSS table#page_footer { font-size: . }

Image settings for access profiles


You can customize the following settings for the main page image with the Customization tool.

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.

Form settings for access profiles


You can customize the following settings for the login form with the Customization tool. Style sheet (CSS)
settings are available for customization in the Advanced Customization view.

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

Form settings illustration


This figure illustrates a form and its settings within a form cell.

Figure 7: Access profile form cell, form, and form settings

Form element settings for access profiles


You can customize the appearance of elements in the logon form using these settings in the General
Customization view.

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

Form element settings illustration


This figure illustrates the elements in a form configured with these setting values.
Header alignment: center
Label alignment: right
Label width: 40%
Label position: left
Field alignment: right
Field width: 50%

Figure 8: Access profile form elements and settings

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.

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.

About general customization for logon pages


Logon page customization depends to some extent on the logon page properties that are configured in the
visual policy editor. Logon page properties include five fields that can be configured to accept some type
of input or not (when the input type is set to none). Any field that does not accept input is hidden from the
user at logon; however, it is not hidden in the customization user interface.
General customization for a logon page supports changing:
The text on the screen, including the prompts for input fields.
The image to display.

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.

Logon page field customization illustration


The type of input that a logon page field accepts can only be specified in the visual policy editor. If the type
is none, the field cannot be customized in the visual policy editor and, at logon, it is hidden from the user.
However, all five fields are always available for customization from the General Customization view.

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

Logon page settings


You can customize the following settings for logon pages that appear in web browsers and on mobile devices
with the Customization tool.

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.

About mobile browser support


Mobile browsers and full browsers share the same UI page template HTML, but use different CSS files to
optimize presentation for the type of device. To tune the mobile browser CSS, you must edit CSS files using
the Advanced Customization view.

29
Chapter

3
Coding Tips and Examples

About advanced customization


About customization variables
About PHP code
About CSS code
Coding recommendations
About advanced customization images
About best practices for advanced
customization images
Example: Adding an image to an access
policy page
Example: Adding an image to a profile and
a page
Coding Tips and Examples

About advanced customization


With advanced customization, it is possible to change almost anything with a certain knowledge of HTML,
CSS, and JavaScript. UI templates, which consist of HTML and PHP files, and CSS files, are available for
edit directly from the Advanced Customization view.

About customization variables


Customization variables are special symbols, such as %[variable_name], in a UI template. A customization
variable is a placeholder for actual customization and localization values. When a UI page is generated from
a UI template, customization variables are replaced with actual values.

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.

About PHP code


Customization uses PHP code inside UI templates.

Important: F5 recommends that when you customize UI templates, you do not delete or modify PHP code.

About CSS code


In the hierarchy of the advanced customization user interface, all CSS code is located under Access Profile >
Common. The folder contains various versions of the Access Policy Manager (APM) CSS code with
names such as apm_mobile.css and apm_full.css. When displaying generated UI pages, APM picks
the correct .css file for the client (mobile browser, full browser, BIG-IP Edge Client).
If you create a UI template that partially or completely replaces the default structure provided by F5, F5
recommends that you 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.

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">.

Access profile common .css and .inc files


You can customize the following files for access profiles in the Advanced Customization view.

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.

Important: F5 recommends that you do not edit this file.

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.

Access profile logout .inc files


You can customize the following files for access profiles in the Advanced Customization view.

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.

Access profile logon .inc files


You can customize the following files for access profiles in the Advanced Customization view.

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.

Access profile decision box .inc files


You can customize the following files for access profiles in the Advanced Customization view.

Name Description
decision_box.inc Specifies the layout for the HTML that appears in a decision box.

Access profile message box .inc files


You can customize the following files for access profiles in the Advanced Customization view.

34
BIG-IP Access Policy Manager: Customization

Name Description
message_box.inc Specifies the layout for the HTML that appears in a message box.

Access profile ending page .inc files


You can customize the following files for access profiles in the Advanced Customization view.

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.

Webtop .css and .inc files


You can customize the following files for webtops in the Advanced Customization view.

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.

About advanced customization images


In the General Customization view, each access profile, access profile page, and webtop includes an Advanced
Customization Images setting. The setting provides storage for up to ten images that are then available for
use in the Advanced Customization view. An image specified in the setting is managed with the parent
object; it is exported, imported, copied, or deleted along with the parent object. It persists with the parent
object through backup and upgrade procedures. An image is specified as a name-value pair.

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

About best practices for advanced customization images


You can think of the Advanced Customization Images settings as libraries of images. Each library has a
scope: the object that manages the library can always use images from it; sometimes child objects can also
use images from the library of a parent object. Advanced Customization Images settings offer a lot of
flexibility. When deciding where to store images, consider how much flexibility you need and whether
using images from a parent object library provides adequate control.

Access Profile Advanced Customization Images


If you store images in the Advanced Customization Images setting for an access profile, you can use
the images not only in the access profile code but also in the code for access policy pages. The advantage
of this approach is that if you need to update images, you only need to change them in one setting.
However, if you want to ensure that images on an access policy page remain the same regardless of
changes to images in the access profile Advanced Customization Images setting, this might not be the
approach you want to use.

36
BIG-IP Access Policy Manager: Customization

Access Policy pages Advanced Customization Images


If you store images in the Advanced Customization Images setting for an access policy page, you can
use the images in the code for that page only. You can store the same images that are stored at the access
profile level, different images, a mix of both, or no images.

Webtop Advanced Customization Images


If you store images in the Advanced Customization Images for a webtop, you can use the images in the
code for that webtop only. However, general customization provides many settings in which to specify
icons; it might be simpler to use it.

Example: Adding an image to an access policy page


In this example, a custom image is stored in the Advanced Customization Images settings for one of the
access policy pages, a message box page. In the Advanced Customization view, the code for the message
box page is updated to add a custom image to the right side of the page.

Figure 12: Sample custom image

Figure 13: Default message page

37
Coding Tips and Examples

Figure 14: Customized message page with image

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.

Uploading images for use in customization


You can add images for Access Policy Manager customization with the image browser. You can then
select and use these images by means of settings within 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.
2. On the menu bar, click Image Browser.
The image browser opens in a new screen.
3. Select the image filter method from the Filter Messages list.
Select Default Images to view the included default Access Policy Manager images.
Select User Uploaded Images to view the custom uploaded images.

4. Add and remove images.


To add an image, click Add Image, select the image, and click Open.
To remove an image, select the image in the image browser, and click Delete Image.

38
BIG-IP Access Policy Manager: Customization

Storing images for advanced customization of a specific page


This example explains how to store a custom image for use in the advanced customization of an access
policy message page. To follow this example, you need an access profile with an access policy that contains
a Message Box action item.
Specify an image in the Advanced Customization Images setting for an object so that the image can be
used in advanced customization of the object.
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 these folders Access Policy > Message Pages > Message Box.

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.

Settings for the message box access policy item display.


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. Make a note of the image name; you need it when you perform advanced customization.
You can use the image name as a variable in advanced customization of the parent object only. A message
box page is the parent object in this example.

The image is now available for use in advanced customization of the message box item.

Updating message box code with a custom image


You need to have the value of the name of image available from the Advanced Customization Images setting
for the particular message box that you want to update.
You remove and replace the code that specifies the image to display so that a customized image displays
instead.
1. From the View list, select Advanced Customization.
The advanced customization (tree) view displays.
2. Navigate to the message box item to be customized.
a) Expand the Access Profiles folder and expand the folder for the access profile you want to customize.
b) Expand these folders Access Policy > Message Pages > Message Box.

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.

Settings for the message box access policy item display.

3. Click message_box.inc.
Code displays in the Advanced Customization Editor.
4. Scroll down to this code.

<table id="main_table" class="message_box">


<tr>
<? if( $GLOBALS["page_layout"] == "form_right" ){ ?><td id="main_table_image_cell"><img
src="<? print( $GLOBALS["page_image_default"] ); ?>"></td><? } ?>
<td id="main_table_info_cell">
<table id="interaction_table">
<tr>
<td id="interaction_table_header"><? print('%[form_message]'); ?></td>
</tr>
<tr>
<td class="interaction_table_text_cell"><? print('<a href="#"
onclick="javascript:SubmitResult(1);return 1;">%[link]</a>'); ?></td>
</tr>
<tr>
<td class="interaction_table_footer"></td>
</tr>
</table>
</td>
<? if( $GLOBALS["page_layout"] == "form_left" ){ ?><td id="main_table_image_cell"><img
src="<? print( $GLOBALS["page_image_default"] ); ?>"></td><? } ?>
</tr>
</table>

5. After the first table row open tag (<tr>), remove this line of code.

<? if( $GLOBALS["page_layout"] == "form_right" ){ ?><td id="main_table_image_cell"><img src="<?


print( $GLOBALS["page_image_default"] ); ?>"></td><? } ?>

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.

<? if( $GLOBALS["page_layout"] == "form_left" ){ ?><td id="main_table_image_cell"><img src="<?


print( $GLOBALS["page_image_default"] ); ?>"></td><? } ?>

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.

<td id="main_table_image_cell"><img src="%[imagenn]"/></td>

8. In the Advanced Customization Editor area, click Save Draft.


In the navigation tree, message_box.inc now displays in italics.
9. On the menu bar, click Save.
In the navigation tree, message_box.inc is no longer italicized. In the screen header, the Apply Access
Policy link displays.
10. In the screen header, click the Apply Access Policy link.
A screen displays the access profile list with the access profile you have been editing selected.
11. Click the Apply Access Policy button.

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

Example: Adding an image to a profile and a page


In this example, a custom image is stored in the Advanced Customization Images settings for an access
profile. Then, the value of the image is used in advanced customization of the access profile page header.
The header displays on all access policy pages, including the logon page. Then, the value of the image is
used in additional advanced customization of the access policy logon page.

Figure 15: Sample custom image

Uploading images for use in customization


You can add images for Access Policy Manager customization with the image browser. You can then
select and use these images by means of settings within 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.
2. On the menu bar, click Image Browser.
The image browser opens in a new screen.
3. Select the image filter method from the Filter Messages list.
Select Default Images to view the included default Access Policy Manager images.
Select User Uploaded Images to view the custom uploaded images.

4. Add and remove images.


To add an image, click Add Image, select the image, and click Open.
To remove an image, select the image in the image browser, and click Delete Image.

Storing images for advanced customization of policy pages


To follow this example, you need an access profile with an access policy that contains a Logon Page action
item.
Specify an image in the Advanced Customization Images setting for an access profile to use the image
in advanced customization of the access profile and any access policy pages.

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.

Adding an image in the page header code


In this example, an image is added to the access profile page header. Make sure that the value of the image
is available exactly as specified in the Advanced Customization Images setting for the particular access
profile that you want to update.
Add code to specify an image to display in the page header.
1. From the View list, select Advanced Customization.
The advanced customization view displays.
2. In the navigation tree, expand the Access Profiles folder and expand the folder for the access profile
you want to customize.
3. Expand the Common folder.
4. Click header.inc.
Code displays in the Advanced Customization Editor area of the screen.
5. Scroll to the end of the file to this code.

<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.

<img src="image_value_from_advanced_customization_settings" />

7. In the Advanced Customization Editor area, click Save Draft.


In the navigation tree, header.inc now displays in italics.
8. On the menu bar, click Save.
In the navigation tree, header.inc is no longer italicized. In the screen header, the Apply Access Policy
link displays.
9. In the screen header, click the Apply Access Policy link.
A screen displays the access profile list with the access profile you have been editing selected.
10. Click the Apply Access Policy button.
11. To verify the result, in the General or Advanced Customization view, click Preview and navigate to and
click any access policy page.

Figure 16: Logon page with customized page header

Adding an image in the logon page code


This example shows one way to change the image that is displayed on a logon page. Have the value of the
image available exactly as it is specified in the Advanced Customization Images setting for the parent
access profile.
Add code to specify an image to display after the logon page.
1. From the View list, select Advanced Customization.
The advanced customization view displays.

43
Coding Tips and Examples

2. Navigate to the logon page item to be customized.


a) Expand the Access Profiles folder and expand the folder for the access profile you want to customize.
b) Expand these folders Access Policy > Logon Pages > Logon Page.

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.

Settings for the logon page access policy item display.

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>

<? include_customized_page("general_ui", "footer.inc"); ?>

<? include_once("sam/webtop/renderer/vk.inc"); ?>

<div id="MessageDIV" class="inspectionHostDIVSmall"></div>

</body>
</html>

5. After the table close tag (</table>), insert this line of code.

<img src="image_value_from_advanced_customization_settings" />

6. In the Advanced Customization Editor area, click Save Draft.


In the navigation tree, login.inc now displays in italics.
7. On the menu bar, click Save.
In the navigation tree, logon.inc is no longer italicized. In the screen header, the Apply Access Policy
link displays.
8. In the screen header, click the Apply Access Policy link.
A screen displays the access profile list with the access profile you have been editing selected.
9. Click the Apply Access Policy button.
10. To verify the result, in the General or Advanced customization view, click Preview and navigate to and
click any access policy page.

Figure 17: Logon page with custom image after the form

44
BIG-IP Access Policy Manager: Customization

45
Chapter

4
Advanced Customization Using Templates

About advanced customization templates


Advanced Customization Using Templates

About advanced customization templates


Access Policy Manager advanced customization templates provide code and images for creating customized
pages. With the templates and the instructions provided for them, you can walk through step-by-step
instructions and produce pages with a look-and-feel and with features that are frequently requested .
Templates and instructions are available for download from the BIG-IP Access Policy Manager page on
DevCentral at
https://devcentral.f5.com/wiki/APM.APM-Advanced-Customization-Templates.ashx.

48
Chapter

5
The Customization Tool

About the Customization tool


About customization views and form factors
The Customization Tool

About the Customization tool


The Customization tool is an application that you start from the BIG-IP admin console. With the
Customization tool, you can personalize screen messages and prompts, change screen layouts, colors, and
images, and customize error and other messages to specific languages for policies and profiles used on
BIG-IP Access Policy Manager.

Starting the Customization tool


Start the Customization tool to personalize and localize page layout, colors, images, and messages for the
BIG-IP Edge Client, browser pages, and mobile device screens.
On the Main tab, click Access Policy > Customization.
The Customization tool appears, in Basic Customization view.

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.

About customization views and form factors


The Customization tool provides three views.

Basic Customization (Quick Start)


This is the default customization view. Use this to configure basic look and feel for pages, and common
text labels and captions for resources on the webtop.

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.

BIG-IP Edge Client


Use this mode to configure the appearance and messages that appear in the BIG-IP Edge Client for
a platform or device.
In the General Customization view, for each form factor you can also choose to customize Branding or
Text by selecting the tab at the top of the Form Factor column.

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

About Basic Customization view


Configuring Settings in Basic Customization View

About Basic Customization view


You can use the Basic Customization view to configure common settings for access profile web pages, and
the webtop captions, descriptions, and images for any item that appears on a full webtop. In addition, you
can customize webtop font size and link colors.
With this view, you can customize all of these items:

Common Page Styles


Specifies settings for the logon form display, header image, and alignment of items.

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.

Common webtop settings


Specifies display settings that apply to all resources on the full webtop.

Webtop links
Specifies display settings that apply to all resources on the full webtop.

Customizing Basic settings


Start Basic customization to configure custom settings for access profiles and items that appear on the full
webtop. Basic customization provides a starting point that you can later refine through the Advanced
Customization view.
1. On the Main tab, click Access Policy > Customization > Quick Start/Basic.
The Basic Customization view opens.
2. In the left column of the page, select the category of items to customize.
For example, select Network Access to customize the appearance of a network access resource item on
the full webtop.
3. On the right side of the page, from the list, select the specific item for which you want to customize
settings.
The customizable settings for the item are displayed.
4. Configure settings for the resource item or access profile.
When configuring Common Page Styles, click Preview at the bottom of the screen to display changes
without first saving them.

After you customize settings, click Save to save the new customization settings. To return to the original
settings and discard your changes, click Revert.

Common page style settings


The Basic Customization view provides settings for customizing an access profile.

Setting Value Description


Access Profile An access profile already The access profile for which you want to change
defined on the system. basic settings.

54
BIG-IP Access Policy Manager: Customization

Setting Value Description


Language A language already specified in This specifies the language for which you are
the access profile on the system. changing customization settings. Select All
languages to apply the same customization
changes to all languages in the access profile.
Page Alignment Left, center, or right. Sets the alignment of the page within the web
browser screen.
Page Width Pixel or percentage value (for The width of any access policy web pages inside
example 90%). the web browser frame.
Header Logo An image. The header logo appears, by default, at the
upper-left corner of the defined HTML page.
Typically this is a square, transparent image file.
Acceptable formats for transparency are GIF and
PNG. The page header area expands to the height
of this image.
Page Background A color, selected from a color Indicates the color behind pages.
Color chooser.
Header A color, selected from a color Indicates the color of the header on a page.
Background Color chooser.
Table Background A color, selected from a color Indicates the color behind a table on a page.
Color chooser.
Form Left Margin A numeric pixel value, or a The margin between the left edge of the form and
percentage (for example, 10px the left edge of the browser window, on
or 5%). form-based pages.
Form Top Margin A numeric pixel value or a The margin between the top edge of the form and
percentage, (for example, 10px). the bottom edge of the header image, on
form-based pages.
Form Height A numeric pixel value or a The height of the form, on form-based pages. Any
percentage, (for example, 500px value less than the full height of the browser
or 50%). increases the space at the bottom of the form, as
the top margin is set by the Form Top Margin
value.
Form Background A color, selected from a color Indicates the color behind form-based pages.
Color chooser.
Footer Text A text string. Specifies the footer message that appears at the
bottom of access policy web pages.
Footer Font Size Font size in pixels (for example Indicates the size for the footer message at the
10px). bottom of access policy web pages.

App tunnel basic settings


The Basic Customization view provides settings for customizing an app tunnel on the full webtop.

Setting Value Description


App Tunnel An app tunnel already The app tunnel for which you want to change basic
defined on the system settings.

55
Configuring Settings in Basic Customization View

Setting Value Description


Language A language already specified This specifies the language for which you are changing
on the system customization settings. Select All languages to apply the
same customization changes to all languages in the access
profile.
Caption A text string The text under the icon for the app tunnel, on a full
webtop.
Description A text string The description text for the app tunnel, on a full webtop.
Image An image or icon The image acts as an icon on the full webtop to represent
the app tunnel. Select an image from the list, or click
Upload New Image to add a new image.

Network access basic settings


The Basic Customization view provides settings for customizing a network access resource on the full
webtop.

Setting Value Description


Network Access A network access resource The network access resource for which you want to
already defined on the change basic settings.
system
Language A language already specified This specifies the language for which you are changing
on the system customization settings. Select All languages to apply the
same customization changes to all languages in the access
profile.
Caption A text string The text under the icon for the network access resource,
on a full webtop.
Description A text string The description text for the network access resource, on
a full webtop.
Image An image or icon The image acts as an icon on the full webtop to represent
the network access resource. Select an image from the
list, or click Upload New Image to add a new image.

Remote desktop basic settings


The Basic Customization view provides settings for customizing a remote desktop on the full webtop.

Setting Value Description


Remote desktop A remote desktop already The remote desktop for which you want to change basic
defined on the system settings.
Language A language already This specifies the language for which you are changing
specified on the system customization settings. Select All languages to apply the
same customization changes to all languages in the access
profile.
Caption A text string The text under the icon for the remote desktop, on a full
webtop.

56
BIG-IP Access Policy Manager: Customization

Setting Value Description


Description A text string The description text for the remote desktop, on a full
webtop.
Image An image or icon The image acts as an icon on the full webtop to represent
the remote desktop. Select an image from the list, or click
Upload New Image to add a new image.

Common webtop settings


The Basic Customization view provides these shared settings for customizing full webtops.

Setting Value Description


Webtop A webtop already defined on The webtop for which you want to change basic
the system settings.
Language A language already specified This specifies the language for which you are
on the system changing customization settings. Select All languages
to apply the same customization changes to all
languages in the access profile.
Font size A pixel value, (for example The font size used for text on the full webtop.
14px)

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.

Webtop link basic settings


The Basic Customization viewprovides settings for customizing a webtop link on the full webtop.

Setting Value Description


Webtop link A webtop link already The webtop link for which you want to change basic
defined on the system settings.
Language A language already specified This specifies the language for which you are changing
on the system customization settings. Select All languages to apply the
same customization changes to all languages in the access
profile.
Caption A text string The text under the icon for the webtop link, on a full
webtop.
Description A text string The description text for the webtop link, on a full webtop.
Image An image or icon The image acts as an icon on the full webtop to represent
the webtop link. Select an image from the list, or click
Upload New Image to add a new image.

57
Configuring Settings in Basic Customization View

Portal access resource basic settings


The Basic Customization view provides settings for customizing a portal access resource on the full webtop.

Setting Value Description


Portal Access A portal access resource The portal access resource for which you want to change
already defined on the basic settings.
system
Language A language already specified This specifies the language for which you are changing
on the system customization settings. Select All languages to apply the
same customization changes to all languages in the access
profile.
Caption A text string The text under the icon for the portal access resource, on
a full webtop.
Description A text string The description text for the portal access resource, on a
full webtop.
Image An image or icon The image acts as an icon on the full webtop to represent
the portal access resource. Select an image from the list,
or click Upload New Image to add a new image.

58
Chapter

7
Personalizing Client Appearance in General View

What is client personalization?


Uploading images for use in customization
Personalizing client colors, logos, and icons
Localizing screen appearance for BIG-IP
Edge Client
Personalizing Client Appearance in General View

What is client personalization?


To personalize client pages, you use BIG-IP Edge Client customization. You can change the branding
and localization of the BIG-IP Edge Client on client PCs and devices.

Uploading images for use in customization


You can add images for Access Policy Manager customization with the image browser. You can then
select and use these images by means of settings within 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.
2. On the menu bar, click Image Browser.
The image browser opens in a new screen.
3. Select the image filter method from the Filter Messages list.
Select Default Images to view the included default Access Policy Manager images.
Select User Uploaded Images to view the custom uploaded images.

4. Add and remove images.


To add an image, click Add Image, select the image, and click Open.
To remove an image, select the image in the image browser, and click Delete Image.

Personalizing client colors, logos, and icons


In a connectivity profile, you can customize the appearance of the BIG-IP Edge Clientand the web client.
The settings you specify are saved with the connectivity profile, and applied when users download the client
package.
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. From the Form Factor menu at the top of the Customization tool, select BIG-IP Edge Client.
3. To select the BIG-IP Edge Client, in the left pane, expand the folders and navigate to Customization
Settings > Connectivity Profiles > name_of_connectivity_profile, and click BIG-IP Edge
Client.
4. Customize the settings for BIG-IP Edge Client branding.
5. After you customize settings, click the Save icon at the top of the Customization tool.

60
BIG-IP Access Policy Manager: Customization

Previewing customization changes


You must have customized an element with the Customization tool to see a preview of your changes.
After you customize and save an element with the Customization tool, you can preview the changes you
have made in the Preview window. The Preview window opens a separate browser window, and shows a
live update of changes as you save them.
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. On the menu bar, at right, click the Preview button.
3. Navigate to a page to view customizations.
For example, to navigate to a logon page and view the results of access profile branding customization,
in the Preview window expand Customization Settings > Access Profiles > access_profile_name >
Access Policy > Logon Pages, then click logon_page_name.

The Preview window shows the results of any customization changes.

Appearance properties for BIG-IP Edge Client


You can customize the following appearance settings for BIG-IP Edge Client with the Customization
tool.

Name Value Description


Banner A hex color code, for example, #123ABC. Indicates the color that the banner for the
Color When you click the color value, two color BIG-IP Edge Client uses. Note that the Banner
choosers appear. One allows you to select a Text Color should be legible over this color.
color from 40 common color blocks, and the
other allows you to select any HTML color
from a more sophisticated color wheel. You
can also type the color value in as text.
Banner A hex color code, for example, #123ABC. Indicates the color in which the banner text
Text Color When you click the color value, two color appears. This color appears over the Banner
choosers appear. One allows you to select a Color and should be readable on it.
color from 40 common color blocks, and the
other allows you to select any HTML color
from a more sophisticated color wheel. You
can also type the color value in as text.
Logo A 48 x 48 PNG, JPG, or GIF icon. This logo appears in the BIG-IP Edge Client
as the company logo. The generic logo is an
F5 logo. To change the logo, click the logo
popout button, then click Replace. Select an
image file to replace the logo file. Note that
you can add files to the Customization tool in
the image browser.
Tray Icon The F5 tray logo set or the generic icon set. Select the setting that will appear in the system
Set tray to show connection activity and status.
You can choose the F5 icon set (red ball), or
a Generic icon set.

61
Personalizing Client Appearance in General View

Localizing screen appearance for BIG-IP Edge Client


Configure localization for BIG-IP Edge Client to change the messages and text in the BIG-IP Edge Client
application.
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. From the Form Factor menu at the top of the Customization tool, select BIG-IP Edge Client.
3. In the left pane, click the Text tab.
A navigation tree displays in the left pane.
4. To select the BIG-IP Edge Client, in the left pane, expand the folders and navigate to Customization
Settings > Connectivity Profiles > name_of_connectivity_profile, and click BIG-IP Edge
Client.
5. At the top right of the Customization settings pane, select the Language for which to customize
localization messages for the BIG-IP Edge Client.
6. Customize the settings for BIG-IP Edge Client localization.
7. After you customize settings, click the Save icon at the top of the Customization tool.

Previewing customization changes


You must have customized an element with the Customization tool to see a preview of your changes.
After you customize and save an element with the Customization tool, you can preview the changes you
have made in the Preview window. The Preview window opens a separate browser window, and shows a
live update of changes as you save them.
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. On the menu bar, at right, click the Preview button.
3. Navigate to a page to view customizations.
For example, to navigate to a logon page and view the results of access profile branding customization,
in the Preview window expand Customization Settings > Access Profiles > access_profile_name >
Access Policy > Logon Pages, then click logon_page_name.

The Preview window shows the results of any customization changes.

Text properties for BIG-IP Edge Client


You can customize the following settings for BIG-IP Edge Client customization with the Customization
tool.

Name Value Description


About link A URL The text that appears as a link in the About area of the BIG-IP
Edge Client.

62
BIG-IP Access Policy Manager: Customization

Name Value Description


About text Text Text, typically copyright info or some other identifying
information, that appears in the About area of the BIG-IP Edge
Client.
Application Name Text The application name, which appears in the status bar of the
application.

63
Chapter

8
Personalizing Access Profile Appearance Settings

What is access profile personalization?


Personalizing page appearance for common
access profile settings
Personalizing page appearance for access
profile logout settings
Personalizing page appearance for access
policy pages
Localizing messages for BIG-IP Edge Client
Personalizing Access Profile Appearance Settings

What is access profile personalization?


With full and mobile browser customization, you can change the appearance, text, and messages of all pages
that a browser views, either from the BIG-IP Edge Client by directly logging in through a web browser,
or on a mobile device. Some settings that are specific to the BIG-IP Edge Client software are customized
separately in the BIG-IP Edge Client customization view.

Personalizing page appearance for common access profile settings


Personalize access profile login pages to change the front image and advanced customization images for
the login page in a specific access policy.
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. To configure common settings, click Customization Settings > Access Profiles >
access_profile_name > Common.
3. Customize the settings for each individual element by clicking the element and changing the displayed
settings.
4. After you customize settings, click the Save icon at the top of the Customization tool.

The access policy login page reflects your changes.

Previewing customization changes


You must have customized an element with the Customization tool to see a preview of your changes.
After you customize and save an element with the Customization tool, you can preview the changes you
have made in the Preview window. The Preview window opens a separate browser window, and shows a
live update of changes as you save them.
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. On the menu bar, at right, click the Preview button.
3. Navigate to a page to view customizations.
For example, to navigate to a logon page and view the results of access profile branding customization,
in the Preview window expand Customization Settings > Access Profiles > access_profile_name >
Access Policy > Logon Pages, then click logon_page_name.

The Preview window shows the results of any customization changes.

General page style settings for access profiles


You can customize the following settings for general page style with the Customization tool.

66
BIG-IP Access Policy Manager: Customization

Name Value Description


Page alignment Left, Center, or Right. Indicates the general HTML page
alignment for all pages displayed by the
access profile.
Page A hex color code, for example, #123ABC. Indicates the color for the general page
background When you click the color value, two color background for all pages displayed by the
color choosers appear. One allows you to select a access profile.
color from 40 common color blocks, and the
other allows you to select any HTML color
from a more sophisticated color wheel. You
can also type the color value in as text.
Page width (px A specific pixel value, for example 800px, Specifies the width of the content on all
or %) or a percentage, for example 80%. HTML pages displayed by the access
profile, as an absolute pixel value or as a
percentage of the entire browser screen.

Font settings for access profiles


You can customize the following settings for general page style with the Customization tool.

Setting Value Description


Font family Font names or font-family names, Specifies the base font used by pages
(comma-separated) space-separated, for example displayed by the access profile.
Calibri, Tahoma, Verdana,
Arial, Helvetica, Sans-Serif.

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.

Page header settings for access profiles


You can customize the following settings for the page header style with the Customization tool.

Setting Value Description


Disconnect icon An image icon 48 x 48 pixels or smaller. Specifies the icon image displayed in the
browser when the page is disconnected.
Header A hex color code, for example, #123ABC. Indicates the background color for HTML
background color When you click the color value, two color header elements for the web pages served
choosers appear. One allows you to select to web and mobile clients.
a color from 40 common color blocks, and
the other allows you to select any HTML
color from a more sophisticated color
wheel. You can also type the color value
in as text.
Header left image An image name. This is a larger image up The header image for web pages. To
(Full Size) to 80 x 80 pixels, for display on web replace this image, type the relative path,
pages.

67
Personalizing Access Profile Appearance Settings

Setting Value Description


or click the preview icon to the right of
the filename, and click Replace.
Header left image An image name. This is a smaller image The header image for mobile device
(Mobile Devices up to 32 x 32 pixels, for display on mobile pages. To replace this image, type the
Size) devices. relative path, or click the preview icon to
the right of the filename, and click
Replace.

Page footer settings for access profiles


You can customize the following settings for the page footer style with the Customization tool.

Name Value Description


Footer font size (px) A font size, in pixels, for example Specifies the font size for text in web page
12px. footers.

Layout settings for access profiles


You can customize the following settings for page layouts with the Customization tool.

Name Value Description


Form cell width Width, in pixels or percentage, of the main Specifies the width of the login page
(px or %) login page form, for example 240px, or 50%. form in pixels or as a percentage of
the frame.
Image cell width Width, in pixels or percentage, of the main Specifies the width of the login page
(px or %) login page image cell width, for example image area in pixels or as a
240px, or 50%. percentage of the frame.
Main table A hex color code, for example, #123ABC. Indicates the background color for
background color When you click the color value, two color the login page main frame.
choosers appear. One allows you to select a
color from 40 common color blocks, and the
other allows you to select any HTML color
from a more sophisticated color wheel. You
can also type the color value in as text.
Page layout Form left, form center, or form right. Indicates the placement of the login
page form on the main access policy
page.

Image settings for access profiles


You can customize the following settings for the main page image with the Customization tool.

Name Value Description


Default image Width, in pixels or percentage, of the Specifies the width of the login page
main login page form, for example form in pixels or as a percentage of the
240px, or 50%. frame.

68
BIG-IP Access Policy Manager: Customization

Name Value Description


Image left margin Left side margin, in pixels, of the main Specifies the left margin of the login
(px) login page image, for example 24px. page image.
Image right margin Right side margin, in pixels, of the main Specifies the right margin of the login
(px) login page image, for example 24px. page image.
Image top margin Top-edge margin, in pixels, of the main Specifies the top margin of the login
(px) login page image, for example 24px. page image.
Side image alignment Center, left, or right. Specifies the alignment of the image
within the side frame.

Form settings for access profiles


You can customize the following settings for the login form with the Customization tool.

Setting Value Description


Form alignment Center, Left, or Right. Specifies the alignment of the
form within the form frame.
Form background A hex color code, for example, #123ABC. When Indicates the background color
color you click the color value, two color choosers for the login page form.
appear. One allows you to select a color from
40 common color blocks, and the other allows
you to select any HTML color from a more
sophisticated color wheel. You can also type
the color value in as text.
Form height (px, %, Height value in pixels, as a percentage of the Specifies the height of the login
or auto) frame, or auto, for example 240px, 40%, or form in the login frame.
auto.

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.

Form element settings for access profiles


You can customize the following settings for the appearance of elements in the login form with the
Customization tool.

Name Value Description


Field alignment Center, Left, or Right. Specifies how fields align in the login form.
Field width (%) A percentage value, for Specifies the width of fields in the login form, as
example 67%. a percentage of the total size of the login form.

69
Personalizing Access Profile Appearance Settings

Name Value Description


Header alignment Left, center, or right. Specifies the alignment of header elements in the
login form.
Label alignment Left, center, or right. Specifies the alignment of form field labels in the
login form.
Label position Left or above. Specifies whether login form field labels are
above or to the left of their respective fields.
Label width (%) A percentage value, for Specifies the width of field labels in the login
example 67%. form.

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

Personalizing page appearance for access profile logout settings


Personalize access profile logout settings to add advanced customization image support to logout pages in
the access profile.
1. On the Main tab, click Access Policy > Customization > Advanced.
The Customization tool appears in Advanced Customization view, displaying the Form Factor:
Full/Mobile Browser settings in the left pane.
2. To configure logout settings, in the left pane, expand the folders and navigate to Customization Settings >
Access Profiles > access_profile_name > Logout.
3. Customize the settings for advanced customization images.
4. After you customize settings, click the Save icon at the top of the Customization tool.

The access policy advanced customization page reflects your changes.

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

70
BIG-IP Access Policy Manager: Customization

Personalizing page appearance for access policy pages


Personalize access policy pages to change advanced customization images for the login page in a specific
access policy, and to add advanced customization images for other access policy pages.
1. On the Main tab, click Access Policy > Customization > Advanced.
The Customization tool appears in Advanced Customization view, displaying the Form Factor:
Full/Mobile Browser settings in the left pane.
2. On the Branding tab, click Customization Settings > Access Profiles > access_profile_name >
Access Policy, and select the folder for the item to customize.
3. Customize the settings for each individual element by clicking the element and changing the displayed
settings.
4. After you customize settings, click the Save icon at the top of the Customization tool.

The access policy pages reflect your changes.

Customization settings for access policy items


You can personalize the following settings for pages exposed to the user in an access policy.

Setting Value Description


General > Front Image The image that appears in the image frame of the login page for an
image access policy.
Advanced Images Each Advanced Customization Images properties page allows you to
Customization set advanced customization images from the image browser to associate
Images with advanced customization image names. Each access policy item
has a page for advanced customization images. You can use these
image names to add an image to a page using advanced 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.

Localizing messages for BIG-IP Edge Client


Configure localization for BIG-IP Edge Client to change the messages and text in the BIG-IP Edge Client
application.
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. From the Form Factor menu at the top of the Customization tool, select BIG-IP Edge Client.
3. To select the BIG-IP Edge Client, in the left pane, expand the folders and navigate to Customization
Settings > Connectivity Profiles > name_of_connectivity_profile, and click BIG-IP Edge
Client.
4. At the top right of the Customization settings pane, select the Language for which to customize
localization messages for the BIG-IP Edge Client.

71
Personalizing Access Profile Appearance Settings

5. Customize the settings for BIG-IP Edge Client localization.


6. After you customize settings, click the Save icon at the top of the Customization tool.

Previewing customization changes


You must have customized an element with the Customization tool to see a preview of your changes.
After you customize and save an element with the Customization tool, you can preview the changes you
have made in the Preview window. The Preview window opens a separate browser window, and shows a
live update of changes as you save them.
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. On the menu bar, at right, click the Preview button.
3. Navigate to a page to view customizations.
For example, to navigate to a logon page and view the results of access profile branding customization,
in the Preview window expand Customization Settings > Access Profiles > access_profile_name >
Access Policy > Logon Pages, then click logon_page_name.

The Preview window shows the results of any customization changes.

Customization settings for BIG-IP Edge Client localization


You can customize the following settings for BIG-IP Edge Client customization with the Customization
tool.

Setting Value Description


About link A URL The text that appears as a link in the about area of the BIG-IP
Edge Client.
About text Text Text, typically copyright info or some other identifying
information, that appears in the about area of the BIG-IP Edge
Client.
Application Name Text The application name, which appears in the status bar of the
application.

72
Chapter

9
Personalizing Webtop Appearance Settings in General View

What is webtop appearance personalization?


Personalizing page appearance for webtops
Personalizing Webtop Appearance Settings in General View

What is webtop appearance personalization?


You can customize the appearance of a webtop, including the layout of the webtop screen, images, and
colors associated with the webtop.

Personalizing page appearance for webtops


Personalize webtop appearance settings to change the appearance and layout of specific webtops.
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, expand the folders and navigate to Customization Settings > Webtops > webtop_name.
3. Customize the settings for each individual element by clicking the element and changing the displayed
settings.
4. After you customize settings, click the Save icon at the top of the Customization tool.

The webtop pages display your changes.

Webtop network connectivity status icons settings


You can customize the following icons for connectivity status on the webtop.

Name Value Description


Connected icon 16x16px image Specifies the image for the connected status light on
the webtop.
Disconnected icon 16x16px image Specifies the image for the disconnected status light
on the webtop.
Waiting icon 32x32px image Specifies the image that displays while the client is
connecting.

CSS sprite image setting


You can specify the portal access connection CSS sprites image with this setting.

Name Value Description


CSS Sprites image An image file Specifies the image to use for sprites to construct
the webtop windows.

74
BIG-IP Access Policy Manager: Customization

Web Applications Session Timeout settings


Portal access timeouts cause special behavior on the portal access webtop screen. When the session reaches
the session timeout guard time, BIG-IPAccess Policy Manager displays a session timeout warning, and
dims the screen behind the warning. Depending on the type of timeout, the user sees different choices. You
can use the following options to customize and configure session timeout options.

Name Value Description


'Inactivity Timeout' A hex color code, for example, Specifies the color of the background that
background color #123ABC. When you click the appears behind the session timeout
color value, two color choosers warning pop-up screen, when the timeout
appear. One allows you to select a occurs because the session is inactive.
color from 40 common color
blocks, and the other allows you
to select any HTML color from a
more sophisticated color wheel.
You can also type the color value
in as text.
'Maximum Session A hex color code, for example, Specifies the color of the background that
Timeout' background #123ABC. When you click the appears behind the session timeout
color color value, two color choosers warning pop-up screen, when the timeout
appear. One allows you to select a occurs because the session has reached
color from 40 common color the maximum timeout.
blocks, and the other allows you
to select any HTML color from a
more sophisticated color wheel.
You can also type the color value
in as text.
Dialog background color A hex color code, for example, Indicates the page background color for
#123ABC. When you click the the timeout dialog box presented by
color value, two color choosers session inactivity timeouts or maximum
appear. One allows you to select a session timeouts.
color from 40 common color
blocks, and the other allows you
to select any HTML color from a
more sophisticated color wheel.
You can also type the color value
in as text.
Dialog x-size in pixels Number (px) Specifies the width, in pixels, of the
timeout dialog.
Dialog y-size in pixels Number (px) Specifies the height, in pixels, of the
timeout dialog.
Dimmed opacity Number (1-100) Specifies the opacity of the background
percentage that appears behind the session timeout
warning pop-up screen.
Guard time Number (seconds) Specifies the number of seconds before
timeout that the session timeout warning
pop-up screen appears.
Position of buttons Coordinates in px (-left, -top) Specifies the offset from the left and top
Background image margin of the CSS Sprites image for the

75
Personalizing Webtop Appearance Settings in General View

Name Value Description


(hover) in CSS Sprites button background image that appears
image when the mouse hover.
Position of buttons Coordinates in px (-left, -top) Specifies the offset from the left and top
Background image in margin of the CSS Sprites image for the
CSS Sprites image button background image.
Position of header Coordinates in px (-left, -top) Specifies the offset from the left and top
Background image in margin of the CSS Sprites image for the
CSS Sprites image background hover image.
Position of Left Sidepart Coordinates in px (-left, -top) Specifies the offset from the left and top
image (hover) in CSS margin of the CSS Sprites image for the
Sprites image left-side mouse hover image.
Position of Left Sidepart Coordinates in px (-left, -top) Specifies the offset from the left and top
image in CSS Sprites margin of the CSS Sprites image for the
image left-side image.
Position of Logout image Coordinates in px (-left, -top) Specifies the offset from the left and top
in CSS Sprites image margin of the CSS Sprites image for the
logout image.
Position of Right Coordinates in px (-left, -top) Specifies the offset from the left and top
Sidepart image (hover) in margin of the CSS Sprites image for the
CSS Sprites image right-side hover image.
Position of Right Coordinates in px (-left, -top) Specifies the offset from the left and top
Sidepart image in CSS margin of the CSS Sprites image for the
Sprites image right-side image.
Position of Warning Coordinates in px (-left, -top) Specifies the offset from the left and top
image in CSS Sprites margin of the CSS Sprites image for the
image warning image.

Web Applications Hometab settings


Portal access connections include an optional hometab, which provides buttons and links for working with
portal access and a URL bar. You can customize and configure the hometab with the following options.

Name Value Description


Data entry background A hex color code, for example, Specifies the color of the background that
color #123ABC. When you click the color appears behind the data entry fields on
value, two color choosers appear. the hometab.
One allows you to select a color
from 40 common color blocks, and
the other allows you to select any
HTML color from a more
sophisticated color wheel. You can
also type the color value in as text.
Data entry left and right A hex color code, for example, Specifies the color of the borders for the
border color #123ABC. When you click the color data entry area.
value, two color choosers appear.
One allows you to select a color
from 40 common color blocks, and
the other allows you to select any

76
BIG-IP Access Policy Manager: Customization

Name Value Description


HTML color from a more
sophisticated color wheel. You can
also type the color value in as text.
Data entry text color A hex color code, for example, Specifies the text color for data entry
#123ABC. When you click the color fields.
value, two color choosers appear.
One allows you to select a color
from 40 common color blocks, and
the other allows you to select any
HTML color from a more
sophisticated color wheel. You can
also type the color value in as text.
Font size (px) pixel value (for example, 14px) Specifies the font size on the hometab.
Link color A hex color code, for example, Specifies the link text color on the
#123ABC. When you click the color hometab.
value, two color choosers appear.
One allows you to select a color
from 40 common color blocks, and
the other allows you to select any
HTML color from a more
sophisticated color wheel. You can
also type the color value in as text.
Link color (hover) A hex color code, for example, Specifies the color for links when the
#123ABC. When you click the color mouse hovers over them.
value, two color choosers appear.
One allows you to select a color
from 40 common color blocks, and
the other allows you to select any
HTML color from a more
sophisticated color wheel. You can
also type the color value in as text.
Position of Background coordinates in px (-left, -top) Specifies the offset from the left and top
image (hover) in CSS margin of the CSS Sprites image for the
Sprites image background image that appears when the
mouse hovers.
Position of Background coordinates in px (-left, -top) Specifies the offset from the left and top
image in CSS Sprites margin of the CSS Sprites image for the
image background image.
Position of divider image coordinates in px (-left, -top) Specifies the offset from the left and top
in CSS Sprites image margin of the CSS Sprites image for the
divider image.
Position of home image coordinates in px (-left, -top) Specifies the offset from the left and top
in CSS Sprites image margin of the CSS Sprites image for the
Home image.
Position of Left Sidepart coordinates in px (-left, -top) Specifies the offset from the left and top
image in CSS Sprites margin of the CSS Sprites image for the
image left side image.

77
Personalizing Webtop Appearance Settings in General View

Name Value Description


Position of Logout image coordinates in px (-left, -top) Specifies the offset from the left and top
in CSS Sprites image margin of the CSS Sprites image for the
logout image.
Position of coordinates in px (-left, -top) Specifies the offset from the left and top
Open-In-New-Window margin of the CSS Sprites image for the
image (hover) in CSS "open in new window" image, when the
Sprites image mouse hovers over it.
Position of coordinates in px (-left, -top) Specifies the offset from the left and top
Open-In-New-Window margin of the CSS Sprites image for the
image in CSS Sprites "open in new window" image.
image
Position of Reduced coordinates in px (-left, -top) Specifies the offset from the left and top
toolbar image (hover) in margin of the CSS Sprites image for the
CSS Sprites image minimized toolbar image, when the
mouse hovers over it.
Position of Reduced coordinates in px (-left, -top) Specifies the offset from the left and top
toolbar image in CSS margin of the CSS Sprites image for the
Sprites image minimized toolbar image.
Position of Right coordinates in px (-left, -top) Specifies the offset from the left and top
Sidepart image in CSS margin of the CSS Sprites image for the
Sprites image right side image.
Position of Shrink image coordinates in px (-left, -top) Specifies the offset from the left and top
(hover) in CSS Sprites margin of the CSS Sprites image for the
image shrink image, when the mouse hovers
over it.
Position of Shrink image coordinates in px (-left, -top) Specifies the offset from the left and top
in CSS Sprites image margin of the CSS Sprites image for the
shrink image.
Position of Transparent coordinates in px (-left, -top) Specifies the offset from the left and top
background image in margin of the CSS Sprites image for the
CSS Sprites image warning image.
Position of Transparent coordinates in px (-left, -top) Specifies the offset from the left and top
sidepart image in CSS margin of the CSS Sprites image for the
Sprites image transparent side image.
Set of elements to be comma-separated list This is a comma-separated list of all the
displayed elements displayed on the hometab. The
hometab is arranged in the order in which
you specify these elements. Elements can
be used more than once. The default
specification is
shrink,divider,home,url,logout.

You can specify the following elements


for the home tab:

shrink
Specifies the hometab shrink element.

78
BIG-IP Access Policy Manager: Customization

Name Value Description


divider
Specifies a hometab field separator
element.

url
Specifies the hometab URL box
element.

home
Specifies the home link and text
element.

logout
Specifies the logout link and image
element.

Full webtop settings


You can configure the appearance of the full webtop with these settings.

Name Value Description


Header message Image Specifies the image for the header message icon on the full webtop. To
icon change the image, click the image popout button at the right of the field,
then click Replace. Select an image file to replace the image file. Note
that you can add files to the Customization tool in the image browser.
Help window logo Image Specifies the image that a webtop user can click to open the webtop online
help. To change the image, click the image popout button at the right of
the field, then click Replace. Select an image file to replace the image
file. Note that you can add files to the Customization tool in the image
browser.
Toolbar - go icon Image Specifies the image that a user clicks to go to a site from the webtop
toolbar. To change the image, click the image popout button at the right
of the field, then click Replace. Select an image file to replace the image
file. Note that you can add files to the Customization tool in the image
browser.
Toolbar - help Image Specifies the image that a user clicks to open the help from the webtop
icon toolbar. To change the image, click the image popout button at the right
of the field, then click Replace. Select an image file to replace the image
file. Note that you can add files to the Customization tool in the image
browser.

Full webtop popup window setting


You can add the company logo to the full webtop with this setting.

Name Value Description


Company logo Image Specifies the image for the company logo on the full webtop.
To change the image, click the image popout button at the right
of the field, then click Replace. Select an image file to replace

79
Personalizing Webtop Appearance Settings in General View

Name Value Description


the image file. Note that you can add files to the Customization
tool in the image browser.
Show Statistics on or off Specifies whether to display make a table with connection
Table statistics available for display on the full webtop.
Tray Icon Set null, F5, or Specifies the icon to display in the tray.
Generic

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

80
Chapter

10
Personalizing Images for Resources in Advanced View

What is resource image personalization?


Personalizing resource images
Personalizing Images for Resources in Advanced View

What is resource image personalization?


With image personalization, you can change the image displayed for a resource on the webtop.

Personalizing resource images


Personalize webtop resource images to provide customized icons on the full webtop for resources.
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 on the Branding tab, select the resource type folder for App Tunnels, Network Access,
Remote Desktops, Portal Access, or Webtop Links.
3. Select the resource name.
4. 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.
5. In the Image area, click the icon at the right of the field to show the current icon, then click Replace
and select a new image.
6. After you customize settings, click the Save icon at the top of the Customization tool.

82
Chapter

11
Localizing Messages and Images in General View

What is full and mobile browser localization?


Localizing messages for common access
profile settings
Localizing layout and content of the logon
page
Localizing layout and content of logout pages
Localizing error messages
Localizing logon pages
Localizing decision pages
Localizing message box pages
Localizing ending pages
Localizing Messages and Images in General View

What is full and mobile browser localization?


With localization, you can change the text and messages for web browsers and mobile clients for any
language defined in an access profile. The Customization tool provides a tree view that you can use to
navigate through the hierarchy of access profile items, in order to localize messages.

Localizing messages for common access profile settings


Localize common access profile pages to configure headers, footers, and standard warnings and text messages
for 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.

Localizing layout and content of the logon page


Customize the layout and content of components that appear on the logon page when the access policy is
starting by customizing the framework pages.

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

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 and click Framework Installation.
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 logon page elements.
6. After you customize settings, click the Save icon at the top of the Customization tool.

Framework installation settings


You can customize the following settings for general page style with the Customization tool.

Name Value Description


ActiveX install options Formatted Specifies the page text and links that prompt a user to install
screen HTML text a new ActiveX browser component. This screen appears for
Windows Internet Explorer users only.
Allow browser plugin Formatted Specifies the page text and links displayed when the user's
install screen HTML text browser does not currently allow software installation. This
page contains information about how to enable software
installation, and links to continue to install plug-ins or to
continue without installing the browser plug-ins.
Allow browser plugin Formatted Specifies the page text and links displayed when the user's
install screen (Linux) HTML text browser does not currently allow software installation. This
page contains information about how to enable software
installation, and links for continuing to install plug-ins or to
continue without installing the browser plug-ins. This screen
appears for Linux operating systems and browsers.
Browser plugin install Formatted Specifies the page text and links that prompt a user to install
with manual install HTML text a new browser plug-in component. This screen provides
options screen manual download and installation options. This screen appears
for most operating systems and browsers.
Browser plug-in install Formatted Specifies the page text and links that prompt a user to install
with manual install HTML text a new browser plug-in component. This screen provides
options screen (Linux) manual download and installation options. This screen appears
for Linux operating systems and browsers.
Java applet install Formatted Specifies the page text and links that appear when the
failure screen HTML text installation of software with a Java applet fails. This page
allows the user options to restart the session, download and
manually install the software, or continue without installing
software. This page appears only on non-Windows systems.
Java applet install Formatted Specifies the text that appears on a page with a Java applet to
screen HTML text install a new browser plugin. This page appears only on
non-Windows systems. Java applet install started screen on
Safari browser specifies the page text and links that appear
when the Java applet is installing software. This page appears
only on Macintosh systems with the Safari web browser.

85
Localizing Messages and Images in General View

Name Value Description


Java applet install Formatted Specifies the page text and links that appear when the Java
started screen HTML text applet is installing software. This page appears only on
non-Windows systems.

Endpoint security settings


You can customize the following settings for endpoint security messages that appear in web browsers and
on mobile devices with the Customization tool.

Name Value Description


Antivirus check message Text Specifies the message displayed while the antivirus check
action is checking the system.
Cache and session control Text Specifies the message displayed when the cache and session
ActiveX loading message control ActiveX control is loading and the user may be
prompted to allow cache and session control installation.
Cache and session control Text Specifies the text displayed when the client requires ActiveX
ActiveX missing message to start the cache and session control plug-in, and ActiveX
is not available or enabled.
Cache and session control Text Specifies the link text that the user clicks to continue when
continue link the cache and session control plug-in cannot load.
Cache and session control Text Specifies the message displayed when a popup blocker is
blocked popup message enabled. The message includes information on how to allow
popups from the BIG-IP device. Note: We recommend
that you use an HTML editor to edit the HTML code for
this box. The code appears unformatted and without line
breaks in the box.
Cache and session control Text Specifies the message displayed when the cache and session
failure message control plug-in fails to start. The message includes
information on possible causes. Note: We recommend that
you use an HTML editor to edit the HTML code for this
box. The code appears unformatted and without line breaks
in the box.
Cache and session control Text Specifies the text displayed while the cache and session
loading message control plug-in starts. Note: We recommend that you use
an HTML editor to edit the HTML code for this box. The
code appears unformatted and without line breaks in the
box.
Checking client message Text Specifies the message displayed when the system is
checking the client for an unspecified action.
Continue link Text Specifies the link text that the user clicks to continue after
opening a new browser window.
Continue without endpoint Text Specifies the messages displayed when client-side security
inspection message checks fail. You can specify link text to cancel and link text
to continue. The continue link allows the client to continue
on the fallback branch.
Downloading message Text Specifies the message displayed while the client is
(appended to other messages) downloading software components.

86
BIG-IP Access Policy Manager: Customization

Name Value Description


File check message Text Specifies the message displayed while the file check action
is checking the system.
Firewall check message Text Specifies the message displayed while the firewall check
action is checking the system.
Installing message (appended Text Specifies the message displayed while the client is installing
to other messages) software.
Machine check info message Text Specifies the message displayed when the client is collecting
machine info for the machine info check.
New browser window required Text Specifies the message displayed when browser settings have
message changed, and the user must open a new browser window to
continue.
Process check message Text Specifies the message displayed while the process check
action is checking the system.
Virtual keyboard hide Text Specifies the link text that the user clicks to hide the virtual
keyboard link keyboard.
Virtual keyboard label Text Specifies the label for the virtual keyboard.
Windows Group Policy action Text Specifies the message displayed while the Windows group
message policy action is configuring the system.
Windows Info check message Text Specifies the message displayed while the Windows
information check action is checking the system.
Windows machine certificate Text Specifies the message displayed while the Windows
check message machine certificate check action is checking the system.
Windows Protected Workspace Text Specifies the message displayed while the Protected
action message Workspace action is starting the protected workspace.
Windows Protected Workspace Text Specifies the link text specified that the user can click to
continue link continue without starting protected workspace.
Windows Protected Workspace Text Specifies the message displayed when the protected
continuing: extended message workspace starts, and the system requires some time to
display the protected workspace.
Windows Protected Workspace Text Specifies the message displayed on the client when protected
logon: short message workspace resumes the logon procedure after starting.
Windows Protected Workspace Text Specifies the message displayed when protected workspace
started: close browser message has successfully started,
Windows Registry check Text Specifies the message displayed while the registry check
message action is checking the system.

Localizing layout and content of logout pages


Customize the layout and content of components that appear on logout pages when the access policy or
user ends a session.
1. On the Main tab, click Access Policy > Customization > General.

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.

Logout component settings


You can customize the following settings for logout messages that appear in web browsers and on mobile
devices with the Customization tool.

Name Value Description


Access not found page reject Text Specifies the message displayed when the access policy
message cannot be completed correctly.
Access not found page title Text Specifies the title for the page displayed when the access
policy cannot be completed correctly.
ACL denied page reject Text Specifies the message displayed when the user attempts to
message access a page to which access is specifically denied by an
access control list.
ACL denied page return link Text Specifies the link text on the ACL Denied page that the user
message can click to return to the previous page.
ACL denied page title Text Specifies the title text on the ACL Denied page.
Error message Text Provides a more specific error message that follows the error
title, which indicates that a problem may have occurred
during access policy evaluation.
Error title Text Specifies text that indicates that the session could not start.
New session link Text Specifies the text label for the hypertext link to start a new
session, such as click here. This link follows the New session
text.
New session text Text Specifies text that precedes the link a user clicks to start a
new session.
Session expired message Text Specifies the message that appears when the user session
expires due to inactivity.
Session ID title Text Specifies the text that precedes the session number when an
error occurs.
Success message Text Specifies the text displayed when the user logs out
successfully.
Success title Text Specifies the text displayed when a session is finished.
Thank you message Text Specifies a thank you message displayed for network access
users after logout.

88
BIG-IP Access Policy Manager: Customization

Localizing error messages


Customize the error messages that appear when the client or browser encounters errors while processing
the login page or running access policy sessions.
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 > Error Messages > error_message_category.
4. At the top right of the Customization settings pane, select the Language for which to customize error
messages for full and mobile browsers.
5. Customize the settings for the error messages.
6. After you customize settings, click the Save icon at the top of the Customization tool.

General error settings


You can customize the following settings for general error messages that appear in web browsers and on
mobile devices with the Customization tool.

Name Value Description


Access denied by ACL Text Specifies the error displayed when an ACL entry denies
access.
Client IP address changed Text Specifies the error displayed if the client IP address changes
while the session is in progress.
Invalid Network Access Text Specifies the error displayed when the access profile cannot
resource find a valid Network Access resource.
Invalid Session ID Text Specifies the error displayed when the Session ID is not
correct. This may occur because the session has timed out.
Request error Text Specifies the error displayed when there is a malformed
request or there is another problem with a request.
Server in maintenance mode Text Specifies the error displayed when a session cannot start
because the server is performing maintenance.
Session ID is not found Text Specifies the error displayed when cookies are disabled, and
this causes the session ID to be unavailable in the request.
Stateful failover couldnt be Text Specifies the error displayed when the access policy has
supported changed and due to failover issues, the admin must log in
again.
System is not licensed Text Specifies the error displayed when a session cannot start
because the system is not licensed.
Terminated Session Text Specifies the error displayed when the session is terminated
by the server.

89
Localizing Messages and Images in General View

Name Value Description


Unsupported User-Agent Text Specifies the error displayed when the browser user agent is
not supported in the policy.
User limit reached Text Specifies the error displayed when the resource cannot be
assigned because the limit on the number of sessions has
been reached.

AAA error settings


You can customize the following settings for AAA error messages that appear in web browsers and on
mobile devices with the Customization tool.

Name Value Description


AD domain password change Text Specifies the text displayed when the attempt to change
failure the Active Directory password failed.
AD domain password change Text Specifies the text displayed when the attempt to change
failure with extended error the Active Directory password failed, and includes the
error message from the Active Directory component.
AD domain password expired Text Specifies the text displayed when the Active Directory
domain password has expired.
AD domain password expired Text Specifies the text displayed when the Active Directory
with extended error password has expired, and includes the error message
from the Active Directory component.
Incorrect AD username or Text Specifies the text displayed when the Active Directory
password with extended error user name or password is incorrect, and includes the error
message from the Active Directory component.
Incorrect LDAP username or Text Specifies the text displayed when the LDAP user name
password with extended error or password is incorrect, and includes the error message
from the LDAP component.
Incorrect OAM username or Text Specifies the text displayed when the OAM user name or
password with extended error password is incorrect, and includes the error message
from the OAM component.
Incorrect RADIUS username or Text Specifies the text displayed when the RADIUS user name
password with extended error or password is incorrect, and includes the error message
from the RADIUS component.
Incorrect username or password Text Specifies the text displayed when the user name or
password is incorrect.
OAM authentication error Text Specifies the text displayed when there is an OAM
authentication error.
OAM authorization error Text Specifies the text displayed when there is an OAM
authorization error.
OAM internal error Text Specifies the text displayed when there is an invalid setup
for the OAM server.
OAM SDK initialization error Text Specifies the text displayed when there is an OAM error
related to the F5 webgate and OAM SDK.

90
BIG-IP Access Policy Manager: Customization

Name Value Description


RADIUS challenge failure Text Specifies the text displayed when a RADIUS challenge
fails.
RADIUS challenge failure with Text Specifies the text displayed when a RADIUS challenge
extended error fails, and includes the error message from the RADIUS
component.
SecurID logon failure with retry Text Specifies the text displayed when the RSA SecurID logon
or password is incorrect.
SecurID logon failure with retry Text Specifies the text displayed when the RSA SecurID logon
with extended error or password is incorrect, and includes the error message
from the SecurID component.

Installation error settings


You can customize the following settings for installation error messages that appear in web browsers and
on mobile devices with the Customization tool.

Name Value Description


ActiveX is not allowed or Text Specifies the error displayed when the access policy
unsupported attempts to load an ActiveX control in Microsoft Internet
Explorer and ActiveX is not enabled.
Installation failure Text Specifies the error displayed when installation of a browser
component fails.

Resource error settings


You can customize the following settings for resource error messages that appear in web browsers and on
mobile devices with the Customization tool.

Name Value Description


ACL does not exist Text Specifies the error text displayed when the assigned ACL
does not exist.
Inconsistent host replacement Text Specifies the error text displayed when portal access
string resources configured in Minimal Patching mode contain
inconsistent host replace strings.
Incorrect resource assigned Text Specifies the error text displayed when a resource assign
(Network Access) action is configured to assign a portal access webtop with
a network access resource. Webtop and resource types must
match.
Incorrect resource assigned Text Specifies the error text displayed when a resource assign
(Portal Access) action is configured to assign a network access webtop with
a portal access resource.
Invalid Dynamic ACL Text Specifies the error text displayed when the dynamic ACL
Assignment is incorrectly assigned or configured.

91
Localizing Messages and Images in General View

Name Value Description


Invalid host for App Tunnel Text Specifies the error text displayed when a host that the app
resource tunnel attempts to start a connection to does not respond
correctly.
Invalid host for Remote Text Specifies the error text displayed when the host that a remote
Desktop resource desktop resource attempts to start a connection to does not
respond correctly.
Invalid Portal Access start URI Text Specifies the error text displayed when the portal access
webtop has an invalid start URI.
Invalid Static ACL assignment Text Specifies the error text displayed when a static ACL is not
configured correctly.
Missing Network Access Text Specifies the error text displayed when a network access
resource webtop is configured with no network access resource.
Webtop and resource types must match.
More than one Network Access Text Specifies the error text displayed when more than one
resource network access resource is assigned to an access policy
branch.
Network Access and Portal Text Specifies the error text displayed when both network access
Access resources assigned and portal accesss resources are assigned to an access policy
branch.
Portal Access resources have Text Specifies the error text displayed when multiple portal
inconsistent patching methods accesss are assigned to an access policy branch, with
different patching methods. All portal access resources
assigned to an access policy branch must use the same
patching method.
Resource does not exist Text Specifies the error text displayed when the assigned resource
does not exist.
Webtop does not exist Text Specifies the error text displayed when the assigned webtop
does not exist.
Webtop required Text Specifies the error text displayed when a webtop is required,
but not assigned.

Dynamic configuration error settings


You can customize the following settings for dynamic configuration error messages that appear in web
browsers and on mobile devices with the Customization tool.

Name Value Description


Invalid Dynamic ACL entries Text Specifies the text displayed when a dynamic ACL
contains invalid entries.

Other configuration error settings


You can customize the following settings for other errors that appear in web browsers and on mobile devices
with the Customization tool.

92
BIG-IP Access Policy Manager: Customization

Name Value Description


Unknown error Text Specifies the text displayed when an unknown error
occurs.

Localizing logon pages


Customize the messages that appear for a specific logon page or HTTP 401 response page in an access
policy.
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. To locate a logon page, in the left pane, expand the folders and navigate to Customization Settings >
Access Profiles > name_of_access_profile > Access Policy > Logon Pages.
4. Select the folder for the logon page or HTTP 401 response action.
5. Select the General settings.
6. At the top right of the Customization settings pane, select the Language for which to customize logon
pages.
7. Customize the settings for the logon pages.
8. After you customize settings, click the Save icon at the top of the Customization tool.

Logon page settings


You can customize the following settings for logon pages that appear in web browsers and on mobile devices
with the Customization tool.

Name Value Description


Form Header Text Text Specifies the text that appears at the top of the logon screen.
HTTP 401 Response Text Specifies the text displayed when an HTTP 401 authentication
error occurs.
Logon Button Text Specifies the text that appears on the logon button, which a
user clicks to post the defined logon agents.
Logon Page Input Field # Text These fields specify the text that is displayed on the logon
(1-5) page for each of the logon page agents, defined in the Logon
Page Agent screen area.
New Password Prompt Text Specifies the prompt displayed when a new Active Directory
password is requested.
Password and Password Text Specifies the prompt displayed to confirm the new password
Verification do not Match when a new Active Directory password is requested.
Save Password Checkbox Text Specifies the text that appears adjacent to the check box that
allows users to save their passwords in the logon form. This
field is used only in the secure access client, and not in the
web client.

93
Localizing Messages and Images in General View

Name Value Description


Verify Password Prompt Text Specifies the prompt displayed to confirm the new password
when a new Active Directory password is requested.

Localizing decision pages


Customize the messages that appear for decision pages.
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. To locate decision pages, in the left pane, expand the folders and navigate to Customization Settings >
Access Profiles > name_of_access_profile > Access Policy > Decision Pages.
4. Select the folder for the decision box page.
5. Click the General or Advanced Customization Images setting.
6. At the top right of the Customization settings pane, select the Language for which to customize decision
pages.
7. Customize the settings for the decision pages.
8. After you customize settings, click the Save icon at the top of the Customization tool.

General decision page settings


You can customize the following settings for decision pages that appear in web browsers and on mobile
devices with the Customization tool.

Name Value Description


Field 1 Image Image Specifies the image that appears in the first option field on the
decision page. Click the icon at the right of the field to view the
image. Click Replace to change the image.
Field 2 Image Image Specifies the image that appears in the second option field on the
decision page. Click the icon at the right of the field to view the
image. Click Replace to change the image.

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

94
BIG-IP Access Policy Manager: Customization

Localizing message box pages


Customize the message boxes that appear for message box pages.
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. To locate message box pages, in the left pane, expand the folders and navigate to Customization
Settings > Access Profiles > name_of_access_profile > Access Policy > Message Pages.
4. Select the folder for the message box page.
5. Click Advanced Customization Images.
6. At the top right of the Customization settings pane, select the Language for which to customize message
pages.
7. Customize the settings for the message box pages.
8. After you customize settings, click the Save icon at the top of the Customization tool.

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

Localizing ending pages


Customize the ending pages that appear in access policies.
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. To locate ending pages, in the left pane, expand the folders and navigate to Customization Settings >
Access Profiles > name_of_access_profile > Access Policy > Ending Pages.
4. Select the folder for the message box page.
5. Click Advanced Customization Images.
6. At the top right of the Customization settings pane, select the Language for which to customize ending
pages.
7. Customize the settings for the ending pages.

95
Localizing Messages and Images in General View

8. After you customize settings, click the Save icon at the top of the Customization tool.

Advanced customization image settings


You set advanced customization images to make images you add through the image browser available to
your advanced customization pages.
The Advanced Customization Images properties pages allow you to set advanced customization images
from the image browser to associate with advanced customization image names. You can then use the image
name to add an image to an advanced customization page.
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.

96
Chapter

12
Localizing Webtops in General View

What is webtop localization?


Localizing webtops
Localizing Webtops in General View

What is webtop localization?


You can customize webtop settings, including the messages displayed when starting and closing the
connection, and any error messages, for any language supported on the server. A webtop must be assigned
to an access profile to see and customize the webtop for the languages assigned to the access profile. If you
customize a webtop that is not assigned to any access profile, you can customize the default set of languages
only.

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.

Webtop form and message settings


You can customize the following settings for form and message settings that appear on webtops, in web
browsers and on mobile devices, with the Customization tool.

Name Value Description


App Tunnels conflict with Text Specifies the message that appears when an application
Network Access message tunnel is open and the user attempts to start a network access
tunnel.
Connected message Text Specifies the message displayed on the login screen when
the client is connected.

98
BIG-IP Access Policy Manager: Customization

Name Value Description


Connecting message Text Specifies the message displayed on the login screen when
the client is connecting.
Connection already established Text Specifies the message displayed when a connection is
error message already established.
Connection closed by server Text Specifies the error message displayed when an error occurs
error message on the server, and causes the session to fail. Check the log
files for more specific information.
Connection dropped error Text Specifies the message displayed when an error occurs, and
message the connection is dropped. Check the log files for more
specific information.
Connection failed to start error Text Specifies the message displayed when the connection cannot
message start. Check the log files for more specific information.
Connection to server could not Text Specifies the error message displayed when the client cannot
start error message make a connection to the server. Check the log files for
more specific information.
Disconnected due to Text Specifies the error displayed when a configuration error
configuration error message causes the session to stop and the client to be disconnected.
Disconnected message Text Specifies the message displayed on the login screen when
the client is disconnected.
Downloading progress bar Text Specifies the caption displayed above the progress bar when
(caption) client components are downloading.
F5 plug-in not installed or Text Specifies the error message displayed when the F5 plug-in
incompatible plug-in error is not installed or is incompatible with the current server.
message This error occurs on Macintoshand Linux clients only.
Failed message Text Specifies the message displayed on the login screen when
the connection fails.
Initialization message Text Specifies the message displayed on the login screen when
the login sequence is initializing.
Installation error pppd daemon Text Specifies the error message displayed when the pppd
not found in /usr/sbin directory daemon cannot start. This error occurs on Macintosh and
(mac/linux) Linux clients only.
Installation message Text Specifies the message displayed on the login screen when
the login sequence is installing software.
Loading message Text Specifies the message displayed on the login screen when
the login sequence is starting installed software.
Network Access client internal Text Specifies the message displayed when an internal client
error message error occurs and causes the network access session to fail.
Check the log files for more specific information.
Network Access conflict with Text Specifies the message that appears when a network access
App Tunnels message tunnel is open and the user attempts to start an app tunnel.
Plugin installation incomplete Text Specifies the message displayed when the F5 plugin is not
error message installed correctly. This error occurs on Linux clients only.
pppd daemon did not start Text Specifies the error message displayed when the pppd
error message (mac/linux) daemon cannot start. This error occurs on Macintosh and
Linux clients only.

99
Localizing Webtops in General View

Name Value Description


Queued message Text Specifies the message displayed on the login screen when
the client is queued to make a connection.
Reconnecting message Text Specifies the message displayed on the login screen when
the client is reconnecting.
Request local credentials during Text Specifies the code that creates a local credentials request
linux installation screen. This is required for Linux systems only. We
recommend that you edit this code in an HTML editor to
make the layout easier to view.

Note: Do not add manual line breaks to the webtop form;


this causes errors. Use the <br> tag to add a line break to
the code.

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.

BIG-IP Edge Client webtop settings


You can customize the following settings for the BIG-IP Edge Client webtop, in web browsers and on
mobile devices, with the Customization tool.

Name Value Description


Connection Established Text Specifies the message that appears in the BIG-IP Edge
notification Client when a connection is established.
Disconnected due to configuration Text Specifies the message displayed in the BIG-IP Edge
error notification Client when the connection is closed due to a
configuration error.
New BIG-IP Edge Client available Text Specifies the message displayed during connection, when
message a newer version of the BIG-IP Edge Client is available
from the server.
Routing table change causes Text Specifies the message displayed when a change in the
disconnect notification routing table on the client machine causes the client to
disconnect.

Settings for showing and hiding information on webtops


You can customize the following show and hide settings for the webtop, in web browsers and on mobile
devices, with the Customization tool.

Name Value Description


Disable logging link Text Specifies the link text to disable logging.

100
BIG-IP Access Policy Manager: Customization

Name Value Description


Enable logging link Text Specifies the link text to enable logging.
Hide label in table caption link Text Specifies the text on the webtop screen that the user
clicks to hide a table caption.
Show IP address configuration Text Specifies the text on the webtop screen that the user
link clicks to show the IP address configuration.
Show label in table caption link Text Specifies the text on the webtop screen that the user
clicks to show a table caption.
Show log file link Text Specifies the text on the secure access screen that the
user clicks to show the log file.
Show routing table link Text Specifies the text on the webtop screen that the user
clicks to show the routing table.
Status element Text Specifies the text on the webtop screen that heads the
status section.

Webtop logout and relaunch settings


You can customize the following settings for logout and relaunch messages that appear on webtops, in web
browsers and on mobile devices, with the Customization tool.

Name Value Description


Logout link Text Specifies the link text on the webtop screen that the user clicks
to log out.
Relaunch applications Text Specifies the link text on the webtop screen that the user clicks
link to restart the applications that are defined in the network access
launch applications section.

Webtop activity section setting


You can customize the following setting for the activity section.

Name Value Description


Activity section caption Text Specifies the caption for the section that shows client
and server activity.

Webtop new session settings


You can customize the following settings for new sessions on the webtop.

Name Value Description


New session link Text Specifies the link text on the webtop screen that the user
clicks to start a new session.
New session text Text Specifies the text that precedes the new session link.

101
Localizing Webtops in General View

Webtop web applications session timeout settings


You can localize the timeout settings for portal access applications that are displayed on the webtop.

Name Value Description


Header message (idle timeout) Text Specifies the message displayed when the idle timeout
is reached for a portal access session.
Header message (maximum Text Specifies the message displayed when the maximum
timeout) session time timeout is reached for a portal access
session.
Postfix text for 'remaining time' Text Specifies the text after the seconds display in the
message (idle timeout) remaining time warning for a portal access idle timeout.
Postfix text for 'remaining time' Text Specifies the text after the seconds display in the
message (maximum timeout) remaining time warning for a portal access maximum
session time timeout.
Postfix text for seconds in Text Specifies the text after the number of seconds remaining
'remaining time' message (idle when an idle timeout is reached.
timeout)
Postfix text for seconds in Text Specifies the text after the number of seconds remaining
'remaining time' message when a maximum session time timeout is reached.
(maximum timeout)
Prefix text for 'remaining time' Text Specifies the message displayed before the seconds and
message (idle timeout) postfix message display in the remaining time warning
for a portal access idle timeout.
Prefix text for 'remaining time' Text Specifies the text before the seconds and postfix
message (maximum timeout) message display in the remaining time warning for a
portal access maximum session time timeout.
Prefix text for seconds in 'remaining Text Specifies the text displayed before the number of
time' message (idle timeout) seconds remaining when an idle timeout is reached.
Prefix text for seconds in 'remaining Text Specifies the text displayed before the number of
time' message (maximum timeout) seconds remaining when a maximum session time
timeout is reached.
Text for 'disconnect' button Text Specifies the text on the button that the user clicks to
disconnect the session.
Text for 'disconnect' button tooltip Text Specifies the tooltip text for the button that the user
clicks to disconnect the session.
Text for 'stay connected' button Text Specifies the text on the button that the user clicks to
(idle timeout) stay connected to the session in the event of an idle
timeout.
Text for 'stay connected' button Text Specifies the text on the button that the user clicks to
(maximum timeout) stay connected to the session in the event of a maximum
session time timeout.
Text for 'stay connected' button Text Specifies the tooltip text for the button that the user
tooltip (idle timeout) clicks to stay connected to the session in the event of
an idle timeout.

102
BIG-IP Access Policy Manager: Customization

Name Value Description


Text for 'stay connected' button Text Specifies the tooltip text for the button that the user
tooltip (maximum timeout) clicks to stay connected to the session in the event of
a maximum session time timeout.

Webtop hometab settings


You can localize the timeout settings for portal access applications that are displayed on the webtop.

Name Value Description


Home image text Text Specifies the text for the home image on the hometab.
Home link text Text Specifies the text for the home link.
Postfix text for 'remaining time' Text Specifies the text after the seconds display in the
message (idle timeout) remaining time warning for a portal access idle timeout.
Postfix text for 'remaining time' Text Specifies the text after the seconds display in the
message (maximum timeout) remaining time warning for a portal access maximum
session time timeout.
Postfix text for seconds in Text Specifies the text after the number of seconds
'remaining time' message (idle remaining when an idle timeout is reached.
timeout)
Postfix text for seconds in Text Specifies the text after the number of seconds
'remaining time' message remaining when a maximum session time timeout is
(maximum timeout) reached.
Prefix text for 'remaining time' Text Specifies the message displayed before the seconds
message (idle timeout) and postfix message display in the remaining time
warning for a portal access idle timeout.
Prefix text for 'remaining time' Text Specifies the text before the seconds and postfix
message (maximum timeout) message display in the remaining time warning for a
portal access maximum session time timeout.
Prefix text for seconds in 'remaining Text Specifies the text displayed before the number of
time' message (idle timeout) seconds remaining when an idle timeout is reached.
Prefix text for seconds in 'remaining Text Specifies the text displayed before the number of
time' message (maximum timeout) seconds remaining when a maximum session time
timeout is reached.
Text for 'disconnect' button Text Specifies the text on the button that the user clicks to
disconnect the session.
Text for 'disconnect' button tooltip Text Specifies the tooltip text for the button that the user
clicks to disconnect the session.
Text for 'stay connected' button Text Specifies the text on the button that the user clicks to
(idle timeout) stay connected to the session in the event of an idle
timeout.
Text for 'stay connected' button Text Specifies the text on the button that the user clicks to
(maximum timeout) stay connected to the session in the event of a
maximum session time timeout.

103
Localizing Webtops in General View

Name Value Description


Text for 'stay connected' button Text Specifies the tooltip text for the button that the user
tooltip (idle timeout) clicks to stay connected to the session in the event of
an idle timeout.
Text for 'stay connected' button Text Specifies the tooltip text for the button that the user
tooltip (maximum timeout) clicks to stay connected to the session in the event of
a maximum session time timeout.

Full webtop settings


You can localize particular messages and links for full webtops.

Name Value Description


Applications and links Text Specifies the header text for the applications and links
section on the full webtop.
Empty URL input message Text Specifies the text in the empty URL field on the full
webtop.
Header message Text Specifies the header message for the full webtop.
Help window contents Text/HTML Specifies the help text in the help window. Click the
edit button to the right of this field to see the full text.
Help window contents header Text Specifies the header for the Help window.
Network access Text Specifies the text for the network access section.
Toolbar - help Text Specifies the help link text on the toolbar.

Full webtop popup window settings


You can localize particular messages and links for full webtops.

Name Value Description


Action label Text Specifies the label for the action section on the webtop
popup.
Application Name label Text Specifies the label for the application name section on
the webtop popup.
Application Tunnels label Text Specifies the label for the application tunnels section on
the webtop popup.
Connected to message Text Specifies the text for the tunnel or resource the user is
connected to, on the webtop popup.
Logged in as message Text Specifies the label for the user name that the user is
logged in as on the webtop popup.
Network access label Text Specifies the label for the network access section.
Optimized Applications label Text Specifies the label for the optimized applications section.
Page title Text Specifies the page title for the popup window.

104
BIG-IP Access Policy Manager: Customization

Name Value Description


Status label Text Specifies the text for the status label on the popup
window.
Summary label Text Specifies the text for the label for the summary section
on the popup window.
Terminate All Tunnels button Text Specifies the text for the button to stop all tunnel
connections.
Terminate button Text Specifies the text for the Terminate button for a specific
connection.
Terminate NA Tunnels button Text Specifies the text for the button to stop the network
access connection.
Total Traffic label Text Specifies the label for the total traffic display.
Traffic compression label Text Specifies the label for the traffic compression display.
Traffic label Text Specifies the label for the traffic display.
Traffic Received label Text Specifies the label for received traffic section.
Traffic Received label Text Specifies the label for received traffic section.
Traffic Sent label Text Specifies the label for sent traffic section.
Traffic Type label Text Specifies the label for the traffic type section.
View label Text Specifies the label for the view section.
Warning before closing popup Text Specifies the warning that appears before closing the
popup window and closing all connections.
Warning when user navigated Text Specifies the warning that appears when the user attempts
from Webtop to navigate away from the webtop and close connections.
Warning when Webtop closed Text Specifies the warning when the webtop popup is closed
and connections are to be closed.

Full webtop Citrix logon form settings


You can localize settings for the Citrix logon form on the webtop.

Name Value Description


Cancel button text Text Specifies the text for the cancel button on the Citrix
logon form.
Domain label Text Specifies the label for the domain field on the Citrix
logon form.
Logon button text Text Specifies the text on the logon button on the Citrix
logon form.
Logon form caption Text Specifies the text for the Citrix logon form caption.
Logon form caption when logon Text Specifies the text to display when Citrix logon fails.
fails
Message to show to the user when Text Specifies the text to display when the Citrix connection
connection to Citrix server fails fails, and a retry or cancel option is presented.

105
Localizing Webtops in General View

Name Value Description


Message to show to the user when Text Specifies the text to display when the logon to the
logon to Citrix server fails Citrix server fails, and a retry or cancel option is
presented.
Password label Text Specifies the label for the password field.
Try again button text Text Specifies the text for the retry button when the Citrix
logon or connection fails.
Username label Text Specifies the text for the label for the username field.

Full webtop Citrix installer settings


You can localize settings for the Citrix installer on the webtop.

Name Value Description


Citrix client not detected caption Text Specifies the caption when the Citrix client is not
detected by the installer.
Citrix client not detected Text Specifies the message when the Citrix client is not
message detected by the installer, and provide instructions to
download the installer.
Citrix client not up-to-date Text Specifies the text when a newer Citrix client is available
caption for download.
Citrix client not up-to-date Text Specifies the message when a newer Citrix client is
message available for download, and provides instructions to
download an updated client.
Download button text Text Specifies the label on the download button.
Skip installation button text Text Specifies the label on the button to skip installation.

Full webtop Citrix browser setting


You can localize settings for the Citrix browser on the webtop.

Name Value Description


Close browser Text Specifies the text to close the Citrix browser.

106
Chapter

13
Localizing Captions for Resources in General View

What is resource caption localization?


Localizing captions
Localizing Captions for Resources in General View

What is resource caption localization?


With caption localization, you can change the caption and description for resources on the webtop.

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

About Advanced Customization view


Changing Customized Properties in Advanced View

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 View


Edit files in Advanced View to configure settings not easily set in General View.
1. On the Main tab, click Access Policy > 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 or Webtops.
3. Navigate through the folder hierarchy to find the file you want to edit, and click it.
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.

Properties for access profiles in Advanced View


You can customize the following files for access profiles in Advanced View.

Files Location Description


apm_edge.css Customization Settings > Access The CSS that controls the look and feel
Profiles > access_profile > for BIG-IP Edge Client pages.
Common
header.inc Customization Settings > Access Specifies the page header content for
Profiles > access_profile > access profile pages on all devices.
Common
apm_mobile_ppc.css Customization Settings > Access The CSS that controls the look and feel
Profiles > access_profile > for pages on a PocketPC device.
Common
javascript_disabled.inc Customization Settings > Access The layout for the page that appears
Profiles > access_profile > when JavaScript is disabled on the
Common client.
apm_mobile.css Customization Settings > Access The layout properties for access policy
Profiles > access_profile > pages on any mobile device that is not
Common a PocketPC.

110
BIG-IP Access Policy Manager: Customization

Files Location Description


apm_full.css Customization Settings > Access The CSS and PHP code that controls
Profiles > access_profile > the look and feel for pages on a web
Common browser.
footer.inc Customization Settings > Access The include that specifies the footer text
Profiles > access_profile > line.
Common
apm.css Customization Settings > Access The PHP code that determines the CSS
Profiles > access_profile > file that is used with a particular
Common browser or device.
access_notfound.inc Customization Settings > Access The HTML, JavaScript, and PHP code
Profiles > access_profile > Logout that presents a page when access is not
granted.
logout.inc Customization Settings > Access The HTML, JavaScript, and PHP code
Profiles > access_profile > Logout that presents a page when the user logs
out. The file includes several options
for different logout reasons.
my.acl.inc Customization Settings > Access The HTML, JavaScript, and PHP code
Profiles > access_profile > Logout that presents a page when the access to
a page is denied for one of several
reasons, including by an ACL.
http_401.inc Customization Settings > Access The page that appears when and HTTP
Profiles > access_profile > Access 401 error (unauthorized) occurs.
Policy > Logon Pages > logon_page
logon.inc Customization Settings > Access A PHP file that specifies the layout and
Profiles > access_profile > Access items that appear on the logon page.
Policy > Logon Pages > logon_page
decision_box.inc Customization Settings > Access Specifies the layout for the HTML that
Profiles > access_profile > Access appears in a decision box.
Policy > Decision Pages >
decision_box

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

Properties for webtops in Advanced View


You can customize the following files for webtops in Advanced View.

Files Location Description


webtop_popup.css Customization Settings > The CSS that controls the look and feel for the
Webtops > webtop webtop popup screen.
desktopClass.js.inc Customization Settings > The JavaScript code that specifies how the
Webtops > webtop webtop page is dynamically created.
webtop_help.inc Customization Settings > The HTML code on the webtop page that
Webtops > webtop provides the link to the webtop help page.
hometab.inc Customization Settings > The JavaScript code that controls the look and
Webtops > webtop feel for the Home tab.

112
Chapter

15
Customizing the APM logon page

Overview: Customizing the logon page


Customizing the APM logon page

Overview: Customizing the logon page


Using the Customization tool, you can personalize your logon page with your organization's brand images
and colors, and change the layout of the logon page screen. In this implementation, you change a header
logo image on the logon page.

Customizing a logo on the logon screen


Customization is a trial-and-error process. For practice, you should create a new virtual server and access
policy in Access Policy Manager (APM) before you start customizing your logon page.
With the Customization tool, you can personalize and localize page layout, colors, images, and messages
for the BIG-IP APM browser pages.
1. In your web browser address bar, type the IP address of the BIG-IP system with which you are working.
The BIG-IP system logon page opens.
2. Right-click the logon page.
The browser shortcut menu opens.
3. Click Inspect Element.
The Inspect Element option might appear as a different name in different browsers (such as, View
Source).
A screen displaying the HTML code of the web page opens.
4. Hover your cursor over a line of HTML code.
You can see the exact HTML code that matches the icons, text, entry fields, and buttons that appear on
the GUI. The tag ID displays the type of the object on the GUI, such as a header or a banner.
5. On the logon page, in the Username and Password fields, type your user name and password, and click
Log in.
6. On the Main tab, click Access Policy > Customization > General.
The Customization tool appears in General Customization view, displaying Form Factor: Full/Mobile
Browser settings.
7. In the left pane, expand the folders and navigate to Access Profiles > Common >
access_profile_name > Common, then click Page Header Settings.
The access profile for your configuration is unique. You can select the access profile that is relevant to
the BIG-IP system. For other items in the Configuration utility besides the page header, use the HTML
code to determine the correct tab and the access policy in the Customization screen.
The Page Header Settings display.
8. For the Header left image (Full Size) setting, click the file path of the image in the Value column, and
in the resulting field, type the file path of the new image that you want to add.
9. Click the Save button.
10. On the Main tab, click Access Policy > Access Profiles.
The Access Profiles List screen opens.
11. Select the check box for the access policy that you customized.
12. Click Apply Access Policy.
13. Click Log Out.
The logon page opens.

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

CSS files (continued) error messages (continued)


for webtops 112 localizing other error messages 92
CSS sprites image localizing resource error messages 91
setting 74 other error settings 92
customization resource settings 91
editing in Advanced Customization view 110
editing in the Advanced Customization view 3233
for BIG-IP Edge Client 60
F
for full and mobile browsers 66 fonts
for logon page 26, 29 settings for access profiles 21, 67
form factors 1417, 50 form
for webtops 74 settings for access profiles 23, 69
of logon page 114 form and message settings
overview 14, 114 localizing for webtops 98
Customization form appearance
114 settings for access profiles 24, 69
tool 26, 50 form cell
customization templates illustration 21
downloading 48 form element settings
Customization tool illustration 25
starting 50 form factors
customized pages for customization 1417, 50
preview 6162, 66, 72 form settings
customizing illustration 24
basic settings 54 framework
by editing files 110 localizing 84, 87
customizing decision box pages 71 settings 85
customizing ending pages 71 full and mobile browser
customizing message box pages 71 branding for access policy items 71
full webtop
D appearance settings 79
Citrix browser setting 106
decision box pages Citrix installer settings 106
customizing appearance 71 Citrix logon settings 105
localizing 94 company logo 79
decision pages localize settings 104
localizing 94 popup window settings 104
localizing in access policy 94 full webtops
settings in access policy 94 localizing images 82
localizing resource captions 108
E
G
Edge Client
localizing webtop settings 100 general page style
webtop settings 100 illustration 20
ending pages
customizing appearance 71
localizing 95
H
endpoint security hide
localizing messages 86 localizing webtop settings 100
settings 86 webtop settings 100
error messages hometab
AAA settings 90 configuration settings 76
dynamic configuration settings 92
general settings 89
installation settings 91 I
localizing 89
image
localizing AAA error messages 90
adding a company logo 79
localizing dynamic configuration error messages 92
adding to access policy page 37
localizing general errors 89
adding to page 41
localizing in access profiles 89
adding to profile 41
localizing installation error messages 91

116
Index

image (continued) logon page (continued)


settings for access profiles 23, 68 overview 114
image00 personalizing 26
about 35 settings in access policy 28, 93
image browser logon pages
adding images 3839, 4143, 60 localizing 93
image cell logout
illustration 21 customizing 70
images webtop settings 101
adding with the image browser 3839, 4143, 60 logout page
localizing for webtops 98 localizing layout and content 87
logout pages
localizing messages 88
J settings 88
JavaScript files
for access profiles 3335, 110 M
for webtops 112
message box pages
customizing appearance 71
L localizing 95
language messages
access profile localization 14 localizing 71
for access profile objects 14 localizing for common pages 84
for resource objects 14 mobile browser
resource object localization 14 personalizing 29
selected for display 14
layout N
settings for access profiles 21, 68
localization network access
about 14 basic settings 56
customizing for BIG-IP Edge Client 62, 71 new sessions
for access policy items 71 webtop settings 101
for BIG-IP Edge Client 62, 72
for common pages 84
for resource captions 108
P
for webtops 98 page alignment
language choices 14 illustrated 20
of decision pages 94 page footers
of ending pages 95 settings for access profiles 23, 68
of error messages 89 page headers
of logon page 84 settings for access profiles 22, 67
of logon pages 93 page layout
of loout page 87 illustration 21
of message box pages 95 pages
localizing images localizing in access profiles 84, 87
for webtops 98, 108 page width
localizing messages illustrated 20
for full and mobile browsers 84 personalization
for webtops 98, 108 for resource images 82
login form personalizing
personalizing 23, 69 images for resources 82
login form appearance personalizing images
personalizing 24, 69 for webtops 82
login pages PHP files
customizing appearance 71 for access profiles 3335, 110
logo for webtops 112
customizing 114 portal access
logon page basic settings 58
customizing 114 timeout settings 102103
customizing logo 114 portal access hometab
localizing in access policy 28, 93 configuration settings 76
localizing layout and content 84

117
Index

portal access timeout U


configuration settings 75
preview customization changes 6162, 66, 72 UI template
role of advanced customization 16
Q
V
quick start
54 views
access profile customization settings 54 Basic 54
app tunnel customization settings 55 for customization 1417, 50
network access customization settings 56
portal access customization settings 58
remote desktop customization settings 56
W
using for customization 54 web applications
webtop common customization settings 57 timeout settings 102103
webtop link customization settings 57 web browsers
customizing access profile logout 70
R webtop
activity setting 101
relaunch appearance settings 79
webtop settings 101 basic settings 57
remote desktop connectivity status icons 74
basic settings 56 CSS sprites image 74
resource objects 14 form settings 98
full webtop Citrix browser setting 106
full webtop Citrix installer settings 106
S full webtop Citrix settings 105
show full webtop popup settings 104
localizing webtop settings 100 full webtop settings 104
webtop settings 100 logout settings 101
starting the Customization tool 50 message settings 98
new session settings 101
portal access hometab settings 76
T portal access session timeout settings 102103
portal access timeout settings 75
the advanced customization view
relaunch settings 101
files for access profiles 33
settings for BIG-IP Edge Client 100
the Advanced Customization view
showing information settings 100
editing CSS 3233
webtop customization 82
editing JavaScript 3233
webtop cuztomization 98, 108
editing PHP 3233
webtop link
timeout
basic settings 57
webtop settings 102103
webtops
timeout window
customizing appearance 74
configuration settings 75
localizing 98
tool
personalizing 74
for customization 26, 50

118

S-ar putea să vă placă și