Add a Site

To configure connections between sites and platforms to the Knowledge Platform, use the Sites page. With sites, you can add connection information for each site that you want to integrate with the Knowledge Platform.

This topic contains the following sections:

NOTE: You must have Administrator permissions to add sites. For more information about setting up user permissions, refer to Manage User Accounts.

Add a site for Reporting and Metrics

The Knowledge Platform provides dashboards and reporting for the Stewardship Tier, via embedded dashboards, to extend and improve the planning, status tracking and reporting around your data initiatives. Initially this functionality supports the Advanced Data Migration solution with Data Quality and Governance to be added in future releases. To enable the embedded dashboards, a Reporting Site must be created to link the Knowledge Platform to the correct Stewardship Tier instance.

To add a site for Reporting and Metrics:

  1. Click Admin in the Profile menu.
  2. Click Sites on the left.
  3. Click Add Site.

  4. Select Reporting and Metrics from the Purpose list box.
  5. Enter a name for the site in the Name field.
  6. Enter your username in the Username field.
  7. Enter your password in the Password field.
  8. Enter the hostname or IP address of your server in the Hostname field.
  9. Enter the port for your server in the Port field.
  10. Enter the name of the instance to which you want to connect in the Instance field.
  11. If you want to enter your server credentials in the Connection URL field without using the URL builder, use the following format: sqlserver://username:password@host:port/instance?param...

    NOTE: The connection information is the same information that the Stewardship Tier WebApp is configured to use for connecting to the database. This address is relative to the Stewardship Tier WebApp server because in most cases, the Stewardship Tier database is only exposed to a local network. The address could be an internal hostname or an RFC 1918 address so long as the Stewardship Tier WebApp machine can resolve the name and connect to it.

    NOTE: The Stewardship Tier database may or may not be on the same machine as the Stewardship Tier WebApp, which is where the Reporting and Metrics Agent runs to collect the data.

    Below are some examples of what needs to be populated in the Connection Information field based upon common SQL Server setup.

    Example

    Expected Connection Information String

    Server Name, Standard Port

    • Server Name: 10.1.2.89
    • SQL Instance: <No Instance>
    • Port: <Standard Port 1433>
    • Username: DSP
    • Password: Password

    sqlserver://DSP:Password@10.1.2.89

     

    Server Name, Instance Standard Port

    • Server Name: 10.1.2.89
    • SQL Instance: SQL2019
    • Port: <Standard Port 1433>
    • Username: DSP
    • Password: Password

    sqlserver://DSP:Password@10.1.2.89/SQL2019

     

    Server Name, Non Standard Port

    • Server Name: 10.1.2.89
    • SQL Instance: <No Instance>
    • Port: 1480
    • Username: DSP
    • Password: Password

    sqlserver://DSP:Password@10.1.2.89:1480

     

    Server Name, Instance, Non-Standard Port

    • Server Name: 10.1.2.89
    • SQL Instance: SQL2019
    • Port: 1480
    • Username: DSP
    • Password: Password

    sqlserver://DSP:Password@10.1.2.89:1480/SQL2019

     

     

  12. Click Save.
  13. Copy and save the contents of the Config File field that in a text file.

    NOTE: The Config File will disappear once you navigate away from the page, so be sure to save it somewhere secure first.

    NOTE: Config Files are used to link the Stewardship Tier to the Knowledge Platform tenant. Refer to the section Set Up and Configuration for Reporting and Metrics Agent in the Installation & Upgrade Manual for more information.

  14. Click the Use as a source for migration dashboard toggle to enable the site to be used as a source for the migration dashboard. Refer to Enable/Disable the Migration Metrics plugin for more information.

    NOTE: When the site is disabled as a source for a migration dashboard, all data associated with the site will be deleted from the dashboard and cannot be retrieved again.

Queries Executed

When the site is added, metrics extraction queries are executed.

Enable/Disable the Migration Metrics plugin

One or more sites may be used as a source for migration dashboards. To use a site as a source for a migration dashboard, click the Use as a source for migration dashboard toggle. There are a few things to keep in mind when enabling and disabling sites for this purpose:

  • It can take up to 10 minutes for the initial extraction of data from the site, so don’t worry if you don’t see your updated migration dashboard right away.

  • If you remove the source, you will lose any history of the site as the dashboard's source and the site’s record will be updated to reflect the change. Once you save this change, the deletion of dashboard data may take 1 or more hours to complete.

  • If you disable a site as a source for a migration dashboard, all data and history related to that site as a source must be deleted before the site can be re-enabled as a source. We’ll do this behind the scenes, but you’ll have to wait 1 or more hours before you can re-enable the site as a source.

  • Only one site may be used for each Stewardship Tier project landscape (as in, Dev, QA, and Prod instances for a single project). If you have two or more project landscapes, you may select more than one source; however, if you select more than one source for instances within the same project landscape, the data will be duplicated in the dashboard. If you only wish to use one site as a source for a project, you must disable the original site as a source for the dashboard to avoid duplication or incorrect data.

Delete a site

To delete a site:

  1. Click in the Page toolbar.

  2. Select Delete Site from the list box.

    NOTE: If this site is used as the source for a migration dashboard, a new site must be selected or the dashboard will be empty.

    NOTE: When the site is disabled as a source for a migration dashboard, all data associated with the site will be deleted from the dashboard and cannot be retrieved again.

  3. Click Yes, Delete.

View agent error logs

You can use the agent errors logs to view the status of a site that uses an agents to the Knowledge Platform to Stewardship Tier instance. The log offers details of any errors raised in the last 48 hours. Each error message is stamped with the date and time (in UTC, regardless of the user’s local selection) of the event that caused the agent/plugin to experience an error.

To troubleshoot uploading errors between the Knowledge Platform and Reporting and Metrics sites:

  1. Click the icon above the upload status.
  2. Click View Error Log.
  3. Scroll up and down to view all relevant error messages.
  4. Click x to close the window.

The following are some common error messages and possible reasons these messages display:

Error Message

Implication

“could not collect metric logs: Login error: mssql: Login failed for user XXXX.”

Authentication issues—Incorrect credentials entered; incorrect username/password combination.

“could not collect version: mssql: The SELECT permission was denied on the object XXXX, database XXXX, schema ‘dbo’.”

Permissions issues—Insufficient permissions on the user account running the agent.

“could not collect metric logs: Unable to get instances from Sql Server Browser on host <IP ADDRESS>: read udp <IP ADDRESS>:<PORT>-><IP ADDRESS>:<PORT>: i/o timeout”

NOTE: IP and Port are redacted in the UI, but the values display in the logs.

IP address/port issues—Possibly incorrect values entered or blocked by firewall/network configuration.

“could not collect metric logs: Unable to open tcp connection with host <IP ADDRESS> dial tcp <IP ADDRESS>:<PORT> connectex: No connection could be made because the target machine actively refused it.”

“could not collect metric logs: Unable to get instances from Sql Server Browser on host <IP ADDRESS> read udp <IP ADDRESS>:<PORT>-><IP ADDRESS>:<PORT>: i/o timeout”