Use startEditMode API on Public Versions

As an application designer or story developer, you can use startEditMode API to start edit mode on specific planning areas in public versions.

You can use the following API to start edit mode:
Code Syntax
startEditMode(planningPublicEditOption: PlanningPublicEditOption, planningAreaFilters?: PlanningAreaFilters): boolean;
For the parameter PlanningPublicEditOption, you can specify the planning area:
  • AllData: Start edit mode on all data.
  • CustomizedPlanningArea: Start edit mode on customized planning area. You need to specify the dimensions and members that construct the planning area via PlanningAreaFilters, which is mandatory. For more information, refer to the following section.
  • PlanningArea: Start edit mode on planning area with data access control and data locking.
  • TableContextWithPlanningArea: Start edit mode on planning area with table context, data access control and data locking.
    Note

    The startEditMode API won't be affected by the setting Auto-generate based on the table context in tables' Builder panel.

Start Edit Mode on Customized Planning Area

Here's a script example to start edit mode on customized planning area with specified filters:
Sample Code
var PlanningAreaFilters = Table_1.getPlanning().getPlanningAreaInfo();

// Remove predefined Date dimension filter
PlanningAreaFilters.removeFilter("Date");

// Change predefined filter.
PlanningAreaFilters.changeFilter("GenericDimension", {"hierarchy":"H1","members":["[ GenericDimension].[H1].&[A]"]});

// Assign filter
var filters = PlanningAreaFilters.getFilters();

// Start edit mode with CustomizedPlanningArea option and filters
Table_1.getPlanning().getPublicVersion("Actual").startEditMode("Actual2", planningPublicEditOption.CustomizedPlanningArea, filters )
Note

If Optimize Recommended Planning Area isn't enabled in Modeler, edit mode starts on all data instead of planning area with table context or customized planning area.

Related Information