Planning API Reference

Complete reference for planning operations in SAP Analytics Cloud scripting.

Source: Analytics Designer API Reference (current release)

Getting Planning Reference
Version Management
Data Operations
Data Locking
Data Actions
Multi-Actions
Planning Enumerations
Complete Examples

Getting Planning Reference

Access Planning API via Table widget:

var planning = Table_1.getPlanning();

Note: Planning features require a planning-enabled model connected to the table.

Version Management

Public Versions

getPublicVersion(versionId)

Returns a public version object.

var budgetVersion = Table_1.getPlanning().getPublicVersion("Budget2024");

getPublicVersions()

Returns all public versions.

var allPublicVersions = Table_1.getPlanning().getPublicVersions();

Private Versions

getPrivateVersion(versionId)

Returns a private version object.

var draftVersion = Table_1.getPlanning().getPrivateVersion("myDraft");

getPrivateVersions()

Returns all private versions.

var allPrivateVersions = Table_1.getPlanning().getPrivateVersions();

createPrivateVersion(versionId, options)

Creates a new private version.

var newDraft = Table_1.getPlanning()
    .createPrivateVersion("Draft_" + Date.now().toString());

Version Object Methods

isDirty()

Checks if version has unsaved changes.

var version = Table_1.getPlanning().getPublicVersion("Budget2024");
if (version.isDirty()) {
    console.log("Version has unsaved changes");
}

publish()

Publishes changes to the version.

var version = Table_1.getPlanning().getPublicVersion("Budget2024");
if (version) {
    if (version.isDirty()) {
        version.publish();
    }
}

copy(targetVersionId, copyOption, category?)

Copies version to a new version.

Parameters:

Parameter	Type	Required	Description
targetVersionId	string	Yes	Name for new version
copyOption	PlanningCopyOption	Yes	What to copy
category	PlanningCategory	No	Version category

// Copy public version to new private version
var budgetVersion = Table_1.getPlanning().getPublicVersion("Budget2024");
if (budgetVersion) {
    budgetVersion.copy(
        "Budget_Copy_" + Date.now().toString(),
        PlanningCopyOption.PlanningArea
    );
}

// Copy with category
var sourceVersion = Table_1.getPlanning().getPrivateVersion("Source");
if (sourceVersion) {
    sourceVersion.copy(
        "TargetVersion",
        PlanningCopyOption.AllData,
        PlanningCategory.Budget
    );
}

// Copy as Forecast
var forecastSource = Table_1.getPlanning().getPrivateVersion("ForecastDraft");
if (forecastSource) {
    forecastSource.copy(
        "Forecast_" + Date.now().toString(),
        PlanningCopyOption.PlanningArea,
        PlanningCategory.Forecast
    );
}

revert()

Reverts unsaved changes in the version.

var version = Table_1.getPlanning().getPublicVersion("Budget2024");
version.revert();

delete()

Deletes a private version.

var draft = Table_1.getPlanning().getPrivateVersion("OldDraft");
if (draft) {
    draft.delete();
}

Data Operations

submitData()

Submits pending data changes.

Table_1.getPlanning().submitData();

getPlanningArea()

Returns planning area configuration.

var planningArea = Table_1.getPlanning().getPlanningArea();

Data Locking

getDataLocking()

Returns data locking interface.

var dataLocking = Table_1.getPlanning().getDataLocking();

getState(selection)

Returns lock state for a selection.

var selection = Table_1.getSelections()[0];
var lockState = Table_1.getPlanning().getDataLocking().getState(selection);

Lock States:

Locked - Data is locked by another user
Unlocked - Data is available for editing
LockedByMe - Data is locked by current user

Example: Check Before Edit

var selection = Table_1.getSelections()[0];
var lockState = Table_1.getPlanning().getDataLocking().getState(selection);

if (lockState === DataLockingState.Locked) {
    Application.showMessage(
        ApplicationMessageType.Warning,
        "Data is locked by another user"
    );
} else {
    // Proceed with edit
    performEdit();
}

Data Actions

Execute predefined data actions.

Execute Data Action

// Simple execution
DataAction_1.execute();

// With parameters
DataAction_1.setParameterValue("YEAR", "2024");
DataAction_1.setParameterValue("VERSION", "Budget");
DataAction_1.execute();

Data Action Events

DataAction_1.onBeforeExecute = function() {
    Application.showBusyIndicator();
};

DataAction_1.onAfterExecute = function(result) {
    Application.hideBusyIndicator();
    if (result.success) {
        Application.showMessage(ApplicationMessageType.Info, "Data action completed");
    } else {
        Application.showMessage(ApplicationMessageType.Error, "Data action failed");
    }
};

Background Execution

// Execute in background
DataAction_1.executeInBackground();

// Monitor status
DataAction_1.onExecutionStatusUpdate = function(status) {
    console.log("Status:", status);
    if (status === ExecutionStatus.Completed) {
        Table_1.getDataSource().refreshData();
    }
};

Multi-Actions

Execute multiple data actions in sequence.

Execute Multi-Action

MultiAction_1.execute();

With Parameters

MultiAction_1.setParameterValue("YEAR", "2024");
MultiAction_1.setParameterValue("SCENARIO", "Actual");
MultiAction_1.execute();

Events

MultiAction_1.onBeforeExecute = function() {
    Application.showBusyIndicator();
};

MultiAction_1.onAfterExecute = function(result) {
    Application.hideBusyIndicator();
    Table_1.getDataSource().refreshData();
};

Planning Enumerations

PlanningCopyOption

PlanningCopyOption.AllData       // Copy all data
PlanningCopyOption.PlanningArea  // Copy planning area only

PlanningCategory

PlanningCategory.Budget          // Budget category
PlanningCategory.Forecast        // Forecast category
PlanningCategory.Actual          // Actual category
PlanningCategory.Plan            // Plan category

DataLockingState

DataLockingState.Locked          // Locked by another user
DataLockingState.Unlocked        // Available for editing
DataLockingState.LockedByMe      // Locked by current user

ExecutionStatus

ExecutionStatus.Running          // In progress
ExecutionStatus.Completed        // Successfully completed
ExecutionStatus.Failed           // Execution failed
ExecutionStatus.Cancelled        // Cancelled by user

Complete Examples

Example 1: Version Publishing Workflow

// Button: Publish Budget
Button_Publish.onClick = function() {
    Application.showBusyIndicator();

    try {
        var budgetVersion = Table_1.getPlanning().getPublicVersion("Budget2024");

        if (!budgetVersion) {
            Application.showMessage(
                ApplicationMessageType.Error,
                "Budget version not found"
            );
            return;
        }

        if (!budgetVersion.isDirty()) {
            Application.showMessage(
                ApplicationMessageType.Info,
                "No changes to publish"
            );
            return;
        }

        budgetVersion.publish();
        Application.showMessage(
            ApplicationMessageType.Success,
            "Budget published successfully"
        );

    } catch (error) {
        console.log("Error:", error);
        Application.showMessage(
            ApplicationMessageType.Error,
            "Failed to publish budget"
        );
    } finally {
        Application.hideBusyIndicator();
    }
};

Example 2: Create Working Copy

// Button: Create Working Copy
Button_CreateCopy.onClick = function() {
    var sourceVersion = Table_1.getPlanning().getPublicVersion("Budget2024");

    if (sourceVersion) {
        var timestamp = Date.now().toString();
        var copyName = "WorkingCopy_" + timestamp;

        sourceVersion.copy(copyName, PlanningCopyOption.AllData);

        Application.showMessage(
            ApplicationMessageType.Info,
            "Created working copy: " + copyName
        );
    }
};

Example 3: Data Action with Confirmation

// Button: Run Allocation
Button_RunAllocation.onClick = function() {
    Popup_Confirm.open();
};

// Confirm button in popup
Button_ConfirmYes.onClick = function() {
    Popup_Confirm.close();

    Application.showBusyIndicator();

    // Set parameters from dropdown selections
    DataAction_Allocation.setParameterValue(
        "SOURCE_VERSION",
        Dropdown_SourceVersion.getSelectedKey()
    );
    DataAction_Allocation.setParameterValue(
        "TARGET_VERSION",
        Dropdown_TargetVersion.getSelectedKey()
    );
    DataAction_Allocation.setParameterValue(
        "YEAR",
        Dropdown_Year.getSelectedKey()
    );

    DataAction_Allocation.execute();
};

DataAction_Allocation.onAfterExecute = function(result) {
    Application.hideBusyIndicator();

    if (result.success) {
        // Refresh data
        Table_1.getDataSource().refreshData();
        Application.showMessage(
            ApplicationMessageType.Success,
            "Allocation completed successfully"
        );
    } else {
        Application.showMessage(
            ApplicationMessageType.Error,
            "Allocation failed: " + result.message
        );
    }
};

Example 4: Find Active Planning Cycle

// Find active planning cycle from attribute
function findActivePlanningCycle() {
    var allCycles = PlanningModel_1.getMembers("PlanningCycle");
    var activeCycle = null;

    for (var i = 0; i < allCycles.length; i++) {
        if (allCycles[i].properties.IsActive === "X") {
            activeCycle = allCycles[i].id;
            break;
        }
    }

    return activeCycle;
}

// Use in initialization or filter setup
var activeCycle = findActivePlanningCycle();
if (activeCycle) {
    Table_1.getDataSource().setDimensionFilter(
        "PlanningCycle",
        activeCycle
    );
}

Example 5: Revert Changes

// Button: Discard Changes
Button_Revert.onClick = function() {
    var version = Table_1.getPlanning().getPublicVersion("Budget2024");

    if (version && version.isDirty()) {
        version.revert();
        Table_1.getDataSource().refreshData();
        Application.showMessage(
            ApplicationMessageType.Info,
            "Changes discarded"
        );
    } else {
        Application.showMessage(
            ApplicationMessageType.Info,
            "No changes to discard"
        );
    }
};

Best Practices

Always check version exists before operations
Use isDirty() before publish to avoid unnecessary saves
Show busy indicator during long operations
Handle errors with try-catch blocks
Refresh data after successful operations
Check lock state before editing shared data

/sap-sac-scripting