Using the Planning Enabled Property and the setEnabled API

When you work with planning applications and use a planning model for the table, the table property Planning enabled is active in the Builder panel.

This property determines whether the table is input-enabled or not.
Note

If you use BPC live data connections you can switch between read-only and input mode for tables at runtime by using the table's quick actions menu (Switch to Read-Only Mode and Switch to Input Mode)..

At design time, you can program whether the table should be switched to input or read-only mode with the help of the setEnabled( API:

  • If you use the script (for example for a button) Table.getPlanning().setEnabled(false), the table is switched to read-only mode when the application user clicks the button..

  • If you use the script Table.getPlanning().setEnabled(true), the table is switched to input mode.

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 have been changed, the table will be set to read-only and the according locks in BPC will be released.

  • If data cells have been changed, no publish dialog will be shown. The table will be set to read-only mode and the locks and the 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.