Task refresh-iwidget-definitions

Use this configuration task to refresh iWidget definitions in the portal. This task affects all iWidget definitions referenced through absolute HTTP or HTTPS URLs in addition to iWidget definitions referenced via WebDAV URIs.

Refreshing an iWidget definition in this context means, re-loading the iWidget definition XML files and updating the corresponding iWidget Wrapper portlet clone accordingly. You can execute the task in a synchronous or asynchronous manner. If you run this task asynchronously, the configuration task completes immediately after starting a corresponding asynchronous system task. You can use this mode to avoid timeout problems that might occur if there are a high number of iWidget definitions to be refreshed. The completion of the system task is indicated in SystemOut.log.
Notes about this task:

• refresh-iwidget-definitions updates the titles and the descriptions of an iWidget Wrapper portlet clone only if you set the following portlet preferences to true: com.ibm.portal.replace.titles and com.ibm.portal.replace.descriptions.

• When you refresh an iWidget Wrapper portlet clone, values of iWidget attributes, or the items of the iWidget attributes item set, are not updated unless the attributes are flagged as read-only in the iWidget definition XML file. As a result, values of iWidget attributes customized after registering the iWidget in WebSphere Portal are prevented from becoming lost during a refresh operation.

Usage: Use this task to refresh iWidget definitions in the portal.

WebSphere Portal must be running to use this task.
Syntax: Invoke this task as part of the ConfigEngine script as follows:

• UNIX™: ./ConfigEngine.sh refresh-iwidget-definitions

• i:

  • From the UserData directory: ConfigEngine.sh refresh-iwidget-definitions

Mandatory parameters that you can specify through the command line or in wkplc.properties:
WasUserid

User ID for WAS.

WasPassword

Corresponding password for WAS.

PortalAdminId

User ID for WebSphere Portal.

PortalAdminPwd

Corresponding password for WebSphere Portal.

Optional parameters that you can specify only through the command line:
Synchronous

Specify one of the following values:
true to run the task in synchronous mode. Default.setting.

false to run this task in asynchronous mode.

Scheduling the refresh-iwidget-definitions task

You can schedule the task refresh-iwidget-definitions by using the following task: com.ibm.portal.services.RefreshIWidgetDefinitionsTask. See XML configuration reference for instructions.

Parent

Manage the Page Builder theme by configuration tasks

Related tasks

Customize iWidget attributes
XML configuration reference
Update iWidget attributes when refreshing iWidget definitions

 

+

Search Tips   |   Advanced Search