EssSetUserType

Enables you to define the application access type for a user. You can add, remove, or replace different application access types for a user name.

The application access type is a user property. If a user is created inOracle Hyperion Planning, Fusion Edition, it automatically has an application access type of planning; if a user is created in Administration Services, it automatically has an application access type of Essbase. Once a user is created, the application access type can be modified in the corresponding application using EssSetUserType.

Syntax

ESS_FUNC_M EssSetUserType (hCtx, UserName, UserType, Cmd)

Parameter	Data Type	Description
hCtx	ESS_HCTX_T	Essbase API context handle.
UserName	ESS_STR_T	Name of user.
UserType	ESS_USER_TYPE_T	ESS_USER_ESSBASE is the application access type, if no application access type is specified. This user will be enabled with all functionality.
Cmd	ESS_USERTYPE_CMD_T	Whether to add/remove/replace the type specified. Only the Essbase type, ESS_USER_ESSBASE, can be added or removed. ESS_USERTYPE_CMD_ADD—Adds the new type specified to the existing application access type. ESS_USERTYPE_CMD_REMOVE—Removes the types specified from the existing application access type.

Return Value

Returns the status of the API.

Example

ESS_FUNC_M
ESS_SetUserType (ESS_HCTX_T   hCtx)
{
   ESS_FUNC_M                   sts = ESS_STS_NOERR;
   ESS_STR_T                    UserName="jsmith";
   ESS_USER_TYPE_T              UserType = ESS_USER_ESSBASE;
   ESS_USERTYPE_CMD_T           cmd = ESS_USERTYPE_CMD_ADD;
   sts = EssSetUserType         (hCtx, UserName, UserType, Cmd);
   return (sts);
}