Jabber Messenger Administration Guide Product Version 2.7 Document Version B -- GA July 15, 2003
1899 Wynkoop Street, Suite 600 Denver, CO 80202 303-308-3231
Disclaimers Copyright 2003 Jabber, Inc. The information contained in this document is proprietary to Jabber, Inc. This information is considered confidential and is not to be disclosed to any outside parties without the express written consent of Jabber, Inc. This document is provided for informational purposes only, and the information herein is subject to change without notice. Jabber, Inc. does not provide any warranties covering and specifically disclaims any liability in connection with this document.
Trademarks JABBER® and the light bulb logo are trademarks of Jabber, Inc. All other trademarks are the property of their respective owners.
jm2.7_admin
Contents
Overview ............................................................................................................... 5 Server Configuration 6 Local Configuration 7 Process Illustration 8 Installation ........................................................................................................... 11 System Requirements 11 Installing Jabber Messenger 12 Local Components 12 Server-Side Components 13 Feature Configuration ......................................................................................... 15 Configuring System Features 16 Configuring User Features 23 Community Groups ............................................................................................. 27 Installing the Community Group Components 28 Modifying communitygroup.xml 29 Modifying modules.xml 29 Auto Update Configuration ................................................................................. 31 Auto Update Overview 32 When to Use the Auto Update Feature 32 Updating Components 33 Enabling the Auto Update Feature 33 Updating Component XML Files 34 Updating modules.xml 34
Table of Contents | Page iii
Branding ............................................................................................................. 37 Roles and Responsibilities 38 Customized Setup File Creation......................................................................... Verifying Required Files Creating the Basic Setup File (No Branding) Creating the Branded Setup File
39 40 40 41
XML Files .......................................................................................................... feature.xml branding.xml modules.xml setup.xml msxml3.xml contacts.xml communitygroup.xml
45 45 47 48 48 49 49 50
Command Line Options ..................................................................................... 51 Index ................................................................................................................... 53
Page iv | Table of Contents
Chapter 1 | Overview
J
abber Messenger is an advanced, full-featured instant messaging and contentdelivery client application that runs on Windows systems. If desired, you can customize Jabber Messenger’s features and appearance to meet the specific needs of your organization. Jabber Messenger is designed to operate with the eXtensible Communications Platform. It gives your users access to the features of the Jabber server. Jabber Messenger is XMPP compliant and should operate with any XMPP compliant server. Note: If your users log into a Jabber server other than the eXtensible Communications Platform, they will not have access to some of the Jabber Messenger’s features like Community Groups. These features represent extensions to the standard XMPP protocol by Jabber, Inc., and are not present on other Jabber servers. Your users will, however, be able to perform the standard XMPP functions like chatting. If your enterprise is running the Jabber Directory Suite (JDS), you can give users access to community groups through Jabber Messenger. Community groups are collections of Jabber users created by your database administrator that organize users into meaningful groups. For example, groups for each department in an enterprise might be created, or groups for geographical regions might be set up. Users can send broadcast messages to all members of a group. Jabber Messenger can also incorporate the use of special live-content feed tabs; for example, you may want to create a weather forecast tab to provide your users with weather information. Instructions for creating and installing these tabs to work with Jabber Messenger are provided in the Jabber Messenger Tab Installation Guide.
Overview | Page 5
The Jabber Messenger application is fully brandable. This means that you can create icons, buttons, advertising banners, and content tabs to customize the appearance of Jabber Messenger. Branding instructions are provided in the Jabber Messenger Branding Guide. Note: If you choose not to customize Jabber Messenger’s features or appearance, you can distribute the setup file (setup.exe) that comes with Jabber Messenger to your Jabber users. This file contains all of the default features settings, including the default Jabber server, jabber.com. As system administrator, you are responsible for: ■
Installing Jabber Messenger local and server-side components on the appropriate systems
■
Configuring server-side components
■
Optionally configuring system and user features
■
Optionally branding Jabber Messenger
■
Distributing a customized setup file to the Jabber users if you have configured features or branded Jabber Messenger
Server Configuration Table 1 lists and describes the server files that exist in a full Jabber Messenger configuration. The server files should reside on a web server or on a shared network drive that is accessible to all Jabber users. Filenames shown in italics are names of files that you create. Table 1. Server-side configuration File
File Origin
contacts.cab
JM distribution
Contains the roster tab.
contacts.xml
JM distribution
Contains the location of the contacts.cab file.
msxml3.cab
JM distribution
Contains the Microsoft XML parser.
msxml3.xml
JM distribution
Contains the location of the msxml3.cab file.
custom_setup.exe
Jabber Admin creates this file
Installs the Jabber Messenger on enduser desktops.
setup.xml
JM distribution
Contains the location of the custom_setup.exe file.
Page 6 | Overview
Description
File
File Origin
Description
communitygroup.cab
JM distribution if you have also installed JDS.
Contains the community group tab, and activates community groups if the Jabber Directory Suite is also installed.
communitygroup.xml
JM distribution if you have also installed JDS.
Contains the location of the communitygroup.cab file.
content_tab icon and HTML file
Brander creates these files
Customized, HTML-based content tabs.
content_tab.xml
Brander creates this file
Contains the location of the tab’s icon and HTML files. See the Jabber Messaging Branding Guide for instructions on branding.
modules.xml
JM distribution
Contains the location of each XML file listed previously in this table for the purpose of enabling the auto update feature.
Local Configuration Table 2 lists the Jabber Messenger files that you place on a local Windows system. You can configure system and user features, and customize the look-and feel of the application in the feature.xml and branding.xml files. You then use these files in the creation of the customized setup file that you distribute to your Jabber Messenger users (see Chapter 7, “Customized Setup File Creation”). Table 2. Local configuration File
File Origin
Description
Basic Components feature.xml
JM distribution
Contains configurable system and user features. It also contains the location of the online help, the privacy statement, and the modules.xml file (which is used for auto updating JM components). You can set where Jabber Messenger installs on the users’ systems within this file.
Overview | Page 7
File
File Origin
Description
setup.exe
JM distribution
The original setup file for Jabber Messenger. You can send this file to your Jabber users if you don’t want to customize Jabber Messenger features or appearance. The default Jabber server in the setup.exe file is jabber.com.
JMadmin.exe
JM distribution
The tool that you use to create the customized setup file.
Branding Components branding.xml
JM distribution
Contains the names of customized button and icon images, and the location of additional license agreement information.
lic.xml
JM distribution
Contains the license key for branding Jabber Messenger. It must be located in the same directory as JMadmin.exe when you create the customized setup file.
customized icon and button images
Created by the Brander
Customized icon and button images that are used in branding Jabber Messenger. The path names of these images are placed in the branding.xml file. When you run JMadmin.exe, it looks for the images in the location specified in the branding.xml file. Make sure the paths in branding.xml match the location of the files on your local Windows system.
Process Illustration The following figures illustrate high-level processes for setting up the basic Jabber Messenger distribution and for creating a custom Jabber Messenger distribution. As illustrated in Figure 1, if you don’t plan to configure features, add content tabs, or brand Jabber Messenger, you can simply distribute the setup.exe file that comes with the Jabber Messenger distribution.
Page 8 | Overview
Start
Install Jabber Messenger local components on a Windows system
Install Jabber Messenger server components on a webserver
Add Community Groups tab to Jabber Messenger?
Note: Although this figure refers to a webserver, you can also install JM server components on a shared network drive that is accessible by all Jabber users.
Yes
Place community group .xml and .cab file on webserver
Modify community group .xml file and modules.xml file
No
Go to Figure 2.
Yes
Customize Jabber Messenger? No Distribute original setup.exe file to Jabber users
End
Figure 1. Basic setup process
Overview | Page 9
Continued from Figure 1.
Configure system and user features in feature.xml
Yes
Customize features? No Brand Jabber Messenger?
Yes
Create customized icon and button images
No Modify branding.xml
Create XML file for content tab
Create HTML page and icon for content tab
Add content tabs?
No
Modify modules.xml
Modify feature.xml
Create customized setup file
Distribute customized setup file to Jabber users
End
Figure 2. Custom setup process
Page 10 | Overview
Yes
Chapter 2 | Installation
Installing Jabber Messenger is simply a matter of placing some components on a local Windows system and other components on a server that your Jabber users can access.
System Requirements This section lists the minimum system requirements for running Jabber Messenger 2.7: ■ ■
■
■
■
eXtensible Communications Platform version 2.7 A web server or a shared network drive that is accessible by all your Jabber Messenger users. This is only required if you want to use the auto-update, content tab, and Community Groups features. An SMTP server must be available if you want to enable the Offline SMTP feature or the Send Transcript feature, which allows users to send a transcript of the current text conferencing session to other people via e-mail. Optionally, if you want to enable community groups through Jabber Messenger, you must be running the Jabber Directory Suite (JDS). This version of JDS incorporates the LDAP database, which is required for community group functionality. (See Chapter 4 for more information about community groups.) Jabber Messenger client systems must have: -
Windows 98SE, 2000, ME, or XP. Windows 2000 users must have Service Pack 2 installed if they want to log in with a secure SSL connection. Windows 98SE users must have dsclient.exe installed if they want to log in with a secure SSL connections.
Installation | Page 11
-
Internet Explorer 5.0
-
256 MB RAM
-
28.8 Kbps or faster modem, ISDN, or LAN connection
-
Microsoft NetMeeting 3.01 (if NetMeeting integration is desired)
Installing Jabber Messenger The Jabber Messenger distribution comes with local components, which must be installed on a local Windows system, and server-side components, which must be installed on a web server or on a shared network drive that is accessible by all Jabber Messenger users through the same network name and port. The Jabber Messenger distribution comes with the following compressed files: ■
JM-2.7.x.x.zip
■
JM-Server-2.7.x.x.zip
Local Components Local components include basic Jabber Messenger files and branding files. You must install these files on a local Windows system; you will use them when you create the customized setup file (described in Chapter 7). To install local components: 1. On a local Windows system, create a directory for the Jabber Messenger components. 2. Extract the JM-2.7.x.x.zip file to the directory. The following table lists and describes the extracted files. File
Page 12 | Installation
This file is...
setup.exe
The original Jabber Messenger setup file.
feature.xml
The XML file that contains Jabber Messenger system and user features.
JMadmin.exe
The utility that you use to create the customized Jabber Messenger setup file.
File
branding.xml
This file is...
The XML file that contains the tags that specify Jabber Messenger’s brandable components, which include the product title, additional license agreement, ad banner, and a variety of icon and button images. Note: See the Jabber Messenger Branding Guide for detailed branding instructions.
lic.xml
The branding license file. This file must be located in the same directory with the JMadmin.exe utility. Note: See the Jabber Messenger Branding Guide for detailed branding instructions.
Server-Side Components The Jabber Messenger server-side components can be placed on a web server or on a shared network drive, as long as the drive is accessible by every Jabber user. The server-side components are provided in a zipped file: JM-Server-2.7.x.x.zip. To install server-side components: 1. On the server, create a directory for the Jabber Messenger server-side components. 2. Extract the JM-Server-2.7.x.x.zip file into the directory you created in Step 1. Table 3 lists and describes the extracted server-side components. Table 3. Server-side components Filename
This file contains...
setup.xml
The location of the customized setup file.
setup.exe
The installation file for the Jabber Messenger client.
contacts.cab
The DLL that controls the Contacts tab.
contacts.xml
The location of the contacts.cab file.
msxml3.cab
The Microsoft XML parser.
msxml3.xml
The location of the msxml3.cab file.
modules.xml
The locations of setup.xml, contacts.xml, msxml3.xml, and other added components as needed.
communitygroup.cab
The community groups component.
communitygroup.xml
The location of the communitygroups.cab file.
Installation | Page 13
Page 14 | Installation
Chapter 3 | Feature Configuration
You can change the configuration of Jabber Messenger system and user features if you prefer not to use the default feature settings. If you configure features, you must then create the customized setup file, as described in Chapter 7, to distribute to your Jabber users. Jabber Messenger features are configured in the feature.xml file that is provided with Jabber Messenger. You can use a text editor to modify this file as needed.
System features are those that you can enable and disable for all Jabber users. For example, if you enable the Remember Password feature, users can set the Remember Password option on the Jabber Messenger login screen. If you disable this feature, users do not see the option when they log into the application. User features are those that Jabber users can change once they begin using the application; you can set initial default values for these features, which the users see the first time they start Jabber Messenger. The users can then change the features as desired. For example, you might set the Subscription default to “Ask me on all requests;” the user may then change this setting to “Auto Accept” or to “Auto Accept From Contacts” as desired. Note: Any changes that you make to the feature.xml file overrides features provided by the Jabber server configuration file; for example, if the Jabber server has text conferencing enabled and you disable this feature in feature.xml, the Jabber Messenger users will not have text conferencing. If you want to configure different feature sets for different Jabber user groups, you can create multiple versions of the feature.xml file, each containing different settings. You can name these files whatever you want; just be sure to include the appropriate feature file when you create each customized setup file.
Feature Configuration | Page 15
Configuring System Features System features are features that the Jabber users cannot change once you have set them. For example, if you disable the tag, users cannot save their login passwords locally. Caution: If you are using an LDAP directory service, disable the following tags: , , and . The current LDAP component does not allow users to add accounts to it. The system administrator must create new accounts using the native LDAP directory service tools. Otherwise, the user may receive an error when they attempt to register. Note: Text conferencing servers are configured by the eXtensible Communications Platform. Refer to the Cross-Product Feature Configuration Guide if you want to configure the text conferencing servers that are available to Jabber clients. To configure Jabber Messenger system features: 1. Open the feature.xml file in a text editor. 2. Locate the following lines of XML: Contact by ID... {NICKNAME} Check out Jabber Messenger Enter Tell A Friend text here and download URL location(optional) Welcome to Jabber Text Conferencing! The Text Conferencing feature allows you to chat in online conference rooms with other Jabber users. You can create new conference rooms, or you can join existing ones. You can create two types of conference rooms: ad hoc and persistent. An ad hoc conference room is a temporary room that exists only as long as at least one user remains in the room. A persistent conference room remains in existence on the server even after all users have left the room. When you create a room, you can set options for it such as whether the room is for members only, whether the room is password protected, how many users can participate in the room, etc. You can also establish a room membership list, and set permissions for each user in the room. To start text conferencing, select Room> New> Ad Hoc or
Page 16 | Feature Configuration
Persistent to create a new room, or select Room > Join Existing Room to join an existing one. JabberMessenger http://hostname/modules.xml 400 15 Jabber\Messenger http://support.jabber.com/jmhelpfiles/ JMHelp.htm http://www.jabber.com /company_privacy_statement.php
Note: The tags that are listed in the tables that follow steps 3, 4 and 5 are not necessarily in the order as shown in the XML. 3. If desired, type new content for the following tags. The text that is in each of these elements displays to Jabber Messenger users when they are using the client. Tag
Description
Default setting: Contact by ID... This text displays in the Add button’s pull-down menu for adding a contact by ID.
Feature Configuration | Page 17
Tag
Description
Default setting: {NICKNAME} This tag contains the vCard field(s) and format to use for the display name. (See the Cross Product Feature Configuration Guide for more information about vCard fields that you can use.) Note: the tag must be enabled for the tag to have any meaning.
This text displays to people receiving the tell-afriend e-mail message. The tell-a-friend message is sent by users to their friends and colleagues promoting Jabber Messenger (or your branded version of JM). You can change the subject as desired.
The text of the tell-a-friend message describes Jabber Messenger and its uses. You can change the message text and link as desired. You must enable the tag to use these features.
When users open the text conferencing interface, this text displays. You can change the explanation as desired.
This is the default resource when a user logs in.
4. Configure the enabled attribute for each of the following system features using a value of “true” or “false”: This tag...
Enables or disables...
The display of the Contact by Jabber ID option in the Add button’s pull-down menu. Default setting: “true”
The display of the Rename Contact from Profile option in the menu when a user rightclicks a contact in the roster. Default setting: “false”
The text conferencing feature, which lets users create, search for, receive invites to, join, and chat in conference rooms. Default setting: “true”
Page 18 | Feature Configuration
This tag...
Enables or disables...
The file transfer feature, which lets users send an d receive files during a chat session. Default setting: “true”
The account creation feature, which lets users create multiple Jabber Messenger accounts. Default setting: “true” Note: If you are using an LDAP directory service, disable this feature. The current LDAP component does not allow users to add accounts to it. The system administrator must create new accounts using the native LDAP directory service tools.
The remember password feature, which lets users save Jabber Messenger login passwords locally. Passwords are not encrypted. Default setting: “true”
The change password feature, which lets users change their Jabber Messenger login passwords. Default setting: “true” Note: If you are using an LDAP directory service, disable this feature. The system administrator must change passwords using the native LDAP directory service tools.
The edit profile feature, which lets users edit their own profiles. Default setting: “true”
The automatic update feature, which lets users update their clients to the latest Jabber Messenger components and receive updated content tabs. When enabled (set to “true”), you should also update the and tags. They are described in the next tables. Default setting: “true”
Feature Configuration | Page 19
This tag...
Enables or disables...
The content tab feature, which lets users install additional tabs. (See the Jabber Messenger Branding Guide for information about adding customized content tabs.) Default setting: “true”
The tell-a-friend feature, which lets users email a preset message about Jabber Messenger. Default setting: “false”
The transport feature, which lets users activate the gateways to communicate with users of other IM services (if the server supports transports). Default setting: “false”
The toast popup feature, which lets users receive notifications when other Jabber users come online. Default setting: “true”
The message archive feature, which lets users archive chat messages. Default setting: “true”
The user directory feature, which lets users search the Jabber user directory. Default setting: “true”
The user directory registration feature, which lets users register with the user directory so that other users can search for them. Default setting: “true” Note: If you are using an LDAP directory service, disable this feature. The current LDAP component does not allow users to add accounts to it. The system administrator must create new accounts using the native LDAP directory service tools.
Page 20 | Feature Configuration
This tag...
Enables or disables...
The server lock feature, which prevents users from changing Jabber servers. If you enable this feature, make sure that you also specify a hostname for the host attribute in the tag; otherwise, the default server is locked to jabber.com. Default setting: “false”
The online help feature, which lets users access the Jabber Messenger online help. Default setting: “true”
The change nickname feature, which allows users to change their nicknames while in a text conference room. Default setting: “true”
The send transcript feature, which allows users to send a transcript of the current text conferencing session to other people via e-mail. Default setting: “true”
When enabled, a warning message displays when a user enters an anonymous conference room. Default setting: “false”
When enabled, a confirmation message displays when a user attempts to enter a non-anonymous conference room. The user must confirm that they want to enter the room. Default setting: “true”
The maximum rooms feature, which sets the maximum number of text conference rooms to which a user can subscribe. Default setting: 400
The maximum views feature, which sets the maximum number of views a user can create to filter text conference room information. Default setting: 15
Feature Configuration | Page 21
This tag...
Enables or disables...
This is where the client is installed on your system. Default setting: Jabber/Messenger
The user’s ability to change the location where Jabber Messenger installs. If disabled, Jabber Messenger always installs in the default location specified in the tag. Default setting: “false”
Allows the user to login only with an SSL connection. If you enable this feature, you must change the element to xmpps. Default setting: “false”
5. Supply URLs for the following tags: This tag...
Specifies the location of...
The modules.xml file. The tag must be enabled for this to work. The modules.xml file contains the locations of all Jabber Messenger components that can be updated. By placing its location in the tag, you enable the client systems to automatically update when new components become available. (See Chapter 5 for more information.)
JMHelp.htm, the file that launches the online help. The tag must be enabled for this to work. If you change the default URL, make sure you still use the filename, JMHelp.htm; otherwise, Jabber Messenger cannot launch the online help.
The privacy statement, which is displayed from the client’s Help menu. The default URL is for Jabber Inc.’s privacy statement. The privacy statement is an HTML file, which you or someone in your organization can write.
6. Save and close feature.xml.
Page 22 | Feature Configuration
Configuring User Features User features are features that Jabber users can change once they begin using Jabber Messenger. As system administrator, you can configure initial default settings for user features. For example, you might set the auto away message to display after 10 minutes; the user can then change this setting if desired. To configure Jabber Messenger user features: 1. Open the feature.xml file in a text editor. 2. Locate the following lines of XML: 4 8 c: Ask Me Auto Accept Auto Accept From Contacts --> Standard Secure SSL
3. Configure the attributes using the following acceptable values: This tag...
Lets users...
Set the “Identify users from profile information” option in the client interfaces. Default setting: “true”
Automatically install all available tabs the first time they install the Jabber Messenger client. Default setting: “true”
Feature Configuration | Page 23
This tag...
Lets users...
Decide whether or not to display the text version or each contact’s status in the roster; for example, “(Available).” Default setting: “false”
Display only those contacts who are online in the roster. Default setting: “false”
Show or hide the toolbar.
Show or hide the status selector.
Archive messages and set the size of the archive file in megabytes. You can set the default size in megabytes; the number must be a positive integer.
Default setting: “true”
Default setting: “true”
Default settings: “true”, 4 MB
Display toast popup notifications and set the number of seconds each notification displays in the system tray. You can set the default number of seconds each notification displays; the number must be a positive integer. Default settings: “true”, 8
Enable or disable their auto away message and set the number of minutes Jabber Messenger waits before notifying other users that they are away. You can set the default number of minutes Jabber Messenger waits before sending the away notification; the number must be a positive integer. Default settings: “false”
Specify a local directory in which to store files that they receive during chat sessions. Default setting: c:
Page 24 | Feature Configuration
This tag...
Lets users...
Use a proxy server. The user can specify the proxy server’s protocol, hostname, and port number. Attributes: enabled=“true”|“false” protocol=“http”|“socks4” host=“hostname” port=“port_num” Defaults: enabled=“true” protocol=“socks4” host=“” port=“000”
Specify the Jabber server’s default connection protocol and hostname. Attribute: default_protocol=“xmpp|xmpps” host=“hostname” Defaults: default_protocol=“xmpp” host=“jabber.com” Change the port attribute in the child elements to the ports that your server uses for standard and secure SSL connections.
4. Configure the tag as described below: Tag
Description
Specify one of the following responses as the default for accepting subscription requests: Ask Me, Auto Accept, or Auto Accept From Contacts. Comment out the lines of the responses that you don’t want to use as the default. Default Setting: Ask Me Caution: Do not change the wording of the response in any way, or Jabber Messenger will not recognize it.
The auto accept choices are described as follows: Ask Me - The Jabber user is prompted to accept or deny all subscription requests. Auto Accept - The Jabber client automatically accepts every subscription request without the user’s knowledge.
Feature Configuration | Page 25
Auto Accept from Contacts - The Jabber client automatically accepts all subscription requests from contacts in the user’s roster; all other requests require the user’s acceptance. 5. Save and close feature.xml.
Page 26 | Feature Configuration
Chapter 4 | Community Groups
Community groups are collections of Jabber users that are created by the database administrator. For example, your enterprise may create a community group for each department, or for employees in different geographical locations. Note: To enable community groups in Jabber Messenger, you must be running the Jabber Directory Suite (JDS). Membership in community groups is set by the database administrator; Jabber users cannot alter their memberships through JDS or Jabber Messenger. However, users can add and interact with community groups based on their access permissions. Access rules include View Members, Subscribe, Send Presence, and Send Groupcast. The access rules for community groups are set by the administrator through JDS. See the Jabber Directory Suite Administration Guide for information on setting community group access rules. The community group tab (shown in Figure 3) does not install by default on the Jabber Messenger client; Jabber users must install it from the View menu after they install Jabber Messenger. This chapter describes how to enable the community groups tab. The following sections are provided: ■
Installing the Community Group Components
■
Modifying communitygroup.xml
■
Modifying modules.xml
Community Groups | Page 27
Figure 3. Community Groups Tab
Installing the Community Group Components The community group components consist of a .cab file and an .xml file. The communitygroup.cab file contains the community group tab icon and registry information; the communitygroup.xml file must contain the location of the cab file. After you have enabled Community Groups, your end-users will need to select an option in Jabber Messenger to view them. From the View Menu, they should select Tabs > Community Groups. These directions are included in the Help system of Jabber Messenger.
Page 28 | Community Groups
To install the community group components: 1. Make sure you are running the Jabber Directory Suite. 2. Place the communitygroup.xml and the communitygroup.cab files on the server in the same location you put the other Jabber Messenger XML and cab files.
Modifying communitygroup.xml The communitygroup.xml file references the communitygroup.cab file, which contains the icon and the registry information for the Community Group tab. You must insert the location of the cab file in the communitygroup.xml file. To modify the communitygroup.xml file: 1. Open the communitygroup.xml file (shown below) in a text editor. Community Group
2. In the tag, type the location of the communitygroup.cab file; for example: http://webserver/path/communitygroup.cab
3. Save and close communitygroup.xml.
Modifying modules.xml The modules.xml file already contains the tag, but you must insert the location of the communitygroup.xml file to enable the community group tab. To add the community group tab to the modules.xml file: 1. Open the modules.xml file (shown below) in a text editor. http://hostname/msxml3.xml http://hostname/setup.xml http://hostname/contacts.xml
2. Insert the tag, including the location of the communitygroup.xml file. For example: http://webserver/path/ communitygroup.xml
Community Groups | Page 29
3. Save and close modules.xml.
Page 30 | Community Groups
Chapter 5 | Auto Update Configuration
Jabber Messenger provides an auto-update feature, which allows Jabber users to update to new versions of components when they become available. Uses of the auto update feature include: ■
Updates of existing components
■
Updates of the Jabber Messenger client
■
Deployment of new components
The auto update feature may be used to automate the deployment of updated versions of the Jabber Messenger client and its components to your users. For example, you might use this procedure when Jabber, Inc. sends you new versions of the client or new .cab files for the content tabs. With auto update enabled, it becomes fairly easy to distribute new versions of the client to all of your users. Note: If you created your own content tabs, including .cab files, please refer to the Jabber Messenger Tabs Guide for information on updating them. Alternately, you may use the auto update feature to control the deployment of new components to your users. For example, if you deploy the XCP server without community groups, you might later want to make them available. If auto update is enabled in Jabber Messenger, you could simply deploy community groups on the XCP server, and place the community groups content tab with the Jabber Messenger server-side files. The next time your users open Jabber Messenger, it will detect the availability of a new tab and automatically download it to the client.
Auto Update Configuration | Page 31
Auto Update Overview The auto update feature detects newer versions of the client and the tabs using the version number. You should follow the instructions in this chapter when you have received new .exe or .cab files from Jabber, Inc. The process for setting up the auto update feature includes: ■
Updating Components
■
Enabling the Auto Update Feature
■
Updating Component XML Files
■
Updating modules.xml
The remaining sections in this chapter provide step-by-step instructions for this process.
When to Use the Auto Update Feature Since the Auto Update feature uses version numbers to detect the presence of updated files, there are specific times when it should be used. ■
■
If you created your own tabs, please refer to the Tabs Guide for instructions on how to increment the version number so that the Auto Update feature will detect updated versions of them. If you received new .exe or .cab files from Jabber, Inc., use the directions in this chapter to distribute them to your users via auto-updates.
The Auto Update feature does not detect changes in the .exe and .cab files that do not involve new version numbers. Specifically, it cannot be used to update your users in the following cases: ■
■
When you create a new .exe file using the JMAdmin Tool (e.g., you changed the options in features.xml or branding.xml), the new executable does not have an incremented version number. The Auto Update feature will not detect this type of change. When you want to update the HTML content of a tab, you do not need to increment the version number of the tab. You can simply include a META tag in the HTML code for the tab that causes it to periodically refresh. For example, if you include the following tag within the tags, the content tab will refresh every 1200 seconds (20 minutes):
Page 32 | Auto Update Configuration
Updating Components Table 4 lists the basic Jabber Messenger components that can be updated from a client system. The table also lists the corresponding XML file for each component; you must modify the corresponding XML file to contain the updated component’s path. Place updated components on the server with the other Jabber Messenger serverside components. Table 4. Auto update components Component
Corresponding XML File
Description
setup.exe
The customized setup file
setup.xml
contacts.cab
Contains the roster tab
contacts.xml
msxml3.cab
Contains the Microsoft XML parser
msxml3.xml
communitygroups.cab
Contains the community groups tab
communitygroups.xml
Enabling the Auto Update Feature Jabber Messenger’s auto update tags are contained in the feature.xml file, which was placed on a local Windows system during installation (see “Local Components” on page 12). These tags must be enabled on the clients in order for auto update to be active. By default, these tags are enabled. To enable the auto update feature: 1. Open the feature.xml file in a text editor. 2. Locate the tag and make sure it is enabled as shown:
3. Locate the tag, and insert the location of the modules.xml file. For example: http://webserver/path/modules.xml
4. Locate the tag and make sure it is enabled as shown. When enabled, the client automatically downloads all tabs the first time the user logs into the Jabber server.
Auto Update Configuration | Page 33
5. Save and close feature.xml.
Updating Component XML Files When you place an updated component on the server, you must modify the corresponding XML file to point to the component. To modify a component’s XML file: 1. Open the updated component’s corresponding XML file in a text editor. The communitygroups.xml file is shown here as an example: Community Group http://hostname/communitygroups.cab
2. Increment the version number in the tag, where component is community groups, setup, contacts, or msxml3. Make sure you use commas to separate the digits. The new version number enables the client systems to detect the updated component. 3. Locate the tag, and insert the component’s location; for example: http://webserver/path/contacts.cab
4. Optionally, add an tag at the end of the XML file (before the tag) like the one shown below. Use the same version number that you used in Step 2, and type a note about what’s new and different in this release. This note is merely for your own benefit if you want to keep a record of what has changed in each version. The Jabber users do not see it. description
5. Save and close the XML file.
Updating modules.xml You must modify the modules.xml file to contain the locations of the new or updated components’ XML files. This allows the client systems to detect when new components are available for users to download. To update the modules.xml file: 1. Open the modules.xml file (shown below) in a text editor.
Page 34 | Auto Update Configuration
2. In the tag for each updated component, supply the location of the component’s corresponding XML file; for example: http://webserver/path/msxml3.xml http://webserver/path/setup.xml http://webserver/path/contacts.xml http://webserver/path/ communitygroup.xml
Note: Community groups are discussed in detail in Chapter 4. If you are not enabling the community group tab, leave the tag empty. 3. Save and close modules.xml.
Auto Update Configuration | Page 35
Page 36 | Auto Update Configuration
Chapter 6 | Branding
Using Jabber Messenger’s branding options, you can customize the appearance of the application to meet the needs of your organization. For example, you can customize certain Jabber Messenger icon and button images, and the ad banner located at the bottom of the Jabber Messenger window. You can also create new content tabs to display information on the client. For information about which Jabber Messenger components can be branded and for instructions on branding, see the Jabber Messenger Branding Guide. Note: In this guide, we assume that there is someone in your organization (other than yourself) who is responsible for branding; we call this person the “brander.” You must interact with the brander to coordinate the branding effort. The roles and responsibilities of the brander, the Jabber administrator and the Jabber user are outlined both in this chapter and in the Jabber Messenger Branding Guide. For branding, do the following: 1. Send the branding.xml file and the Jabber Messenger Branding Guide to the brander. The brander creates customized icon and button images, HTML files for any added content tabs or advertising, and updates the branding.xml file. 2. Obtain the following files from the brander and put them on your local Windows system with the JMadmin.exe, feature.xml, setup.exe, and lic.xml files: -
Modified branding.xml file
-
All branded icon and button images
Branding | Page 37
-
The files for any content tabs and ad banners being added
3. Create a customized setup file that contains your new look-and-feel for the Jabber Messenger. See “Creating the Branded Setup File” on page 41 for complete information.
Roles and Responsibilities The principal players in customizing, installing, and using Jabber Messenger are the brander, Jabber administrator, and the Jabber user. These players and their responsibilities are described in the following table. Role
Brander
Responsibilities • Customize content tabs and images of buttons, icons, etc. that
will be used in Jabber Messenger. • Modify the branding.xml file to contain references to images, URLs, etc. • Send modified branding.xml file and images to Jabber administrator. Jabber Administrator
• Configure Jabber Messenger system features and user feature • • •
•
Jabber User
defaults in the feature.xml files. Send branding.xml file to the Brander. Receive modified branding.xml file and images from the Brander. Use JMadmin.exe (provided with Jabber Messenger) to package the XML files and the setup.exe file into a customized installation file. Distribute the customized file to the Jabber users.
• Receive the executable installation file from the Jabber
administrator. • Double-click the file to install Jabber Messenger. • Configure personal settings in Jabber Messenger. (if desired) • Chat!
Page 38 | Branding
Chapter 7 | Customized Setup File Creation
If you have modified Jabber Messenger features or have branded the application, you must create a customized setup file that contains the Jabber Messenger components required for installation on the client systems. You create this file using the JMadmin.exe utility provided with Jabber Messenger. It provides a simple GUI that allows you to create the customized setup file quickly and easily. During the setup file creation, you can also generate a unique client key that can be used to configure the Jabber server for client-server locking. For more information, see the “Client-Server Locking” chapter in the Cross Product Feature Configuration Guide. The JMadmin utility must be run on a Windows 2000 or XP system. Caution: In order for the JMadmin utility to create the setup file, you must have iexpress.exe installed on your system. IExpress is a Microsoft® utility that creates stand-alone installation files. Jabber Messenger’s JMadmin utility uses it to create installation files with your specifications. If you are running Windows XP or Internet Explorer 6.x, you already have iexpress.exe. If iexpress.exe is not installed on your system, you receive a warning message. The following sections are provided: ■
Verifying Required Files
■
Creating the Basic Setup File (No Branding)
■
Creating the Branded Setup File
Customized Setup File Creation | Page 39
Verifying Required Files Before you create the customized setup file, make sure you have the following files on your local Windows system: ■
JMadmin.exe - the utility you use to create the customized setup file
■
setup.exe - the original setup file provided with Jabber Messenger
■
feature.xml file - the file that contains Jabber Messenger system and user features
If you are creating a branded version of Jabber Messenger, you need these files as well: ■
■
■
branding.xml file - the file that contains the product title, additional license information, and the names of customized icon and button images lic.xml - the branding licence file. This file must be in the same directory as JMadmin.exe All branded icon and button image files
Creating the Basic Setup File (No Branding) This section describes how to create the basic customized setup file, which does not include any branding changes. If you are creating the branded setup file, skip to the next section, “Creating the Branded Setup File”. To create the basic customized setup file: 1. Double-click the JMadmin.exe file to run the utility. The Jabber Messenger Admin Utility window opens as shown in the following figure.
Page 40 | Customized Setup File Creation
2. Browse to the location of the original Jabber Messenger setup.exe file, and double-click the file to select it. 3. Browse to the location of the feature.xml file for this distribution, and doubleclick the file to select it. 4. Select “Enable client-server locking” if you want to generate a unique key for client-server locking purposes. (For more information, see the “Client-Server Locking” chapter in the Cross Product Feature Configuration Guide.) 5. Type a name (including a path if desired) for the customized setup file. The .exe extension is supplied automatically when the file is created. Caution: We recommend that you not use the name “setup” for this file. If the Jabber Messenger original setup.exe file is located in the same directory as JMadmin.exe, the new customized setup file will overwrite it. 6. Click the Create button. The file is saved in the directory where JMadmin.exe is located or in the location you specified when naming the file. You should see the Finished Building message, which indicates that the build was successful. 7. Click OK. 8. Distribute the customized setup file to your Jabber users.
Creating the Branded Setup File If you have made use of Jabber Messenger’s brandable options, your customized setup file includes all of the icons and button images created by the brander. The branding XML file contains the relative locations and names of these images. You must have these images on your system when you create the setup file. Caution: Make sure that the location of the images on your system match the locations referenced in the branding XML file.The JMadmin utility uses the locations in the XML file to pull the branded images into the customized setup file. If the utility can’t find these files, it will display error messages and will not create the setup file. Make sure that the Jabber Messenger lic.xml file is located in the same directory as the JMadmin utility. These instructions assume that you have already followed the steps in the Jabber Messenger Branding Guide to brand different elements of the client.
Customized Setup File Creation | Page 41
To create the branded customized setup file: 1. Double-click the JMadmin.exe file to run the utility. The Jabber Messenger Admin Utility window opens as shown in the following figure.
2. Browse to the location of the original Jabber Messenger setup.exe file, and double-click the file to select it. 3. Browse to the location of the feature.xml file for this distribution, and doubleclick the file to select it. 4. Browse to the location of the branding.xml file for this distribution, and double-click the file to select it. 5. Select “Enable client-server locking” if you want to generate a unique key for client-server locking purposes. (For more information, see the “Client-Server Locking” chapter in the Cross Product Feature Configuration Guide.) 6. Type a name (including a path if desired) for the customized setup file. The .exe extension is supplied automatically when the file is created. Caution: We recommend that you not use the name “setup” for this file. If the Jabber Messenger original setup.exe file is located in the same directory as JMadmin.exe, the new customized setup file will overwrite it. 7. Click the Create button to create the file. The JMadmin utility locates the associated branding images using the paths provided in the branding.xml file and includes them in the setup file. You receive an error message if the JMadmin utility cannot locate an image.
Page 42 | Customized Setup File Creation
The file is saved in the directory where JMadmin.exe is located or in the location you specified when naming the file. You should see the Finished Building message, which indicates that the build was successful. 8. Click OK. 9. Distribute the branded customized setup file to your Jabber users.
Customized Setup File Creation | Page 43
Page 44 | Customized Setup File Creation
Appendix A | XML Files
This appendix contains the XML files that come with Jabber Messenger. In the files, you must supply values for many of the tags. These files are explained in detail in earlier chapters.
feature.xml The feature.xml file contains the Jabber Messenger system features that you can enable and disable. The file contains default settings for these features, but you can change them as desired. This file also contains user features for which you can set initial default values. You must supply values for some of the tags in the file, such as URLs and hostnames. See Chapter 3, “Feature Configuration” for instructions on modifying the feature.xml file. Contact by ID... {NICKNAME} Check out Jabber Messenger Enter Tell A Friend text here and download URL location(optional)
| Page 45
Welcome to Jabber Text Conferencing! The Text Conferencing feature allows you to chat in online conference rooms with other Jabber users. You can create new conference rooms, or you can join existing ones. You can create two types of conference rooms: ad hoc and persistent. An ad hoc conference room is a temporary room that exists only as long as at least one user remains in the room. A persistent conference room remains in existence on the server even after all users have left the room. When you create a room, you can set options for it such as whether the room is for members only, whether the room is password protected, how many users can participate in the room, etc. You can also establish a room membership list, and set permissions for each user in the room. To start text conferencing, select Room> New> Ad Hoc or Persistent to create a new room, or select Room > Join Existing Room to join an existing one. JabberMessenger http://hostname/modules.xml 400 15 Jabber\Messenger http://support.jabber.com/jmhelpfiles /JMHelp.htm
Page 46 |
http://www.jabber.com /company_privacy_statement.php 4 8 c: Ask Me Auto Accept Auto Accept From Contacts --> Standard Secure SSL
branding.xml The branding.xml file contains tags that specify brandable components. These components include the product title, license agreement, installation location, and a variety of icon and button images. Instructions for branding Jabber Messenger are provided in the Jabber Messenger Branding Guide. Information about how you work with the brander to create the final branded product are provided in Chapter 6, “Branding”.
| Page 47
modules.xml The modules.xml file is used for enabling the auto update feature when you update any of the Jabber Messenger components. These components include msxml3.cab, contacts.cab, the customized client setup file, and the community group tab. You must update the modules.xml file to point to the locations of these components so that the client systems can detect them and prompt the Jabber users to install the new versions. (See Chapter 4, “Community Groups” and Chapter 5, “Auto Update Configuration” for instructions on modifying the modules.xml file.) http://hostname/msxml3.xml http://hostname/setup.xml http://hostname/contacts.xml
setup.xml The setup.xml file enables client systems to detect new versions of the client setup file (described in Chapter 7, “Customized Setup File Creation”). When you create an updated version of the client setup file, you must update the setup.xml file to
Page 48 |
point to its location and to increment the version number. Chapter 5, “Auto Update Configuration” provides information about modifying the setup.xml file. http://hostname/customizedsetup.exe
msxml3.xml The msxml3.xml file enables client systems to detect new versions of the msxml3.cab file. When an updated version of msxml3.cab is available, you must update the msxml3.xml file to point to its location and to increment the version number. Chapter 5, “Auto Update Configuration” provides information about modifying the msxml3.xml file. http://hostname/msxml3.cab
contacts.xml The contacts.xml file enables client systems to detect new versions of the contacts.cab file. When an updated version of contacts.cab is available, you must update the contacts.xml file to point to its location and to increment the version number. Chapter 5, “Auto Update Configuration” provides information about modifying the contacts.xml file. Contacts http://hostname/contacts.cab
| Page 49
communitygroup.xml The communitygroup.xml file enables client systems to detect the communitygroup.cab file for initial installation and later updates. When an updated version of communitygroup.cab is available, you must update the communitygroup.xml file to point to its location and to increment the version number. Chapter 4, “Community Groups” provides information about setting up the community group tab. Community Group http://hostname/communitygroups.cab
Page 50 |
Appendix B | Command Line Options
This appendix contains several command line options that you can add to the Jabber Messenger shortcut properties to modify how the application runs.
Table 5. Command line options Option
Dependency
Description
debug
None.
Automatically launch the debug window.
ssl
Requires the port option.
Connect using SSL. If you use this option, you must also specify the port option (e.g. /ssl /port 5223).
multi
None.
Enable ability to run multiple instances of Jabber Messenger.
silent
None.
Do not display the Sign-in window.
hidden
None.
Launch Jabber Messenger minimized to the taskbar.
jid
None.
Specify the username to use when logging in.
pass
Requires the jid option.
Specify the password to use when logging in. If you use this option, you must also specify the jid option.
create
Requires the jid and pass options.
Display the Create New Account window rather than the Sign-in window at start-up. If you use this option, you must also specify the jid and pass options.
server
None.
Specify the server to use when logging in.
| Page 51
Option
port
Dependency
None.
Description
Specify the port to use when logging in.
To add command line options: 1. Install Jabber Messenger on a Windows system. 2. Create a shortcut to Jabber Messenger on the desktop. 3. Right-click the shortcut and select Properties. 4. In the Target field, enter the desired command line options after the executable and end quote. Each option must be preceded by a forward slash (/). For example: "C:\Program Files\Jabber\Messenger\JabberMessenger.exe" /jid jsmith /pass secret /hidden
This example launches Jabber Messenger logged in as jsmith with a password of “secret”. Jabber Messenger opens and is immediately minimized (hidden) in the taskbar. 5. Click OK. 6. Double-click the shortcut to launch Jabber Messenger. Jabber Messenger launches with your specifications.
Page 52 |
Index A archive_messages feature 24 auto update components cabbase tag 34 contacts.cab 33 msxml3.cab 33 setup.exe 33 update tag 34 version number 34 description of 31 enabling 33 auto_accept feature 25 auto_away feature 24 auto_load_content_tabs feature 23 auto_update feature 19 auto_update_url feature 22
confirm_non_anon_entry feature 21 connection_type feature 25 contacts.cab 6, 33 installing 13 contacts.xml 6 content tab files 7 content_tabs feature 20 creating customized setup file 39 customized setup file 6, 39 basic 40 branded 41
D display_contact_status feature 24
E edit_profile feature 19
B
F
brander roles and responsibilities 38 working with 37 branding components installing 13 branding Jabber Messenger 37 branding.xml 8, 37 installing 13
feature.xml 7 installing 12 referencing modules.xml 33 features system 15 auto_update 19 auto_update_url 22 change_TC_nickname 21 confirm_non_anon_entry 21 content_tabs 20 edit_profile 19 file_transfers 19 global_message_history 20 lock_install_location 22 lock_server 21 max_rooms 21 max_views 21 online_help 21 online_help_url 22 privacy_statement 22 remember_password 19 send_transcript 11, 21 tc_welcome_msg 18 tell_a_friend 20 tell_a_friend_subject 18 tell_a_friend_text 18
C cabbase tag 34 change_TC_nickname feature 21 community groups 27 JDS and LDAP requirements 11 communitygroup.cab 7 communitygroup.xml 7 modifying 29 components location of 12 configuring community groups 27 local Windows system 7 server 6 system features 16 user features 23
Index | Page 53
text_conferencing 18 toast_notification 20 user_access_to_transports 20 user_create_account 19 user_directory_registration 20 user_directory_search 20 warn_anon_room_entry 21 user 15 archive_messages 24 auto_accept 25 auto_away 24 auto_load_content_tabs 23 connection_type 25 display_contact_status 24 proxy_server 25 receive_file_directory 24 show_online_only 24 show_status_selector 24 show_toolbar 24 toast_notification 24 file_transfers feature 19
G global_message_history feature 20
I installing branding components 13 Jabber Messenger 11 local components 12 server-side components 13
J Jabber administrator 38 brander 38 user 38 Jabber Communications Platform requirements 11 Jabber Directory Suite required for community groups 11 Jabber Messenger auto update 31 branding 37 component locations 12 customized setup file 39 installing 11
Page 54 | Index
server-side components 13 setup process 8 system features 16 requirements 11 user features 23 Jabber user features 15, 23 platform requirements 11 JMadmin.exe 8, 39 installing 12
L LDAP requirement for community groups 11 lic.xml 8 installing 13 local components installing 12 local configuration 7 lock_install_location feature 22 lock_server feature 21
M max_rooms feature 21 max_views feature 21 modules.xml 7 installing 13 reference in feature.xml 33 msxml3.cab 6, 33 installing 13 msxml3.xml 6 installing 13
O online_help feature 21 online_help_url feature 22
P privacy_statement feature 22 proxy_server feature 25
R receive_file_directory feature 24 remember_password feature 19 roles and responsibilities 38
S send_transcript feature 11, 21 server components contacts.cab 13 contacts.xml 13 installing 13 modulex.xml 13 msxml2.xml 13 msxml3.cab 13 setup.xml 13 configuration 6 requirements SMTP 11 webserver 11 setup file creating customized 39 customized basic 40 customized branded 41 setup process for Jabber Messenger 8 setup.exe 8, 33 installing 12 setup.xml 6 installing 13 show_online_only feature 24 show_status_selector feature 24 show_toolbar feature 24 SMTP server requirements 11 system features 15 auto_update 19 auto_update_url 22 change_TC_nickname 21
configuring 16 confirm_non_anon_entry 21 content_tabs 20 edit_profile 19 file_transfers 19 global_message_history 20 lock_install_location 22 lock_server 21 max_rooms 21 max_views 21 online_help 21 online_help_url 22 privacy_statement 22 remember_password 19 send_transcript 11, 21 tc_welcome_msg 18 tell_a_friend 20 tell_a_friend_subject 18 tell_a_friend_text 18 text_conferencing 18 toast_notification 20 user_access_to_transports 20 user_create_account 19 user_directory_registration 20 user_directory_search 20 warn_anon_room_entry 21 requirements Jabber Communications Platform 11 Jabber Directory Suite and LDAP 11 Jabber user platform 11 server 11 SMTP server 11 webserver 11
Index | Page 55
T tc_welcome_msg feature 18 tell_a_friend feature 20 tell_a_friend_subject feature 18 tell_a_friend_text feature 18 text_conferencing feature 18 toast_notification feature 20, 24
U update tag 34 user features 15 archive_messages 24 auto_accept 25 auto_away 24 auto_load_content_tabs 23 configuring 23 connection_type 25 display_contact_status 24 proxy_server 25 receive_file_directory 24 show_online_only 24 show_status_selector 24 show_toolbar 24 toast_notification 24 user requirements 11 user_access_to_transports feature 20 user_create_account feature 19 user_directory_registration feature 20 user_directory_search feature 20
V version number for auto update components 34
W warn_anon_room_entry feature 21 webserver requirements 11
Page 56 | Index
