C H A P T E R  18

Portal Configuration

The portals or interface components of Content Delivery Server are the Developer Portal, Subscriber Portal, Catalog Manager administration console, and the Vending Manager administration console. Content Delivery Server provides a number of properties that you can set to configure these interfaces to meet your needs. Each interface has its own file that contains the properties for that interface. A common file contains properties that apply to all interfaces.

Many configuration properties are described in other sections of this guide. This chapter provides information on some of the available properties that are not described in other sections.

This chapter includes the following topics:


18.1 Setting the Common Properties

The following table describes properties in the $CDS_HOME/deployment/deployment-name/conf/CommonConsole.properties file that you can modify to meet the needs of your system. These properties apply to all of the Content Delivery Server interfaces.


TABLE 18-1 Properties in the CommonConsole.properties File

Property

Description

catalog.categories.max

Maximum number of levels in the category hierarchy for both the Catalog Manager and the Vending Manager. For example, a value of 3 indicates that the main category can have subcategories and the subcategories can have subcategories. The default is 10.

handset.default.maximum.application.size

Default size in bytes that is used as the maximum application size when a device is defined without specifying a value for this device attribute. The default is 64000.

handset.default.maximum.content.size

Default size in bytes that is used as the maximum size for static content when a device is defined without specifying a value for this device attribute. The default is 100000.

web.common.upload_max_size

Size in megabytes of the largest file that Content Delivery Server accepts. This size applies to all files submitted to Content Delivery Server, including submission packages and libraries. The default is 10.



18.2 Setting the Developer Portal Properties

The following table describes properties in the $CDS_HOME/deployment/deployment-name/conf/DeveloperPortal.properties file that you can modify to meet the needs of your system. These properties apply only to the Developer Portal.


TABLE 18-2 Properties in the DeveloperPortal.properties File

Property

Description

developer.pagination.display.max

Maximum number of items displayed per page in the Developer Portal. The default is 20.

developer.pagination.display.threshold

Number of items that must appear on a page before the list navigation bar is repeated at the bottom of the page. If fewer items than the number specified are available, the list navigation bar appears only at the top of the page. The default is 15.

external.content.minimum_refresh_period

Minimum amount of time in milliseconds that Content Delivery Server waits before rechecking external content for updates. The default is 3600000.



18.3 Setting the Subscriber Portal Properties

The following table describes properties in the$CDS_HOME/deployment/deployment-name/conf/SubscriberPortal.properties file that you can modify to meet the needs of your system. These properties apply only to the Subscriber Portal.


TABLE 18-3 Properties in the SubscriberPortal.properties File

Property

Description

autoCreate.newDevice

Enables an unknown device used by a subscriber to be added automatically to the Content Delivery Server database with information from the HTTP headers.

Set this property to true to allow unknown devices to be added to the database automatically when used by a subscriber. Set to false to prevent devices from being added automatically.

autoCreate.newUser

Enables subscriber accounts to be created automatically in the Content Delivery Server database when an unregistered subscriber accesses the Subscriber Portal from a device. Whether the new subscriber is added to your subscriber database is dependent on the settings for the auto_provision.unknown.user properties.

Set this property to true to create subscriber accounts in the Content Delivery Server database. Set to false to prevent the creation of new subscriber accounts.

autoLogin.mobileId.enable

Enables device login based on URL parameters instead of a user name and password. Automatic login based on mobile ID depends on information in the headers passed by the WAP gateway.

Set this property to true to enable automatic login based on mobile ID. Set to false to disable automatic login.

autoLogin.subscriberId.enable

Enables device login based on URL parameters instead of a user name and password. Automatic login based on Subscriber ID looks for the subId parameter in the URL. This option is appropriate primarily for demonstration systems.

Set this property to true to enable automatic login based on subscriber ID. Set to false to disable automatic login.

autoLogin.uniqueId.enable

Enables device login based on URL parameters instead of a user name and password. Automatic login based on unique ID depends on information in the headers passed by the WAP gateway.

Set this property to true to enable automatic login based on unique ID. Set to false to disable automatic login.

autoLogin.username.enable

Enables device login based on URL parameters instead of a user name and password. Automatic login based on user name looks for the user parameter in the URL. This option is appropriate primarily for demonstration systems.

Set this property to true to enable automatic login based on user name. Set to false to disable automatic login.

default.pushType

Specifies the default type of push message.

Specify the default type of push message to send. Valid values are sms and wap. The corresponding property, either wap.push.enable or sms.push.enable, must also be set to true.

descriptor.contentType.encoding.device-id

Specifies the type of encoding for content type that is supported by the device identified by device-id in each property. To specify the default type of encoding, use 0 as the device ID.

Set this property to the default character set encoding string to be included in the Content-Type HTTP header when downloading the Java Application Descriptor (JAD) file, for example, ISO-8859-1. If the device cannot handle the inclusion of the character set in the Content-Type header, set the property to none.

Note - To get the ID for a specific device, place your mouse over the model name in the Device Management page in the Catalog Manager administration console. The ID is contained in the command shown in the status area of your browser.

descriptor.outputStream.encoding.device-id

Specifies the type of encoding for the output stream that is supported by the device identified by device-id in each property. To specify the default type of encoding, use 0 as the device ID.

Set this property to the type of encoding used for the output stream, for example, ISO-8859-1.

Note - To get the ID for a specific device, place your mouse over the model name in the Device Management page in the Catalog Manager administration console. The ID is contained in the command shown in the status area of your browser.

desktop.confirmPurchase

Specifies if a confirmation page is shown when content is purchased from the PC-based Subscriber Portal. Set this property to true to show a confirmation page. Set to false not show a confirmation page.

desktop.display.numberOfItemsInContentList

Specifies the number of items displayed for a search or browse result. If more items are available than are shown, navigation options are provided to view the entire result set. The default is 20.

desktop.display.numberOfItemsInMyCampaigns

Specifies the number of items displayed for the subscriber’s My Campaigns list. The most recent items added are displayed. If more items are available than are shown, a link is provided to view all items. Set to -1 to display all items. The default is 5.

desktop.display.numberOfItemsInMyGiftsReceived

Specifies the number of items. displayed when subscribers view the gifts they have received. The default is 5.

desktop.display.numberOfItemsInMyGiftsSent

Specifies the number of items. displayed when subscribers view the gifts they have sent. The default is 5.

desktop.display.numberOfItemsInMyPurchases

Specifies the number of items displayed for the subscriber’s My Downloads list. The most recent items downloaded are displayed. If more items are available than are shown, a link is provided to view all items. Set to -1 to display all items. The default is 5.

desktop.display.numberOfItemsInMyWishlist

Specifies the number of items displayed for the subscriber’s My Wish List. The most recent items added are displayed. If more items are available than are shown, a link is provided to view all items. Set to -1 to display all items. The default is 5.

desktop.signup.disable_link

Prevents an unknown subscriber from accessing the signup page on the desktop portal and registering for services.

Set this property to true to disable the link to the signup page. Set to false to enable the link.

desktop.signup.hide_link

Prevents an unknown subscriber from accessing the signup page on the desktop portal and registering for services.

Set this property to true to hide the link to the signup page. Set to false to show the link.

device.confirmPurchase

Specifies if subscribers must agree to a defined set of terms and conditions before each purchase.

Set this property to true include a “Terms and Conditions” page in the purchase process. Set to false to not include a “Terms and Conditions” page.

device.display.no_or_items_per_page

Specifies the number of items that are displayed in the content list on the device-based Subscriber Portal. The default is 5.

display.price.my_downloads

Specifies if the current price or the purchase price is shown when a subscriber views the content details from the My Downloads list. Also specifies if the current configuration of a bundle is shown or if the configuration at the time of purchase is shown.

Set this property to retail to show the current price and configuration of bundles. Set to purchase to show the price and bundle configuration at the time of purchase.

display.price.navigation

Specifies if the current price or the purchase price is shown when a subscriber views the content details from the Select Content page. Also specifies if the current configuration of a bundle is shown or if the configuration at the time of purchase is shown.

Set this property to retail to show all subscribers the current price and the current configuration of bundles. Set to purchase to show the price and bundle configuration at the time the subscriber purchased the content or bundle.

dynamic_banner.default.path

Specifies the path of the dynamic HTML that is displayed on the desktop home page. Set this property to the location for your system.

gifts_restricted_to_recipients_plan

Determines if subscribers can give content to another subscriber if the recipient’s subscriber plan does not allow the recipient access to that content. Set this property to true to restrict the giver to giving only content allowed by the recipient’s subscriber plan. Set to false to allow the giver to give content that is not in the recipient’s subscriber plan. The default is false.

lb.cookiename

Specifies the name of the load balancer cookie. If a load balancer is being used to route traffic to different servers, a key-value pair can be added to every request to ensure that a subscriber’s session remains on a specific server.

Set this property to the name of the key evaluated by the load balancer.

lb.cookievalue

Specifies the value of the load balancer cookie. If a load balancer is being used to route traffic to different servers, a key-value pair can be added to every request to ensure that a subscriber’s session remains on a specific server.

Set this property to the value associated with the key evaluated by the load balancer.

max.device.message.length

Specifies the maximum number of bytes included in a message pushed to a device. The default is 10000.

newDevice.notification.emailAddress

Sends notification of a new device. A notification email can be sent when a new device is automatically created. See autoCreate.newDevice to specify that devices are to be created automatically.

Set this property to the email address to which notifications of new devices are sent.

password_reminder.emailenabled

Specifies if subscribers are provided with the option of having the password reminder sent to their email.

Set this property to true to provide subscribers with the option. Set to false to hide the option.

password_reminder.firstnameenabled

Specifies if the First Name field is visible on the password reminder screen.

Set this property to true to make the field visible. Set to false to hide the field.

password_reminder.lastnameenabled

Specifies if the Last Name field is visible on the password reminder screen.

Set this property to true to make the field visible. Set to false to hide the field.

password_reminder.template.filename

Specifies the name of the style sheet used to generate password reminder messages. The default is text/password_reminder.xsl.

password_reminder.webalertenabled

Specifies if subscribers are provided with the option of having the password reminder sent to their device as an alert.

Set this property to true to provide subscribers with the option. Set to false to hide the option.

quarantine.newDevice

Specifies if a device created automatically is quarantined. See autoCreate.newDevice to specify that devices are to be created automatically. Because the information from the HTTP headers might be incomplete, an option is provided to quarantine the device until the administrator completes the definition.

Set this property to true to quarantine a newly added device. Set to false to make the device immediately available. Detected devices might not be fully defined.

quick.browse.enabled

Enables faster page loading by checking the number of items in a category and number of times an item was downloaded only once per user session.

Set this property to false to check counts with every request. Set this property to true to check the counts once per user session. The default is true.

quick.purchase.enabled

Enables a faster purchase process by validating the purchase using the data received when the subscriber logged in or retrieved content instead of updating the data before validation. Validation checks include verifying that the subscriber is not disabled or that the content is not inactive.

Set this property to false to make all validation checks at purchase time. Set this property to true to use the data retrieved when the subscriber logged in or the last time the subscriber retrieved the content. The default is true.

share_content.gifting.expirationDays

Specifies the number of days. a gift can be redeemed before it expires. The default is 30 days.

share_content.template.filename

Specifies the name of a style sheet from which the gift message is generated. The default is text/share_content.xsl.

signup.unknown.user

Determines if a user who is not in the subscriber database can register with Content Delivery Server. No check is done inside the function to determine if the user being registered is known to Content Delivery Server.

Set this property to true to enable unknown users to register. Set to false to prevent unknown users from registering. The default is true.

signup.unknown.user.firstName

Specifies the value used for a subscriber’s first name if a value is not provided when registering an unknown user. The default is Signed-up User.

signup.unknown.user.lastName

Specifies the value used for a subscriber’s last name if a value is not provided when registering an unknown user. The default is Signed-up User.

signup.unknown.user.middleName

Specifies the value used for a subscriber’s middle name if a value is not provided when registering an unknown user. The default is Signed-up User.

signup.unknown.user.enabled

Specifies if the subscriber account created for an unknown user is enabled when it is created. Set this property to true to enable the account. Set to false to disable the account. The default is true.

signup.unknown.user.email

Specifies the email domain used for a subscriber’s email address if a value is not provided when registering an unknown user. The user's phone number is added to the beginning of the string to form the complete address. The default is @external.com.

sms.bundle.items.threshold

Specifies the maximum number of items in a bundle that are pushed directly to a device at one time. If a bundle contains more items for SMS delivery than this property specifies, the subscriber is provided with a link to the list of items to be downloaded individually. For example, if this property is set to 4 and the subscriber purchases a bundle that contains four or fewer items, all items are sent directly to the subscriber’s device. If the bundle purchased contains more than four items, a link to the list of items is sent to the subscriber.

sms.push.enable

Specifies if SMS Push messages can be sent.

Set this property to true to enable the sending of SMS Push messages. Set to false to disable SMS Push messages.

subscriber.every_download.update_license

Indicates if the license for content that a subscriber downloaded is updated when the license is changed. This property applies only to licenses that specify that the subscriber is charged on every download.

Set this property to true to indicate that the subscriber is charged according to the new billing model when the billing model is changed. Set to false to indicate that the subscriber is charged according to the original billing model.

user.security.max_login_attempts

Specifies the number of times a subscriber can attempt to log in and fail before the account is locked. Set to 0 to allow unlimited attempts. The default is 3.

wap.push.enable

Specifies if WAP Push messages can be sent.

Set this property to true to enable the sending of WAP Push messages. Set to false to disable WAP Push messages.

wml.display.no_of_items_per_page

Specifies the maximum number of items. displayed per page by the device-based Subscriber Portal. The default is 5.



18.4 Setting the Catalog Manager Properties

The following table describes properties in the $CDS_HOME/deployment/deployment-name/conf/AdminConsole.properties file that you can modify to meet the needs of your system. These properties apply only to the Catalog Manager administration console.


TABLE 18-4 Properties in the AdminConsole.properties File

Property

Description

admin.pagination.display.max

Specifies the maximum number of items displayed per page by the Catalog Manager administration console. The default is 20.

admin.pagination.display.threshold

Specifies the number of items that must appear on a page before the list navigation bar is repeated at the bottom of the page. If fewer items than the number specified are available, the list navigation bar appears only at the top of the page. The default is 15.

preload_device_capabilities_on_device_list

Determines if device capabilities for all devices are loaded the first time that the list of devices is accessed. Depending on the number of devices and the amount of content in your system, loading the capabilities for all devices might take several minutes or more and impact the performance of device-related activities such as viewing and editing devices.

Set this property to true to load all device capabilities on first access. Set to false to load the device capabilities for a device only when that device is selected. The default is true. If you have many devices defined and notice a performance degradation when first accessing devices after a server restart, set this property to false.



18.5 Setting the Vending Manager Properties

The following table describes properties in the $CDS_HOME/deployment/deployment-name/conf/VSAdminConsole.properties file that you can set to meet the needs of your system. These properties apply only to the Vending Manager administration console.


TABLE 18-5 Properties in the VSAdminConsole.properties File

Property

Description

admin.pagination.display.max

Specifies the maximum number of items displayed per page in the Vending Manager administration console. The default is 20.

admin.pagination.display.threshold

Specifies the number of items that must appear on a page before the list navigation bar is repeated at the bottom of the page. If fewer items than the number specified are available, the list navigation bar appears only at the top of the page. The default is 15.