Database Setup for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)
IM and Presence external database setup
Downloads: This chapterpdf (PDF - 299.0KB) The complete bookPDF (PDF - 791.0KB) | Feedback

IM and Presence external database setup

IM and Presence external database setup

This chapter provides information about the IM and Presence external database setup.

About external database assignment

External database and node assignment

When you configure an external database entry on IM and Presence, you assign the external database to a node, or nodes, in your cluster as follows:

  • For the Compliance feature, you require at least one external database per cluster. Depending on your deployment requirements, you can also configure a separate external database per node.
  • For the Permanent Group Chat feature, you require a unique external database per node. Configure and assign a unique external database for each node in your cluster.
  • If you deploy both the Permanent Group Chat and Compliance features on an IM and Presence node, you can assign the same external database to both features.

For further information on configuring the Compliance feature on IM and Presence, see Instant Messaging Compliance for IM and Presence Service on Cisco Unified Communications Manager.

For further information on configuring the Permanent Group Chat feature on IM and Presence, see the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager.

Related References

External database connection

IM and Presence does not establish a connection to the external database when you configure a external database entry. The external database has not created the database schema at this point. It is only when you assign an external database entry to a node that IM and Presence establishes an ODBC (Open Database Connectivity) connection with the external database. Once IM and Presence establishes a connection, the external database creates the database tables for the IM and Presence features.

Once you assign an external database entry to a node, you should be able to validate the connection using the System Troubleshooter in IM and Presence Administration.

Set up external database entry on IM and Presence

Perform this configuration on the publisher node of your IM and Presence cluster.

Before You Begin
  • Install and configure the PostgreSQL database.
  • Obtain the hostname or IP address of the PostgreSQL database.
Procedure
    Step 1   Select Cisco Unified CM IM and Presence Administration > Messaging > External Server Setup > External Databases.
    Step 2   Select Add New.
    Step 3   Enter the name of database that you defined at external database installation, for example "tcmadb."
    Step 4   Enter the username for the database user (owner) that you defined at external database installation, for example "tcuser."
    Step 5   Enter and confirm the password for the database user, for example "mypassword."
    Step 6   Enter the hostname or IP address for the external database.
    Step 7   Enter a port number for the external database.
    Step 8   Select Save.

    What to Do Next

    Assign the external database to a node in your cluster:

    • To assign an external database to a node for the Compliance feature, select Cisco Unified CM IM and Presence Administration > Messaging > External Server Setup > External Databases. See Instant Messaging Compliance for IM and Presence Service on Cisco Unified Communications Manager for information on configuring the IM Compliance feature on IM and Presence.
    • To assign an external database to a node for the Permanent Group Chat feature, select Cisco Unified CM IM and Presence Administration > Messaging > Group Chat and Persistent Chat. See the Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager for further information on configuring the Permanent Group Chat feature on IM and Presence.

    Verify external database connection status

    If you make a configuration change in the <install_dir>/data/pg_hba.conf or the <install_dir>/data/ postgresql.conf file after you assign the external database, perform these steps:

    1. Unassign and reassign the external database to the IM and Presence node.
    2. Restart the Cisco XCP Router service. Select Cisco Unified IM and Presence Serviceability > Tools > Control Center - Network Services to restart this service.
    Related Information

    Verifying the Status of an External Database Connection on IM and Presence

    IM and Presence provides the following status information on an external database:

    • Database reachability - verifies that IM and Presence can ping an external database.
    • Database connectivity - verifies that IM and Presence has successfully established an ODBC connection with the external database.
    Procedure
      Step 1   Select Cisco Unified CM IM and Presence Administration > External Server Setup > External Databases.
      Step 2   Select Find.
      Step 3   Select the external database entry that you wish to view.
      Step 4   Verify that there are check marks beside each of the result entries for the external database in the External Database Status section.
      Step 5   Select Cisco Unified CM IM and Presence Administration > Diagnostics > System Troubleshooter.
      Step 6   Verify that there are check marks beside the status of each of the external database connection entries in the External Database Troubleshooter section.

      Troubleshooting Tips

      • IM and Presence raises an alarm if it loses the ODBC connection to an external database.
      • You can also verify the status of the external database connection using the psql command. You must sign in to the Linux shell from a remote support account to run this command, it is not accessible through the administrator CLI. Run this command after you install the external database, but before you assign the database to a IM and Presence node. Enter: $sudo -u xcpuser /usr/local/xcp/bin/psql -U <database user> -h <database server> <database name> For example: $sudo –u xcpuser /usr/local/xcp/bin/psql –U postgres -h node1 tcmadb
      • If you configure the Compliance feature, and the Cisco XCP Message Archiver service fails to start, but the System Troubleshooter (Cisco Unified CM IM and Presence Administration > Diagnostics > System Troubleshooter) shows that the status of the external database connection is ok, we recommend that you unassign the external database from the node, and reassign it again.