User Guide for the Cisco Unified Intelligence Center Reporting Application, Release 9.1(1)
Data Sources
Downloads: This chapterpdf (PDF - 1.37MB) The complete bookPDF (PDF - 6.54MB) | The complete bookePub (ePub - 2.08MB) | Feedback

Data Sources

Data Sources

A data source represents a database. Each reporting server requires one data source for each database from which reports are populated.

Note


  • Unified Intelligence Center supports MS SQL Server and Informix databases.
  • Unified Intelligence Center supports Data Source connections across a wide area network.
  • Unified Intelligence Center does not support Windows Authentication to an MS SQL Server database. Use SQL authentication only.

Data Sources Drawer : Click the Data Sources drawer in the left panel to open the Data Sources page. (Only users with the System Configuration Administrator privileges can access the full functions of this drawer.)


Note


All actions on the Data Source interface are based on user role and on the user's object permissions for data sources.

See also Troubleshooting Data Sources.

Data Sources Page

This page opens when you click the Data Sources drawer. After a new installation, this page shows the following Data Sources:

  • Unified Intelligence Center data source
    • A Data Source for the Unified Intelligence Center database is added by the installer. This database holds tables for objects such as reports, dashboards, value lists, and users that are added and maintained on that member node. The Unified Intelligence Center data source for each member is replicated across the cluster.
    • You can edit the description for the Unified Intelligence Center data source, but do not change other fields. The Unified Intelligence Center data source for each node is configured by default to point to that member.
  • UCCE Historical data source
    • This data source is added by default to support the Unified ICM/CC stock historical reports and UCCE User Integration.
    • Complete the Database Host, Database Name, and the Database User ID and Password fields for this data source and ensure that it is online before Unified CCE User Synchronization can occur.
  • UCCE Realtime data source
    • This data source is added by default to support the Unified ICM/CC stock real time reports.
    • Complete the Database Host, Database Name, and the Database User ID and Password fields for this data source.

Depending on your environment, the UCCE Historical and UCCE Realtime data sources can point to the same machine.


Note


If you attempt to import CVP Call Back Reports on the standard data source (cvp_data), the import fails with the following message:

“Import could not be completed: Query validation failed against the selected data source.”

To correct this issue, create a separate data source to point to the callback database instead of the cvp_data database.


For more information about configuring a CVP data source, refer to Create a Data Source for Unified CVP Report Data section in CVP Reporting Guide.

You have the option to execute a CLI command such that each node points to a unique IP Address for the UCCE Historical or Realtime data source. The command is set cuic-properties host-to-ip. The CLI is documented in the Administration Console User Guide for Cisco Unified Intelligence Center.

Figure 1. Data Sources

If you plan to import reports that will pull data from databases other than the aw_hds, add data sources for those databases.

Click the radio button at the left of each row to select and edit that data source.

Table 1 Rows on Data Sources Page

Field

Description

Name

The name of the data source.

Connected Node

Shows the status of the connected data source. The green check mark indicates connectivity. The red x indicates no connectivity. Primary indicates primary data source. Secondary indicates secondary data source.

Standby Node

Shows the status of the standby data source. The green checkmark indicates connectivity. The red x indicates no connectivity. Primary indicates primary data source. Secondary indicates secondary data source.

Type

The database type (MS SQL Server or Informix).

Database Host

DNS name or IP address of the database server.

Note   

The database name must be the AWDB name and not the HDS name. The system uses the views from the AW database to get information from the HDS database.

Database Name

The name of the database.

Charset

The character set used by the data source.

Actions from this page depend on your permissions and include:

  • Create—opens the Data Source Create/Edit page with blank fields for defining a new data source. (Available only for the System Configuration Administrator user.)
  • Edit—enabled when a row is selected, opens the Data Source Create/Edit page where you can review or modify fields. (Disabled for most users.)
  • Delete—enabled when a row is selected, prompts for a confirmation and then deletes the data source. (Available only for System Configuration Administrator users with WRITE permissions on the data source.)
  • Refresh—updates the data source page to reflect any changes.
  • Switch Node— prompts to switch over to the alternate database host. This button is enabled if the selected data source has a secondary database host configured to it, and the user has edit permissions to the data source.
  • Help—opens online help.
  • X—closes the page.

Automatic Switch Over

If the connection to the database fails while running a report, Unified Intelligence Center attempts to switch to a standby node if one is available. A switch over is attempted if any of the following conditions occur:

  1. Connection Failure (SQL States = 08000, 08002, 08003, 08006, 08S01, 08007, 01002)
  2. SQL-client unable to establish SQL-connection (SQL State = 08001)
  3. SQL-server rejected establishment of SQL-connection (SQL State = 08004) If any of these condition occur while running a report, Unified Intelligence Center checks whether the corresponding datasource has a standby node configured. An automatic switch takes place, if a standby node is configured and is reachable. The report execution will be uninterrupted and it will run against the newly connected datasource node.

Data Source Rules

A database must be set up with an SQL user account with a password and read-only permission for the database and minimum OS user privileges (for Informix).

The database server must be set to allow SQL authentication and to enable TCP/IP protocol and remote network connection.

The database port must not be blocked by firewalls, routers, or any other security software (such as Cisco Security Agent).

The following are not supported:

  • Windows integrated authentication connection to MS SQL Server.
  • A data source that points to more than one database.

Create a Data Source

Unified Intelligence Center allows you to configure primary and secondary data sources from data source page.

Procedure
    Step 1   Select Data Sources drawer > Data Sources page > Create to open the Data Sources create page.
    Step 2   Complete fields in the Primary tab as follows to configure the primary data source:

    Field

    Fields available in

    Value

    Name

    All data sources

    Enter the name of the data source.

    When users create Report Definitions and Value Lists, they see only the name of the data sources. Give a meaningful name to a new Data Source.

    Description

    All data sources

    Enter a description for this data source.

    Type

    All data sources

    Select a value from the list. Options are Informix and MS SQL Server.

    Select a value from the list. Options are Informix and MS SQL Server.

    Database Host

    Microsoft SQL Server and Informix data sources

    In a single-node deployment, enter the DNS name or IP address of the primary database server.

    In a multi-node cluster, use the DNS name. Do not use the IP address.

    Port

    Microsoft SQL Server and Informix data sources

    Enter the port for the database

    For SQL Server, leave this field blank to use the default port (1433).

    Database Name

    Microsoft SQL Server and Informix data sources

    Enter the database name.

    Instance

    Microsoft SQL Server and Informix data sources

    Required for Informix. Specify the server instance name of the Informix database you are connecting to. The environment INFORMIXSERVER on the Informix database server should contain the instance information.

    Timezone

    Microsoft SQL Server and Informix data sources

    Select the correct time zone for the data stored in the database.

    Database User ID

    Microsoft SQL Server and Informix data sources

    Enter the ID for the user who is authorized to access the database.

    Password and Confirm Password

    All data sources

    Enter and confirm the password for the database user.

    Charset

    Microsoft SQL Server and Informix data sources

    The character set used by the database.

    The default character set is ISO-8859-1 (Latin 1).

    If your database uses Non-Latin-1 encoding, select the appropriate character set for your locale from the drop-down menu.

    If the character set is not correct, the data source may fail to connect to the database or reports may not be readable.

    This must be UTF-8 for the Unified CVP Informix database.

    Permissions

    All data sources

    View or edit the permissions for this data source for My Group.

    Note   

    My Group refers to the data source owner's default group. If this default group is All Users group, the option to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.

    Step 3   Complete the fields on the Secondary tab as follows to configure the secondary data source.

    Field

    Value

    Failover Enabled

    Select the Failover Enabled check box to enable secondary data source.

    Database Host

    In a single-node deployment, enter the DNS name or IP address of the secondary database server.

    In a multi-node cluster, use the DNS name. Do not use the IP address.

    Port

    Enter the port for the database

    For SQL Server, leave this field blank to use the default port (1433).

    Database Name

    Enter the database name.

    Instance

    Required for Informix. Specify the server instance name of the Informix database you are connecting to. The environment INFORMIXSERVER on the Informix database server should contain the instance information.

    Timezone

    Select the correct time zone for the data stored in the database.

    Database User ID

    Enter the ID for the user who is authorized to access the database.

    Password and Confirm Password

    Enter and confirm the password for the database user.

    Charset

    The character set used by the database.

    The default character set is ISO-8859-1 (Latin 1).

    If your database uses Non-Latin-1 encoding, select the appropriate character set for your locale from the drop-down menu.

    If the character set is not correct, the data source may fail to connect to the database or reports may not be readable.

    This must be UTF-8 for the Unified CVP Informix database.

    Default Permissions

    View or edit the permissions for this data source for My Group.

    Note   

    My Group refers to the data source owner's default group. If this default group is All Users group, the option to set permissions for non-administrative users is disabled. Only administrative users can set permissions for the All Users group.

    Step 4   Test the database connection before you save the data source.

    Actions from this page:

    • Save—Saves your new entry or changes to the fields.
    • Cancel—Cancels your changes and closes the page.
    • Test Connection—Tests that the Data Source is online. If the status is Offline, review the error message to determine the cause and edit the data source accordingly. Repeat the steps until the data source is Online.
    • If the data source is offline or there is a connection issue, an error message button labeled Show Error Details becomes available on the Data Sources page. Click this button to see the error message provided from the database.
    • Help—opens online help.
    • X on the tab heading—closes the page.

    Note


    When the database type is Informix, the error message may be a generic one and may not provide detail about why the connection failed.

    Delete a Data Source

    To delete a data source, click the radio button to the left of the data source name and then click Delete.

    Click Yes to confirm the deletion. Click No to cancel.

    Both Yes and No generate another dialog box confirming your action to delete or to cancel the deletion. Click OK to confirm the deletion.


    Note


    Data sources are referenced by Report Definitions and Value Lists. When you delete a data source that is used by Report Definitions or Value Lists, a message informs you that you cannot delete the data source until the dependent value lists or report definitions are deleted or are updated to reference another data source.

    Map to Multiple Databases

    Unified Intelligence Center is a clustered solution. For each node you can import and install stock reports that run against the real-time and historical databases.

    A single database may be unable to support an entire cluster simultaneously. You can distribute the reporting load to several databases using the CLI and conventional name resolution.

    To direct a specific Member node to a database host other than the one in Data Sources, use the set cuic-properties host-to-ip command to resolve the data source name differently on each node.

    Using this command at each Member node, you can define a unique mapping so that different nodes map the same database name to a different IP address as follows:

    For example, if the Datasource host for the UCCE Historical datasource is sprhds2.krypton.icm:

    Figure 2. Map the Data Source



    Then to map the UCCE Historical data source for Member_Node_2 to a unique IP Address, access the CLI from Member_Node_2 and enter the command: set cuic-properties host-to-ip sprhds2.krypton.icm <hds ip-address>.

    The CLI is documented in the Administration Console User Guide for Cisco Unified Intelligence Center. With this command, you map the host name with an IP address.

    You can use this method for any data source.


    Note


    Avoid using DNS. The mapping is from a name to an IP address, but the name is not necessarily a DNS name.