Use Planning Enabled Property and setEnabled API

As an application designer or story developer, when you use a planning model for the table in your analytic application or optimized story, you can enable planning in the Builder panel or leverage setEnabled() API to let planners input data.

When you add a table with planning model, Planning Enabled is by default active in its Builder panel. This property determines whether the table is input-enabled or not.

Note

If you use BPC live data connections, planners can switch between read-only and input mode for tables in view time by selecting Switch to Read-Only Mode or Switch to Input Mode from the context menu.

In addition, you can use setEnabled() API to let planners turn on read-only mode or input mode.
Example

For a button, if you write Table.getPlanning().setEnabled(false) for its onClick event, the table is switched to read-only mode when the end user clicks the button. If you write Table.getPlanning().setEnabled(true), the table is switched to input mode upon the click.

Note
If you set the setEnabled() API to false, on a table with BPC live data connection with an input-ready query, two cases can occur:

  • If no data cells've been changed, the table is set to read-only and the according locks in BPC are released.

  • If data cells've been changed, no publish dialog is shown. The table is set to read-only mode and the locks and changed data are kept in the BPC System. If the data is published or reverted with the help of APIs, the kept data is removed, and the BPC locks are deleted.