Database Setup for IM and Presence Service on Cisco Unified Communications Manager, Release 9.0(1)
IM and Presence Service External Database Setup
Downloads: This chapterpdf (PDF - 1.31 MB) The complete bookPDF (PDF - 2.17 MB) | Feedback

IM and Presence Service External Database Setup

IM and Presence Service External Database Setup

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

About External Database Assignment

External Database and Node Assignment

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

  • Message Archiver (compliance) — You require at least one external database per cluster. Depending on your deployment requirements, you can also configure a unique external database per node.

  • Persistent Group Chat — You require a unique external database per node. Configure and assign a unique external database for each node in your cluster.

  • If you deploy the persistent group chat and message archiver features on an IM and Presence Service node, you can assign the same external database to both of the features.

For more information see:
  • Message Archiver — Instant Messaging Compliance for IM and Presence Service on Cisco Unified Communications Manager.

  • Persistent Group Chat — Configuration and Administration of IM and Presence Service on Cisco Unified Communications Manager.

Related References

External Database Connection

IM and Presence Service does not establish a connection to the external database when you configure an 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 Service establishes an ODBC (Open Database Connectivity) connection with the external database. Once IM and Presence Service establishes a connection, the external database creates the database tables for the IM and Presence Service features.

Once you assign an external database entry to a node, you can validate the connection using the System Troubleshooter in the Cisco Unified CM IM and Presence Service Administration user interface.

Set Up External Database Entry on IM and Presence Service

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

Before You Begin
  • Install and configure the external database.

  • Obtain the hostname or IP address of the external database.

Procedure
    Step 1   Log in to the Cisco Unified CM IM and Presence Administration user interface. Choose Messaging > External Server Setup > External Databases.
    Step 2   Click Add New.
    Step 3   Enter the name of the 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.

    The default port numbers for Postgres (5432) and Oracle (1521) are prepopulated in the Port Number field. You can choose to enter a different port number if required.

    Step 8   Click Save.

    If you make a configuration change in the install_dir/data/pg_hba.conf file or the install_dir/data/postgresql.conf file after you assign the external database, you should verify the external database connection.

    What to Do Next

    • To assign an external database to a node for the persistent chat feature — Log in to the Cisco Unified CM IM and Presence Administration user interface. Choose Messaging > Group Chat and Persistent Chat. See Configuration and Administration of IM and Presence Service on Cisco Unified Communications Manager for further information on configuring the persistent chat feature on the IM and Presence Service.

    • To assign an external database to a node for the message archiver feature — See Configuration and Administration of IM and Presence Service on Cisco Unified Communications Manager for further information on configuring the message archiver feature on the IM and Presence Service.

    Verify External Database Connection

    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:

    Procedure
      Step 1   Unassign and reassign the external database to the IM and Presence Service node.
      Step 2   Restart the Cisco XCP Router service. Log in to the Cisco Unified IM and Presence Serviceability user interface. Choose Tools > Control Center - Network Services to restart this service.

      Verify External Database Connection Status on IM and Presence Service

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

      • Database reachability — Verifies that the IM and Presence Service can ping an external database.

      • Database connectivity — Verifies that the IM and Presence Service has successfully established an Open Database Connectivity (ODBC) connection with the external database.

      Procedure
        Step 1   Log in to the Cisco Unified CM IM and Presence Administration user interface. Choose Messaging > External Server Setup > External Databases.
        Step 2   Click Find.
        Step 3   Click the link for the external database entry that you want 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.
        Tip   
        • The IM and Presence Service generates an alarm if it loses ODBC to an external database.

        • You can also verify the status of the Postgres 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 the following command after you install the Postgres database, but before you assign the database to an IM and Presence Service node.

          Enter:

          $sudo -u xcpuser /usr/local/xcp/bin/psql -U db_user -h db_server db_name

          For example:

          $sudo –u xcpuser /usr/local/xcp/bin/psql –U postgres -h postgres_server tcmadb

        • If you configure the message archiver (compliance) feature, and the Cisco XCP Message Archiver service fails to start, but the System Configuration Troubleshooter window 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.


        To view the status and verification tests for all database connections, you can also access the System Troubleshooter:

        Procedure
          Step 1   Log in to the Cisco Unified CM IM and Presence Administration user interface, choose Diagnostics > System Troubleshooter.
          Step 2   Verify that there are check marks beside the status of each of the external database connection entries in the External Database Troubleshooter section.