Dynamic Business Objects

Summary of DBOs

The following table lists the dynamic business objects (DBO)s that My webMethods Server provides out-of-the-box.

Name	Description
AuthScheme DBO	Dynamic Business Objects. Portlet developers use objects of this type to define auth-handlers.
Ftp Folder DBO	Containers. End users use this type of folder to perform a bulk update or upload of files to a My webMethods Server folder from a remote FTP client.
Http Header Policy DBO	Security. Administrators use this security provider to configure permissions on My webMethods Server items. Unlike other security providers where privileges are manually assigned, use this security provider to dynamically grant or deny access to server objects based on information that is passed to My webMethods Server in the HTTP header when a user logs in.
Locale Property Storage DBO	Dynamic Business Objects. The system uses this system dynamic business object (DBO) to implement multi-locale property value storage. When implemented for a portlet, an end user can define different property values based on locales. My webMethods Server automatically publishes instances of this Locale Property Storage DBO; users cannot publish it.
Mime Message DBO	Dynamic Business Objects. The system uses an instance of this data type in My webMethods Server to publish an e-mail message that was retrieved from an e-mail inbox or NNTP newsgroup on an external server to a file in a folder. My webMethods Server typically uses this data type when synchronizing an e-mail inbox or NNTP newsgroup to a wm_xt_nntpfolder and wm_xt_pop3folder folder instance.
My webMethods Folder DBO	Dynamic Business Objects. Page developers use this dynamic business object to provide additional data to folders such as whether it is an "isTaskFolder".
NNTP Folder DBO	Containers. Administrators publish an instance of this folder type to a My webMethods Server to provide a way to view the contents of an NNTP newsgroup. The NNTP Folder polls an NNTP newsgroup and creates entries within the folder for each newsgroup message it retrieves.
Pop3 Folder DBO	Containers. Administrators publish an instance of this folder type to a My webMethods Server page to provide a way to view the contents of a POP3 mailbox. The Pop3 Folder polls a POP3 mailbox and creates entries within the folder for each e-mail message it retrieves.
Portal Skin DBO	Dynamic Business Objects. Page developers use this object type to define a new skin and configure its properties.
Relative Link DBO	Dynamic Business Objects. Page developers use instances of this type to add links that are relative to the front-end server to a page. To provide a set of links for the end user, page developers publish multiple instances of this link type to a folder.
Restful Link DBO	Dynamic Business Objects. Page developers use this portlet to build a link to another My webMethods Server page. In addition to linking to another page, this portlet also allows the page developer to supply initial values of properties for a portlet on the target page.
Role DBO	Dynamic Business Objects. Administrators use this dynamic business object (DBO) in My webMethods Server to store general role properties for a role. My webMethods Server implicitly creates instances of this DBO when new roles are added to the system.
Shell DBO	Dynamic Business Objects. Page developers use this object type to define a new shell and configure its header, footer, left navigation, and right navigation.
Shortcut DBO	Dynamic Business Objects. Page developers use instances of this type to define shortcuts to My webMethods Server resources.
Static Role Provider DBO	Dynamic Business Objects. Administrators use this dynamic business object (DBO) in My webMethods Server to store configuration for static roles. My webMethods Server implicitly creates instances of this DBO when new static roles are added to the system.
Website Archive Viewer DBO	Page components. Page developers use this File dynamic business object (DBO) to upload a static web site archive (either a .zip or .jar), and to publish the web site archive so that end users can browse its contents within the My webMethods Server taxonomy.

AuthScheme DBO

Edit online

Portlet Title	AuthScheme
Portlet Name	wm_xt_authscheme
Portlet File Name	wm_xt_authscheme.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. Portlet developers use objects of this type to define auth-handlers.

Properties

Visual Style (visualStyle): Identifies the JSP file to use to render this auth-scheme's properties. The default value is dbo_view.jsp. All instances of the portlet share the value of this property.

General Properties

Name (name): Required. Defines the name for this auth-scheme. Specify a string that contains less than 100 characters.
Description (description): Defines a description for this auth-scheme. Specify a string that contains less than 255 characters.
Keywords (keywords): Defines the keywords for this auth-scheme. Users can later use these keywords to search for this auth-scheme by using My webMethods Server search capabilities. The length of the entire list of keywords must be less than 255 characters.

Location Properties

Parent Folder (parentID): Required. Identifies the folder where this auth-scheme is stored. Specify the thingID or alias of the folder, for example, folder.auth.schemes.

Extended Properties

Authentication Scheme ID (authSchemeLevel)

Required. Identifies this auth-scheme. This ID must be a unique integer among the auth-schemes deployed to My webMethods Server. Auth-schemes built into My webMethods Server use numbers less than 10.

AuthScheme Runtime ClassName (challengeResponseClassName)

Required. Defines the class of the auth-handler. Specify the class, including path.

Performs Redirect (hasRedirect)

Indicates whether to use the Redirect URI (redirectURI) property. Specify one of the following:

true – Use the Redirect URI (redirectURI) property.
false – Do not use the Redirect URI (redirectURI) property.

Redirect URI (redirectURI): Identifies the page that provides the auth-handler change input. For example, for forms-auth the redirectURI would be a login page. Specify the URI of the page. If the property has no value, or hasRedirect is false, the auth-handler challenge will return the requested page, instead of redirecting.

Ftp Folder DBO

Edit online

Portlet Title	Ftp Folder
Portlet Name	wm_xt_ftpfolder
Portlet File Name	wm_xt_ftpfolder.pdp
Top-level Folder	default
JSR168 Portlet?	No
Alias	/portlet/wm_xt_ftpfolder Note: Do not use this instance. Instead publish another instance into My webMethods Server.
Default Instances of the portlet	None

Containers. End users use this type of folder to perform a bulk update or upload of files to a My webMethods Server folder from a remote FTP client.

The Ftp Folder behaves like a typical My webMethods Server folder or page, but it starts an FTP server that uses a configured FTP port. From a remote FTP client, an administrator uses the folder to manipulate (for example, create, delete, or update) My webMethods Server folders, pages, and content files as if they are file system folders and files. The administrator cannot use the Ftp Folder to manipulate My webMethods Server portlets.

To use the Ftp Folder, administrators must log into the FTP server providing valid credentials for a My webMethods Server user account. The folder does not support anonymous access. Additionally, the My webMethods Server user account must have at least READ access to the folders, pages, and content files being manipulated.

You can publish instances of the Ftp Folder in the following ways:

When opening a folder or page for editing. From a My webMethods Server page:
1. Use the Tools popup menu and select the Edit Page command.
2. Click the Containers link in the editor palette.
3. Drag the Ftp Folder on to the page.
4. Specify properties for the folder. For more information, see General Properties and Extended Properties below.
When publishing a folder.
1. Access the Publish portlet: Administration > Content > Publish.
2. Select Folder for the type of object to publish and then select the subtype Ftp Folder.
3. Select the parent folder or page where the Ftp Folder is to be placed.
4. Specify properties for the folder. For more information, see General Properties and Extended Properties below.

General Properties

Name (name): Required. The name of the folder, as it will be displayed in the My webMethods Server taxonomy. Specify the name of an object in the taxonomy. You can specify from 1 through 100 characters.
Description (description): Provides a description of the folder in the My webMethods Server taxonomy. Must be less than 255 characters long. If the property has no value, no description will be displayed for the folder.
Keywords (keywords): Provides a list of keywords to assign to the folder in the My webMethods Server taxonomy. Users can later use these keywords to search for this folder in the taxonomy. Use 0 through 255 characters for keywords. If the property has no value, no keywords will be displayed for the folder.

Extended Properties

Ftp Port (port)

Required. Identifies the FTP port to use when starting the FTP server for the Ftp Folder portlet. Specify a port number that is globally unique among all Ftp Folder portlets published in My webMethods Server. Also ensure the port that you specify does not conflict with any other ports on the physical server running My webMethods Server. The default FTP port is 8021.

Folder Type (specialFolderType)

This folder can make a different folder available by means of FTP. By default, the folder is made available as the root of an FTP server; however, if a special folder type is selected, then a different folder will be made available as the root of the FTP server that this folder configures.

Indicates the type of FTP folder made available. Specify one of the following:

Default (0) - Default. The folder that is made available as the root of the FTP server. This folder is a normal FTP folder, behaving the same way as a folder or page in the My webMethods Server taxonomy. The Ftp Folder physically stores files published to the FTP server in this FTP folder taxonomy.
User Home Folder (1) - Makes the Home Folder of the My webMethods Server user who is publishing data (also known as My Folders) available as the root of the FTP server. When a user logs on to the FTP server, My webMethods Server automatically uses that user's Home Folder, which means that each user can only access his or her own Home Folder.
Public Folders (2) - Makes the My webMethods Server Public Folders available as the root of the FTP server. Specify Public Folders to provide quick FTP access to Public Folders and the taxonomy under it.
Root Folder (3) - Makes the My webMethods Server Root Folder available as the root of the FTP server. The Root Folder is the root of all folders, and the parent of Public Folders, the System folder, and so on. Specify Root Folder to provide quick FTP access to the entire taxonomy.

Http Header Policy DBO

Edit online

Portlet Title	Http Header Policy
Portlet Name	wm_xt_httpheaderpolicy
Portlet File Name	wm_xt_httpheaderpolicy.pdp
Top-level Folder	extras
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	Folders > System > Policy Providers > Available Types > Http Header Policy Provider

Security. Administrators use this security provider to configure permissions on My webMethods Server items. Unlike other security providers where privileges are manually assigned, use this security provider to dynamically grant or deny access to server objects based on information that is passed to My webMethods Server in the HTTP header when a user logs in.

Administrators select to use the HTTP Header Policy security provider when creating a new security realm. This security provider is useful when My webMethods Server is protected by a front-end authentication product, for example, SiteMinder.

The HTTP Header Policy security provider grants or denies READ, MODIFY, CREATE CHILD, SET PERMISSIONS, and DELETE privileges. To grant/deny privileges, the security provider first examines the key/value pairs in the HTTP header attempting to find those that match key/value pairs configured in the properties of the HTTP Header Policy portlet. Administrator can configure key/value pairs for each of the privileges. When the security provider finds a matching key/value pair in the HTTP header, it determines whether to grant or deny the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

If an administrator does not configure a key/value pair for a privilege, the security provider uses the Default Right Set (defaultRightSet) property to determine whether to grant or deny that privilege. For example, if an administrator does not configure a key/value pair for the CREATE CHILD privilege, the security provider grants the privilege if it is configured in the default right set or denies the privilege if it is not configured in the default right set.

Policy Configuration Properties

Default Right Set (defaultRightSet): Identifies the set of default privileges to grant to the security realm. The security provider uses the default right set to determine whether to grant a privilege when there is no configured key/value pair for that privilege, or when the configured key/value pair is not present in the HTTP header. By default, READ is included in the default right set.

When using the portlet's user interface, select the check boxes that correspond to the privileges that you to include in the default right set. When programmatically configuring this portlet, provide a bit field to indicate the privileges to include in the default right set. The following table shows the bits associated with each privilege:

Bits	Privileges
`00000001`	READ
`00000100`	CREATE CHILD
`00010000`	MODIFY
`01000000`	SET PERMISSIONS
`10000000`	DELETE

For example, to set the default right set to include the READ, SET PERMISSIONS, and DELETE privileges, specify the bit field 11000001.

Authorization Policy (authorizationPolicy)

Indicates whether to grant or deny the privileges associated with the configured key/value pairs found in the HTTP header. For example, if the security provider finds the key/value pair identified by the READ Header (readHeader) property, it grants or denies READ access based on the value of this property. Specify one of the following:

GRANT – Default. Grant the privileges associated with the configured key/value pairs that are found in the HTTP header.
DENY – Deny the privileges associated with the configured key/value pairs that are found in the HTTP header.

READ Header (readHeader): Identifies the key/value pair in the HTTP header to associate with the READ privilege. If the security provider finds the key/value pair in the HTTP header, it grants or denies the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

For example, you might set this property to read_privilege=UseSecurityProvider and the Authorization Policy (authorizationPolicy) to GRANT. If the security provider finds the key/value pair read_privilege=UseSecurityProviderin the HTTP header, it grants the READ privilege.

If the property has no value, the security provider grants the READ privilege if it is included in the Default Right Set (defaultRightSet) property or denies the READ privilege if it is not included in the Default Right Set (defaultRightSet) property.

CREATE CHILD Header (createItemHeader): Identifies the key/value pair in the HTTP header to associate with the CREATE CHILD privilege. The CREATE CHILD privilege controls whether the user can create new items or create subfolders in folders controlled by the security realm. If the security provider finds the key/value pair in the HTTP header, it grants or denies the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

For example, you might set this property to create_privilege=UseSecurityProvider and the Authorization Policy to GRANT. If the security provider finds the key/value pair create_privilege=UseSecurityProvider in the HTTP header, it grants the CREATE CHILD privilege.

If the property has no value, the security provider grants the CREATE CHILD privilege if it is included in the Default Right Set (defaultRightSet) property or denies the CREATE CHILD privilege if it is not included in the Default Right Set (defaultRightSet) property.

MODIFY Header (modifyHeader): Identifies the key/value pair in the HTTP header to associate with the MODIFY privilege. If the security provider finds the key/value pair in the HTTP header, it grants or denies the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

For example, you might set this property to modify_privilege=UseSecurityProvider and the Authorization Policy to DENY. If the security provider finds the key/value pair modify_privilege=UseSecurityProvider in the HTTP header, it denies the MODIFY privilege.

If the property has no value, the security provider grants the MODIFY privilege if it is included in the Default Right Set (defaultRightSet) property or denies the MODIFY privilege if it is not included in the Default Right Set (defaultRightSet) property.

SET PERMISSIONS Header (setPermissionsHeader): Identifies the key/value pair in the HTTP header to associate with the SET PERMISSIONS privilege. The SET PERMISSIONS privilege controls whether the user can modify the permissions of items controlled by the security realm. If the security provider finds the key/value pair in the HTTP header, it grants or denies the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

For example, you might set this property to permissions_privilege=UseSecurityProvider and the Authorization Policy to GRANT. If the security provider finds the key/value pair permissions_privilege=UseSecurityProvider in the HTTP header, it grants the SET PERMISSIONS privilege.

If the property has no value, the security provider grants the SET PERMISSIONS privilege if it is included in the Default Right Set (defaultRightSet) property or denies the SET PERMISSIONS privilege if it is not included in the Default Right Set (defaultRightSet) property.

DELETE Header (deleteHeader): Identifies the key/value pair in the HTTP header to associate with the DELETE privilege. If the security provider finds the key/value pair in the HTTP header, it grants or denies the privilege based on the value of the Authorization Policy (authorizationPolicy) property.

For example, you might set this property to delete_privilege=UseSecurityProvider and the Authorization Policy (authorizationPolicy) to DENY. If the security provider finds the key/value pair delete_privilege=UseSecurityProviderin the HTTP header, it denies the DELETE privilege.

If the property has no value, the security provider grants the DELETE privilege if it is included in the Default Right Set (defaultRightSet) property or denies the DELETE privilege if it is not included in the Default Right Set (defaultRightSet) property.

Locale Property Storage DBO

Edit online

Portlet Title	Locale Property Storage
Portlet Name	wm_xt_localepropstorage
Portlet File Name	wm_xt_localepropstorage.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	/portlet/wm_xt_localepropstorage
Default Instances of the portlet	None

Dynamic Business Objects. The system uses this system dynamic business object (DBO) to implement multi-locale property value storage. When implemented for a portlet, an end user can define different property values based on locales. My webMethods Server automatically publishes instances of this Locale Property Storage DBO; users cannot publish it.

An example of a portlet that uses this support is the HTML Text Portlet, which allows per-locale storage for the Text (HTMLText) property. End users can define different HTML text to display for one or more locales. The portlet stores the property value for each locale and returns the appropriate value based on the end user's current locale.

Mime Message DBO

Edit online

Portlet Title	Mime Message
Portlet Name	wm_xt_mimemessage
Portlet File Name	wm_xt_mimemessage.pdp
Top-level Folder	extras
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. The system uses an instance of this data type in My webMethods Server to publish an e-mail message that was retrieved from an e-mail inbox or NNTP newsgroup on an external server to a file in a folder. My webMethods Server typically uses this data type when synchronizing an e-mail inbox or NNTP newsgroup to a wm_xt_nntpfolder and wm_xt_pop3folder folder instance.

This data type is a My webMethods Server custom data type, extending the "File" data type to make available the additional e-mail related properties that are embedded in e-mail files. When an e-mail message is published to a folder, the message is parsed and the extended properties are extracted and saved for easy subsequent access.

General Properties

Name (name): Required. Identifies the folder where the messages are to be published. Specify the name of the folder.
Description (description): Provides a the description of the folder where the messages are to be published. If the property has no value, the folder will not have a description.
Keywords (keywords): Defines the keywords for the folder where the messages are to be published. These keywords can be associated with items in the folder and subsequently searched. If the property has no value, the folder will not have keywords associated with it.

Location Properties

Parent Folder (parentID): Required. Identifies the parent folder of the folder where the messages are to be published. Specify the ID of the parent folder.

File Properties

File (origFileName): Required. Identifies the e-mail file to publish. Specify the original file name of the e-mail file. During publishing, this field also holds the uploaded file. If this property has no value during publishing, the creation of the instance fails.

Message Properties

Subject (msgSubject): Required. Holds the subject of the e-mail file being published. The portlet automatically extracts the subject from the file during publishing. You do not need to provide a value.
From (msgFrom): Required. Holds the "From" e-mail address from the e-mail file being published. The portlet automatically extracts the e-mail address from the file during publishing. You do not need to provide a value.
Sent (msgSent): Required. Holds the sent date from the e-mail file being published. The portlet automatically extracts the date from the file during publishing. You do not need to provide a value.
Size (msgSize): Required. Holds the size of the published message. The portlet automatically extracts the size during publishing. You do not need to provide a value.

My webMethods Folder DBO

Edit online

Portlet Title	My webMethods Folder
Portlet Name	wm_xt_fabricfolder
Portlet File Name	wm_xt_fabricfolder.pdp
Top-level Folder	None
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	There are hundreds of these folders inside the My webMethods Applications Taxonomy, depending on how many "Fabric UIs" are deployed (for example, Monitor, Optimize, and so on.)

Dynamic Business Objects. Page developers use this dynamic business object to provide additional data to folders such as whether it is an "isTaskFolder".

One special behavior of this folder is that whenever a child folder is created that child is automatically converted from type folder to type "wm_xt_fabricfolder".

The Main Nav Portlet pays special attention to folders of type "wm_xt_fabricfolder". If a Fabric Nav portlet is showing navigation to folders of type "wm_xt_fabricfolder", it will only draw links if the isTaskFolder property is set to true.

Additionally, whenever a "wm_xt_fabricfolder" is created, if it has the "isTaskFolder" property set to true, it will automatically generate a Security Realm and add itself to that Security Realm.

Properties

Is Openable (isOpenable): Provides a true/false flag to indicate whether this folder is openable when displayed in the LHS navigation tree. If set to true, the folder will open as a new tab when clicked. If set to false, it will act as a simple container node in the LHS and will only expand/contract. If this property has no value, it defaults to true.
Is Task Folder (isTaskFolder): Determines whether or not this Fabric Folder should generate a Security Realm on creation and whether or not the Main Nav Portlet should be allowed to show this folder in its navigation. If this property has no value, the property defaults to false and this folder acts as a regular, basic folder.
Required Products (requiredProducts): Deprecated.
Keywords (keywords): Provides a keywords list assigned to this object. This property can be used for searches in the My webMethods Server taxonomy. If this property has no value, no keywords will be displayed for this object.
Parent Folder (parentID): Required. Used during publishing through the Publish portlet. It defines the parent folder ID where this object is stored.

NNTP Folder DBO

Edit online

Portlet Title	NNTP Folder
Portlet Name	wm_xt_nntpfolder
Portlet File Name	wm_xt_nntpfolder.pdp
Top-level Folder	extras
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Containers. Administrators publish an instance of this folder type to a My webMethods Server to provide a way to view the contents of an NNTP newsgroup. The NNTP Folder polls an NNTP newsgroup and creates entries within the folder for each newsgroup message it retrieves.

Typically, My webMethods Server uses the Mime Message Folder Renderer Portlet or NNTP Folder Threaded View Portlet to render an instance of a NNTP Folder.

The Mime Message Folder Renderer Portlet displays the list of newsgroup messages as a table.
The NNTP Folder Threaded View Portlet displays the list of newsgroup messages as a set of threads

A user can click a newsgroup message to view the contents of that message.

The NNTP Folder also adds a Fetch New Articles option to the Tools menu so that end users can force an immediate refresh of messages from the NNTP newsgroup, overriding the refresh interval.

Extended Properties

Refresh Interval (refreshInterval): Indicates how many hours you want the portlet to wait before polling the NNTP newsgroup again to check for new newsgroup messages. Specify 1, 2, 4, 5, 12, or 24 hours. If the property has no value, for example, when set to an empty value, then the portlet continuously polls the mailbox.

Connection Parameters

Host (host): Identifies the NNTP server for the NNTP newsgroup. Specify the host name of the server. If the property has no value, the portlet does not make attempts to retrieve newsgroup messages and, as a result, the NNTP Folder will contain no content.
Port (port): Identifies the port to use to connect to the NNTP server. Specify the port number. The standard NNTP server port number is 119. If the property has no value, for example, when set to an empty value, then the portlet does not make attempts to retrieve newsgroup messages and, as a result, the NNTP Folder will contain no content.
User Name (userName): Identifies the user name the portlet is to supply to the NNTP server for authentication. Specify a valid user name for the NNTP server. If the property has no value, the portlet cannot retrieve messages and, as a result, the NNTP Folder will contain no content.
Password (password): Provides the password for the user name. The NNTP Folder portlet supplies this password, along with the user name, to the NNTP server for authentication. If the property has no value, the portlet cannot retrieve messages and, as a result, the NNTP Folder will contain no content.
NewsGroup Name (newsGroupName): Identifies the newsgroup to poll. Specify the name of the newsgroup. If the property has no value, the portlet will retrieve no messages and, as a result, the NNTP Folder will contain no content.

Pop3 Folder DBO

Edit online

Portlet Title	Pop3 Folder
Portlet Name	wm_xt_pop3folder
Portlet File Name	wm_xt_pop3folder.pdp
Top-level Folder	extras
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Containers. Administrators publish an instance of this folder type to a My webMethods Server page to provide a way to view the contents of a POP3 mailbox. The Pop3 Folder polls a POP3 mailbox and creates entries within the folder for each e-mail message it retrieves.

By default, My webMethods Server uses the Mime Message Folder Renderer Portlet to render an instance of a Pop3 Folder. The Mime Message Folder Renderer Portlet renders the mailbox content by displaying the list of e-mail messages in a table. A user can click an e-mail message in the table to view the contents of that message.

The Pop3 Folder also adds a Fetch New Messages option to the Tools menu so that end users can force an immediate refresh of messages from the POP3 mailbox, overriding the refresh interval.

Extended Properties

Refresh Interval (refreshInterval): Indicates how many hours you want the portlet to wait before polling the POP3 mailbox again to check for new e-mail messages. Specify 1, 2, 4, 5, 12, or 24 hours. If the property has no value, for example, when set to an empty value, then the portlet continuously polls the mailbox.

Connection Parameters

Host (host): Identifies the POP3 server for the POP3 mailbox. Specify the host name of the server. If the property has no value, the portlet does not make attempts to retrieve e-mail messages and, as a result, the Pop3 Folder will contain no content.
Port (port): Identifies the port to use to connect to the POP3 server. Specify the port number. The standard POP3 server port number is 30. If the property has no value, the portlet does not make attempts to retrieve e-mail messages and, as a result, the Pop3 Folder will contain no content.
User Name (username): Identifies the mailbox on the POP3 server from which to retrieve messages. Specify the user name associated with the mailbox. The Pop3 Folder supplies this user name to the POP3 server for authentication. If the property has no value, the portlet cannot retrieve e-mail messages and, as a result, the Pop3 Folder will contain no content.
Password (password): Provides the password for the user name. The Pop3 Folder supplies this password, along with the user name, to the POP3 server for authentication. If the property has no value, the portlet cannot retrieve e-mail messages and, as a result, the Pop3 Folder will contain no content.

Portal Skin DBO

Edit online

Portlet Title	Portal Skin
Portlet Name	wm_xt_skin
Portlet File Name	wm_xt_skin.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	/xtype/wm_xt_skin
Default Instances of the portlet	None

Dynamic Business Objects. Page developers use this object type to define a new skin and configure its properties.

All skins that a page developer creates by using the Administration Dashboard > User Interface > Skin Administration portlet are instances of this object type. For detailed information about creating skins, see information about skins in Administering My webMethods Server.

Properties

Style (visualStyle): Identifies the JSP file to us to render the skin's properties. Do not change this value. All instances of the portlet share the value of this property.

General Properties

Name (name): Required. Defines the name of the skin. This is an internal name and is not displayed to the end user. Specify an alphanumeric string that contains less than 100 characters. You can use ASCII letters, numbers, and the underbar character.
Description (description): Defines a description for the skin. This is the display name of the skin that the end user sees. Specify a string that contains less than 255 characters. If the property has no value, the skin will not have a description.
Keywords (keywords): Defines one or more keywords (or tags) to use when searching for skins. Specify a comma-separated list of keywords. If the property has no value, the skin will not have any keywords assigned to it.

Location Properties

Parent Folder (parentID): Required. Identifies the folder where the skin you are defining is stored. Specify the thingID or alias of the folder. This is usually folder.skins.

Skin Properties

Server Side Resource Path (serverSideResourcePath): Required. Defines the base location for skin resources that are used on the server side, for example, skin properties file. Specify the location as a path within the portal.war; that is, specify /ui/skins/ skin_name, where skin_name is the name of the skin.
Client Side Resource Path (clientSideResourcePath): Required. Defines the base URL for skin resources that are used on the client side, for example, the CSS and image files. Specify the base URL as a path from the server root; that is, specify /ui/skins/ skin_name, where skin_name is the name of the skin.
CSS Preview (cssPreview): Required. Defines the CSS style declaration to use on a menu item displaying the name of the skin. Specify a name that indicates what the skin looks like. For example, for a skin with a blue and red color scheme, you might specify:

color: blue; background-color: red;

Relative Link DBO

Edit online

Portlet Title	Relative Link
Portlet Name	wm_xt_relativelink
Portlet File Name	wm_xt_relativelink.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. Page developers use instances of this type to add links that are relative to the front-end server to a page. To provide a set of links for the end user, page developers publish multiple instances of this link type to a folder.

When publishing an instance of this link, developers specify a URL relative to the server root, such as "/folder.public" or "/folder.system?layout=details", and so on. When rendered, the link will be automatically prepended with the front-end URL of the My webMethods Server cluster, for example, "http://example.com/folder.public" or "http://mws.example.com:8585/folder.system?layout=details".

Link Properties

URL (URL)

Required. Defines the link. Specify the link path relative to the My webMethods Server front-end URL.

Link Target (linkTarget)

Identifies the window or frame in which the link should open. Specify one of the following:

null – Also blank (""). Default. When the property has no value, the link opens in the current window.
_self – The link opens in the current window.
_blank – The link opens in a new, unique window.
portal-link – The link opens in a new, shared window.

Restful Link DBO

Edit online

Portlet Title	Restful Link
Portlet Name	wm_xt_restfullink
Portlet File Name	wm_xt_restfullink.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	/portlet/wm_xt_restfullink
Default Instances of the portlet	None

Dynamic Business Objects. Page developers use this portlet to build a link to another My webMethods Server page. In addition to linking to another page, this portlet also allows the page developer to supply initial values of properties for a portlet on the target page.

Link Properties

Base Page ID (baseID): Required. Identifies the target
Item ID (uriID): Identifies the portlet on the target page for which to supply property values. Specify the alias or thingID of the portlet. If the property has no value, the link behaves like a regular link; property values will not be supplied for a target portlet.
Parameters (linkParams): Defines the property values to use for the target portlet. Specify a comma-separated list of property name/value pairs. Each pair in the list should use the format:

name=value

If the property has no value, no property values are assigned to the target portlet.

Role DBO

Edit online

Portlet Title	Role
Portlet Name	wm_xt_role
Portlet File Name	wm_xt_role.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. Administrators use this dynamic business object (DBO) in My webMethods Server to store general role properties for a role. My webMethods Server implicitly creates instances of this DBO when new roles are added to the system.

Users should never publish instances of this DBO. However, administrators can use this DBO to create roles from xmlImport.xml script files, for example, to create multiple roles to be deployed to multiple servers. The following is an example of an xmlImport script file that creates a static role named "Test Role". "Test Role" has the members: "user1", "user2", and "user3".

<context alias="role.provider.storage"> 
   <!-Creating storage for static role --> 
   <wm_xt_staticrole name="Test Role" principals="user1,user2,user3"
      alias="test. role.storage" targetURI="test.role.storage" />
</context>
<context alias="role.provider.roles">
   <!-Creating Role instance -->
   <wm_xt_role name="Test Role"  
      roleProviderURI="role.static.provider"  
      alias="test.role">  
   <relation path="test.role.storage" 
      type="role.relation" 
   />  
</context>

General Properties

Name (name): Required. Defines the role name. Specify a name that is unique among all role names.
Description (description): Defines a description of the role. Specify a description. If the property has no value, the role will not have a description.
Keywords (keywords): Defines keywords for the role. Specify keywords that can be used when searching for the role in the My webMethods Server taxonomy. If the property has no value, no keywords are assigned to the role.
Parent Folder (parentID): Required. Identifies where to store the role. Specify the parent folder ID.

Role Properties

Role Provider (roleProviderURI)

Required. Defines the alias or thingID of the role type provider to use for this instance. Specify one of the following:

role.static.provider – Default. Static role.
role.ldap.query.provider – LDAP query role.
role.db.provider – Database role.
role.rule.provider – Rule-based role.

Shell DBO

Edit online

Portlet Title	Shell
Portlet Name	wm_xt_shell
Portlet File Name	wm_xt_shell.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	/xtype/wm_xt_shell
Default Instances of the portlet	None

Dynamic Business Objects. Page developers use this object type to define a new shell and configure its header, footer, left navigation, and right navigation.

All shells that a page developer creates by using the Administration Dashboard > User Interface > Shell Administration portlet are instances of this object type. For detailed information about creating shells, see Administering My webMethods Server.

Properties

Visual Style (visualStyle): Identifies the JSP file to use to render the shell's properties. Do not change this value. The default value is dbo_view.jsp. All instances of the portlet share the value of this property.

General Properties

Name (name): Required. Defines the name for the shell. Specify a string that contains less than 100 characters.
Description (description): Defines a description for shell. Specify a string that contains less than 255 characters. If the property has no value, the shell will not have a description.
Keywords (keywords): Defines one or more keywords (or tags) to use when searching for shells. Specify a comma-separated list of keywords. If the property has no value, the shell will not have any keywords assigned to it.

Location Properties

Parent Folder (parentID): Required. Identifies the folder where the shell you are defining is stored. Specify the thingID or alias of the folder. This is usually folder.shells.

Shell Properties

Parent (parent): Defines the parent shell to use to obtain property values for properties not explicitly defined for the shell you are creating. The shell you create will inherit shell-category properties from the parent shell. If the property has no value, the shell you are defining will not inherit values.
Header (head): Defines the header to use for the shell. Specify the thingID or alias of the page to use as the shell header. If the property has no value, the shell inherits the header from the parent, or if you did not specify the Parent (parent) property, the shell will not have a header.
Footer (footer): Defines the footer to use for the shell. Specify the thingID or alias of the page to use as the shell footer. If the property has no value, the shell inherits the footer from the parent, or if you did not specify the Parent (parent) property, the shell will not have a footer.
Leftnav (leftnav): Defines the left navigation to use for the shell. Specify the thingID or alias of the page to use as the left navigation. If the property has no value, the shell inherits the left navigation from the parent, or if you did not specify the Parent (parent) property, the shell will not have left navigation.
Rightnav (rightnav): Defines the right navigation to use for the shell. Specify the thingID or alias of the page to use as the right navigation. If the property has no value, the shell inherits the right navigation from the parent, or if you did not specify the Parent (parent) property, the shell will not have right navigation.
Titlebar (titlebar): Defines the title bar to use for the shell. Specify the thingID or alias of the page to use as the title bar. If the property has no value, the shell inherits title bar from the parent, or if you did not specify the Parent (parent) property, the shell will not have a title bar.

Shortcut DBO

Edit online

Portlet Title	Shortcut
Portlet Name	wm_xt_shortcut
Portlet File Name	wm_xt_shortcut.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. Page developers use instances of this type to define shortcuts to My webMethods Server resources.

Properties

Display Style (visualStyle): Identifies the JSP file to use to render the shortcut's properties. The default value is dbo_view.jsp.

General Properties

Description (description): Defines a description of this shortcut. Must be less than 255 characters. If the property has no value, no description will be displayed for this shortcut.
Name (name): Required. Defines a name for this shortcut. Must be less than 100 characters.
Keywords (keywords): Defines the keywords to associate with this shortcut. The total number of characters for all keywords combined must be less than 255 characters. If this property has no value, no keywords will be associated with this shortcut.

Location Properties

Parent Folder (parentID): Required. Identifies the folder ID that contains this shortcut. Specify the thingID or alias of a folder.

Link Properties

Target Resource (URL)

Required. Identifies the target of this shortcut. Specify the thingID or alias of a resource.

Link Target (linkTarget)

Defines the window or frame into which the target resource should open when the user clicks the shortcut link. Possible values include:

blank – Also empty (""). Link opens in current window.
_blank – Link opens in a unique window.
specified-name – Link opens in a frame or window with the specified name, that is, (specified-name).

Target Db ID (targetDbID): Do not modify. Used internally.
Target XType (targetXType>): Do not modify. Used internally.
Target Data Source (targetDataSource): Do not modify. Used internally.

Static Role Provider DBO

Edit online

Portlet Title	Static Role Provider
Portlet Name	wm_xt_staticrole
Portlet File Name	wm_xt_staticrole.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	None
Default Instances of the portlet	None

Dynamic Business Objects. Administrators use this dynamic business object (DBO) in My webMethods Server to store configuration for static roles. My webMethods Server implicitly creates instances of this DBO when new static roles are added to the system.

Users should never publish instances of this DBO. However, administrators can use this DBO to create static roles from xmlImport.xml script files, for example, to create multiple static roles to be deployed to multiple servers. The following is an example of an xmlImport script file that creates a static role named "Test Role". "Test Role" has the members: "user1", "user2", and "user3".

<context alias="role.provider.storage">
   <!-Creating storage for static role -->
   alias="test.role.storage"  
</context>  
<context alias="role.provider.roles"> 
   <!-Creating Role instance -->      
   <wm_xt_role name="Test Role" roleProviderURI="role.static.provider" 
      alias="test. role"> <relation path="test.role.storage"
      type="role.relation" 
   />  
</context>

General Properties

Name (name): Required. Defines a name for the static role. Specify a name that is unique among all role names.
Description (description): Defines a description for the static role. Specify a description. If the property has no value, the role will not have a description.
Keywords (keywords): Defines keywords for the static role. Specify keywords that can be used when searching for the static role in the My webMethods Server taxonomy. If the property has no value, no keywords are assigned to the role.
Parent Folder (parentID): Required. Identifies where to store the role. Specify the parent folder ID.

Role Membership Properties

Principals (principals): Required. Defines the members of the static role. Specify a string that contains a comma-separated list of the principal UIDs.

Website Archive Viewer DBO

Edit online

Portlet Title	Website Archive Viewer
Portlet Name	wm_xt_websitearchive
Portlet File Name	wm_xt_websitearchive.pdp
Top-level Folder	extras
JSR168 Portlet?	No
Alias	/xtype/wm_xt_websitearchive
Default Instances of the portlet	None

Page components. Page developers use this File dynamic business object (DBO) to upload a static web site archive (either a .zip or .jar), and to publish the web site archive so that end users can browse its contents within the My webMethods Server taxonomy.

The Website Archive Viewer DBO extends the basic file DBO functionality (upload, download, etc.) with special rendering features. Uploaded files must be in .zip or .jar format and contain a collection of static web resources, for example, HTML pages, image files, etc. A page developer publishes the uploaded file using the Publish Portlet; the Page Editor cannot be used. After the file is published, when the end user clicks on the file, the system displays the contents of the web site archive in an IFrame. The page developer configures the Website Archive Viewer DBO to define the initial page to display during the publish process.

File Properties

WebSite Archive (origFileName): Required. Identifies the archive to upload. Use the user interface to select a local file on your machine to upload. The file extension of the file must be either .zip or .jar. This property value is not shared among portlet instances. Instances of the portlet do not share the value of this property.

Web Site Properties

Default Page (defaultPage): Required. Identifies the file within the uploaded web site archive to use as the starting page to display for the web site. The default is index.html. Instances of the portlet do not share the value of this property.
Frame Height (frameHeight): Defines the height of the IFrame to use to display the web site. Specify the number of pixels. The default is 400. Instances of the portlet do not share the value of this property.