Branding the PC-Based Subscriber Portal

C H A P T E R 1

This chapter describes how to brand the PC version of the Subscriber Portal component of Sun Java System Content Delivery Server. You can change any or all of the files described in the following table to make the Subscriber Portal interface more closely conform to your corporate image.

TABLE 1-1 Subscriber Portal Files
File	Description
`$CDS_HOME/deployment/`deployment-name`/.../tpl/_tpl_main.jsp`¹	Banner and footer for each page
`$CDS_HOME/deployment/`deployment-name`/localization/SubscriberPortalLocaleResource.properties`	Strings used for the title and other text elements
`$CDS_HOME/deployment/`deployment-name`/.../static/media/t0-banner.gif`¹	Graphic used for the logo
`$CDS_HOME/deployment/`deployment-name`/dynamic_banner/modelloggedin.html`	Home page shown to subscribers who have specified a device and are logged in
`$CDS_HOME/deployment/`deployment-name`/dynamic_banner/modelnotloggedin.html`	Home page shown to subscribers who have specified a device, but are not logged in
`$CDS_HOME/deployment/`deployment-name`/dynamic_banner/nomodelnotloggedin.html`	Home page shown to subscribers who have not specified a device and are not logged in
`$CDS_HOME/deployment/`deployment-name`/.../styles/subscriber.cs`s¹	Style sheet used for basic colors and fonts
`$CDS_HOME/deployment/`deployment-name`/.../layouts/default/user_agreement.html`¹	User license agreement
¹The directory path differs depending on the application server that you are using: If you are using Sun Java System Application Server, Subscriber Portal files are in the `$CDS_HOME/deployment/`deployment-name`/sun/domains/`server-domain`/applications/j2ee-modules/CDSSubscriberPortal` directory. If you are using WebLogic Server, Subscriber Portal files are in the `$CDS_HOME/deployment/`deployment-name`/weblogic/domains/`server-domain`/applications/subscriber` directory. deployment-name is the name specified when the Vending Manager was deployed. server-domain is the value specified in the deployment configuration file for the `app.server.domain` property.

Tip - The files listed in TABLE 1-1 are used to present the pages of the Subscriber Portal. Changes are displayed when a page is refreshed. You might want to edit copies of the files, then replace the original files with the changed files after you are sure there are no errors.

This section presents the following topics:

Changing the Banner

Adding a Footer

Changing the Title

Changing Text

Changing the Main Region

Changing Buttons

Changing Basic Colors and Fonts

Providing a User License Agreement

To make changes to the version of the Subscriber Portal that subscribers access from their mobile devices, see Chapter 2. To replace the Subscriber Portal with your own subscriber interface, see information on the Subscriber API in the Sun Java System Content Delivery Server Customization Guide.

1.1 Changing the Banner

The banner is a graphic that is displayed at the top of each page. The default banner is a blue bar with the words “Wireless, Inc.” To change the banner, follow these steps:

1. Open $CDS_HOME/deployment/deployment-name/.../tpl/_tpl_main.jsp.

2. Search for the string wireless.inc-masthead.gif and replace it with the name of the image file that you want to use.

If the image is not localized, use the image path variable img_url. If the image is localized, use the image path variable localized_image_url. The following code example shows the path for an image that is localized.

<td width="377" height="87">
  <img src="<%=img_url%>/wireless.inc-masthead.gif" width="283" height="45">
</td>

3. Save your changes.

4. Store the image.

If the new image is not localized, store the image in the $CDS_HOME/deployment/deployment-name/.../static/media directory. If the image is localized, store the image in the directory specified for the localized.path.image_url property in each language-specific SubscriberPortalLocaleResource.properties file.

1.2 Adding a Footer

The footer is text or graphics that appear at the bottom of each page. The default footer is blank. To add a footer, follow these steps:

1. Edit $CDS_HOME/deployment/deployment-name/.../tpl/_tpl_main.jsp.

2. Search for the statement .

3. Add the text or images that you want to appear at the bottom of each page in the second column of this row in the table.

If an image is not localized, use the image path variable img_url. If an image is localized, use the image path variable localized_image_url. The following example shows the path for images that are not localized.

<tr> <!-- BEGIN 3rd Row -->
<td width="1" height="24" bgcolor="#cccccc"><img src=
    "<%=img_url%>/v3_pixel.gif" width="1" height="24" alt="" border="0"></td>
<td colspan="5" height="24">sample copyright statement; all rights reserved
</td>
<td width="1" height="24" bgcolor="#cccccc"><img src=
    "<%=img_url%>/v3_pixel.gif" width="1" height="24" alt="" border="0"></td>
</tr>

4. Store the image.

If an image is not localized, store the image in the $CDS_HOME/deployment/deployment-name/.../static/media directory. If an image is localized, store the image in the directory specified for the localized.path.image_url property in each language-specific SubscriberPortalLocaleResource.properties file.

1.3 Changing the Title

To change the title of the main page, edit the $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file. Replace the value of the desktop.common.applicationTitle property with the title that you require, for example:

desktop.common.applicationTitle=Test Subscriber Portal

If you have locale-specific resource files, set the property in each file.

1.4 Changing Text

The text shown on the pages of the Subscriber Portal is read from the $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file. To change messages or the labels for the fields, edit the strings in this file. The properties used for the PC-based Subscriber Portal are prefixed with desktop, for example, desktop.common.applicationTitle.

If you have locale-specific resource files, edit the strings in the files for the locales that you use.

1.5 Changing the Main Region

Modify the following files in the $CDS_HOME/deployment/deployment-name/dynamic_banner directory to change what is presented to the subscriber on the home page:

modelloggedin.html - Page shown to subscribers who are logged in to the Subscriber Portal and have specified a device

modelnotloggedin.html - Page displayed to subscribers who have selected a device, but have not yet logged in

nomodelnotloggedin.html - Page displayed to subscribers who have not selected a device and have not logged in

To change the pages, for each file follow these steps:

1. Edit the file and replace the body of the table with valid HTML statements to create the page that you want.

Keep the following points in mind while editing the table:

Do not remove the <table> and </table> statements.

Any text or image that you include must not be wider than 375 pixels.

To reference a file in the $CDS_HOME/deployment/deployment_name/dynamic_banner directory, use BANNER_ROOT, for example, <img src="BANNER_ROOT/home1.gif">

2. When you complete your changes, save the file.

The new version of the file is used the next time the page is referenced by a subscriber.

Note - Improper handling of tables by some browsers could result in text and images overlapping when a table is used to display text next to an image. Refreshing the image usually corrects the problem.

The pages can also be presented in different languages:

1. Copy each of the files and add the language code to the name.

For example, for a version of a file in French, create a file named modelloggedin_fr.html.

2. Make the changes that you want to each file.

3. Edit each language-specific $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file and set the following properties to the names of the new files:

desktop.dynamicBanner.model_logged_in

desktop.dynamicBanner.model_not_logged_in

desktop.dynamicBanner.no_model_not_logged_in

1.6 Changing Buttons

Buttons on the Subscriber Portal that are localized, such as Log In and Search, are images in the $CDS_HOME/deployment/deployment-name/.../static/media/language-code directories. You can replace these buttons with images of your choice by replacing the existing files. To provide these buttons in a different language, see Section 4.1.3, Providing Localized Templates and Images.

The following table describes the buttons and their associated images.

TABLE 1-2 Subscriber Portal Localized Buttons
Button	File Name	Size in Pixels (Width x Height)
Cancel	`cancel.gif`	60 x 18
Done	`done.gif`	60 x 18
Down	`MoveDown.gif`	60 x 18
Download	`download.gif`	60 x 18
Edit	`edit.gif`	60 x 18
Forgot Your Password?	`forgetYourPassword.gif`	120 x 18
Log in	`login.gif`	60 x 18
Log off	`logOff.gif`	60 x 18
Message	`message.gif`	60 x 18
No	`no.gif`	60 x 18
OK	`ok.gif`	60 x 18
Purchase	`purchase.gif`	60 x 18
Redeem Coupon	`redeemCoupon.gif`	100 x 18
Reset	`reset.gif`	60 x 18
Return to Catalog	`returnToCatalog.gif`	110 x 18
Search	`search.gif`	60 x 18
Send	`send.gif`	60 x 18
Sign Up	`signUp.gif`	60 x 18
Up	`MoveUp.gif`	60 x 18
Update	`update.gif`	60 x 18
Update User Profile	`updateUserProfile.gif`	110 x 18
User Profile	`userProfile.gif`	75 x 18
Yes	`yes.gif`	60 x 18

Buttons on the Subscriber Portal that are not localized, such as arrow buttons, are images in the $CDS_HOME/deployment/deployment-name/.../static/media/common directory. You can replace these buttons with images of your choice. The following table describes the buttons and their associated images.

TABLE 1-3 Subscriber Portal Buttons Not Localized
Button	File Name	Size in Pixels (Width x Height)
Add a category (>)	`Add.gif`	60 x 18
Add all categories (>>)	`AddAll.gif`	60 x 18
Edit	`edit_1.gif`	20 x 20
Go to first page (\|<)	`pagination_first.gif`	23 x 20
Go to last page (>\|)	`pagination_last.gif`	23 x 20
Go to next page (>)	`pagination_next.gif`	23 x 20
Go to previous page (<)	`pagination_prev.gif`	23 x 20
Remove a category (<)	`Remove.gif`	60 x 18
Remove all categories (<<)	`RemoveAll.gif`	60 x 18

1.7 Changing Basic Colors and Fonts

To simplify branding, the layout of the Subscriber Portal is controlled by a style sheet, $CDS_HOME/deployment/deployment-name/.../styles/subscriber.css. Background and font colors are defined in the style sheet. Edit the style sheet to change the colors and fonts for the Subscriber Portal. Use any text editor to edit this file.

1.8 Providing a User License Agreement

The Subscriber Portal provides a placeholder for a license agreement that you can provide to specify the terms and conditions that users must accept to access and download content from your server. Replace the placeholder with your license agreement using one of the following methods:

Replace the $CDS_HOME/deployment/deployment-name/.../layouts/default/user_agreement.html file with your own file of the same name.

Point the Subscriber Portal to a different file.

If you choose to provide a different file, edit the $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file and set the value of the desktop.fileInclude.userAgreement property to the location of your license agreement, for example:

desktop.fileInclude.userAgreement=/legal/cds/terms-conditions.html

The default text for the link to the license agreement is “Wireless, Inc User Agreement.” To change the text for the link, follow these steps:

1. Open the $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file.

2. Replace the value of the desktop.signup.agreementLink property with the string that you require, for example:

desktop.signup.agreementLink=Terms and Conditions

3. Save the file.