Use the configuration file to define the way in which Presence Server uses
the group list server, for example the functionality provided in IBM® WebSphere® XML
Document Management Server Component (IBM XDMS),
to retrieve public groups content.
Before you begin
You will need the following files to complete
this task. After you install the
Presence Server product,
these files are found in the directory
was_root/installableApps/presence/scripts/config.
- SystemConfiguration.xml
- ConfigurationParams.txt
- UpdateConfiguration.jar
Before you can make changes to your configuration, the file
UpdateConfiguration.jar must
be in the class path.
To configure
Presence Server to
communicate with an
IBM XDMS server,
you will need the following information:
- SIP address, port and transport protocol
for the IBM XDMS server.
The transport protocol is optional; if left blank it defaults to UDP.
- P-asserted-identity, which should include the SuperAdmin user
defined in IBM XDMS
- IBM XDMS superuser
ID and password with authority to query the user groups that you are
trying to access (required only if the Aggregation Proxy is
deployed with IBM XDMS)
- HTTP URL of the IBM XDMS server
from which Presence Server should
get data
- (For storing group lists) A valid SIP URI that will appear in
the From: header for outgoing SUBSCRIBE requests sent to the server
- (For enabling authorization lists) Paths on the server for white-list
and black-list definitions
Finally, before you can make these configuration changes,
the Presence Server database
must be running.
About this task
To configure Presence Server so
that it can use IBM XDMS to
get information about group lists, complete the following steps:
- Open SystemConfiguration.xml with
a text editor.
- Modify the attributes on the groupListServer tag
to identify the IBM XDMS server
and user.
You can set the following attributes. Default
values are shown.
- enable="false"
- true to enable integration with an IBM XDMS server; false to
disable it
- sipAddress=""
- Address and port of the IBM XDMS instance
to which SUBSCRIBE requests are sent. The transport protocol for incoming
requests can be specified here. If the transport protocol is omitted,
then the XDMS listening port is configured in UDP protocol by default.
- assertedIdentity=""
- URI, in scheme:identity format, of the requester authorized to
get XCAP documents from the IBM XDMS shared
list server. This value is required.
This value will appear in the P-Asserted-Id:
header for outgoing SUBSCRIBE requests sent to the IBM XDMS shared
list server. The
identity must have IBM XDMS administrator
authority to access user groups.
For the
assertedIdentity attribute,
the display name is optional. If you choose to define a display name,
you must use the HTML code for symbols for the value of the attribute.
For example, use
<assertedIdentity=""Super Admin" <glm:GLMSuperAdmin>"/>
instead
of
<assertedIdentity=""Super Admin" <glm:GLMSuperAdmin>" />
- user=""
- A user ID with administrator-level privileges, for connecting
to the Aggregation Proxy. This value is optional.
- password=""
- Password of the administrator-level user, for connecting to the
Aggregation Proxy. Required only when a user is specified.
- fromURI=""
- A valid SIP URI that will appear in the
From: header for outgoing SUBSCRIBE requests sent to the IBM XDMS shared
list server. This value is required.
- retryInterval="5"
- Time, in minutes, to wait before retrying a request
that fails. This applies to outgoing SUBSCRIBE requests sent to an
external source–for example, the IBM XDMS shared
list server. Presence Server sends
the requests to subscribe to the group content and to receive notification
when the group content is modified. The valid range is 1-1440.
- subscribeExpiration="63"
- Time, in minutes, to specify in the Expire header
when Presence Server sends
SUBSCRIBE requests to the IBM XDMS shared
list server. The subscription will be refreshed as long as there are
client subscriptions on the server.
- xcapRoot=""
- HTTP URL of the IBM XDMS server
from which Presence Server should
get data using xcap_get requests. This attribute
provides a way for Presence Server to
connect directly with the IBM XDMS server
rather than connecting through the Aggregation Proxy.
When xcapRoot is
specified, Presence Server uses
this value as the URI for performing the xcap_get operation–bypassing
the Aggregation Proxy.
In this case, Presence Server uses
the asserted identity to perform the operation.
When xcapRoot is
not specified, Presence Server performs
the xcap_get operation using the xcap root URI
that is specified in the NOTIFY request received from IBM XDMS.
In this case, Presence Server uses
the specified user ID and password to perform the operation.
You
must specify an xcapRoot when enableXcapEvent is
true.
- enableXcapEvent= " "
- If set to true, Presence Server will
use the xcap-diff event package for communication
with the IBM XDMS server.
If set to false (the default), Presence Server will
use the ua-profile event package.
- specifyAssertedIdentityOnAllRequests="true"
- If set to true, a P-Asserted-Identity must be
specified in all outgoing subsequent subscribe requests. If set to false,
a P-Asserted-Identity is required only in the first outgoing SUBSCRIBE
request but is not required in subsequent SUBSCRIBE requests.
Here is an example of a groupListServer tag:- <groupListServer enable="true" sipAddress="sip:server.example.com:7010;transport=UDP"
assertedIdentity=""Super Admin1"<sip:ps@example.com>" user="glsuser" password="authpw" fromURI="sip:Admin1@example.com"
retryInterval="5" subscribeExpiration="63" xcapRoot="http://xdmshostname.example.com:9086/services"
enableXcapEvent="true" specifyAssertedIdentityOnAllRequests="true"/>
- Save and close the file.
- Open ConfigurationParams.txt with
a text editor.
- Update
the following parameters for your environment:
- cfg.system = xml_path (where xml_path is
the directory location for SystemConfiguration.xml)
- username = database_administrator_user_name
- password = database_administrator_password
dbDriver =
com.ibm.db2.jcc.DB2Driver
dbDriver =
oracle.jdbc.driver.OracleDriver
dbConnectionString =
jdbc:db2://database_host_name:database_port/database_name
dbConnectionString =
jdbc:oracle:thin:@database_host_name:database_port:database_name
- Run the java command
that is appropriate for your operating system:
Important: Enter the following
parameters on a single line.

java
-classpath UpdateConfiguration.jar: jdbc_path CmdConfig config_path/ConfigurationParams.txt
(where jdbc_path is the directory location
for your JDBC drivers and config_path is the directory
location for ConfigurationParams.txt)Important: JDBC drivers must be separated by a colon.
For example:
/usr/IBM/WebSphere/AppServer/java/bin/java -classpath UpdateConfiguration.jar:/opt/IBM/db2/V9.5/java/db2jcc.jar:/opt/IBM/db2/V9.5/java/db2jcc_license_cu.jar CmdConfig ConfigurationParams.txt
/opt/IBM/WebSphere/AppServer/java/bin/java -classpath UpdateConfiguration.jar:/opt/IBM/db2/V9.5/java/db2jcc.jar:/opt/IBM/db2/V9.5/java/db2jcc_license_cu.jar CmdConfig ConfigurationParams.txt
- Restart the application:
- Click .
Note: If you are using WebSphere Application Server version 6.1.0.x, reach
this window by clicking .
- Select the check box associated with the Presence Server.
- Click Stop. The Application
Status column should indicate a Stopped status.
- Click Start. The Application
Status column should indicate a Started status.
Results
Note: xcap_get requests for external lists
group lists uses user and password, if available. If there is no configured
user, asserted identity is used assertedIdentity.