Checks whether the application is in administration mode with access limited only to Service Administrators.

This command, which returns true if the application is in administration mode and false otherwise, is useful for checking the status of the application before running automation scripts. For example, the refreshCube command requires the application to be in administration mode. You can use this command in the automation script as follows to check if the application is in administration mode.

adminMode = ‘ getApplicationAdminMode’
        if ["$adminMode" == "true"]

Applies to

Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management, Account Reconciliation, Strategic Workforce Planning, and Sales Planning.

Required Roles

Service Administrator


epmautomate getApplicationAdminMode


epmautomate getApplicationAdminMode