Essbase User Roles From Group Names Properties

The following properties are available for Essbase User Roles From Group Names objects, grouped by the categories shown in the authentication service editors.

Behavior

Property Type Default Description

AllowStartupForUserAssignedNoRoles

bool

true

Controls whether the application starts up when the user is not assigned any roles.

MessageCaptionForUserAssignedNoRoles

string

When the user is not assigned any roles and AllowStartupForUserAssignedNoRoles is False, a MessageBox is optionally displayed. If MessageTextForUserAssignedNoRoles is non-empty, the MessageCaptionForUserAssignedNoRoles is used as the MessageBox caption.

MessageTextForUserAssignedNoRoles

string

When the user is not assigned any roles and AllowStartupForUserAssignedNoRoles is False, a MessageBox is optionally displayed. If MessageTextForUserAssignedNoRoles is non-empty, a MessageBox is displayed and the MessageTextForUserAssignedNoRoles is used as the MessageBox text.

RoleFilters

string[]

Filters the Essbase and Dodeca user roles leveraged by the application. When a large number of roles are present, but only a limited number of the roles are relevant for the application, one or more RoleFilters can be applied to limit the roles that are valid in the context of the application.

Multiple filters can be applied, one per line, and wildcards and character range matching are supported. For example:

Center — Allows any role ending with the word "Center". [0-9]  — Allows any role starting with a number. User  — Allows the role "User".

RolesRequiredForStartup

RolesRequiredForStartupFilter

RolesRequiredForStartupFilter.AnyRole

Controls which roles are required to start the application.

AnyRole - allows any user with an assigned role to start the application.

AnySpecificRole - allows any user with an assigned role that matches any of the specified roles to start the application.

AllSpecificRoles - allows any user who matches all of the specified roles to start the application.

RolesRequiredForStartup_SpecificRoles

ViewAccessInfoList

Identifies the specific role requirements to start the application when the RolesRequiredForStartup property is set to AnySpecificRole or AllSpecificRoles.

Essbase Connection

Property Type Default Description

EssbaseConnectionID

string

The Essbase connection ID used to look up the connection metadata that defines the Essbase connection settings.

EssbaseLoginServiceObjectTypeID

string

The object type ID of the login service that obtains the credentials used to sign on to Essbase Deployment Services.

ValidateCredentialsOnly

bool

false

Controls whether the application simply validates the user-provided credentials or connects to the Essbase database specified by the Essbase connection settings associated with the EssbaseConnectionID.

View Sharing

Property Type Default Description

AllUsersExternalOnly

bool

true

Controls whether the list of users contains only external users or all defined users.

The list of users is obtained when users are allowed to specify a user with whom to share the saved view. The AllUsersExternalOnly setting is not used to authenticate the current user.

AllUsersExternalProtocol

string

CSS

Controls the external authentication protocol used when obtaining external users.

The list of users is obtained when users are allowed to specify a user with whom to share the saved view. The AllUsersExternalProtocol must be set when AllUsersExternalOnly setting is True. The AllUsersExternalProtocol setting is not used to authenticate the current user.

AllowSharingViewsWithEveryone

bool

true

Controls whether the authenticated user is allowed to share saved views with everyone.

By default, the user is allowed to share saved views with everyone. The property is typically set to False when the RolesToShareViewsWith and/or UsersToShareViewsWith restrict the roles and/or users with whom the user is allowed to share saved views.

RolesToShareViewsWith

RolesToShareViewsWithFilter

RolesToShareViewsWithFilter.None

Controls which roles (i.e. Essbase groups) the authenticated user is allowed to share views with.

None - No sharing with roles is allowed.

SameRoleAsUser - Sharing is allowed with the roles that the authenticated user is assigned to.

AllRoles - Sharing is allowed with all roles.

SpecificRoles - Sharing is allowed with the roles identified by the RolesToShareViewsWith_SpecificRoles property.

RolesToShareViewsWith_SpecificRoles

ViewAccessInfoList

Identifies the specific role(s) the authenticated user is allowed to share views with when the RolesToShareViewsWith is set to SpecificRoles.

UsersToShareViewsWith

UsersToShareViewsWithFilter

UsersToShareViewsWithFilter.None

Controls which users the authenticated user is allowed to share views with.

None - No sharing with individual users is allowed.

UsersInSameRoleAsUser - Sharing is allowed with any user who is assigned to a role (i.e. Essbase group) that the authenticated user is also assigned to. For instance, if the authenticated user is assigned to GroupA and GroupB, then sharing is allowed with the other users who are assigned to GroupA along with the other users who are assigned to GroupB.

AllUsers - Sharing is allowed with all other users.

SpecificUsers - Sharing is allowed with the users identified by the UsersToShareViewsWith_SpecificUsers property.

UsersToShareViewsWith_SpecificUsers

ViewAccessInfoList

Identifies the specific user(s) the authenticated user is allowed to share views with when the UsersToShareViewsWith is set to SpecificUsers.