Registering a new Sametime Gateway Server with the Sametime System Console

After installing an IBM® Sametime® Gateway server, register it with the Sametime System Console, so you can manage all of the Sametime servers from a central location.

Before you begin

Before you register the server, verify that you have completed the following tasks:
  • The Sametime System Console must be started.
  • The LDAP server must be connected to the System Console and must be started.
  • The Gateway database must be connected to the System Console and must be started.
  • The Community Server that the Gateway server connects to must already be registered with the Console and must be started.

About this task

Working from the server that you want to connect to the console, follow these steps to update properties files and run the registration utility.

During this task you will edit the following files; click the topic titles to see details on each file. Use Ctrl+Click to open the topic in a new browser tab or window so you can keep it open for reference:

Procedure

  1. On the Sametime Gateway server, navigate to the stgw_server_root/IBM/WebSphere/STgateway/console directory. For additional information about default paths, see Directory conventions.
  2. Make backup copies (using different names) of the console.properties and productConfig.properties files.
  3. Update the console.properties file with the following values, and then save and close the file.
    Table 1. console.properties settings
    Property Value
    SSCHostName Provide the fully qualified host name of the Sametime System Console server.
    SSCHTTPPort Specify the HTTP port used for the Sametime System Console server if SSL is not enabled and the value for SSCSSLEnabled is "false."

    To determine the correct HTTP port, open the AboutThisProfile.txt file for the Sametime System Console Application Server Profile and use the setting specified for the "HTTP transport port." The default profile name is STSCAppProfile.
    SSCUserName Enter the IBM WebSphere Application Server User ID that you created when you installed Sametime System Console. The default is wasadmin.
    SSCPassword Enter the WebSphere Application Server password associated with the SSCUserName.
    SSCSSLEnabled Change this value to "true" to connect to the Sametime System Console using a secure connection.
    SSCHTTPSPort Specify the HTTPS port used by the Sametime System Console server if SSCSSLEnabled is set to true.
  4. In the productConfig.properties file, set the value of isFederated to true for a primary or secondary node. The registration utility cannot run without this value. Verify that the other settings are correct, modifying them as needed before saving and closing the file.
  5. Run the registration utility:
    • AIX®, Linux™: registerProduct.sh
    • Windows™: registerProduct.bat

    The utility registers the server, generating a log file called ConsoleUtility.log and storing it in the console/logs directory. If the registration is successful, a console.pid will also be generated.

  6. Start the Sametime Gateway server, if it is not already running.