Pipette Analysis Charting - Integration Guide (On Prem)

Last Updated: Oct 10, 2015 04:49PM PDT

Summary: on-prem Pipette Analysis Charting can be integrated with Pipeline Pilot, and configured to work with dashboard layouts, templates, and JavaScript and server-side callbacks. This article provides details on how to perform these integration tasks.

Covered Topics

Clicking a link will scroll the page to the relevant section.

Data from Cache

To launch Pipette Analysis Charting with data pulled from a user-scoped Pipeline Pilot cache, specify a dataid parameter with the cache name:

http://myserver:9944/pipettechart/?dataid=mycache

To create a temporary store that will be automatically cleaned up, use the Pipette Cache Writer component.

Loading Data from a Protocol

To launch Pipette Analysis Charting with data generated by a Pipeline Pilot protocol, specify a _service parameter with the protocol name:

http://myserver:9944/pipettechart/?_service=protocols/myapp/myprotocol

You can also pass parameters to the protocol:

http://myserver:9944/pipettechart/?_service=protocols/myapp/myprotocol&project=123456&timeframe=1week

Each time the user visits the URL, the protocol runs. This works well for dashboards where live data is required.

The Pipette Analysis Dashboard Builder component automatically generates the URL with the service and parameters, when placed into the protocol you want to turn into a dashboard.

Dashboard Layouts

The configuration of the dashboard is serialized in the # after the URL:

http://myserver:9944/pipettechart/?dataid=mycache#xy;Alcohol;;Calories||histogram;Rating

When you set up your dashboard in Pipette Analysis Charting, this # is generated automatically and can be copied if you need to use it programmatically in your code.

Templates

Users can define a set of templates on a per-server basis. The easiest way to do this is through the Templates tab on the user interface.

Shared templates can only be edited by people with the Pipette Analysis/EditSharedTemplate permission.

Callbacks

The following types of callbacks are available to applications that launch Pipette Analysis Charting:

  • JavaScript callbacks back to the launching web page
  • Server-side callbacks

Note: The sent callback events and information is the same for both types of callbacks.

Currently Supported Callback Events

Currently supported callback events include:

  • config – A change to the chart configuration.
  • export – The export of data from the charting application.
  • selection – The currently selected user data. This may include data indexes, ranges for numeric properties and lists of categorical properties.

JavaScript Callbacks

This is similar to the postMessage integration option with the Pipette Sketcher described previously.

To request notification of messages from the application, get a reference to the frame containing the Pipette Analysis Charting application and send an empty message like the following:

   iframeRef.postMessage('', '*');

Key events in the application will then be sent back to the containing application as a JSON string:

   window.addEventListener("message", function(event) {
      if (event.origin === "http://charting.acme.com") { //It's good to check this
         var message = event.data;
         //TODO – your application logic here
      }
   }, false);

Server Callbacks

To request that the application sends callbacks directly to the server, add the _callback and _callbackMessage parameters. For example, to be notified of config changes and exports:

Each time these events occur, a POST is made to URL /my/callback with the following parameters:

http://myserver:9944/pipettechart/?_service=protocols/myapp/
  myprotocol&_callback=/my/callback&_callbackMessage=config&_callbackMessage=export

Each time these events occur, a POST is made to URL /my/callback with the following parameters:

Parameter Value(s)
Message config
export
Content JSON string with relevant event details

Note: For security reasons, the URL must be a relative URL (starting with /) on the server that runs Pipette Analysis Charting.

Related

Pipette Analysis Charting

Pipette Sketcher Integration


http://assets0.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete