Getting Started with JBuddy-CF IM Event Gateways

Post-Installation Configuration

Assuming the installation of JBuddy-CF finished correctly and ColdFusion Server is currently shutdown per the installation instructions, you are ready to create IM Event Gateways using JBuddy-CF so start ColdFusion Server. It's as simple as 1-2-3!
  1. Proxy Settings
  2. Specify IM Accounts
  3. Create Gateway Types Automatically OR Create Gateway Types by Hand
  4. Create Gateway Instances for each IM account you specified in step 2

Proxy Settings

JBuddy-CF makes outgoing TCP socket connections to the specified IM services. The default hosts, ports, client version numbers, etc that JBuddy-CF will use are specified in the property files corresponding to the IM protocol. See {cf.root}\gateway\lib\AIM.properties for AIM connectivity. See {cf.root}\gateway\lib\MSN.properties for MSN connectivity, etc. If a direct TCP socket connection to the specify host and port are not permitted by your internet firewall or if your organization has some type of IM archival or management solution in place, you have may have to modify some settings for a particular IM service. JBuddy-CF supports DIRECT, SOCKS4, SOCKS5, and HTTPS Proxy (HTTP Tunneling) connectivity to the IM services. To change the connectivity or other IM service specific settings:
  1. cd to {cf.root} and then into gateway\lib\
  2. Edit a .properties file corresponding to the IM service (AIM, ICQ, MSN, YIM, LCS (LCS/OCS), JSC, XMPP, SAMETIME)*
* You may need to restart ColdFusion for changes to take effect if you have already started an IM Event Gateway of this type.

Specify IM Accounts

Each Gateway Instance requires it's own IM screen name and password. Follow these steps to specify your IM accounts:
  1. cd to {cf.root} and then into gateway\config\
  2. Create or edit a .cfg file corresponding to each Gateway Instance you created. Supply a screen name and password

Creating Gateway Types Automatically

You can create JBuddy-CF Event Gateway Types automatically using a supplied script.
  1. cd to {cf.root} and then into gateway\config\
  2. Open register_jbuddy_cf_gatewaytypes.cfm in a text editor
  3. Change the password from 'admin' to your CF Administrator password and then save the file
  4. Next, deploy the file to your wwwroot
  5. Now request it with your browser. This should register all the new JBuddy-CF eventgateway types automatically
  6. Proceed to Create Gateway Instances

Creating Gateway Types by Hand

You can manually create JBuddy-CF Event Gateway Types within CF Administrator. Refer to Event Gateway Types table below)
  1. Expand the Event Gateway tab
  2. Click Gateway Types item
  3. Create a new Gateway Type from the types below and corresponding to the screen name and password you used above
  4. Saving the new Gateway Type

Creating Gateway Instances

Within CF Administrator, expand the Event Gateway tab then click Gateway Instances item:
  1. Create a new gateway instance for the gateway type you just created above
  2. Specify the ColdFusion Component to handle events from the IM event gateway (CFC Path)
  3. Specify the cfg File for corresponding IM account (the file you edited in Specify IM Accounts)
  4. Click the start button to tell your gateway instance to connect to the IM service

 

Event Gateways > Gateway Types

The following table describes the instant messaging event gateway types available within JBuddy-CF.

Type Name Description Java Class Startup Timeout Kill on Startup Timeout
AIM JBuddy-CF AIM event gateway type com.zion.jbuddy.cf.AIMGateway 60 enabled
ICQ JBuddy-CF ICQ event gateway type com.zion.jbuddy.cf.ICQGateway 60 enabled
MSN JBuddy-CF MSN Messenger event gateway type com.zion.jbuddy.cf.MSNGateway 60 enabled
YIM JBuddy-CF Yahoo Messenger event gateway type com.zion.jbuddy.cf.YIMGateway 60 enabled
LCS JBuddy-CF Microsoft Office Communications Server (OCS 2007, LCS 2005) event gateway type com.zion.jbuddy.cf.LCSGateway 60 enabled
JSC JBuddy-CF *JBuddy Message Server event gateway type com.zion.jbuddy.cf.JSCGateway 60 enabled
*The JSC event gateway type allows ColdFusion to work with Zion's Enterprise Instant Messaging solution, JBuddy Message Server and is available as a separate product from Zion Software.

JBuddy, JBuddy-CF, JBuddy Message Server are trademarks of Zion Software, LLC. AIM, ICQ and AOL Instant Messenger Service are service marks of America Online, Inc. MSN Messenger is a registered trademark of Microsoft Corporation. Yahoo Messenger is a registered trademark of Yahoo! Inc. All other trademarks are the property of their respective owners.