Initializing help system before first use

Testing with the Flow Shop Example

After you have finished setting up the Tableau integration, you can check to make sure it is fully operational.
The built-in Xpress Insight Tableau health check runs several system tests to verify that the integration with Tableau is working correctly. However, the health check cannot validate the connection from Tableau to the MySQL mirror database. To do this, you can publish an example app and use it to directly check the Tableau visualization.

Running the Health Check

The Tableau integration health check performs a series of tests that check the configuration of the Tableau integration, as well as the status of individual Tableau-integrated apps.
To run the health check, follow these steps:
  1. Go to the Admin tab in the Xpress Insight user interface.
  2. In the Visualization section, click Health Check.
    The health check report page opens.
The health check starts running as soon as the report page opens and might take several minutes to complete, depending on the status of the system. When the health check is complete, the results appear in the report.
If you want to repeat the health check after correcting any issues, click Refresh.

Health Check Report

The health check report shows the results of multiple tests divided into three sections, which run sequentially. If a failure is encountered, the report indicates the reason for the failure, and subsequent tests in that section are not run. Any tests not run show a status of SKIPPED. The report includes the following secions:

Mirror Health Check

This section reflects the settings entered in the mirror configuration area of the application.properties configuration file and tests the connection to the database.
  • Database URL
  • Username
  • Target Capacity
  • Minimum Time to Live
  • Maximum Idle Time

These five steps reflect the configuration that Insight has read from the application.properties file.

  • Database connection

This step tests the connectivity between the Insight server and the mirror database that is used by the Tableau workbooks. Any failure in this section indicates that there is a problem with the MySQL server or an improper configuration in the Insight properties file.

Tableau Health Check

This section reflects the settings entered in the Tableau configuration area of the application.properties configuration file and tests the connection to Tableau.
  • Tableau URL
  • Site ID
  • System User
  • Mirror Host
  • Mirror Port

These five steps reflect the configuration that Insight has read from the properties file.

The following steps check the connectivity and integration with Tableau Server:

  • Xpress Insight server tries to connect to the URL provided for Tableau Server. If it cannot connect to the provided URL, the resulting error is shown in the report. Connection can be caused by any of the following conditions:
    • The Tableau Server URL is incorrectly configured on the Tableau configuration page.
    • Tableau Server is not running.
    • Tableau Server is running on a different port from what is expected. To see the current port being used, log on to Tableau Server using an account with administrator privileges, run the tsm topology list-ports command, and check the gateway port.
    • A firewall or router is blocking access to Tableau Server.
  • Tableau Version
    • Displays the detected version of Tableau Server.
  • JS API Version
    • Displays the detected version of the Tableau JS API.
  • Server Authentication
    • The Xpress Insight server attempts to log in to Tableau using the Tableau system user credentials. If this attempt is unsuccessful, make sure that the provided credentials are correct and can access the Tableau server and site (if provided).
  • Tableau System User Role
    • The Xpress Insight checks whether the specified user is a system administrator or a site administrator.
  • Tableau Projects
    • The Xpress Insight server attempts to log in to Tableau using the Tableau system user credentials provided and retrieve a lit of Tableau projects. If this attempt fails, check the role of the specified user within Tableau Server and make sure that it has either system administrator or site administrator privileges.
  • Tableau Workbooks
    • The Xpress Insight server attempts to log in to Tableau using the Tableau system user credentials provided and retrieve a lit of Tableau workbooks. If this attempt fails, check the role of the specified user within Tableau Server and make sure that it has either system administrator or site administrator privileges.
  • Trusted Ticket Authentication
    • Checks whether a trusted ticket can be generated using the system user. This checks whether the trust has been configured correctly between Tableau Server and the Xpress Insight server.
      If an error occurs with an error code of -1, the issue is likely to be one or more of the following:
      • The Xpress Insight server is not in the list of trusted hosts. This is the most common reason for this failure.
      • The specified Tableau username is not a valid server user. The Xpress Insight server uses the Tableau system user provided on the Tableau configuration page to perform this check.
  • Remote Client Connection
    • Checks the URL provided for Tableau Server. If the URL is set to localhost or 127.0.0.1, a warning is shown indicating that viewing Tableau views is available only if the Web client is on the same machine as Tableau Server.

Tableau Apps Health Check

This section shows the status of the Tableau integration for each Tableau-enabled app. When you upload an app, Xpress Insight publishes any Tableau assets to the Tableau server in the background. The information in this section indicates whether each app is ready to use, along with details about the publication status of the app's Tableau integration.
  • An overall status of PASS indicates that all Tableau assets have been published successfully, and all apps are online and ready to use.
  • FAIL indicates that an error caused the publication of the Tableau assets for one or more apps to fail. The detailed information for the app includes any error message from Tableau indicating why the failure occurred.
  • WARN indicates that at least one app is offline and not ready to use. This might indicate that the Tableau assets are still being published, or that some problem is preventing the publication from completing. Check the status information for the app for more details.

Testing with the Flow Shop Example

To verify the complete end-to-end Tableau integration, upload an example app to and verify that the Tableau visualization is successfully rendered.
This procedure uses the Flow-Shop demo example app, which is included in the Insight Developer Kit. You can download this from the same location where you downloaded the Xpress Insight software installer, and then unzip it to a suitable location on your local machine.
To test the Tableau integration with an example app, follow these steps:
  1. On the Xpress Insight Home page, click Upload App.
  2. Navigate to the Flow-Shop demo app in the tableau_reports/flowshop folder of the Insight Developer Kit.
  3. Select the flowshop.zip file.
    After the upload completes, a tile for the new app appears on the Home page.
  4. Click the Flow-Shop demo tile.
  5. Click on the shelf to open the Scenario Manager. Double-click on the scenario Scenario 1 to add it to the shelf. Close the Scenario Manager.
  6. Click on the scenario on the shelf to open the scenario action menu. Click Load to load the scenario with data.
  7. When the scenario has finished loading, click on the scenario action menu and click Run to execute the scenario and generate results data.
  8. Click the by Machine Gantt tab.
When the system has completed the execution of the scenario, the preparation of the data in the mirror and the initialization of Tableau, then you should see Tableau render a Gantt chart of the machine scheduling.
Parent Topic Validating the Tableau Integration

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.