Application Builder - Showing analysis results from Content Analytics Miner in an i-Frame widget.

If you use IBM® Watson Explorer Content Analytics, you can publish a widget from Content Analytics Miner to an Application Builder page. Publishing a widget enables it to be accessed by your Watson Explorer applications.

Before you begin

IBM Watson Explorer Content Analytics is provided with IBM Watson Explorer Advanced Edition.

You must create at least one analytics collection in Watson Explorer Content Analytics and verify that you can explore the collection by using Content Analytics Miner. You cannot configure a widget to show results from search collections.

Restriction: To publish a widget from Content Analytics Miner directly to an Application Builder page, you must have authority to log in to the Application Builder server as a Watson Explorer administrator. You are prompted to enter your credentials when you publish the widget.

About this task

To show analysis results from Content Analytics Miner, you must first create an application layout in Watson Explorer Content Analytics. The layout specifies how content in the collection is to be analyzed and how the results are to be rendered, such as in a pie chart or word cloud. You can then publish the layout as an i-Frame widget in Application Builder. If you need assistance with creating a layout, see Creating a layout in Content Analytics Miner.

After the widget is published to an Application Builder page, the content displayed in the widget is automatically updated. Information is dynamically pulled from Content Analytics Miner, based on the query defined in the widget, to ensure that the latest analysis results are shown in Application Builder.

Procedure

To publish a widget from Content Analytics Miner to Application Builder:

On the Dashboard view in Content Analytics Miner, ensure that the layout that contains the widget (layout pane) that you want to publish is displayed and select Actions > Customize.
In the navigation frame of the customizer, select the widget that you want to publish.
In the Layout area, specify a new node name for the widget and click Save.
Tip: By default, node names are not created when you configure layouts in Content Analytics Miner. If the widget that you want to publish already has a node name, you can skip this step and the next step.
After the Dashboard view is refreshed, select Actions > Customize again, and then select the widget that has the new node name that you specified.
Click URL Link next to the Node name field. After the link is generated and displayed, click Publish.
On the Publish to IBM Watson Explorer Application Builder page, specify values for how and where the widget is to be published:
- The Widget URL field contains the URL that was generated for you.
- In the Application Builder URL field, specify the URL for the Application Builder server, such as http://myhost.example.com:8080/AppBuilder.
- In the Page type field, select the type of Application Builder page that you want to add the widget to:
  - Select List if you plan to publish the widget on a custom page that was previously created with the Create custom page option.
  - Select Detail if you plan to publish the widget on the home page or search page.
- In the Entity type field, specify the name of the Application Builder page that you want to add the widget to, such as the home page, the search page, or the name of your custom page.
- In the Widget ID field, specify a unique name for the widget. The ID value is used as the label for the widget in Application Builder.
Click Publish. When prompted, log in to the Application Builder server. A message indicates that the widget was created successfully.
In Application Builder, add the widget to the default view of its associated page. For instructions, see Adding Widgets to Application Pages.

What to do next

In Application Builder, you can customize the widget and alter how the widget is displayed by editing the Evaluated URL field. An example of the URL that is generated by Content Analytics Miner is as follows:

http://content_analytics_miner:port/ui/analytics?layoutfile=my_Layout.json&weembedded=true

Where:

content_analytics_miner:port: Is the host name and port for Content Analytics Miner, such as example.server.com:8393.
?layoutfile=my_Layout.json: Is the file name of the Content Analytics Miner layout file that was used to publish the widget (layout files are stored in .json format).
&weembedded=true: Ensures that only the analysis results are displayed in the widget area. This option hides the Content Analytics Miner banner, search box, menus, and other user interface elements.
?dashboardlayout=myLayout: The name of the layout file in the Content Analytics Miner dashboard. The name is automatically retrieved by the system.
?weembeddedNoFilter=true: Provides access to the definition of the i-Frame widget in Content Analytics Miner. For example, you might want to explore a different collection or configure a default query in the application layout to render more specific analysis results. When this option is omitted (the default setting), the widget is in read-only mode. You can click anywhere in the widget area to view the widget in full-screen mode in Content Analytics Miner, but you cannot make changes to it.
?query=term: Shows the results of the specified query term when you open the widget. If the query term does not match any content in the collection, no results are displayed in the widget (for example, a word cloud might look empty).