Alter System

load application

Start an application, or start all applications on the Essbase Server.

unload application

Stop an application, or stop all applications on the Essbase Server.

set session_idle_limit

Set the interval of time permitted for a session to be inactive before Essbase Server logs off the user. The minimum limit that you can set is five minutes (or 300 seconds). When the session idle limit is set to none, all users can stay logged on until the Essbase Server is shut down.

The default user idle logout time is 60 minutes. When a user initiates a calculation in the background, after 60 minutes the user is considered idle and is logged out, but the calculation continues in the background.

Because the user may mistakenly assume that the calculation stopped because he or she was logged out, you can do one of the following to correct the user experience:

set session_idle_poll

Set the time interval for inactivity checking and security-backup refreshing. The time interval specified in the session idle poll gives Essbase instructions:

set invalid_login_limit

Set the number of unsuccessful login attempts allowed by any user before the system disables it. When you change this setting, the counter resets to 0. When the invalid login limit is set to none, there is no limit. By default, there is no limit.

set inactive_user_days

Set the number of days a user account may remain inactive before being disabled by the system. The counter resets when the user logs in, is edited, or is activated by an administrator. When the inactive days limit is set to none, user accounts remain enabled even if they are not used. By default, there is no limit.

set password_reset_days

Set the number of days users may retain passwords. After the allotted number of days, users are prompted at login to change their passwords. The counter resets for a user when the user changes the password, is edited, or is activated by an administrator. When the password reset days limit is set to none, there is no built-in limit for password retention. By default, there is no limit.

set variable

Change the value of an existing subsitution variable on the system. The value must not exceed 256 bytes. It may contain any character except a leading ampersand (&).

set sss_mode

Migrate Essbase Server and any existing users and groups to Shared Services security mode. Minimum permission required: Administrator. After you have converted to Shared Services security mode, you cannot revert to native security mode.

Password Enforcement Grammar:

set eas_loc

Set or change the Essbase Administration Server location that will be registered with Shared Services upon application creation or migration.

set server_port

Expand a port range specified in essbase.cfg. Each Essbase application uses two ports from this range. If no more ports are available, an error message is displayed.

clear logfile

Clear accumulated entries from the Essbase Server log located in the Essbase directory. New log entries are created to record subsequent activity.

delete export_directory

Delete directories created for linked reporting objects exported from a database to a directory created in ARBORPATH\app. Use this grammar after the exported LROs are migrated into a database using import lro, and the directories containing the exported LRO information are not needed.

To view a list of names of exported linked-reporting-objects directories in ARBORPATH\app, use display system export_directory.

add variable

Create a system-level substitution variable by name, and optionally assign a string value for the variable to represent. You can assign or change the value later using set variable. A substitution variable acts as a global placeholder for information that changes regularly. Substitution variables may be referenced by calculations and report scripts.

If substitution variables with the same name exist at server, application, and database levels, the order of precedence for the variables is as follows: a database-level substitution variable supersedes an application-level variable, which supersedes a server-level variable.

drop variable

Remove a substitution variable and its corresponding value from the system.

logout session all

Terminate all user sessions currently running on the Essbase Server.

logout session...force

Terminate a session (or sessions) even if it is currently processing a request. The request is allowed to proceed to a safe point, and then the transaction is rolled back.

logout session <session-id>

Terminate a session by its unique session ID number. To see the session ID number, use display session.

logout session by user

Terminate all current sessions by a particular user, either across the entire Essbase Server, or limited to a specific application or database.

logout session by user on application

Terminate all current sessions by a particular user across a specific application.

logout session by user on database

Terminate all current sessions by a particular user across a specific database.

logout session on application

Terminate all current user sessions across a specific application.

logout session on database

Terminate all current user sessions across a specific database.

shutdown

Shut down the Essbase Server.

kill request all

Terminate all current requests on the Essbase Server.

kill request <session-id>

Terminate the current request indicated by the session ID. You can obtain session IDs using display session.

kill request by user

Terminate all current requests by the specified user on the Essbase Server.

kill request on application

Terminate all current requests on the specified application.

kill request on database

Terminate all current requests on the specified database.

stop mining session

Terminate the current data-mining session. The session ID of the data-mining session can be determined using display mining session.

sync security_backup

Check whether the security backup file is the same as the security file, and if not, synchronize the security backup file with the current state of Essbase security. The effect is to refresh the backup file with any additions, changes, or deletions related to applications, databases, users, groups, filters, permissions, subsitution variables, locked objects, and system settings.

If sync security_backup is not issued directly as described above, the security backup file is checked/refreshed automatically at the same frequency with which session inactivity is checked globally. The default inactivity check interval is five minutes. To change the interval, use set session_idle_poll, or see the Oracle Essbase Administration Services Online Help.

enable unicode

Set the Essbase Server to allow the creation of Unicode-mode applications and the migration of non-Unicode-mode applications to Unicode-mode applications.

disable unicode

Prevent the Essbase Server from allowing the creation of Unicode-mode applications or the migration of non-Unicode-mode applications to Unicode-mode applications.

compact security file

Defragment the security file. Fragmentation can gradually develop when objects such as users, groups, applications or databases are removed or changed. Please note that this operation slows down agent activity until the operation is completed, which could take a few minutes.

rename global registration name

Change the name of the global application and application project in Shared Services.

reconcile

When Essbase is started using a security backup file (essbase_timestamp.bak) instead of essbase.sec, reconcile the security file to match the state of Essbase on an external disk. This grammar displays discrepancies in application and database information between the security file and the external disk: