Configuration Tasks

The configuration script configures the components that it finds and accesses on each host. However, depending on your configuration and the components you use, such as the type of database and J2EE application server, you may need to manually configure some of the components or to modify the configuration. This section provides a complete list of the configuration procedures for the VTAs and explains which procedures the script completes.

To configure the SDX software to use a VTA, you must:

1. Configure subscribers in the directory.
2. Configure services for the VTA in the directory.
3. Configure the EJB adaptor plug-in.
4. (Threshold VTA only) Configure the retailer to use the tracking plug-in.
5. Configure the database.
6. Configure the J2EE application server.
7. Configure the bootstrap properties and Web applications for the VTA.
8. Deploy the VTA inside the J2EE application server.
9. Configure NICs for the VTAs.
10. Configure the VTA.

Configuring Subscribers

NOTE: If it can access the directory by using the standard password via the standard port, the configuration script /opt/UMC/conf/vta/load configures a retailer and a couple of subscribers in the directory. If you are using the VTA only for testing or demonstration purposes, you can use these subscribers and skip the task below.

To use the VTAs, you must have at least one retailer and a couple of subscribers in the directory. If you do not have an established base of subscribers for testing the VTA, you must either load sample data that includes subscribers or create subscribers. For information about installing sample data, see SDX Software Basics Guide, Chapter 6, Operating the Directory Server. For information about adding subscribers to the directory, see SDX Objects Guide, Chapter 2, Managing Subscribers and Subscriptions.

Configuring Services

NOTE: If it can access the directory by using the standard password via the standard port, the configuration script creates services for the VTAs, and you do not need to complete these tasks. The script also creates policies for the services and configures the services to generate tracking events.

The services you must create for a VTA depend on that particular VTA. Only the VTA should activate and deactivate the services, and you must ensure that these services are not visible on a service selection portal for subscribers to control manually. You can use other services in conjunction with a VTA provided that you design the policies and priorities for those services to work together.

For example, if you manage subscribers with a Quota VTA, you may want to allow subscribers to manually activate a service that overrides the quota service, and consequently prevents charges in the periodic and bought accounts. You would account for use of this service via RADIUS accounting rather than via a Quota VTA, and subscribers would incur an extra cost for using the service. In this case, you would configure the overriding service with a higher precedence than the quota service.

Similarly, for a Threshold VTA, when subscribers have an active subscription to the Misbehaving service, you may want to allow them to manually activate a service that overrides the misbehaving service. You would account for use of this service via RADIUS accounting rather than via a Threshold VTA, and subscribers would incur an extra cost for using the service. In this case, you would configure the overriding service with a higher precedence than the misbehaving service.

To configure services for the VTA:

1. Create the services appropriate for the VTA.

• For the Quota VTA, create a quota service.
• For the Threshold VTA, create a behaving service and a misbehaving service.

2. Configure policies that specify ingress and egress accounting rules consistent with the usage formula.

For information about configuring accounting rules for a policy, see SDX Objects Guide, Chapter 4, Policy Management Overview.

3. For all subscribers managed by the VTA, create an individual or a group subscription to the services you created.

• For the quota service, configure the subscriptions to automatically activate the service when subscribers log in
• For the behaving and misbehaving services, do not configure the subscriptions to automatically activate the services when subscribers log in.

For information about configuring subscriptions, see SDX Objects Guide, Chapter 2, Managing Subscribers and Subscriptions.

4. For the quota service, configure the subscriptions to automatically activate the service when the subscribers log in.

Accessing the J2EE Application Server's Client Libraries

NOTE: If you use JBoss on the host, the script /opt/UMC/conf/vta/load copies the JBoss client libraries to the SAE installation directory, and you do not need to complete these tasks.

Each SAE that interacts with the VTA requires access to the J2EE application server's client libraries. To provide this access:

1. Refer to the documentation for the J2EE application server to determine the locations and names of the files for the client libraries.

When you install the VTAs, the files for the JBoss client libraries are placed in the folder /opt/UMC/conf/vta/jboss-client.

2. Copy the files for the libraries to one of the following folders on each host that supports an SAE.

• opt/UMC/sae/lib—For JUNOS routing platforms
• opt/UMC/ssp/lib—For JUNOSe routers

For example:

cp /opt/UMC/conf/vta/jboss-client/*.jar /opt/UMC/ssp/lib

3. Restart the SAE on each host to which you copied the client libraries.

Configuring the EJB Adaptor Plug-In

You configure the EJB adaptor plug-in in the same way that you configure other internal plug-ins for the SAE. For detailed information about configuring SAE plug-ins, see SDX Components Guide, Vol. 1, Chapter 5, Configuring Authorization and Tracking Plug-Ins.

To configure the EJB adaptor plug-in:

1. In the navigation pane for the configuration editor, open the file for the SAE configuration (the default file is SAE.xml).
2. Click on the Plug-Ins tab.
3. Scroll to the EJB Adaptor heading for the VTA.
4. Customize the properties for the VTA using the following list of properties for the EJB adaptor plug-in:

JNDI Service Provider

• Specifies the classname of the J2EE application server's JNDI service provider.
• Value—Depends on type of J2EE application server; consult documentation for J2EE application server
• Example—(For JBoss) Plugin.quotavta.java.naming.factory.initial = org.jnp.interfaces.NamingContextFactory
• Property name—Plugin.<plugInName>.java.naming.factory.initial

• <plugInName>—quotavta for the Quota VTA, thresholdvta for the Threshold VTA

Application Server URL

• Specifies the URL of J2EE application server that is running JNDI service.
• Value—Depends on type of J2EE application server. Consult documentation for J2EE application server
• Example—(For JBoss) Plugin.quotavta.java.naming.provider.url = jnp://10.227.6.242:1099
• Property name—Plugin.<plugInName>.java.naming.provider.url

JNDI Name of SAE Event Listener

• Specifies the Java Naming and Directory Interface (JNDI) name of SAEEventListener EJB of peer VTA.
• Value—JNDI name
• Defaults—Plugin.quotavta.ejbJNDIName = Quota/SAEEventListenerBean

Plugin.thresholdvta.ejbJNDIName = Threshold/SAEEventListenerBean

• Property name—Plugin.<plugInName>.ejbJNDIName

Event Admitter

• Specifies the property that determines the subscriber and service events that the EJB adaptor plug-in sends to the VTA.
• Value—Filter string of the same form as that used in the Subsrciber.read() method of the SAE external interface defined in the saeaccess.idl file. For information about the SAE external interface, see SDX Components Guide, Vol. 1, Chapter 7, Extending and Using the SAE's Remote Interface.

The variables in the filter include the names of plug-in attributes and a special variable PluginEventType. The value of this variable is the string name of the type of event, such as PE_START_SERVICE. For exact names of plug-in attributes and information about types of plug-in events, see SDX Components Guide, Vol. 1, Chapter 6, Developing External and Hosted Plug-Ins.

NOTE: If you reference plug-in attributes in the property <pluginName>.admitter, you must include those attributes in the property Plugin.<pluginName>.attr.

• Example—Plugin.quotavta.admitter = (&(PluginEventType=PE_*_SERVICE)(PA_SERVICE_NAME=VTA-Quota))
• Property name—Plugin.<plugInName>.admitter

Plugin Attributes

• Lists the plug-in attributes separated by commas. The EJB adaptor plug-in sends these attributes to the VTA listener.
• Value—List of plug-in attributes
• Guidelines—Specify at least the plug-in attributes shown in the example below. You may need to add extra attributes if you use them for the property <pluginName>.admitter. If you do not define a list of attributes, the EJB adaptor plug-in sends all plug-in attributes to the VTA. Sending unnecessary plug-in attributes can adversely affect the performance of SDX components.
• Example—Plugin.quotavta.attr = PA_ROUTER_NAME,PA_SESSION_ID,PA_LOGIN_NAME,PA_USER_IP_ADDRESS,PA_SSP_HOST,PA_DOMAIN,PA_SERVICE_NAME,PA_EVENT_TIME,PA_SESSION_TIME,PA_IN_OCTETS,PA_OUT_OCTETS,PA_SESSION_TIMEOUT,PA_DOWNSTREAM_BANDWIDTH,PA_UPSTREAM_BANDWIDTH, PA_SERVICE_SESSION_NAME,PA_SUBSCRIPTION_NAME
• Property name—Plugin.<plugInName>.attr

Use EJB Cluster

• Specifies whether or not the J2EE application server uses EJB clustering to determine the location that manages requests to the VTA. (This activity is known as load balancing.)
• Value—Yes | No

• Yes (True)—Use EJB clustering
• No (False)—Do not use EJB clustering

• Example—Plugin.quotavta.enableClustering = false
• Property name—Plugin.<plugInName>.enableClustering

EJB Clustering Strategy

• Specifies the load-balancing scheme of the J2EE application server that hosts the VTA. See the documentation for the J2EE application server to determine which load-balancing scheme it supports.
• Value—One of the following options:

• JNDIClustering—Load balancing via JNDI clustering
• EJBHomeClustering—Load balancing via home interface stubs
• EJBObjectClustering—Load balancing via object stubs

• Guidelines—JBoss uses EJBObjectClustering.
• Example—Plugin.quotavta.clusterStrategy = EJBObjectClustering
• Property name—Plugin.<plugInName>.clusterStrategy

Setting the Tracking Plug-In for the Retailer

NOTE: If it can access the directory with the standard password via the standard port, the configuration script creates the retailer virneo-threshold and attaches the thresholdvta plug-in to this retailer. If you require a sample retailer for demonstration or testing purposes only, you can skip this task.

For a Threshold VTA, you must specify the tracking plug-in for the retailer. To do so:

1. Access SDX Admin.
2. In the navigation pane, highlight the retailer.

The Retailer pane appears.

3. Enter thresholdvta in the Tracking Plugin field.

This name matches the name of the EJB adaptor plug-in for Threshold VTA.

4. Click Save.

Configuring the Database

To configure the database:

1. For each VTA, create a database that uses the schema for the VTA.

To view the database schemas, see the following files, which are created when you install the Solaris package for the VTAs.

• /opt/UMC/conf/vta/quota/vtadata.sql
• /opt/UMC/conf/vta/threshold/vtadata.sql

2. Configure access to the database for an administrator by using the VTA to monitor and manage subscribers.

The access parameters you configure must match the access parameters you configure for the data sources created in the J2EE application server (see Configuring the J2EE Application Server).

Configuring the J2EE Application Server

NOTE: If you use JBoss, the configuration script automatically configures the J2EE application server, and you do not need to complete these tasks.

You must configure the J2EE application server to support the VTAs.

To configure the J2EE application server:

1. Install the JDBC driver that allows your database to connect to the J2EE application server.

See the documentation for the database to determine the required JDB driver. For example, for JBoss, copy the driver to /opt/UMC/jboss/server/default/lib.

2. Restart the J2EE application server.
3. For each VTA, create a data source with a JNDI name that matches the name of the data source (see Table 61 for the default names).

If you want to modify the names of the VTA deployment descriptors, see the following section.

4. Set up a JMS connection factory, and link it to the resource environment reference called jms/QueueConnectionFactory.

The way you link the JMS connection factory to the resource environment reference depends on the J2EE application server. For more information, see the documentation for the J2EE application.

5. For each VTA, create a JMS queue for the ConnectionFactory with the appropriate name for the VTA (see Table 61).
6. Create a role called VTA-Admin, and configure the administrators that you want to be able to access the VTA administration portal with this role.
7. Specify an authentication mechanism, and access parameters (such as a username and password) by which administrators can access the data source via the portals.

The access parameters you configure must match the access parameters you configure for the database (see Configuring the Database).

 Table 61:  Names for Data Sources and JMS Queues 

 Type of VTA
 Default Name for Data Sources
 Name for JMS Queue

 Quota

 Quota/MySQLS

 queue/Quota/SAEEventQueue


 Threshold

 Threshold/MySQLS

 queue/Threshold/SAEEventQueue



 

Creating Deployment Descriptors

The enterprise archives (EAR files) for a Quota VTA and a Threshold VTA contain several modules that require deployment descriptors for the J2EE application server. In these EAR files, you will find sample deployment descriptors for several J2EE application servers. See the Release Notes for information about the J2EE servers which we have tested with the VTAs.

NOTE: See the documentation for your J2EE application server to determine the names of the files that contain the descriptors and how to edit them.

If you want to deploy the VTAs in a J2EE application server that we have not tested, you may need to develop your own deployment descriptors. In this case, you may be able to use the samples we provide as a guide.

To create a deployment descriptor:

1. Create a folder for the VTA on a host.

mkdir vta

2. Copy the EAR file for the VTA from the webapp folder on the application library CD to the folder that you created in Step 1. For example:

cp /cdrom/cdrom0/webapp/quotavta.ear vta

3. From the EAR file, extract the following file into the folder you created in
   Step 1:

• vtacore.jar
• datamgr.jar
• quotadp.jar (Quota VTA only)
• thresholddp.jar (Threshold VTA only)

For example:

cd vta

jar xvf quotavta.ear datamgr.jar

4. For each JAR file you extracted, extract the file that defines the deployment descriptors for the J2EE application server. For example, for JBoss:

jar xvf datamgr.jar META-INF/jboss.xml

5. Edit the file that defines the deployment descriptors for the J2EE application server.
6. Replace in the JAR file the file that defines the deployment descriptors for the J2EE application server. For example:

jar uvf datamgr.jar META-INF/jboss.xml

7. Replace the JAR file in the EAR file. For example:

jar uvf quotavta.ear datamgr.jar

Configuring Bootstrap Properties and Web Applications for the VTAs

Bootstrap properties specify how the VTA loads configurations from the directory. If you install the directory on a different host than the J2EE application server, you must modify the bootstrap properties to specify the directory host.

NOTE: The examples shown in these steps are for the Quota VTA. The procedure for the Threshold VTA is identical; however, the EAR filename is thresholdvta.ear.

To configure the bootstrap properties for each VTA:

1. Create a folder for the VTA on a host.

mkdir vta

2. Copy the EAR file for the VTA from the webapp folder on the application library CD to the folder that you created in Step 1.

cp /cdrom/cdrom0/webapp/quotavta.ear vta

3. From the EAR file, extract the file vtacore.jar into the folder you created in
   Step 1.

cd vta

jar xvf quotavta.ear vtacore.jar

4. From the file vtacore.jar, extract the file META-INF/ejb-jar.xml.

jar xvf vtacore.jar META-INF/ejb-jar.xml

5. In the folder you created in Step 1, edit the META-INF/ejb-jar.xml file.

See Properties in ejb-jar.xml file for information about the properties in this file.

6. Replace the file META-INF/ejb-jar.xml in the file vtacore.jar.

jar uvf vtacore.jar META-INF/ejb-jar.xml

7. Replace the file vtacore.jar in the EAR file.

jar uvf quotavta.ear vtacore.jar

To configure the Web applications for the VTAs:

1. From the EAR file, extract the file <vtaName>CustCare.war into the folder you created in Step 1 of the previous procedure.

cd vta

jar xvf quotavta.ear quotaCustCare.war

2. From the file <vtaName>CustCare.war, extract the file CONSTANTS.incl.

jar xvf quotaCustCare.war CONSTANTS.incl

3. Edit the properties in the file CONSTANTS.incl.

See Properties in CONSTANTS.incl file for Quota VTA for information about the properties for a Quota VTA and Properties in CONSTANTS.incl file for Threshold VTA for information about the properties for a Threshold VTA.

4. Replace the file CONSTANTS.incl into the file <vtaName>CustCare.war.

jar uvf quotaCustCare.war CONSTANTS.incl

5. Replace the file <vtaName>CustCare.war into the EAR file.

jar uvf quotavta.ear quotaCustCare.war

Properties in ejb-jar.xml file

The following list shows the properties in the ebj-jar.xml file.

Config.java.naming.provider.url, Config.java.naming.security.principal, Config.java.naming.security.credentials, Config.java.naming.security.protocol

• Specifies standard JNDI properties.
• Value—See SDX Components Guide, Vol. 1, Chapter 13, Configuring the Directory Eventing System.

Config.net.juniper.smgt.lib.config.staticConfigDN

• Specifies the root of the static configuration properties for the VTA.
• Value—DN
• Default—I=VTA, ou =staticConfiguration, ou=Configuration, o=Management, o=umc

Config.net.juniper.smgt.lib.config.dynamicConfigDN

• Specifies the root of the dynamic configuration properties for the VTA.
• Value—DN
• Default—ou=dynamicConfiguration, ou=Configuration, o=Management, o=umc

Config.net.juniper.smgt.des.<propertySuffix>

• Defines how the VTA monitors values it reads from the directory.
• Value—See SDX Components Guide, Vol. 1, Chapter 13, Configuring the Directory Eventing System.

vta.namespace

• Specifies the root namespace of the VTA.
• Value—Path, relative to the root of the static configuration properties, that defines where the VTA's configuration is stored
• Example—/Applications/Quota

Properties in CONSTANTS.incl file for Quota VTA

The following list shows the properties in the CONSTANTS.incl file for Quota VTA.

NIC_PROXY_NAMESPACE

• Specifies the namespace of the NIC proxy.
• Value—Path, relative to the root of the static configuration properties, that defines where the configuration of the NIC proxy is stored. This NIC proxy maps the subscriber's IP address to the identifier that the VTA uses as the key to the subscriber's records in the VTA database. See Configuring NICs for VTAs for information about how to configure the NIC proxy that this configuration property identifies.
• Default—/NicProxies/IpToIdNicProxy

PERIODIC_QUOTA

• Specifies the quota initially deposited in a subscriber's periodic account when the subscriber activates the account through the subscriber's portal. This value must match the value that the administrator specifies when replenishing periodic accounts. (See Portals for Managing Subscribers' VTA Accounts).
• Value—Integer in the range 1-9223372036854775807 followed by the letter L or calculation in Java code
• Default—5000000000L

SUBSCRIBER_ACTIVATE_DESCRIPTION

• Specifies the description recorded for a balance change in the periodic account when the subscriber activates the account through the subscriber's portal. This description records the change in the account status; however, the actual change in the balance is zero.
• Value—Text string
• Default—Activated by subscriber

PERIODIC_QUOTA_INITIAL_TOP_UP_DESCRIPTION

• Specifies the description recorded for a balance change in the periodic account when the subscriber activates the account through the subscriber's portal. This change in the balance is the value of the PERIODIC_QUOTA property.
• Value—Text string
• Default—Periodic replenishment to 5,000 MB

SUBSCRIBER_DEACTIVATE_DESCRIPTION

• Specifies the description for a balance change in the periodic account when the subscriber deactivates the account via the subscriber's portal. This description records the change in the account status; however, the actual change in the balance is zero. When the periodic account is inactive but the balance is nonzero, the VTA continues to use the account until the administrator invalidates inactive accounts via the administrator's portal.
• Value—Text string
• Default—Deactivated by subscriber

PERIODIC_QUOTA_INACTIVE_TOP_UP_DESCRIPTION

• Specifies the description for a balance change in inactive periodic accounts when the administrator replenishes periodic accounts via the administrator's portal. This action sets the balance of inactive periodic accounts to zero.
• Value—Text string
• Default—Expiration of deactivated periodic account's balance

SUBSCRIBER_PURCHASE_DESCRIPTION

• Specifies the description recorded for a balance change in the bought account when the subscriber buys bandwidth via the subscriber's portal (see Portals for Managing Subscribers' VTA Accounts).
• Value—Text string
• Default—Subscriber purchased bandwidth

BOUGHT_QUOTA_ACCOUNT_NAME

• Specifies the name of account that stores bought quota.

CAUTION: Do not change this value.

• Value—BoughtQuota

PERIODIC_QUOTA_ACCOUNT_NAME

• Specifies the name of account that stores periodic quota

CAUTION: Do not change this value.

• Value—PeriodicQuota

ACTIVE_STATUS

• Specifies a status string.

CAUTION: Do not change this value.

• Value—Active

INACTIVE_STATUS

• Specifies a status string.

CAUTION: Do not change this value.

• Value—Inactive

Properties in CONSTANTS.incl file for Threshold VTA

The following list shows the properties in the CONSTANTS.incl file for Threshold VTA.

NIC_PROXY_NAMESPACE

• Specifies the namespace of the NIC proxy.
• Value—Path, relative to the root of the static configuration properties, that defines where the configuration of the NIC proxy is stored. This NIC proxy maps the subscriber's IP address to the identifier that the VTA uses as the key to the subscriber's records in the VTA database. See Configuring NICs for VTAs for information about how to configure the NIC proxy that this configuration property identifies.
• Default—/NicProxies/IpToIdNicProxy

LDAP_BEHAVING_SERVICE_NAME

• Specifies the name of behaving service; must match name of service configured in directory.
• Value—Text string
• Default—VTA-Behaving

LDAP_MISBEHAVING_SERVICE_NAME

• Default—Specifies the name of misbehaving service; must match name of service configured in directory.
• Value—Text string
• Default—VTA-Misbehaving

LDAP_BEHAVING_OBSERVATION_PERIOD_MILLIS

• Specifies the value of behaving observation period in milliseconds; must match value of observation period configured in directory.
• Value—Integer in the range 1-9223372036854775807 followed by the letter L or calculation in Java code
• Default—7*24*60*60*1000 (7 days in milliseconds)

LDAP_MISBEHAVING_OBSERVATION_PERIOD_MILLIS

• Specifies the value of misbehaving observation period in milliseconds; must match name of observation period configured in directory.
• Value—Integer in the range 1-9223372036854775807 followed by the letter L or calculation in Java code
• Default—2*24*60*60*1000 (2 days in milliseconds)

BEHAVING_OBSERVATION_PERIOD

• Specifies the value of behaving observation period that appears in portals; should match value configured in directory.
• Value—Text string
• Default—7 days

MISBEHAVING_OBSERVATION_PERIOD

• Specifies the value of misbehaving observation period that appears in portals; should match value configured in directory.
• Value—Text string
• Default—2 days

UPPER_THRESHOLD

• Specifies the value of upper threshold that appears in portals; should match value configured in directory.
• Value—Text string
• Default—1.15 GB

LOWER_THRESHOLD

• Specifies the value of lower threshold that appears in portals; should match value configured in directory.
• Value—Text string
• Default—66 MB

MISBEHAVING_RATE

• Specifies the value of rate limit for misbehaving service that appears in portals; should match value configured for the rate limit for the policy of the misbehaving service.
• Value—Text string
• Default—64 Kbps

Configuring NICs for VTAs

Use of NICs with the Threshold and Quota VTAs automates some operations for subscribers (see Use of NICs with VTAs). For demonstrations and installations with few subscribers, you can configure the VTA to use a NIC proxy stub, which explicitly defines a set of data mappings. However, for standard installation with a significant number of subscribers and multiple SAEs, you must configure a full NIC configuration.

To configure a NIC for the VTA management portals:

1. Install the sample data called NIC Configuration Sample from the SDX software CD.

This action creates an entry called OnePopLogin under the entry called NIC in the LDAP schema.

2. Configure a NIC proxy stub or a NIC; use the following guidelines for configuring the NIC:

• Review the information about the NIC configuration (see SDX Components Guide, Vol. 2, Chapter 11, Overview of the NIC) to plan your NIC configuration.
• See SDX Components Guide, Vol. 2, Chapter 12, Configuring and Starting the NIC for information about configuring the NIC.
• On each workstation that supports a NIC host for this NIC configuration, configure the ORB to recognize the COS name server. For JacORB, include the following line in the file jacorb.properties.

ORBInitRef.NameService=corbaloc::<host>:<port>/NameService

• <host> is the name or IP address of the Cos name server
• <port> is the TCP port

3. Add the NIC SAE agents to each SAE configuration as external plug-ins, as follows:

Plugin.nic.objectref=corbaname::<host>:<port>/

NameService#nicsae/saePort

Plugin.nic.attr=PA_ROUTER_NAME,PA_SESSION_ID,PA_USER_TYPE,

PA_LOGIN_NAME,PA_USER_IP_ADDRESS

• <host> is the name or IP address of the Cos name server
• <port> is the TCP port

For information, on modifying the SAE configuration, see SDX Components Guide, Vol. 1, Chapter 2, Configuring the SAE.

Configuring VTAs

The configuration script performs configuration tasks automatically. However, depending on your configuration, you may need to modify the configuration properties.

If you change the configuration of the VTA, the VTA will use the new parameters when you save the configuration in the directory. You do not need to restart the VTA to implement the changes.

The best way to configure the VTAs is to modify the sample data provided for these applications. To access the sample data:

1. Start Configuration Editor.

For information about using the configuration editor, see SDX Software Basics Guide, Chapter 15, Using SDX Configuration Editor.

2. Import the SDX system configuration from the directory.

Configuring Logging Properties for all VTAs

You can configure logging properties for all VTAs.

To configure logging properties:

1. In the navigation pane for Configuration Editor, expand the folder called VTA.
2. Select the applications.xml file.
3. Hold down the right mouse button, and select Open With > SDX Configuration Editor.

The Log destinations window appears.

4. Configure the logging properties.

You can see default settings for logging in this file. For information about configuring logging, see SDX Components Guide, Vol. 1, Chapter 12, Configuring Logging.

5. Save the configuration.

Configuring Identifiers for Subscribers and Sessions

To configure identifiers:

1. In the applications.xml file, click on the Subscriber ID and Lookup tab.

The Subscriber ID and Lookup window appears.

2. Select or enter values for the identifiers.

• For the Subscriber ID field, select the data key that identifies the subscriber in the VTA database.
• If you are using a NIC that maps subscriber IP addresses to subscriber identifiers and you select a Subscriber ID that provides a data key for the NIC, specify the NIC proxy that uses that data key in the field Namespace of NICProxy.
• For the SAE Subscriber Lookup field, select the data key that uniquely identifies the subscriber in your SDX configuration.

See the following list for a description of the fields. For more information about this topic, see Identification of Subscribers, SAEs, and Sessions.

Subscriber ID

• Specifies the setting that the VTA uses to identify a subscriber in the VTA database. Some settings also provide information that the NIC and the SAE use to identify subscribers.
• Value—One of the following settings:

NOTE: The following three settings also provide information for the NIC and the SAE.

• Login Name—Data key for VTA database, NIC and SAE is PA_LOGIN_NAME (JUNOSe router only)
• Subscriber DN—Data key for VTA database, NIC and SAE is PA_USER_DN
• Interface Name & VR

• Data key for VTA database is PA_INTERFACE_NAME@PA_ROUTER_NAME
• Data key for NIC is PA_ROUTER_NAME
• Data key for SAE is PA_INTERFACE_NAME

NOTE: The following settings do not provide information for the NIC and the SAE.

• Interface Alias—Data key is PA_INTERFACE_ALIAS
• Interface Alias & VR—Data key is PA_INTERFACE_ALIAS@PA_ROUTER_NAME
• Subscriber MAC Address—Data key is PA_USER_MAC_ADDRESS
• Primary Login Name—Data key is PA_PRIMARY_USER_NAME
• NASPort ID—Data key is PA_PORT_ID@PA_ROUTER_NAME (JUNOSe router only)

• Default—User IP address

Namespace of NICProxy

• Specifies the location of the NIC proxy configuration, relative to the static configuration properties for the VTA. For information about the static configuration properties of the VTA, see Configuring NICs for VTAs, If you use a NIC with the VTA, select the NIC proxy.
• Value—Text string
• Default—/Nic/Proxies/IdToSaeNicProxy
• Property name—Vta.nicProxy.namespace

SAE Subscriber Lookup

• Specifies the setting that the VTA uses to identify a subscriber session or service session when the VTA receives a plug-in event.
• Value—One of the following settings:

• Subscriber IP address (JUNOSe routers only)—Data key is a combination of the plug-in attributes PA_USER_IP_ADDRESS and PA_EVENT_TIME
• Subscriber DN—Data key is PA_USER_DN
• Login Name (JUNOSe router only)—Data key is PA_LOGIN_NAME
• Interface name & VR—Data key is a combination of the plug-in attributes PA_INTERFACE_NAME and PA_ROUTER_NAME
• Primary Login Name—Data key is PA_PRIMARY_USER_NAME
• IP Address, Interface Name & VR—Data key is a combination of the plug-in attributes PA_USER_IP_ADDRESS, PA_INTERFACE_NAME, and PA_ROUTER_NAME

• Default—Subscriber IP address

Configuring NIC Proxies

To configure NIC proxies:

1. In the Configuration Editor navigation pane, expand the folder called NIC proxy in the VTA folder.
2. Select the NIC proxy that you want to configure.

• For both the Quota and Threshold VTAs, if subscribers connect to the network via a JUNOSe router, you can configure a NIC proxy that passes the subscriber's IP address and receives the identifier that you configured for the subscriber (see Identification of Subscribers, SAEs, and Sessions). This NIC allows customers to log in via the client Web portals (see VTA Client Web Portals).

You must also specify the namespace of the NIC proxy in the CONSTANTS.incl file of the Web applications for the client Web portals (see Configuring Bootstrap Properties and Web Applications for the VTAs).

• For the Quota VTA, you can configure a NIC proxy that passes the subscriber's identifier to a NIC resolver and receives the corresponding SAE reference. This NIC allows the Quota VTA to immediately activate a subscriber's quota service when a deposit is made to the subscriber's account (see Immediate Activation of Subscriptions to Quota Service). This feature is available for subscribers who connect to the network via JUNOSe routers and JUNOS routing platforms.

3. Hold down the right mouse button, and select Open With > SDX Configuration Editor.

For information about the parameters that you can configure for NIC proxies, see SDX Components Guide, Vol. 2, Chapter 12, Configuring and Starting the NIC.

Configuring a Quota VTA

To configure a Quota VTA, configure operating settings for the Quota VTA and the initial settings for the periodic and bought accounts.

Configuring the Operating Settings for the Quota VTA

To configure the operating settings for the Quota VTA:

1. In the Configuration Editor navigation pane, expand the folder called Applications in the VTA folder.
2. Select the Quota.xml file.
3. Hold down the right mouse button, and select Open With > SDX Configuration Editor.

The Quota VTA window appears and displays the information in the Periodic and Bought Quota Volume Tracking Application tab.

4. Configure the fields for the VTA. See the following list of configuration properties for the Quota VTA.
5. Save the Quota.xml file.

Quota service name

• Specifies the name of the service managed by the VTA.
• Value—Text string
• Default—VTA-Quota

Quota usage charge formula

• Specifies the formula that calculates the amount by which a subscriber's quota balance should be debited. For information about defining a formula, see Use of Network Resources.
• Value—Function that includes a combination of the following variables:

• upStreamBytes
• downStreamBytes
• interimTime

• Default—Return upStreamBytes+downStreamBytes

Time to next interim accounting

• Provides the formula that specifies the interim accounting interval for the VTA. For information about defining a formula, see Interim Accounting Interval.
• Value—Formula that includes a combination of the following variables:

• periodicBalance
• boughtBalance
• lastInterimTime
• sessionLength
• maxUsageRate
• averageUsageRate

• Default—Return 900
• Example—Return (periodicBalance + boughtBalance)/maxUsageRate

Record balance change history

• Specifies whether the decision plug-in records a debit every time it reduces the balance in an account.
• Value—True | False

• True—Decision plug-in creates records of balance changes when it reduces the balance of an account
• False—Decision plug-in reduces balance without creating records of balance changes

• Default—False

Negative balance account

• Specifies an account in which a negative balance should appear if a subscriber uses more bandwidth than that available in the periodic and bought accounts.
• Value—BoughtQuota | PeriodictQuota | Disabled

• BoughtQuota—Negative balance appears in bought account
• PeriodictQuota—Negative balance appears in periodic account
• Disabled—Balance of 0 appears in both accounts

• Default—Disabled

Configuring Initial Settings for Periodic and Bought Accounts

To configure the initial settings for the periodic and bought accounts:

1. In the Quota.xml file, click on the tab called Account Initialization.
2. Configure the fields in this window. See the following lists of initial settings.
3. Save the Quota.xml file.

The following list shows the initial settings for a bought account.

Initial Balance

• Specifies the initial balance of the periodic account in MB.
• Value—Integer in the range -9223372036854775807 through 9223372036854775807
• Default—0
• Property name—BoughtQuota.InitialBalance

Initial Status

• Specifies the initial status of the periodic account in MB.
• Value—Active | Inactive

• Active—Account is operative
• Inactive—Account is inoperative

• Default—Active
• Property name—BoughtQuota.InitialStatus

The following list shows the initial settings for a periodic account.

Initial Balance

• Specifies the initial balance of the bought account in MB.
• Value—Integer in the range -9223372036854775807 through 9223372036854775807
• Default—0
• Property name—PeriodicQuota.InitialBalance

Initial Status

• Specifies the initial status of the bought account in MB.
• Value—Active | Inactive

• Active—Account is operative
• Inactive—Account is inoperative

• Default—Inactive
• Property name—PeriodicQuota.InitialStatus

Configuring a Threshold VTA

If you change the configuration of the VTA, the VTA will use the new parameters when you save the configuration in the directory. You do not need to restart the VTA to implement the changes. To configure a Threshold VTA:

1. In the Configuration Editor navigation pane, expand the folder called Applications in the VTA folder.
2. Select the Threshold.xml file.
3. Hold down the right mouse button, and select Open With > SDX Configuration Editor.

The Threshold VTA window appears and displays the information in the Bandwidth Threshold Crossing Volume Tracking Application tab.

4. Configure the values for the VTA. See the following list for each property that you can configure.

Behaving service name

• Specifies name of the service in the directory that is active when data transfer statistics are in the acceptable range.
• Value—Text string
• Default—VTA-Behaving

Misbehaving service name

• Specifies name of the service in the directory that is active when data transfer statistics are in the unacceptable range.
• Value—Text string
• Default—VTA-Misbehaving

Behaving observation period

• Specifies time for which the subscriber's data transfer statistics are recorded when the Threshold VTA activates the behaving service.
• Value—Integer in the range 1-9223372036854775807 seconds
• Default—604800

Misbehaving observation period

• Specifies time for which the subscriber's data transfer statistics are recorded when the Threshold VTA activates the misbehaving service.
• Value—Integer in the range 1-9223372036854775807 seconds
• Default—172800

Behaving (lower) threshold

• Specifies the maximum volume in bytes that the subscriber may consume during the misbehaving observation period for the VTA to deactivate the misbehaving service and activate the behaving service. If the subscriber exceeds this limit, the VTA maintains activation of the misbehaving service.
• Value—Integer in the range 1-9223372036854775807
• Default—1150684932

Misbehaving (upper) threshold

• Specifies the maximum volume in bytes that the subscriber may consume during the behaving observation period for the VTA to maintain activation of the behaving service. If the subscriber exceeds this limit, the VTA deactivates the behaving service and activates the misbehaving service.
• Value—Integer in the range 1-9223372036854775807
• Default—65753425

Usage formula

• Specifies a formula that determines the subscriber's use of volume.
• Value—Formula that includes a combination of the following variables:

• upStreamBytes
• downStreamBytes

• Default—return upStreamBytes+downStreamBytes

Deploying VTAs Inside the J2EE Application Server

You must deploy the EAR file for each VTA in the J2EE application server. See the documentation for the J2EE application server for information about deploying applications.

To deploy the VTAs inside JBoss, copy the EAR files to the JBoss default/deploy directory.

cp thresholdvta.ear /opt/UMC/jboss/server/default/deploy

cp quotavta.ear /opt/UMC/jboss/server/default/deploy