Managing Connector Sources

You can view, search, modify, and delete the connector sources.

Procedure

  • To view, search, or delete connector sources, complete the following steps:
    1. In the navigation pane of Dashboard Designer, click Connector & Sources > Connector Sources.

      The All Connector Sources page opens in a new tab. The page displays all the already created data sources.

    2. Complete any of the following steps:
      • To find all the data sources that belong to a connector, from the View list, select a connector type.
      • To find a connector source, enter the name of the source in the Search field.
      • To delete a connector source, click the Delete Delete icon that is displayed on that source row.
  • To modify APM, ITM, or Monitoring Connector Source, complete the following steps:
    1. Under the Actions column for a source, click the View/Edit View/Edit icon.
    2. In the Edit Connector Source window, complete any of the following steps based on the connector source:
      • For APM and ITM data sources, in the Username and Password field, edit the username and password for the source.
      • For Monitoring Data Sources, in the Tenant ID field, edit the tenant ID for the source.
    3. To make sure that the connection to edited data source is active and successful, click Test Connection.

      If the connection to the data source fails, then a message that indicates the reason for connection failure is displayed. You must fix the errors and test the connection again.

    4. Click Save.
  • To modify the third-party JDBC Connector Sources that use JDBC Connector, complete the following steps:
    1. Under the Actions column for a third-party connector source, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. Edit any of the following fields:
      • In the Database Driver Class Name field, enter the driver class name for the third-party data source.
      • In the Database Driver Location field, enter the location of the directory where the JAR file of the database is placed. For example, install_dir/wlp/usr/servers/prdapp/jdbcdrivers/jar_name.jar folder.
        Where
        • install_dir is Cloud Application Business Insights installation location. By default, it is /opt/icabi.
        • jar_name is the name of the JAR file.
      • In the Database User field, enter username for the third-party database provider.
      • In the Password field, enter password for the third-party database provider.
        Note: Even if the third-party database administrators change passwords of the databases, the already active connections remain active and unchanged, unless the connections are deleted and added again.
    3. Click Next.
    4. In the Query field, enter or edit the sample query for the third-party database.
    5. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
    6. Click Save.
  • To modify REST API, Elasticsearch, Nagios XI, QRadar®, SolarWinds, Druid, Prometheus, ServiceNow, Google BigQuery, Google Sheet, Cloud Event Management, or Tivoli® Netcool®/OMNIbus services, complete the following steps, based on the connector type:
    1. Under the Actions column for any REST API services, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. From the Authentication Type list, select None or Basic Authentication based on whether username and password are configured during the installation of the service.
      If you select Basic Authentication, then you must complete the following steps:
      1. In the User Name field, enter a username to connect to the REST API service.
      2. In the Password field, enter a password to connect to the REST API service.
      Note:
      • For REST API connector, you can also select Token-Based Authentication or SSO. For Token-Based Authentication, you can edit any fields that are required for token request. For more information, see Token-Based Authentication.
      • For Google Sheet and Google BigQuery Connectors, you can select Google JWT File, and enter the absolute path of the JWT file.
    3. Click Next, and complete the following steps to modify the sample request.
    4. From the Method list, select a method and complete any of the following steps based on the method that you select:
      • For GET method, in the URI field, enter the uniform resource identified (URI) for the source.
        Note: For Elasticsearch, Nagios XI, Google Sheet, Prometheus, Cloud Event Management, ServiceNow, and QRadar connectors, you can select GET method only.
      • For POST method, in the URI field, enter the URI for the source, and in the Request Body method, enter the post request.
        Note: For Druid connector, you can select POST method only.
      • Under Custom Headers, complete the following steps:
        • In the Name field, enter the request header name that is provided by the REST API web service provider.
        • In the Value field, enter the request header value that is provided by the REST API web service provider.
    5. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
    6. Click Save.
  • To modify a Cassandra Data Source, complete the following steps:
    1. Under the Actions column for a Cassandra Database, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. Optional: In the Keyspace field, enter a Keyspace value.
    3. Optional: In the User Name field, enter a username to connect to the Cassandra Database.
    4. Optional: In the Password field, enter a password to connect to the Cassandra Database.
      Note: If you enter a username, then you must ensure that you also enter a password. You can either leave both the fields blank or enter information in both the fields.
    5. Click Next.
    6. In the Query field, enter or edit the sample query for the Cassandra Database.
    7. Click Save.
    8. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  • To modify a MongoDB Data Source, complete the following steps:
    1. Under the Actions column for a MongoDB Database, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. Optional: In the Mongo Database Name field, enter the name of the MongoDB Database.
    3. In the Mongo Collection Name field, enter the collection name of the MongoDB Database.
    4. Click Next.
    5. In the Query field, enter or edit the sample query for the MongoDB Database.
    6. Click Save.
    7. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  • To modify an Apache Hive Data Source, complete the following steps:
    1. Under the Actions column for an Apache Hive Data Source, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. Optional: In the Database User field, enter a username that is used during Apache Hive configuration.
    3. Optional: In the Password field, enter a password that is used during Apache Hive configuration.
    4. Click Next.
    5. In the Query field, enter a sample query for Apache Hive Data Source.
    6. Click Save.
    7. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  • To modify an HBase Data Source, complete the following steps:
    1. Under the Actions column for an HBase Data Source, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. If you changed the location of the XML configuration file, then in the Hadoop Configuration File field, enter the modified path to the XML configuration file.
    3. In the Table Name field, enter any other database table name from which you want to retrieve data.
    4. Optional: In the Start Rowkey field, enter any other row key value from which you want to retrieve data.
    5. Optional: In the End Rowkey field, enter any other row key value up to which you want to retrieve the data.
      Note: Data is retrieved for all the row key values that lie between the start and the end row keys, including the start row key data. The end row key data is not retrieved.
    6. Optional: In the Columns field, enter column family names or column names for which you want to retrieve data.
      Note: Enter values either in the Columns field or in the Filter Expression field.

      For more information about the End Rowkey and Columns fields, see Configuring Apache HBase Database Connector Sources.

    7. Optional: In the Filter Expressions field, enter any of the HBase filter expressions.
    8. Click Save.
    9. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  • To modify a real-time data source, complete the following steps:
    1. Under the Actions column for a real-time data source, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. Optional: If you changed the Cloud Application Business Insights installation server or if you installed the Real Time Data Collector on another server, then complete the following steps:
      • In the Real Time Data Collector Server IP or Host Name field, enter the IP address or hostname of the server where Real Time Data Collector is installed.
      • In the Port Number field, enter the port number for the Real Time Data Collector.
    3. Click Save.
  • To modify the Excel Connector Sources, complete the following steps:
    1. Under the Actions column for an Excel Connector Source, click the View/Edit View/Edit icon.

      An Edit Connector Source window opens.

    2. In the Excel File Name field, enter the path and file name of any other Excel file.

      For example, <install_dir>/wlp/usr/servers/prdapp/excel/<file_name>

      Where, <install_dir> is Cloud Application Business Insights installation location. By default, it is /opt/icabi.
      Note:
      • Save the Excel file at the specified location. If you change this location, then the file cannot be backed up or restored by using the default backup and restore scripts that are provided along with Cloud Application Business Insights. See Application backup and restore.
      • Files that are saved on a remote server cannot be accessed.
    3. Click Next.
    4. In the Query field, enter or edit the query for the Excel sheet.
    5. To make sure that the connection to the data source is successful, click Test Connection.
      If the source details and the sample request are valid and complete, then a message that indicates that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
      Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
    6. Click Save.

Results

The All Connector Sources page displays the following details for each connector source:
  • Connector source name
  • Connector type
  • Date and time when the connector source was first created, and the username of the user who first created the source.
  • Date and time when the connector source was last modified, and the username of the user who last modified the connector source. Only the latest record is displayed.