PublishContext Portlet
Portlet Title | PublishContext |
Portlet Name | wm_publishcontext |
Portlet File Name | wm_publishcontext.pdp |
Top-level Folder | default |
JSR168 Portlet? | No |
Alias | /portlet/wm_publishcontext |
Default Instances of the portlet | None |
Content Management. Page developers use this portlet to simplify the publish process for end users. The
PublishContext portlet is a helper for the
Publish Portlet, which is a wizard for adding new content to the
My webMethods Server content repository. Use this
PublishContext portlet to render a button, link, or image control on a page so that when a user clicks the control, the application opens a page that contains the
Simple Publish Portlet with the fields of the wizard pre-set. The
PublishContext portlet allows you to pre-populate field values, make fields read-only, and/or hide fields in the
Simple Publish Portlet wizard.
Properties in the Portlet Preferences
Cache Age (cacheAge)
Indicates how long, in minutes, to keep the rendered portlet in cache. All instances of the PublishContext portlet share the value of this property.
The following lists the values that are available in the user interface for this property:
0 – Default. Do not cache potlet.
1 – Cache for 1 minute.
10 – Cache for 10 minutes.
15 – Cache for 15 minutes.
20 – Cache for 20 minutes.
30 – Cache for 30 minutes.
60 – Cache for 1 hour.
-1 – Cache infinitely.
Link User Interface Properties
Link Type (publishLinkType)
Indicates whether you want to use a button, link, or image control. Specify one of the following:
button link image The default is button.
Link Text (publishLinkText)
Defines the label to use for a button or link control. Use this property when Link Type is set to button or link. Specify any text. The default value is:
Publish new ...
Link Image (publishLinkImage)
Identifies the image file to use for an image control. Use this property when Link Type is image.
Specify a URL for the image or relative path to an addressable image in My webMethods Server. If Link Type is image and you do not specify a value for Link Image, or if the value for Link Image is not valid, a broken image icon is displayed.
Publishing Context Properties
DBO/Portlet Type (xTypeThingID)
Restricts the types of resources (files, folders, links, or pages) that an end user can publish using the
Simple Publish Portlet wizard. For example, if you want to allow end users to only publish link objects, set this property to
link.
You must specify a thingID or an alias of a DBO (xtype); otherwise, the portlet type for this property file, folder, link, or page will not work. You can use the following aliases, or any other alias to DBO or portlet types:
/xtype/link – Alias to the base link DBO.
/xtype/content – Alias to the base file DBO.
/xtype/folder – Alias to the base folder DBO.
Note:
You can specify only one thingID or alias.
Publish DBO Properties (publishProperties)
Pre-sets the default values for the properties displayed in the
Simple Publish Portlet wizard. Each DBO or Portlet Type has its own set of properties.
The format for this property is a semicolon-separated list of property settings, and each property setting itself consists of a comma-separated list of four items:
Property | Description |
name | The internal name of the property, for example, "description" is the name property setting for the description property. |
value | The value for the property, for example, "published via a custom Public Context portlet". |
hidden | Indicates whether the property should be hidden or not. The hidden property setting can be either true, false, or default. Note:
The default setting indicates that this property should be hidden if so configured in the DBO or portlet's default configuration. |
readonly | Indicates whether the property should be read-only or not. The readonly setting can be either true, false, or default. Note:
The default setting indicates that this property should be read-only if so configured in the DBO or portlet's default configuration. |
Note:
There is no default property setting. If the property has no value, DBO or Portlet Type properties will not have default values.
The following example of publishProperties specifies three properties:
Example Property | Description |
parentID (Parent Folder) | Specifies that this property should be set to "folder.public" (Public Folders), and that the property should not be displayed to or be editable by the user. |
name | Specifies that the "name" property should default to "New Folder", but that the user can edit this property. |
description | Specifies that the "description" property should be "created via a custom Publish Context portlet", and that while the property and its value will be displayed to the user (hidden is false), the user will not be able to edit it (readonly is true). |
parentID,folder.public,true,true;name,New
Folder,false,false;description,created via a custom Publish Context
portlet,false,true
Publish Finish URL (publishFinishURL)
Identifies the page to display after the
Simple Publish Portlet wizard completes normally. Specify the URL of the page. There is no default. If no publishFinishURL is specified, the application displays the page that the user last viewed last before starting the
Simple Publish Portlet wizard.
Publish Cancel URL (publishCancelURL)
Identifies the page to display when the end user clicks the Cancel button in the
Simple Publish Portlet wizard. Specify the URL of the page. There is no default. If no publishCancelURL is specified, the application displays the page that the user viewed last before starting the
Simple Publish Portlet wizard.