Skip to main content
Pentaho Documentation

Publish an Instaview Project to the BA Server

Overview

Explains how to publish an Instaview project.

This feature is experimental in Pentaho version 5.1 and is disabled by default.

After you have created and saved your Instaview project, you can publish it to a BA Server as a data source that you can share with your colleagues.  Even if they do not have PDI installed, your colleagues will see the Instaview project as a data source that they can use in BA design tools such as Analyzer and Pentaho Interactive Reporting. You can also choose to publish one or more views, which are analyzer reports, along with your Instaview project.  You can schedule an automatic reprocessing of your data so the data source and views are refreshed at regular intervals.

Enable the Publish Feature in Instaview on your System

The publish feature in Instaview is currently shipped as disabled. To enable this feature on your system, you will make several configuration changes.

Step One: Rename the plugin.xml_ File

  1. Navigate to the biserver-ee/pentaho-solutions/system/instaview-svc file.
  2. Rename the 'plugin.xml_' file to 'plugin.xml' by removing the trailing underscore in the file name.

Step Two: Enable the AgileBI Data Source

To enable the AgileBI data source, you must edit the settings.xml file.

  1. Navigate to the biserver-ee/pentaho-solutions/system/data-access file.
  2. Edit the settings.xml file. At the end of the Agile Mart Data Source section of the file, add the following line: <enable-agile-mart-datasource>true</enable-agile-mart-datasource>
  3. Save your changes and restart the BA Server.

Step Three: Enable the Publish Feature in Instaview

To enable the publish feature in Instaview you must edit the settings.xml.

  1. Navigate to the data-integration/plugins/spoon/agile-bi/platform/pentaho-solutions/system/instaview/settings.xml file.
  2. Edit the settings.xml file. At the end of the file, add the following line:  <enable_gui_publish>true</enable_gui_publish>
  3. Save your changes and restart Instaview.

The publish feature for Instaview is now enabled on your system.

Set Up and Publish an Instaview Project to a BA Server

Configure and save your Instaview project, then click the Publish button in the Instaview window.  Three panels appear: BA Server, Analysis Report, and Data Refresh.

Panel Description
BA Server Contains connection credentials
Analysis Report Indicates whether you want to publish an Analyzer report, as well as report publishing details.
Data Refresh Schedules the republishing of the Instaview project and Analyzer reports.

Step One: Connect to Server

Select the connection information for the BA Server you want to publish to from the Server Name text box in the BA Server panel, then click Save.  If the name of the connection that you need does not appear, add one by doing these things.

  1. Click the + button.
  2. Enter the BA Server's Name and URL.
  3. Enter the connection credentials by specifying the user name and password you need to connect to the BA Server.  Make sure that the user you choose is assigned to a role that has Read Content, Create Content, Schedule Content, Execute Transformations and Jobs, Manage Data Sources, and Publish Content permissions assigned.
  4. Click the Test button to make sure that the connection credentials are valid.  Keep in mind that a test can fail if the connection credentials are valid, but the BA Server has stopped or if the BA Server's staging area has not been configured properly.
  5. A message appears indicating whether the connection was made successfully.  Note the message, click the OK button, then make any necessary adjustments.
  6. Click the Done button.
  7. The connection appears as highlighted in the Server Name list.  Click the Save button to select the connection.   
  8. The BA Server panel collapses and the name of the connection you just selected appears.

A new Instaview project data source that has the name of Instaview project you just published appears in the Manage Data Source window in the Pentaho User Console. You can then use it as you would any other data source. If you also published analyzer views, they appear in a folder in the Browse Files page in the Pentaho User Console.

Step Two: Publish the Report
If you don’t want to publish the Analyzer report along with the Instaview project, skip this step.  If you do want to publish the Analyzer report, do these things.

  1. Click the Enable button in the Analysis Report panel.  A list of folders on the BA Server appears.  
  2. Indicate that you want to publish the Analyzer report by clicking the button next to the Upload Analysis report when publishing field so that it is On.
  3. Select the location you want to publish to by clicking the folders until you find the one you want, then click Save, then go to the next step.
    Note: If you have permission to publish or write to a folder, the Save button is enabled.  If not, both the Save button and the + button next to the folder name are disabled.
  4. If you want to create a new folder instead of choosing an existing one navigate to the location where you want to create the folder then click the “+” button to add a folder.  Enter the name of the new folder in the New Folder window, then click the OK button.  The new folder appears in the folder tree structure.  Click Save to save the location.

Step Three: Schedule a Data Refresh
You can schedule a refresh for the data source created when publishing an Instaview project. This feature allows you to create a data source for business users and keep that data current when used in reports run on the BA server.

When scheduling a data refresh, you may want to consider your BA server environment and your users' needs. It is recommended that you schedule the refresh when less system resources are in use, such as on a Sunday at 2:00 AM. Also, you may want to consider when your users require the most current data set.

If you schedule a weekly refresh of the data, you can specify the days of the week to run the refresh, as well as a start and end dates.

  1. In the Data Refresh Schedule panel, click Edit to expand a list of scheduling options in the panel.
  2. In the Repeat drop-down menu, select how often you want to refresh the data.
    • Never: The data will not be scheduled to refresh. The PDI transformation will run once on the BA server, using the same data set as defined in Instaview.
    • Weekly: The data will be scheduled to refresh weekly and will appear in the list in the Schedules window of the User Console. When you select 'Weekly', more customization options appear.
  3. If you selected 'Weekly', then in the Run every week on section, choose the days of the week for refreshing the data.
  4. Choose a start date and start time using the date and time fields provided. You can click the calendar icon to open the date picker. These fields default to the current date and time.
  5. In the Repeat until section, select the No end date option to schedule the data to refresh indefinitely, or select End by and enter a date in the field provided. You can click the calendar icon to open the date picker. The End by date field defaults to the current date.
  6. Click Save. The Data Refresh Schedule panel collapses. The data refresh information now appears in the panel.

Edit the BA Server Connection

Note: If you edit the connection information, all Instaview projects that share the same connection will also use the edited connection information the next time they are published.
  1. Open an existing Instaview project, then click Publish in the Instaview window.
  2. In the BA Server panel, select the server connection information that you want to edit from the Server Name list. 
  3. Click the Edit button. (The Edit button looks like a pencil.) The BA Server panel expands to show the current connection information.
  4. Change the information as needed. Note that if you edit the name, and other Instaview projects are also configured to use this connection, you must manually reset the connection in each of those projects.
  5. Click the Test button to make sure that the connection credentials are correct.  Keep in mind that a test can fail if the connection credentials are valid, but the BA Server is down or if you do not have permission to publish data sources to the BA Server. The test can also fail if the BA Server's staging database has not been configured.
  6. A message appears indicating whether the connection was made successfully.  Note the message, click the OK button, then make any necessary adjustments. 
  7. Click the Done button.
  8. The connection appears as highlighted in the Server Name list.  Click the Save button to select the server.   
  9. The BA Server panel collapses and the name of the server you just selected appears.

Updated server connection information is saved. The next time you publish the Instaview project, or any other Instaview project that uses a connection with the same name, the updated connection information is used.

 

Remove the BA Server Connection

Warning: Use care when you remove the connection information, as it might affect other Instaview projects.
  1. Open an existing Instaview project, then click the Publish button in the Instaview window.
  2. In the BA Server panel, select the server connection information that you want to remove from the Server Name list. 
  3. Click the Remove ("X") button.
  4. The Delete Server Connection message appears. Click Yes. The server information is permanently deleted.

The server connection information is permanently deleted. The next time you publish the Instaview project, or any other Instaview project that uses the deleted connection, you will not be able to publish it until you have manually reset the connection.