SDX 6.4.x Application Library Guide > Managing Subscribers Through SOAP > Configuring and Installing Subscriber Manager

Configuring and Installing Subscriber Manager

This section lists the main tasks involved with configuring and installing Subscriber Manager. Refer to the following sections for more detailed information about these tasks.

To configure and install Subscriber Manager:

1. Complete the prerequisite tasks.
2. Configure one instance of Subscriber Manager for each business partner who uses the gateway.
3. Install the instance of Subscriber Manager.

Before You Use Subscriber Manager

Before you use Subscriber Manager, you must:

• Deploy a working SDX network.
• Determine a method for distinguishing each business partner's instance of Subscriber Manager. The methods you can use depend on your Web application server. The simplest method is to use a different filename for each instance of Subscriber Manager.
• If you want to configure Subscriber Manager to use workflows, you must install and configure the workflow engine and the OSMW. For information about installing the Workflow application, see Chapter 1, Installing the SDX Applications. For information about configuring the Workflow application, see Chapter 24, Configuring the Workflow Application.

Configuring Subscriber Manager

To configure Subscriber Manager:

1. Copy the sub.war file from the webapp folder on the application library CD to a temporary folder on your workstation.

mkdir tmp

cd tmp

cp /cdrom/cdrom0/webapp/sub.war

2. Extract the WEB-INF/web.xml file from the sub.war file.

jar xvf sub.war WEB-INF/web.xml

3. Edit the WEB-INF/web.xml file with any text editor.

This XML file provides information about how Subscriber Manager communicates with the LDAP directory and the OSMW. The default file shows examples of the settings for the properties. See the descriptions in Subscriber Manager Properties on 65 for information about the properties you must configure in this file.

NOTE: Residential subscribers can subscribe only to RADIUS services and value-added services. However, Subscriber Manager does not reject requests to subscribe residential subscribers either to access services or to outsourced services. If you want to block requests for these services, you must specify the objects umcAccessServiceProfile and umcOutsourceServiceProfile as LdapExcludedClasses in the file web.xml:

4. Repack the sub.war file.

jar uvf sub.war WEB-INF/web.xml

Subscriber Manager Properties

Use the descriptions in this section to configure the properties for the Subscriber Manager.

LdapHostUrl

• Location of the primary directory.
• Value—URL of the directory that stores configuration information in the format ldap://<host>:<portNumber>

• <host>—IP address or name of host that supports the Web application
• <portNumber>—Number of the TCP port

LdapBindDn

• DN that contains the username that the Web application server uses to connect to the directory.
• Value—<DN>
• Default—cn=umcadmin, o=umc

LdapPassword

• Password that the Web application server uses to connect to the directory.
• Value—Text string
• Default—admin123

LdapBaseDN

• Root location in the directory.
• Value—<DN>
• Default—o=umc

Retailer

• Name of the business partner whose subscribers are managed by the gateway client.
• Value—Text string
• Guidelines—If one company provides both the retail and wholesale functions, use the name of the default setting.

LdapServiceTreeRdn

• DN, relative to the value of the LdapBaseDN property, of the object that stores service templates.
• Value—<DN>
• Default—o=Services

LdapSubscriberTreeRdn

• DN, relative to the value of the LdapBaseDN property, of the object that stores subscriber profiles.
• Value—<DN>
• Default—o=Users

LdapStateManagerTreeRdn

• DN, relative to the value of the LdapBaseDN property, of the object that stores workflows.
• Value—<DN>
• Default—o=Workflows

LdapServicePrefix

• Prefix that is used to construct service profile DNs.
• Value—Comma-separated list of services in the format serviceName=<serviceName>

• <serviceName>—Name of service in the directory

LdapRetailerPrefix

• Prefix that is used to construct DNs for business partners.
• Value—Retailername=<retailerName>

• <retailerName>—Name of business partner in the directory

LdapLocationPrefix

• Prefix that is used to construct DNs of subscriber folders in the business partner's subtree.
• Value—Name of subscriber folder
• Default—ou=<siteName>

LdapSubscriberPrefix

• Prefix that is used to construct subscriber DNs.
• Value—List of services separated by commands in the format uniqueID=<subscriberName>

• <subscriberName>—Name of subscriber in the directory

LdapStateMachinePrefix

• Prefix that is used to construct RDNs of state machines.
• Value—StateMachineName=<stateMachineName>

• <stateMachineName>—Name of a state machine that the OSMW uses to control transactions

LdapExcludedClasses

• Object classes in the directory that Subscriber Manager cannot change.
• Value—Comma-separated list of object classes
• Default—TransactionalObjectAuxClass, parameterAuxClass, umcOutsourceService, umcAccessServiceProfile, umcOutsourceServiceProfile

LdapExcludedAttributes

• Attributes in the directory that Subscriber Manager cannot change.
• Value—Comma-separated list of attribute names
• Default—objectClass

OsmintHostUrl

• URL of the servlet that processes workflow requests (see Chapter 30, Object State Manager for the Web).
• Value—URL in the format: http://<host>:<portNumber>/osmint

• <host>—IP address or name of host that supports the OSMW
• <portNumber>—Number of the TCP port

OsmintSubscriberSM

• Subscriber state machine.
• Value—Name of the subscriber state machine

OsmintSubscriberSMInitState

• Initial state of the subscriber state machine.
• Default—Initial

OsmintSubscriptionSM

• Subscription state machine.
• Value—Name of the subscription state machine

OsmintSubscriptionSMInitState

• Initial state of the subscription state machine.
• Default—Initial

ReporterServletUrl

• URL of the reporting function for the workflow utility (see Chapter 32, Workflow Engine Functionality).
• Value—URL in the format http://<host>:<portNumber>/subs/report

• <host>—IP address or name of host on which Subscriber Manager is installed
• <portNumber>—Number of the TCP port

• Guidelines—Add two entries for this property in the web.xml file (see the default web.xml file for examples).

WkfXmlDtdFile

• URL of the template that the workflow utility uses to create the XML document that lists the workflow (see Chapter 26, Work Item Library).
• Value—URL in the format: http:// <host>:<portNumber>/Wf-XML-1_0.dtd

• <host>—IP address or name of host specified for the OsmintHostUrl property
• <portNumber>—Number of the TCP port

Installing Subscriber Manager

To install Subscriber Manager:

1. Depending on the method you have chosen, identify the unique instance of Subscriber Manager. For example:

cp sub.war subPartner1.war

2. Deploy the sub.war file by following the procedure appropriate to the Web application server you are using.

cp subPartner1.war /opt/UMC/jboss/server/default/deploy