Alter System

Click here for aggregate storage version

Change the state of the Essbase Server. Start and stop applications, delete application log files, manipulate system-wide variables, manage password and login activity, disconnect users, kill processes, back up the security file, and shut down the server. Permission required: administrator.

Syntax

Use alter system to change the following system-wide settings:

KeywordDescription

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 limit is 60 minutes.

set session_idle_poll

Set the time interval for inactivity checking and security-backup refreshing. The time interval specified in the session idle poll tells Essbase both of the following:

  • How often to check whether user sessions have passed the allowed inactivity interval indicated by session_idle_limit in the alter system statement.

  • How often to refresh the security backup file. If session_idle_poll is set to zero, the security backup file is still refreshed every five minutes.

set invalid_login_limit

Set the number of unsuccessful login attempts allowed by any user before the user account becomes disabled. 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. Once you have converted to Shared Services security mode, you cannot convert back to native security mode.

Password Enforcement Grammar:

  • enforce username_as_password—Create passwords that are the same as user names for users being migrated to Shared Services.

    Note:

    The passwords are created as lower-case, even if there are upper-case letters in the user name. For example, if a user name KSmith is migrated with this option, the password will be ksmith.

  • enforce auto_password—Automatically generate new passwords for the users being migrated to Shared Services. To discover the generated passwords, use display user all in shared_services_native with auto_password;

    Optionally save the generated passwords to a non-default file location. If specifying a file name that already exists, use the force keyword to overwrite the file.

    If no file name and location are specified, the passwords are saved by default to $ESSBASEPATH\bin\MigratedUsersPassword.txt.

  • enforce password <PASSWORD>—Generate the specified password for users being migrated to Shared Services.

set eas_loc

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

Note:

After changing the Essbase Administration Server location, you must re-register any existing applications with Shared Services, using alter application reregister.

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 have already been migrated into a database using import lro, and the directories containing the exported LRO information are no longer needed.

Note:

This process only works for directories created in ARBORPATH\app using the DBS-EXPORT-DIR option of the export lro statement. It does not work for directories created elsewhere using the FULL-EXPORT-DIR option of the export lro statement.

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 find out 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 to 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, or 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 every five minutes. To change the interval, use set session_idle_poll, or see the Oracle Essbase Administration Services Online Help.

resync sss

Applies in Shared Services security mode only. Synchronize the Essbase Server security definitions for all users, groups, and applications with the current state of Shared Services security. Permission required: Administrator.

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.

Notes

SESSION SPECIFICATION

A session is a single user connection to Essbase Server. The session can be identified by keywords and names indicating context, or by a unique session ID number.

A request is a query sent to Essbase Server by a user or by another process; for example, starting an application, or restructuring a database outline. Only one request at a time can be processed in each session.

If a session is processing a request at the time that an administrator attempts to terminate the session, the administrator must either terminate the request first, or use the force kewyord available with alter system to terminate the session and the current request.

PASSWORD ENFORCEMENT SPECIFICATION

Example

alter system unload application Sample;

Stops the Sample application, if it is currently running.

alter system logout session by user Fiona;

Disconnects Fiona from any applications or databases to which she is connected.

Note:

To log out a user, log out the sessions owned by that user.

alter system set password_reset_days 10;

Specifies that all users will be prompted after 10 days to change their passwords. The day count for any user is reset when the user changes the password or is edited or re-activated by an administrator.