Corporate Info | News | Solutions | Products | Partners | Services | Events | Download | How To Buy
Commerce Servers Home | WebLogic Portal Doc Home | JSP Tag Libraries | Previous Topic | Next Topic | Contents

# Portal Administration Tag Reference This is a reference guide to the portal administration tags used in the BEA WebLogic Portal™. It includes the same tags as the Portal Tag Reference with some additional tags for the Portal Administration Tool. ## Contents Shorthand Values The Administration Tag Library <esadmintaglib> <pt:portalmanager> <pt:portletmanager> <pt:groupmanager> <pt:signon> <pt:profile> <pt:eval> <pt:get> <pt:monitorsession> <pt:props> ## Shorthand Values The following table contains shorthand values for certain servlet session values referred to in this document.
Shorthand | Value
--- | ---
PORTAL_NAME | (String)getSessionValue(PortalTagConstants.PORTAL_NAME,request)
PORTAL_GROUP | (String)getSessionValue(PortalTagConstants.PORTAL_GROUP,request)
PORTAL_USER | (String)getSessionValue(PortalTagConstants.PORTAL_USER,request)
PROFILE_USER | (String)getSessionValue(PortalTagConstants.PROFILE_USER,request)
PROFILE_GROUP | (String)getSessionValue(PortalTagConstants.PROFILE_GROUP,request)
## The Administration Tag Library <esadmintaglib> The <esadmintaglib> tag library contains custom JSP extension tags that are used by the Portal Administration Tool. ### <pt:portalmanager> The <pt:portalmanager> tag is used to perform 'create,' 'get,' 'getColumnInfo,' 'update,' and 'remove' actions on com.beasys.portal.Portal objects. This tag is an empty tag.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
id | when action equals get or getColumnInfo |  | The name to which resultant information is assigned for subsequent use in the JSP page.
action | no | update | The action to perform. Allowed values include: create - Creates a new portal. get - Retrieves an object of type `com.beasys.portal.Portal.` getColumnInfo - Retrieves a `com.beasys.portal.PortalColumnInformation[]` update - Updates the provided target `com.beasys.portal.Portal`. remove - Removes the provided target `com.beasys.portal.Portal.`
portalName | no | PORTAL_NAME | The name of the portal to retrieve, or whose column information is to be retrieved.
target | when action equals create, update, or remove |  | The com.beasys.portal.Portal to be created, updated, or removed.
Example: <pt:portalmanager id="portal" action="get" portalName="BEAPortal"/> ### <pt:portletmanager> The <pt:portletmanager> tag is used to perform 'create,' 'get,' 'getArranged,' 'update,' and 'remove' actions on com.beasys.portal.Portlet objects. This tag is an empty tag.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
id | when action equals get or getArranged |  | The name to which resultant information is assigned for subsequent use in the JSP page.
action | no | update | The action to perform. Allowed values include: create - Creates a new portlet. Get - Retrieves an object of type `com.beasys.portal.Portlet.` getArranged - Retrieves a `com.beasys.portal.Portlet[]` which prescribes the row-column layout of portlets for the provided portal-user-group combination. update - Updates the provided target `com.beasys.portal.Portlet.` Remove - Removes the provided target `com.beasys.portal.Portlet.`
portalName | no | PORTAL_NAME | The name of the portal to corresponding to the target portlet or to the portlet(s) to be retrieved.
groupName | no | GROUP_NAME | The name of the group to corresponding to the target portlet or to the portlet(s) to be retrieved.
userName | no | USER_NAME | The name of the user to corresponding to the target portlet or to the portlet(s) to be retrieved.
target | when action equals create, update, or remove |  | The `com.beasys.portal.Portlet` to be created, updated, or removed.
scope | no | global | The scope to be applied to the provided action. Allowed values include: global - Specifies that portlet creation, removal, retrieval, or update should apply across all portals, groups, and users. portal - Specifies that portlet creation, removal, retrieval, or update applies to the provided portal. group - Specifies that portlet creation, removal, retrieval, or update applies to the provided portal-group combination. user - Specifies that portlet creation, removal, retrieval, or update applies to the provided portal-group-user combination.
Example: <pt:portletmanager id="arrangedPortlets" action="getArranged" userName="myUser" portalName="myPortal"/> ### <pt:groupmanager> The <pt:groupmanager> tag is used to create groups for portals, remove groups from portals, get group names associated with a portal user, and retrieve user counts for portal groups.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
action | yes |  | The action to perform. Allowed values include: create - Creates a group to be associated with a portal. Remove - Removes a group from a portal. Get - Retrieves group names for the current portal user. getUserCount-Retrieves the user count for a portal group.
groupName | no | PORTAL_GROUP | The name of the group to be added to or removed from the portal.
portalName | no | PORTAL_NAME | The name of the portal to which the group is added or from which the group is removed.
id | when action is get or getUserCount |  | The id to which the array of portal names or the user count is assigned.
Example:
    <pt:groupmanager action="create" groupName="myGroup" portalName="myPortal"/>
### <pt:signon> The <pt:signon> tag is used to create new portal sign-on accounts, verify log-ins, and update existing accounts.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
action | yes |  | The action to perform. Allowed values include: signon - Verifies a current portal signon attempt. create - Creates a new portal signon account. Update - Updates the password for an existing account.
userName | yes |  | The user name of the account to be signed on, created, or updated.
portalName | yes |  | The portal name of the account to be signed on, created, or updated.
password | yes |  |
oldPassword | when action equals update |  |
resultId | no |  | The name of a variable to which signon activities String results can be assigned. Possible values include: PortalTagConstants.LOGIN_OK (The value returned when any signon activity succeeds.) PortalTagConstants.LOGIN_FAILED PortalTagConstants.NAME_IN_USE PortalTagConstants.USER_CREATION_FAILED PortalTagConstants.USER_UPDATE_FAILED
Example:
    <pt:signon action="signon" userName="myUser" password="myPassword" portalName="myPortal"/>
### <pt:profile> The <pt:profile> tag is used to get, set and remove user/group profile values, and to create and remove user/group profiles.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
action | yes |  | The action to perform. Allowed values include: get - Gets a property value from the specified profile. set - Sets a property value in the specified profile. add - Adds a property value to a multi-valued property in the specified profile. remove - Removes a property value, a property, or an entire profile. If only a profileUser is specified, which is the minimum, the entire profile is removed If a profileUser and property are specified, the property is removed from the profile If a profileUser, property, and value are specified, the value is removed from a presumably multi valued user profile property
profileUser | no | PROFILE_USER | The name of the user whose profile is to be accessed.
profileGroup | no | PROFILE_GROUP | The name of the group profile to be accessed if the user profile is unavailable or does not contain the property being retrieved.
property | when action equals get, set, or add |  | The property which is removed or for which a value is retrieved, set, or added.
value | when action equals get, set, or add |  | The value which is removed, retrieved, set, or added.
forceCreate | no | true | When adding or setting a value, forceCreate indicates a need to create the user profile because one does not already exist.
allowDestroy | no | false | When removing a property or property value from a profile, allowDestroy indicates whether the profile can be destroyed if no remaining properties exist within it.
id | no | false | If included on a get action, the id receives the value of the retrieved property.
Example:
    <pt:profile action="get" profileUser="myUser" property="fave_color"/>
### <pt:eval> The <pt:eval> tag is used to evaluate a conditional attribute of a portlet, for example, 'isMinimizeable.' The tag expects a com.beasys.portal.Portle t to be accessible in the session with the key PortalTagConstants.PORTLET. If the conditional attribute evaluates to true, the body of the <pt:eval> tag is processed. Otherwise, it is not.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
tag | yes |  | The name of the portlet attribute to evaluate.
Example:
    <pt:eval tag="isMinimizeable">
         <% titleBar.include(minimizeButton); %>
    </pt:eval>
### <pt:get> The <pt:get> tag retrieves a String attribute of a portlet. This tag expects a com.beasys.portal.Portlet to be accessible in the session with the key PortalTagConstants.PORTLET.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
tag | yes |  | The name of the portlet attribute to be retrieved.
Example:
    <tr>
       <td>
          <pt:get tag="title"/>
       </td>
    </tr>
### <pt:monitorsession> The <pt:monitorsession> tag can be added to the beginning of any JSP page to disallow access to the page if the session is not valid or if the user is not logged in.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
goToPage | no | portalerror.jsp | The error page that you want displayed if the page is not accessible.
loginRequired | no | false | Indicates whether the user is required to be logged in to access the JSP page including the tag.
Example:
     <pt:monitorsession loginRequired="true" />
### <pt:props> The <pt:props> tag is used to get a property from the Portal Properties bean. The Portal Properties bean's deployment descriptor contains default values used by the Portal Administration Tool.
Attribute | Required? | Default value | Description
--- | --- | --- | ---
id | yes | none | A java.lang.String variable name for the property value.
propertyName | yes | none | The name of the property to get in the Portal Property Bean.
Example:
    <pt:props id="headerURL" propertyName="default.portal.headerURL" />

Copyright © 2000 BEA Systems, Inc. All rights reserved. Required browser: Netscape 4.0 or higher, or Microsoft Internet Explorer 4.0 or higher.