Cube Watcher

The Cube Watcher allows for scheduling jobs by watching for changes to IBM Planning Analytics cube data.

Watch tasks can be set up to periodically check a cell's value. If a specified trigger value is found, a job is run. This makes it easy to orchestrate Euclid Studio jobs from changes in PA data.

To use the Cube Watcher, click on Cube Watcher in the Settings menu under Jobs.

If Cube Watcher is currently active, its icon will be visible in the Euclid Studio top bar. If it's encountered any errors, this will also be shown in the top bar.

Cube Watch Settings

Some settings specific to Cube Watcher must be configured before use. These include a Planning Analytics connection, the cell data to watch, and the jobs to run.

NB: Only one user can edit these settings at a time. Multiple users changing these settings at once can lead to unintended changes.

Persisting Cube Watch Changes

Any changes made to these settings must be Saved in order to preserve them. Any settings not saved will be lost on closing this window.

In order to revert back to the last saved state, click Undo Changes.

Cube Watch Connections

Adding a New Connection

Cube watch requires a connection to Planning Analytics to first be set up; this can be either a PA Local or Cloud connection.

In the Connection Type dropdown, select the desired connection type. This will bring up a dialog similar to that seen when setting up new Flow Connections.

After all connection details are filled out, the connection can be tested and saved.

NB: The Cube Watcher connection is specific to Cube Watcher, and can not use an existing data connection. Only Planning Analytics connections are support for Cube Watcher.

Editing Existings Connections

If an existing connection needs to be updated, the Edit button can be used to alter the current connection.

Planning Analytics Cube Settings

After connecting to a PA instance, the rest of the Cube Watcher settings can be configured.

This includes settings up a reference to an existing PA cube view, and assigning a Trigger column, Status column, and creating Watch Tasks.

Assigning a View

The Cube and View dropdowns allow you to select a specific view to watch. This view will contain all the cells that DataWORQ will watch for changes.

NB: The state of the view that appears in Architect or PAW is what will be polled in DataWORQ. I.e., if zero suppression is enabled for the view, it will be enabled for the watched cells as well.

Trigger Columns

The Trigger Column represents the view column that's actively watched. These values are pulled into DataWORQ and compared against the Trigger Value. If the Trigger Value matches the cell value, a job will be triggered.

After triggering the job, this value will be updated to the Reset Value.

The Data Type for the Trigger Value can be either String or Numeric. This should match the type of the Planning Analytics cell that is being compared against.

NB: It is recommended to use a String value for a trigger.

Status Columns

The Status Column represents the view column that's updated with the current status of the job that's be triggered. Valid states are RUNNING and COMPLETED.

NB: This must be a String value in the PA cube.

Watch Tasks

A Watch Task contains a reference to a row in the view, as well as a DataWORQ flow file.

If the value at the intersection of the Trigger Column and the Watch Task row is the Trigger Value, then the Run Profile in this Watch Task is run as a job.

Multiple watch tasks can be created for different rows in the view.

If notifications are enabled for the Watch Task, then the executed job will run and notify.

Cube Watch Settings Reference

Watch Task Settings Reference