8 Customizing OAAM Web Application Pages

The OAAM Server Web application provides an interface that can be easily tailored for your company look and feel to use with Oracle Adaptive Access Manager. This chapter explains how to configure and deploy the OAAM Server Web application to support one or more Web application authentication and user registration flows. This chapter provides the following sections:

This chapter contains the following sections:

• Tips for Customizing the OAAM Web Application Pages

• OAAM Properties

• Customizing the OAAM Server for Multiple Applications

• Customizing the Appearance of OAAM Server Pages

• Enabling and Disabling the Single Login Page

• Changing the Invalid Characters Check on the Login Page

• Questions/Answers About User Interface Customizations

8.1 Tips for Customizing the OAAM Web Application Pages

As you plan to customize the web user interface, keep the following points in mind:

• When customizing, back up files so that they may be used when the software is upgraded.

• When configuring the web application, use oaam_custom.properties. The file should contain:

  • Client-configured properties (any properties that have been customized for a specific deployment)

  • UIO Proxy system /device configurations. These properties deal with the structural changes in the overall application. It is where the header, footer, and CSS properties are located.

  In the deployed application, the oaam_custom.properties file is located in the web-inf/classes directory.

  Note:

  In 11.1.2, the oaam_custom.properties file replaces the bharosa_server.properties file from previous versions.

• When adapting the OAAM deployment to a particular language, use client_resource_locale.properties where locale is the locale string for which you want to use the custom values (en, es, and others). The client_resource_locale.properties file is used to customize text on the pages when the application is translated into many languages. The file should contain

  • Client-configured properties that are configurable for each locale being supported. locale is the locale string for which you want to use the custom values (en, es, and others).

  • UIO Proxy messaging and page content configuration. For example, page titles, links at the bottom of the pages, page messages, error message, and confirmation messages.

  Note:

  The client_resource_locale.properties file is not used for header and footer files customization.

  The administrator creates the client_resource_locale.properties file to customize the application so that it contains locale-specific properties.

For instructions on customizing, extending, or overriding Oracle Adaptive Access Manager properties, see Chapter 7, "Using the OAAM Extensions Shared Library to Customize OAAM."

8.2 OAAM Properties

You can manage the appearance and behavior of OAAM using user-defined enumerations. User-defined enumerations are a collection of properties that represent a list of items. Each element in the list may contain several different attributes. The definition of a user-defined enum begins with a property ending in the keyword ".enum" and has a value describing the use of the user-defined enum. Each element definition then starts with the same property name as the enum, and adds on an element name and has a value of a unique integer as an ID. The attributes of the element follow the same pattern, beginning with the property name of the element, followed by the attribute name, with the appropriate value for that attribute.

8.2.1 Enum Example

The following is an example of an enum defining credentials displayed on the login screen of an OAAM Server implementation:

bharosa.uio.default.credentials.enum = Enum for Login Credentials
bharosa.uio.default.credentials.enum.companyid=0
bharosa.uio.default.credentials.enum.companyid.name=CompanyID
bharosa.uio.default.credentials.enum.companyid.description=Company ID
bharosa.uio.default.credentials.enum.companyid.inputname=comapanyid
bharosa.uio.default.credentials.enum.companyid.maxlength=24
bharosa.uio.default.credentials.enum.companyid.order=0
bharosa.uio.default.credentials.enum.username=1
bharosa.uio.default.credentials.enum.username.name=Username
bharosa.uio.default.credentials.enum.username.description=Username
bharosa.uio.default.credentials.enum.username.inputname=userid
bharosa.uio.default.credentials.enum.username.maxlength=18
bharosa.uio.default.credentials.enum.username.order=1

This set of properties defines one user-defined enum that contains two elements, each of which with five attributes. The name and description attributes are required to define any user-defined enum, other attributes are defined and used as needed by each individual use of a user-defined enum.

8.2.2 Overriding Existing User-Defined Enums

Overriding existing user-defined enums has some special cases. You may override any existing enum element's attribute value of the default application ID just as you would any other property, but to change the value of an element's attribute in a single application using an appId, you must create the entire enum in that application using the appropriate appId.

For example, using the user defined enum defined in Section 8.2, "OAAM Properties," if you wanted to change Company ID to Profile ID for only one application (appId1), you would need to modify the enum:

bharosa.uio.appId1.credentials.enum = Enum for Login Credentials
bharosa.uio.appId1.credentials.enum.profileid=0
bharosa.uio.appId1.credentials.enum.profileid.name=ProfileID
bharosa.uio.appId1.credentials.enum.profileid.description=Profile ID
bharosa.uio.appId1.credentials.enum.profileid.inputname=profileid
bharosa.uio.appId1.credentials.enum.profileid.maxlength=20
bharosa.uio.appId1.credentials.enum.profileid.order=0
bharosa.uio.appId1.credentials.enum.username=1
bharosa.uio.appId1.credentials.enum.username.name=Username
bharosa.uio.appId1.credentials.enum.username.description=Username
bharosa.uio.appId1.credentials.enum.username.inputname=userid
bharosa.uio.appId1.credentials.enum.username.maxlength=18
bharosa.uio.appId1.credentials.enum.username.order=1

For instructions on customizing, extending, or overriding Oracle Adaptive Access Manager properties or enums, see Chapter 7, "Using the OAAM Extensions Shared Library to Customize OAAM."

8.2.3 Disabling Elements

To disable any already defined element in a user-defined enum, simply add an enabled attribute with a value of false. Using the appId1 credentials enum from Section 8.2.2, "Overriding Existing User-Defined Enums," you would add the following line to remove Profile ID from the elements used by the application:

bharosa.uio.appId1.credentials.enum.profileid.enabled=false

8.3 Customizing the OAAM Server for Multiple Applications

Multitenancy refers to a principle in software architecture where a single instance of the software runs on a server, serving multiple client organizations. With a multitenant architecture, each client organization feels as if they are working with a separate customized application instance.

You can configure the OAAM Server to support one or more Web application authentication and user registration flows. The OAAM Server configuration is specific to the UIO Proxy deployment. The OAAM UIO Proxy offers multifactor authentication to Web applications without requiring any change to the application code.

The OAAM Server proxy intercepts the HTTP traffic between the client (browser) and the server (Web application) and performs appropriate actions, such as redirecting to OAAM Server, to provide multifactor authentication and authorization. OAAM Server in turn communicates with OAAM Admin to determines the risk and takes the appropriate actions, such as permitting the login, challenging the user, blocking the user, and other actions.

Figure 8-1 Universal Installation Deployment

The UIO Proxy can be placed in front of multiple applications and customized to work with each one as required.

8.3.1 Determining the Application ID

To ensure that a customer's data is unique from that of other customers, an Application ID for the client application is mapped to an Organization ID. An Organization ID identifies what tenant applications a user utilizes.

Determine how many applications are to be configured and assign each application an Application ID. This Application ID is the same one used to configure the Proxy (see Chapter 6, "Oracle Adaptive Access Manager Proxy"). In many cases applications are referred to internally by some name or abbreviation, so an integrator configuring OAAM Server might want to use that name. For an example, if the client has two applications, one wholesale banking application and one retail banking application, the integrator might choose to use wholesale and retail as the Application IDs for the two applications.

This Application ID is the same one used to configure the Proxy (see Chapter 6, "Oracle Adaptive Access Manager Proxy").

The Proxy will send the AppId to OAAM Server as needed through an HTTP header. This AppId is then used to determine which configuration is used when displaying pages to the client. OAAM Server is configured by a set of properties which will be discussed in more detail later.

Properties can contain an AppId to allow for multiple configurations for multi-tenant scenarios.

The following example shows how to use the AppId to define a property in the OAAM server:

bharosa.uio.appId1.default.user.group=app1Group

The bold appId1 is in the location in the property where you use the AppId to configure application specific values.

8.3.2 Determining Default User Groups

You can configure each application to have a unique default user group. This is the group that a user of that application will be associated with as their Organization ID when the user is first created in the Oracle Adaptive Access Manager database. The Organization ID is used when a user attempts to log in to the application and user data is loaded from the database.

An example of how Organization ID is used in a property definition is shown as follows:

bharosa.uio.appId1.default.user.group=app1Group
bharosa.uio.appId2.default.user.group=app2Group

In the example, two Organization IDs are defined to two different applications. The application with an AppId of appId 1 has been assigned the Organization ID of app1Group and the application with an AppId of appId2 has been assigned the Organization ID of app2Group.

8.3.3 Configuring OAAM Server Application Properties

An application in OAAM Server is made up of a grouping or set of properties. You can configure OAAM Server properties on a global or application specific level.

OAAM Server property names are prefixed with bharosa.uio. They are followed by the Application ID or default if the setting is global.

Property definitions that start with bharosa.uio.default apply to all Application IDs unless overridden by a more specific value.

In the following example, default is used instead of the appId to designate the property as a global default. The property is used across all applications of the OAAM Server installation unless a specific application has another location specified.

bharosa.uio.default.header = /globalcustomHeader.jsp
bharosa.uio.default.footer = /globalcustomFooter.jsp

The default properties for the path to the custom header and footer are:

bharosa.uio.default.header = path_to_custom_header.jsp
bharosa.uio.default.footer = path_to_custom_footer.jsp

An application-level property is one that only effects a single application when there are more than one application defined in the properties.

In Oracle Adaptive Access Manager and Access Manager integrations, the AppId is oam. This allows OAAM to display a different header and footer that keeps the same look and feel as Access Manager pages.

The properties for the path to the Access Management custom header and footer are:

bharosa.uio.oam.header = path_to_custom_header.jsp
bharosa.uio.oam.footer = path_to_custom_footer.jsp

These specific prefix bharosa.uio.oam value overrides the default settings defined as bharosa.uio.default.

In the following example, app1 uses an application-level defined header and footer file, but app2 uses an application-level defined footer but a global or default defined header file.

bharosa.uio.default.header = /globalcustomHeader.jsp
bharosa.uio.default.footer = /globalcustomFooter.jsp
bharosa.uio.app1.header = /app1customHeader.jsp
bharosa.uio.app1.footer = /app1customFooter.jsp
bharosa.uio.app2.footer = /app2customFooter.jsp

8.3.4 Configuring OAAM Server Properties Several Applications Have In Common

In addition to configuring properties for each application, you can configure a set of properties that several applications have in common. You can then extend that set to customize the parameters that differ between the set of applications.

If you were to configure three applications that all use a single footer, but each has a unique header, you can include the following properties:

bharosa.uio.myAppGroup.footer = /myAppGroup/customFooter.jsp
 
bharosa.uio.appId1.extends=myAppGroup
bharosa.uio.appId1.header=/client/app1/customHeader.jsp
 
bharosa.uio.appId2.extends=myAppGroup
bharosa.uio.appId2.header==/client/app2/customHeader.jsp
 
bharosa.uio.appId3.extends=myAppGroup
bharosa.uio.appId3.header==/client/app3/customHeader.jsp

8.4 Customizing the Appearance of OAAM Server Pages

This section describes how to customize the appearance of the OAAM server pages.

The user interface branding is customized in several ways.

• Custom header / footer files

• Custom CSS file

• Custom properties for page content and messaging

8.4.1 Customizing Headers and Footers in User Interface Branding

You can create custom header and footer files for the applications being secured. The header and footer files are JSP files and can contain any HTML or JSP code required to replicate the look of the application being secured.

1. Create a work folder called oaam_extensions. (The folder can be created anywhere if it is outside the installation folder.)

2. Locate oracle.oaam.extensions.war in the following directory:

   IAM_Home/oaam/oaam_extensions/generic
   

3. Extract oracle.oaam.extensions.war in the oaam_extensions folder.

4. In the oaam_extensions folder, create the following subfolders:

   /client/app1/
   /client/app1/images/
   

5. Create a customHeader.jsp and customFooter.jsp inside the client/app1/ folder.

   The header (customHeader.jsp) and footer (customFooter.jsp) files should contain only content HTML, all page related tags (<html>, <head>, <body>, and so on) are already provided by OAAM Server.

   As a simple example, a header and footer are created that contain a single image each, to be used as the header and footer of an application called "appId1".

   Copy the following code into customHeader.jsp for the header.

   /client/app1/customHeader.jsp
        <img src="client/app1/images/customHeader.jpg" alt="Welcome to App1"/>
   

   Copy the following code into customFooter.jsp for the footer.

   /client/app1/customFooter.jsp
        <img src="client/app1/images/customFooter.jpg" alt="App1 Footer"/>
   

   These files will be deployed in the "/client/app1/" directory within the Web application.

6. Add associated files to the client/app1 folder as needed.

   For example, the customHeader.jpg and customFooter.jpg image files referenced by customHeader.jsp and customFooter.jsp.

   /client/app1/images/customHeader.jpg
   /client/app1/images/customFooter.jpg
   

7. Open the oaam_custom.properties file in the WEB-INF/classes/bharosa_properties directory of the oracle.oaam.extensions.war file.

8. To associate these header and footer files with the application, add the following properties to oaam_custom.properties and save it to oaam_extensions/WEB-INF/classes/bharosa_properties.

   bharosa.uio.appId1.header = /client/app1/customHeader.jsp
   bharosa.uio.appId1.footer = /client/app1/customFooter.jsp
   

9. Repackage oracle.oaam.extensions.war from the parent folder of oaam_extensions using the command:

   jar -cvfm oracle.oaam.extensions.war oaam_extensions/
   META-INF\MANIFEST.MF -C  oaam_extensions/ .
   

   Note:

   Note that there is a dot at the end of the command.

   This command recreates the WAR file with the MANIFEST.MF file. The new JSP files, referenced images, and added properties in oaam_custom.properties are included in the new WAR file.

10. Shut down the OAAM Admin and OAAM Server managed servers.

11. Start the WebLogic Server where Oracle Adaptive Access Manager is deployed and log in to the WebLogic Administration Console.

12. Navigate to Domain Environment > Deployments and lock the console.

13. Click the Install button.

14. Browse to the location of the oracle.oaam.extensions.war file and select it by clicking the radio button next to the .war file and clicking Next.

15. Ensure Install this deployment as a library is selected and click Next.

16. Select OAAM Admin and OAAM Server servers as deployment targets.

17. Click Next again to accept the defaults in this next page and then click Finish.

18. Click the Save button and then Activate Changes.

19. Start the OAAM Admin and OAAM Server managed servers.

8.4.2 Modifying User Interface Styles

For example, to override the font-family of the default body style definition:

1. Create a work folder called oaam_extensions.

   The folder can be created anywhere if it is outside the installation folder.

2. Locate oracle.oaam.extensions.war, which is located in the IAM_Home/oaam/oaam_extensions/generic directory.

3. Explode oracle.oaam.extensions.war into the oaam_extensions folder.

4. Create the client/app1/css directory.

5. Create an app1.css file.

6. Add the following code to the app1.css file.

   body{
       background-color:#ffffff;
       font-size:12px;
       color:#000000;
       font-family:arial,helvetica,sans-serif;
       margin:0px 0px 0px 0px
   }
   

7. Change Helvetica to the primary font-family you want to use for your appId1 application.

8. Add the file to the /client/app1/css directory.

9. Open the oaam_custom.properties file in the WEB-INF/classes/bharosa_properties directory of the oracle.oaam.extensions.war file.

10. To use the newly created file, set the following property in oaam_custom.properties:

    bharosa.uio.appId1.custom.css=/client/app1/css/app1.css
    

11. Repackage oracle.oaam.extensions.war from the parent folder of oaam_extensions using the command:

    jar -cvfm oracle.oaam.extensions.war oaam_extensions/META-INF/MANIFEST.MF -C  oaam_extensions/ .
    

12. Shut down the OAAM Admin and OAAM Server managed servers.

13. Start the WebLogic Server where Oracle Adaptive Access Manager is deployed and log in to the Oracle WebLogic Administration Console.

14. Navigate to Domain Environment > Deployments and lock the console.

15. Click the Install button.

16. Browse to the location of the oracle.oaam.extensions.war file and select it by clicking the option next to the WAR file and clicking Next.

17. Ensure Install this deployment as a library is selected and click Next.

18. Select OAAM Admin and OAAM Server servers as deployment targets.

19. Click Next again to accept the defaults in this next page and then click Finish.

20. Click the Save button and then Activate Changes.

21. Start the OAAM Admin and OAAM Server managed servers.

Any style defined in the oaam_uio.css in the OAAM Server ear file can be overridden in this manner if required.

8.4.3 Customizing Content and Messaging

You can customize content and messaging of the OAAM server pages by adding properties to the client_resource_locale.properties file.

Some customizable items, like page title and message, are applicable for each page. While other items, like login blocked message, are specific to a particular page.

To customize content and messaging:

1. Create a work folder called oaam_extensions. (The folder can be created anywhere if it is outside the installation folder.)

2. Locate oracle.oaam.extensions.war, which is located in the IAM_Home/oaam/oaam_extensions/generic directory.

3. Explode oracle.oaam.extensions.war into the oaam_extensions folder.

4. Create a client_resource_locale.properties file in oaam_extensions\WEB-INF\classes.

5. Add the customized message to this file.

   For example, to change the page title on the login page for the appId1 application, add the following line to client_resource_locale.properties:

   bharosa.uio.appId1.signon.page.title=Welcome to App1, please sign in. 
   

   For example, to customize the error message displayed when a user has been blocked by security rules, add the following line to client_resource_locale.properties:

   bharosa.uio.appId1.login.user.blocked = You are not authorized to login. Please contact customer service at 1-888-555-1234.
   

6. Repackage oracle.oaam.extensions.war from the parent folder of oaam_extensions using the command:

   jar -cvfm oracle.oaam.extensions.war oaam_extensions/META-INF/MANIFEST.MF -C  oaam_extensions/ .
   

7. Shut down all managed servers.

8. Start the WebLogic Server where Oracle Adaptive Access Manager is deployed and log in to the Oracle WebLogic Administration Console.

9. Navigate to Domain Environment > Deployments and lock the console.

10. Click the Install button.

11. Browse to the location of the oracle.oaam.extensions.war file and select it by clicking the option next to the WAR file and clicking Next.

12. Ensure Install this deployment as a library is selected and click Next.

13. Select OAAM Admin and OAAM Server servers as deployment targets.

14. Click Next again to accept the defaults in this next page and then click Finish.

15. Click the Save button and then Activate Changes.

16. Start the OAAM Admin and OAAM Server managed servers.

8.4.4 Customizing the OAAM Server Pages

Areas of the resource bundles you can use to override the page directions and the virtual authentication device text (if desired) are as follows:

# Username Page

bharosa.uio.default.signon.page.title=Sign In:
bharosa.uio.default.signon.page.message=Enter your user name.

# Password Page

bharosa.uio.default.password.page.title=Sign In:
bharosa.uio.default.password.page.message=
   Use this security device to enter your password.
bharosa.uio.default.password.page.DeviceHTMLControl.message=Enter your password.
bharosa.uio.default.password.page.DeviceKeyPadFull.message=
   Please use this secure KeyPad to enter your password.
bharosa.uio.default.password.page.DeviceKeyPadAlpha.message=
   Please use this secure KeyPad to enter your password.
bharosa.uio.default.password.page.DeviceTextPad.message=
   Please use this secure TextPad to enter your password.
bharosa.uio.default.password.page.DevicePinPad.message=
   Please use this secure PinPad to enter your PIN.

### KeyPad Description and Directions

bharosa.authentipad.keypad.accessibility.directions =     
KeyPad directions: Use the following links to enter your password.
Your personalized caption text comes first,
followed by control links, which are then followed by the key links.
Once you have entered your password, use shift-tab to return 
to the enter link to submit your password.

bharosa.authentipad.keypad.security.image.alt = Security Device Image
bharosa.authentipad.keypad.datafield.label=Password
bharosa.authentipad.keypad.enterkey.label=enter

### PinPad Description and Directions

bharosa.authentipad.pinpad.accessibility.directions =
PinPad directions: Use the following links to enter your numeric pin.
Your personalized caption text comes first, followed by control links,
which are then followed by the numeric links.
Once you have entered your numeric pin,
use shift-tab to return to the enter link to submit your pin.

bharosa.authentipad.pinpad.security.image.alt = Security Device Image
bharosa.authentipad.pinpad.datafield.label=Pin
bharosa.authentipad.pinpad.enterkey.label=enter

### TextPad Description and Directions

bharosa.authentipad.textpad.accessibility.directions =
TextPad directions: Use the following items to validate your device.
Your personalized caption text comes first,
followed by a timestamp to ensure the device was generated for this session.
Once you have entered your password in the previous password entry field,
use tab to navigate to the enter link to submit your password.

bharosa.authentipad.textpad.security.image.alt = Security Device Image
bharosa.authentipad.textpad.datafield.label=Password
bharosa.authentipad.textpad.enterkey.label=enter

### TextPadReset Description and Directions

bharosa.authentipad.textpadreset.accessibility.directions = 
TextPad directions:
Use the following items to enter your new password.
Your personalized caption text comes first,
followed by a password input field and password confirmation field.
Once you have entered your password, use tab to navigate to the enter link
to submit your new password.

bharosa.authentipad.textpadreset.security.image.alt = Security Device Image
bharosa.authentipad.textpadreset.datafield.label=Password
bharosa.authentipad.textpadreset.confirmfield.label=Confirm Password
bharosa.authentipad.textpadreset.enterkey.label=enter

### CaptionPad Description and Directions

bharosa.authentipad.captionpad.accessibility.directions =  
CaptionPad directions: 
Use the following items to enter your new caption text.
Control links come first, followed by a text input field.
Once you have entered your caption, use tab to navigate to the enter link
to submit your new caption.

bharosa.authentipad.captionpad.security.image.alt = Security Device Image
bharosa.authentipad.captionpad.datafield.label=Security Phrase
bharosa.authentipad.captionpad.enterkey.label=enter

### CaptionPadConfirm Description and Directions

bharosa.authentipad.captionconfirmpad.accessibility.directions = 
CaptionConfirmPad directions: Use the following items to review your caption text.
To edit your caption text, tab to the Edit link and press Enter.
bharosa.authentipad.captionconfirmpad.security.image.alt = Security Device Image
bharosa.authentipad.captionconfirmpad.datafield.label=Security Phrase
bharosa.authentipad.captionconfirmpad.enterkey.label=enter

### QuestionPad Description and Directions

bharosa.authentipad.questionpad.accessibility.directions = 
QuestionPad directions: Use the following items to enter your answer.  
Your personalized question comes first, followed by your personalized caption,
which is then followed by your answer input field.  Once you have entered 
your answer, use tab to navigate to the enter link to submit your answer.
bharosa.authentipad.questionpad.security.image.alt = Security Device Image
bharosa.authentipad.questionpad.datafield.label=Answer
bharosa.authentipad.questionpad.enterkey.label=enter

8.4.5 Customizing the Text in the OAAM Login Page

You can override the page directions and the virtual authentication device text (if desired) in the resource bundles.

Add these customizations using OAAM Extensions Shared Library. For information on customizations, see Chapter 7, "Using the OAAM Extensions Shared Library to Customize OAAM."

Username Page

Table 8-1 User Name Page Properties

Property	Default Value	Description	Property Must Be In File
bharosa.uio.default.signon.page.title	Sign In:	Title for default User name page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.signon.page.message	Enter your user name.	Message for User Name page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.username.label	UserName	Change the user name label on the OAAM Login page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.credentials.enum.username.name	UserName	Change the user name label on the OAAM Login page.	oaam_custom.properties and client_resource_<locale>.properties

Password Page

Table 8-2 Password Page Properties

Property	Default Value	Description	Property Must Be In File
bharosa.uio.default.password.page.title	Sign In:	Title for default password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.message	Use this security device to enter your password.	Message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.message	Use this security device to enter your password.	Message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.DeviceHTMLControl.message	Enter your password.	Device HTMO message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.DeviceKeyPadFull.message	Please use this secure KeyPad to enter your password.	KeyPad message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.DeviceKeyPadAlpha.message	Please use this secure KeyPad to enter your password.	alphanumeric KeyPad (numbers and letters only, no special characters) message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.DeviceTextPad.message	Please use this secure TextPad to enter your password.	TextPad message for Password page	oaam_custom.properties and client_resource_<locale>.properties
bharosa.uio.default.password.page.DevicePinPad.message	Please use this secure PinPad to enter your PIN.	PinPad message for Password page	oaam_custom.properties and client_resource_<locale>.properties

KeyPad Description and Directions

Table 8-3 KeyPad Description and Direction Properties

Property	Default Value	Description	Property Must Be In File
bharosa.authentipad.keypad.accessibility.directions	KeyPad directions: Use the following links to enter your password. Your personalized caption text comes first, followed by control links, which are then followed by the key links. Once you have entered your password, use shift-tab to return to the enter link to submit your password.	KeyPad directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.keypad.security.image.alt	Security Device Image	KeyPad Authenticator background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.keypad.datafield.label	Password	Password label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.keypad.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties

PinPad Description and Directions

Table 8-4 KeyPad Description and Direction Properties

Property	Default Value	Description	Property Must Be In File
bharosa.authentipad.pinpad.accessibility.directions	PinPad directions: Use the following links to enter your numeric pin. Your personalized caption text comes first, followed by control links, which are then followed by the numeric links. Once you have entered your numeric pin, use shift-tab to return to the enter link to submit your pin.	PinPad directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.pinpad.security.image.alt	Security Device Image	PinPad Authenticator background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.pinpad.datafield.label	PIN	PIN label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.pinpad.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties

TextPad Description and Directions

Table 8-5 TextPad Description and Direction Properties

Property	Default Value	Description	Property Must Be In File
bharosa.authentipad.textpad.accessibility.directions	TextPad directions: Use the following items to validate your device. Your personalized caption text comes first, followed by a timestamp to ensure the device was generated for this session. Once you have entered your password in the previous password entry field, use tab to navigate to the enter link to submit your password.	TextPad directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpad.security.image.alt	Security Device Image	TextPad Authenticator background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpad.datafield.label	Password	Password label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpad.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpadreset.accessibility.directions	TextPad directions: Use the following items to enter your new password. Your personalized caption text comes first, followed by a password input field and password confirmation field. Once you have entered your password, use tab to navigate to the enter link to submit your new password.	TextPad reset directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpadreset.security.image.alt	Security Device Image	TextPad authenticator reset background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpadreset.datafield.label	Password	Password label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.textpadreset.confirmfield.label	Confirm Password	Confirm Password label.
bharosa.authentipad.textpadreset.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties

CaptionPad Description and Directions

Table 8-6 CaptionPad Description and Direction Properties

Property	Default Value	Description	Property Must Be In File
bharosa.authentipad.captionpad.accessibility.directions	CaptionPad directions: Use the following items to enter your new caption text. Control links come first, followed by a text input field. Once you have entered your caption, use tab to navigate to the enter link to submit your new caption.	CaptionPad directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionpad.security.image.alt	Security Device Image	CaptionPad Authenticator background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionpad.datafield.label	Security Phrase	Security Phrase label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionpad.enterkey.label=enter	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionconfirmpad.accessibility.directions	CaptionConfirmPad directions: Use the following items to review your caption text. To edit your caption text, tab to the Edit link and press Enter.	CaptionPad confirm directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionconfirmpad.security.image.alt	Security Device Image	CaptionPad authenticator confirm background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionconfirmpad.datafield.label	Security Phrase	Security Phrase	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.captionconfirmpad.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties

QuestionPad Description and Directions

Table 8-7 KeyPad Description and Direction Properties

Property	Default Value	Description	Property Must Be In File
bharosa.authentipad.questionpad.accessibility.directions	QuestionPad directions: Use the following items to enter your answer. Your personalized question comes first, followed by your personalized caption, which is then followed by your answer input field. Once you have entered your answer, use tab to navigate to the enter link to submit your answer.	QuestionPad directions	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.questionpad.security.image.alt	Security Device Image	QuestionPad Authenticator background graphic	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.questionpad.datafield.label	Answer	Answer label.	oaam_custom.properties and client_resource_<locale>.properties
bharosa.authentipad.questionpad.enterkey.label	Enter	Enter	oaam_custom.properties and client_resource_<locale>.properties

8.5 Enabling and Disabling the Single Login Page

If you want to enable or disable the option to use a single login page, set the following property to true or false:

bharosa.uio.default.signon.links.enum.wherepassword.enabled

8.6 Changing the Invalid Characters Check on the Login Page

To add characters to the invalid characters check on the Login page, add the following property to the client_resource.properties (or client_resource_en.properties) file.

bharosa.uio.default.signon.loginid.regexp=/[^\\s\\\\\\<\\>]/gi

Then add your characters to the property. Afterwards, add the file to the OAAM Extension Library Jar file.

8.7 Questions/Answers About User Interface Customizations

• Question: I have added the following entries to oaam_custom.properties in the OAAM extensions shared library:

  bharosa.uio.default.header = /customHeader.jsp
  bharosa.uio.default.footer = /customFooter.jsp
  

  OAAM server is picking up the default header and footer and not the one I specified in the extensions library.

  Answer: The custom header / footer files should have a unique name as OAAM Server pulls from the web application first. For example, customHeader.jsp and customFooter.jsp.

• Question: Why is the OAAM Server not picking up the css changes in OAAM extensions shared library?

  Answer: The property bharosa.uio.default.custom.css should be set to a css file that is added to the extensions library. That css file can override any existing CSS definitions in the base application (defined by oaam_uio.css).

  For example, if you want to move the username and password text and OTP pads to the center of the screen, you must set bharosa.uio.default.custom.css = CSS_file_name_and_path and add the custom CSS file to the OAAM extensions shared library.

• Question: How do struts_config_extension.xml and tiles-def-extension.xml work in customizations?

  Answer: The OAAM extensions shared library has a struts-config-extension.xml and tiles-def-extension.xml in the WEB-INF folder. Any values added to these will augment or override the ones already defined by struts-config.xml and tiles-def.xml in the application.

  For example, to use a customized JSP file (customUserPreferences.jsp) for the base file (userPreferences.jsp), add the following to tiles-def-extension.xml:

  <definition name="userPreferences" extends="bharosa.uio.baseLayout">
     <put name="body" value="/customUserPreferences.jsp"/> 
  </definition> 
  

• Question: How do I change the login page completely?

  Answer: You must set oaam.uio.login.page=custom_login_page and add the file to the OAAM extensions shared library. You would need to update the struts-config-extension.xml contained in the OAAM extensions shared library to override the "login" outcome. Replace oaamLoginPage.jsp with the custom filename.

  <action path="/entry" type="com.bharosa.uio.actions.EntryAction">
        <forward name="login" path="/oaamLoginPage.jsp" />
  </action>