Displaying an item's security details

Portal, V6.1

Displaying an item's security details

The security component tag is used to display the users or groups granted effective security for an item. This tag can be added to presentation templates, element designs and component designs.
<securitycmpnt type=" " context=" " name=" " field=" " resolve=" " separator=" " format=" " ifEmpty=" " awareness=" " start=" " end=" " />
<securitycmpnt Opens an ID component tag.
type=" " This determines where the workflow field is being referenced from. Either "site", "sitearea", or "content".
context=" " This determines which item is being referenced.

Selected

Refers to a particular item as specified in the name attribute below.

Current

This will reference the component from the current site, site area or content file that is being browsed by the user.

AutoFill

The component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.

name=" " Enter the name and library of the item being referenced. For example, name="library/item" . If no library is specified, the library specified in the URL of the current page is used. This is not used if context=current or context=autofill.
field=" " Enter the access-level of the users or groups you'd like to display. If not specified, all users and groups that have access to an item will be displayed.

user
contributor
editor
manager

resolve=" " This determines which type of access to resolve to when rendering users and groups:

none

Only users and groups selected in the access section of an item will be resolved. This is a combination of User, Workflow and Administrator defined access settings. Virtual users are not resolved. If the field parameter is used, only users and groups directly selected for a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user".

virtual

Only users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of User, Workflow and Administrator defined access settings. If the field parameter is used, only users and groups directly selected for a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user".

inherited

All inherited users and groups plus users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of Inherited, User, Workflow and Administrator defined access settings. If the field parameter is used, only users and groups that are either directly selected for a role type or that inherit a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user".

inheritedonly

Only inherited users and groups, including virtual users, will be resolved. If the field parameter is used, only users and groups that directly inherit a role type will be resolved. For example, a user that inherits "contributor" access would not be resolved if field="user".

effective

Only users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of User, Workflow and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected using the field parameter will be resolved. For example, if field="user", contributors, editors and managers will also be resolved.

all

All inherited users and groups plus users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of Inherited, User, Workflow and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected using the field parameter will be resolved. For example, if field="user", contributors, editors and managers will also be resolved.

separator=" " Used to separate each listed user or group. For example, separator=", "
format=" "

When referencing user details:

When formatting user details, the format parameter is used to define which LDAP parameter to use when displaying user details. For example:

format="cn" is used to display the common name.
format="dn" is used to display the distinguished name.

Maximum character length:

You can also specify a maximum number of characters to display by using this format:

format="length:number_of_characters"

For example, to display a maximum of ten characters you would specify the following parameter:

format="length:10"

awareness=" " If awareness="true" then user names are displayed using the people awareness features. These features displays user names as hyperlinks that allow users to contact people with whom they might want to work. Wherever person links appear, users can click the link to display a menu of actions for collaborating (contacting and working) with the person named by the link. If you, as administrator, have also configured an IBM Lotus Sametime server to work with WebSphere Portal, person links indicate whether a person is active, away, offline, or in a Do Not Disturb state.
People awareness will only work in content rendered using either a local or remote rendering portlet.
If not specified, then awareness="false" and people awareness is not used.
ifEmpty=" " Enter some text to display if no result is returned by the tag. If not specified, nothing is displayed if no result is returned by the tag.
Double-byte character sets
Not all double-byte character sets support extended ASCII. To use tags such as " " replace "&" with "&". For example:
separator="&amp;nbsp;&amp;nbsp;"
start=" "
end=" "
The start and end attributes are used to wrap the data returned by a Web content tag within other tags, such as HTML. These attributes are not mandatory.
/> Closes the tag.
Parent topic
Displaying item details

<securitycmpnt type=" " context=" " name=" " field=" " resolve=" " separator=" " format=" " ifEmpty=" " awareness=" " start=" " end=" " />
<securitycmpnt	Opens an ID component tag.
type=" "	This determines where the workflow field is being referenced from. Either "site", "sitearea", or "content".
context=" "	This determines which item is being referenced. Selected Refers to a particular item as specified in the name attribute below. Current This will reference the component from the current site, site area or content file that is being browsed by the user. AutoFill The component being referenced will be determined by the search parameters of a menu, navigator or taxonomy component.
name=" "	Enter the name and library of the item being referenced. For example, name="library/item" . If no library is specified, the library specified in the URL of the current page is used. This is not used if context=current or context=autofill.
field=" "	Enter the access-level of the users or groups you'd like to display. If not specified, all users and groups that have access to an item will be displayed. user contributor editor manager
resolve=" "	This determines which type of access to resolve to when rendering users and groups: none Only users and groups selected in the access section of an item will be resolved. This is a combination of User, Workflow and Administrator defined access settings. Virtual users are not resolved. If the field parameter is used, only users and groups directly selected for a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user". virtual Only users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of User, Workflow and Administrator defined access settings. If the field parameter is used, only users and groups directly selected for a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user". inherited All inherited users and groups plus users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of Inherited, User, Workflow and Administrator defined access settings. If the field parameter is used, only users and groups that are either directly selected for a role type or that inherit a role type will be resolved. For example, a user assigned "contributor" access would not be resolved if field="user". inheritedonly Only inherited users and groups, including virtual users, will be resolved. If the field parameter is used, only users and groups that directly inherit a role type will be resolved. For example, a user that inherits "contributor" access would not be resolved if field="user". effective Only users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of User, Workflow and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected using the field parameter will be resolved. For example, if field="user", contributors, editors and managers will also be resolved. all All inherited users and groups plus users and groups selected in the access section of an item, including virtual users, will be resolved. This is a combination of Inherited, User, Workflow and Administrator defined access settings. If the field parameter is used, access roles are cascaded down so that users and groups assigned roles higher than the role selected using the field parameter will be resolved. For example, if field="user", contributors, editors and managers will also be resolved.
separator=" "	Used to separate each listed user or group. For example, separator=", "
format=" "	When referencing user details: When formatting user details, the format parameter is used to define which LDAP parameter to use when displaying user details. For example: format="cn" is used to display the common name. format="dn" is used to display the distinguished name. Maximum character length: You can also specify a maximum number of characters to display by using this format: format="length:number_of_characters" For example, to display a maximum of ten characters you would specify the following parameter: format="length:10"
awareness=" "	If awareness="true" then user names are displayed using the people awareness features. These features displays user names as hyperlinks that allow users to contact people with whom they might want to work. Wherever person links appear, users can click the link to display a menu of actions for collaborating (contacting and working) with the person named by the link. If you, as administrator, have also configured an IBM Lotus Sametime server to work with WebSphere Portal, person links indicate whether a person is active, away, offline, or in a Do Not Disturb state. People awareness will only work in content rendered using either a local or remote rendering portlet. If not specified, then awareness="false" and people awareness is not used.
ifEmpty=" "	Enter some text to display if no result is returned by the tag. If not specified, nothing is displayed if no result is returned by the tag.
Double-byte character sets Not all double-byte character sets support extended ASCII. To use tags such as " " replace "&" with "&". For example: separator="&nbsp;&nbsp;"
start=" " end=" "	The start and end attributes are used to wrap the data returned by a Web content tag within other tags, such as HTML. These attributes are not mandatory.
/>	Closes the tag.