Essbase User Roles From SQL Passthrough DataSet Properties

The ID of the SQLPassthroughDataSet that defines the query used to obtain all the roles as defined in the database.

If specified, the SQLPassthroughDataSet is used to obtain the list of roles that are displayed in the Role dropdown list in the View Selector’s HierarchyToRoleMapping dialog.

The ID of the SQLPassthroughDataSet that defines the query used to obtain all the users as defined in the database.

If specified, the SQLPassthroughDataSet is used to obtain the list of users that are displayed by the OwnerFilter_SpecificUsers property editor, which is used to configure a SavedViewList item in a view hierarchy.

This setting is required only if you want to add a SavedViewList item to a hierarchy that is configured to show the shared views of specific user(s).

The string within the RolesForUserSqlPassthroughDataSetID query SELECT statement to be replaced with the name of the Essbase user. This allows the user name to be used in the SELECT statement WHERE clause to query for only the roles associated with the authenticated user.

The user name variable can also be used in the RolesToShareViewsWithSqlPassthroughDataSetID and UsersToShareViewsWithSqlPassthroughDataSetID query SELECT statements to restrict the roles and users with whom the authenticated user is allowed to share views.

The ID of the SQLPassthroughDataSet metadata instance that defines the query used to obtain the authenticated user’s role(s).

Since the user name is not known until runtime, the query’s SELECT statement should include a WHERE clause that contains the SqlPassthroughDataSet_UserNameVariable value within a condition. For example, if the SqlPassthroughDataSet_UserNameVariable is %USERNAME% and the name of the column that contains the user name is UserName, the WHERE clause would be WHERE UserName = '%USERNAME%'.

This setting is required if you want to leverage the view selector’s HierarchyToRoleMapping capability, which allows you to control which view hierarchy or hierarchies are presented in the view selector based on the authenticated user’s role membership.

true

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

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.

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.

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.

See also: RolesRequiredForStartup_SpecificRoles

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

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

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

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.

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 RolesToShareViewsWithSqlPassthroughDataSetID and/or UsersToShareViewsWithSqlPassthroughDataSetID restrict the roles and/or users with whom the user is allowed to share saved views.

The ID of the SQLPassthroughDataSet that is used in conjunction with view sharing.

If specified, the SQLPassthroughDataSet defines the query used to obtain the roles with whom the authenticated user is allowed to share saved views. The roles are displayed in the User/Role dropdown list in the View Sharing dialog.

This setting is only required if you want to allow the user to select the role(s) with whom to share a saved view, which in effect shares the view with all users assigned the selected role.

To restrict the roles with whom the authenticated user can share views, the query’s SELECT statement can include a WHERE clause that contains the SqlPassthroughDataSet_UserNameVariable value within a condition.

The ID of the SQLPassthroughDataSet metadata instance that defines the query used to obtain the users who are assigned to a given role.

The SELECT statement should include a WHERE clause that contains the UsersInRoleSqlPassthroughDataSet_RoleNameVariable value within a condition. For example, if the UsersInRoleSqlPassthroughDataSet_RoleNameVariable is %ROLENAME% and the name of the column that contains the role name is RoleName, the WHERE clause would be WHERE RoleName = '%ROLENAME%'.

The SQLPassthroughDataSet is only used when a SavedViewList item is included in the view hierarchy and the item’s OwnerFilter is set to SpecifiedUsers and a role(s) is specified. At runtime, the SavedViewList item is replaced with all the shared views that are owned by users assigned to the specified role(s), which requires that all the users assigned a specified role be obtained.

The string within the UsersInRoleSqlPassthroughDataSetID query SQL statement to be replaced with the name of a given role.

The ID of the SQLPassthroughDataSet that is used in conjunction with view sharing.

If specified, the SQLPassthroughDataSet defines the query used to obtain the users with whom the authenticated user is allowed to share saved views. The users are displayed in the User/Role dropdown list in the View Sharing dialog.

This setting is only required if you want to allow the user to select the users(s) with whom to share a saved view.

To restrict the users with whom the authenticated user can share views, the query’s SELECT statement can include a WHERE clause that contains the SqlPassthroughDataSet_UserNameVariable value within a condition.