Workplace Access Roles Extensions

The Workplace Access Roles Extensions supports ready-to-use behavior for the creation and management of access roles used by Application Engine applications. This add-on feature supplies a description and name for the access role, identifies the application which created the access role, provides the ability to determine whether the access role is a custom implementation and who are the secured access members of the role, and enables the location of possible unsecured roles available for selection by the user.

Display Name
<Release> Workplace Access Roles Extensions
XML Script Name
WorkplaceAppAccessRoleExtensions.xml
Installation Type
Recommended
Predecessors
Required By

The Workplace Access Roles Extensions provides property templates and implements custom classes, objects, and properties in the following areas throughout Enterprise Manager:

NOTE  The Workplace Access Roles Extensions provides classes and properties which support ready-to-use behavior for the creation and management of access roles used by Application Engine applications. Do not modify the values for properties on object instances created by FileNet ready-to-use applications; changing these values can cause application behavior issues with FileNet applications and add-on features. In addition, do not use other software applications to extend the classes. The descriptions included in this section are provided for informational purposes only.

Property templates

The following property templates are added by Workplace Access Roles Extensions and implemented by various add-on features. These templates are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Property Templates.

Property Template Type Implementations Description
Role Name
String Access Role class Supplies a name to identify this particular access role.
Role Type
String Access Role class Indicates whether this is an access role consisting of commonly understood definitions, or a custom implementation.
Secured Role Object Access Role class Identifies the members who possess the right to access (secured access) as defined in the access role.
Unsecured Role
Object Access Role class Enables an application to determine the roles available to a user. Note that this property does not identify or control who can be a member of the access role.

Custom Subclasses of Custom Object

The following subclasses are derived from the Custom Object by Workplace Access Roles Extensions. These subclasses and their respective properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object > Custom Subclass Name.

Subclass Modifiable Description
Access Role No Provides information required to support ready-to-use behavior for the creation and management of access roles used by Application Engine and Workplace XT applications. Access roles are used to define the set of users and groups which have access to application features exposed through client applications such as Workplace XT, Workplace and application integration. These roles are defined and maintained in Site Preferences.

Access Role, Subclass of Custom Object

The following properties are added to the Access Role subclass by Workplace Access Roles Extensions. These properties are visible in Enterprise Manager under Domain Root > Object Stores > Object Store Name > Other Classes > Custom Object > Access Role, right-click Properties > Property Definitions.

Property Type Modifiable Description
Application Name
String No Identifies the application that created the access role. This property is an implementation of the Application Name property template, which is added by Base Application Extensions.
Custom Object Type
String Yes (Hidden) Specifies the type of a custom object and is used to determine which icon to display for the object in Workplace. The specified string value should exist in the customobjecticon.properties file (located at the root level of the Web tree) and the appropriate icon to display for the object type should be located in the images/customobject directory.

For more information about this property, see the description of the Custom Object Type property template in the Workplace Base Extensions section.

Description
String No Allows the user to capture a description that further identifies the purpose of this access role. This property is an implementation of the Description property template, which is added by Base Application Extensions.
Role Name
String No Supplies a name to identify this particular access role.
Role Type
String No Indicates whether this is an access role consisting of commonly understood definitions, or a custom implementation.
Secured Role Object No Identifies the members who possess the right to access (secured access) as defined in the access role.
Unsecured Role
Object No Enables an application to determine the roles available to a user. Note that this property does not identify or control who can be a member of the access role.