WebSphere Portal ConfigEngine Tasks
Here's a summary of ConfigEngine tasks with a description of what each does. This is not yet a complete summary of all available tasks, but we can add to this list as I find and use them. If you have any to share, please do!
Contents
action-deploy-portlets-prereq.pzn
If you install Portal or WCM using the administration option, or base install, the Personalization features, including the Personalization Navigator and Personalization Editor, are not installed. However, you can add these features manually after installation by deploying the Personalization portlets and adding the Personalization Navigator and Personalization Editor to a page. This task deploys the personalization portlets.
Examples:
UNIX:
./ConfigEngine.sh action-deploy-portlets-prereq.pzn -DPortalAdminPwd=password -DWasPassword=password
Windows:
ConfigEngine.bat action-deploy-portlets-prereq.pzn -DPortalAdminPwd=password -DWasPassword=password
i5/OS:
ConfigEngine.sh action-deploy-portlets-prereq.pzn -DPortalAdminPwd=password -DWasPassword=password
Note that if you want to follow a common structure that IBM uses when personalization is installed, you could use an XMLAccess export from the ContentRoot > Applications > Content > Personalization node taken from a portal instance that has those pages with the portlets deployed on them.
activate-portlets
Auto-synchronization of the Web modules to each node in the cluster might not happen immediately, or at all, depending on how the administrator has auto-synchronization configured in the deployment manager. For this reason, WebSphere Portal cannot guarantee that the portlet has been successfully synchronized to each node in the cluster and thus cannot automatically activate the portlet during deployment.
Perform the following steps to manage your portlets:
Deploy your portlets using either the WebSphere Portal Administration page or the XML configuration interface utility (xmlaccess command).
Run this task to activate the deployed portlets and to synchronize the changes across all cluster members.
Example:
ConfigEngine.bat activate-portlets -DWasPassword=password task from the wp_profile_rootConfigEngine directory
add-wcm-la-attributes
Adds the look-aside (property extension) database attributes necessary for WCM. You have to create the look-aside database first. See: <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Configuring_a_property_extension_database_on_Windows_wp7">http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Configuring_a_property_extension_database_on_Windows_wp7</a>. Example command:
ConfigEngine.bat add-wcm-la-attributes -DWasPassword=password -DparentProperties=full path to wp_profile_root\\ConfigEngine\\config\\helpers\\wp_add_LA.properties
checkin-wp-proxy-config
This task activates changes made to the WebSphere Portal Ajax proxy configuration (wp.proxy.config.xml) file.
Example:
ConfigEngine.sh|bat checkin-wp-proxy-config -DProxyConfigFileName=dir_path/your_updated_proxy_file.name
cluster-node-config-cluster-setup
Example:
ConfigEngine.bat cluster-node-config-cluster-setup -DWasPassword=wpsadmin
create-jcr-jms-resources-post-dbxfer
The Java Content Repository (JCR) TextSearch functions are used for searching for content in the Lotus Web Content Management (WCM) Authoring user interface.As part of the install of IBM WebSphere Portal V7.0, all environments should be running the JMS task, "create-jcr-jms-resources-post-dbxfer," to move the JCR TextSearch resources from an Apache Derby Datasource/database configuration to the Datasouce/database that is used for the JCR repository. Failure to run this task can leave the datasource definitions pointing to Derby or cause the JCR TextSearch to not function properly.
Example:
create-jcr-jms-resources-post-dbxfer -DWasPassword=replaceWithWasPassword
configure-wcm-authoring
Installs the Web Content Management Authoring Portlet, Local Rendering Portlet and Web Content Manager Portal pages. This task can be run, for example, to install WCM atop a base portal install if the licensed edition allows for use of WCM.
Example:
ConfigEngine.bat configure-wcm-authoring -DPortalAdminPwd=xxx -DWasPassword=xxx
Lesson Learned: If the WCM Authoring portlet is invisible after running this task, try going into Portal Admin > Web Modules and make sure the modules for WCM are started (if they have the lightning bolt icon, you need to start them).
create-virtual-portal
Use this task to create a virtual portal. Additional parameters can be passed to the task, so please refer to the Virtual portals reference for details.
create-jcr-jmstopics
Recreates the bus and bus member used for JCR text search functionality.
database-transfer
Transfers the portal database from one to another depending on the settings in your configuration files (typically from the default Derby database to another such as DB2). You typically want to run the validate-database-driver and validate-database-connection tasks before this one.
delete-virtual-portal
Use this task to delete a virtual portal by using its object ID. To determine the correct object ID of the virtual portal, use the task list-all-virtual-portals.
deploy-full-profile-7002-theme
This config task applies the full profile to the WebSphere Portal7.0.0.2 theme.
deploy-lightweight-profile-7002-theme
This config task applies the lightweight profile to the WebSphere Portal7.0.0.2 theme
deploy-deferred-profile-7002-theme
This config task applies the deferred profile to the WebSphere Portal7.0.0.2 theme.
enable-identityprovider-tai
Enables a Trust Association Interceptor (TAI) for allowing OpenID authentication with an identity provider such as Google, Yahoo, or Facebook.
AIX:
./ConfigEngine.sh enable-identityprovider-tai -DWasUserId=username -DWasPassword=password
IBM® i:
ConfigEngine.sh enable-identityprovider-tai -DWasUserId=username -DWasPassword=password
Linux:
./ConfigEngine.sh enable-identityprovider-tai -DWasUserId=username -DWasPassword=password
Solaris:
./ConfigEngine.sh enable-identityprovider-tai -DWasUserId=username -DWasPassword=password
Windows:
ConfigEngine.bat enable-identityprovider-tai -DWasUserId=username -DWasPassword=password
For the additional parameters that must be added to this command for proper function, please refer to the product documentation: <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/page.xsp?documentId=8DADADCD7C68081B852579CC001AFFD6&action=openDocument&mode=original" target="_blank">Configuring OpenID authentication</a>
enable-profiles
This command creates a configuration archive (CAR) file that is used to create additional WebSphere Portal profiles. The Portal.car file is saved to the PortalServer_root
profileTemplates
default.portal
configArchives directory. This is typically done as a step in the process of <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Creating_the_WebSphere_Portal_profile_template_on_Windows_in_a_clustered_environment_wp7">creating the WebSphere Portal profile template in a clustered environment</a>.
enable-wcm
Installs Web Content Manager into an existing Server installation. In a clustered environment, this must be executed on each node.
See: Installing Web Content Manager into an existing Server installation on Windows
export-library-copy
Exports a copy of a web content library. See: Exporting and importing a web content library copy
export-wcm-data
Exports a web content library. Several things need to be in place for this task to be executed properly, so please refer to: Exporting and importing web content libraries
import-library-copy
Imports a copy of a web content library. See: Exporting and importing a web content library copy
import-wcm-data
Imports a web content library. Several things need to be in place for this task to be executed properly, so please refer to: Exporting and importing web content libraries
list-all-virtual-portals
This tasks lists all your virtual portals, together with the following information:
- The title of the virtual portal
- The description of the virtual portal
- The realm of the virtual portal
- The object ID of the virtual portal.
See: Virtual portals reference for details.
list-server-ports
Example:
ConfigEngine.bat list-server-ports -DWasPassword=password
list-server-ports-by-name
Examples:
ConfigEngine.bat list-server-ports-by-name -DServerName=server1 -DWasPassword=password
ConfigEngine.bat list-server-ports-by-name -DServerName=WebSphere_Portal -DWasPassword=password
modify-servlet-path
Changes the default portal Uniform Resource Identifier (URI) after installation.
Example:
./ConfigEngine.sh modify-servlet-path -DPortalAdminPwd=password -DWasPassword=password
Note that additional steps are typically required. See the topic, <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Changing_the_portal_URI_wpbeta" target="_blank">Changing the portal URI</a>, in the appropriate product documentation for your software version.
modify-virtual-portal
Use this task to modify a virtual portal by using its object ID. To determine the correct object ID of the virtual portal, use the task list-all-virtual-portals .
package-profiles
Zips the profileTemplates directory and creates a profileTemplates.zip file in the PortalServer_root/profileTemplates directory. This is typically done after the enable-profiles task as a step in the process of <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Creating_the_WebSphere_Portal_profile_template_on_Windows_in_a_clustered_environment_wp7">creating the WebSphere Portal profile template in a clustered environment</a>.
remove-wcm-authoring
Uninstalls the Web Content Management Authoring Portlet, Local Rendering Portlet and Web Content Manager Portal pages.
run-wcm-admin-task-member-fixer
Creates a report of users or groups referenced in Web Content Manager items that need fixing. See product documentation: <a href="http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Using_the_web_content_member_fixer_task_exp7" target="_blank">Using the web content member fixer task</a>
Example:
ConfigEngine.bat run-wcm-admin-task-member-fixer -DPortalAdminId=username -DPortalAdminPwd=password -DWasUserId=username -DWasPassword=password -Dlibrary="MyLibrary"
To actually run the module and make the fixes, add -Dfix=true as shown below:
ConfigEngine.bat run-wcm-admin-task-member-fixer -DPortalAdminId=username -DPortalAdminPwd=password -DWasUserId=username -DWasPassword=password -Dlibrary="MyLibrary" -Dfix=true
si-remove-setup
Removes the Solution Installer PAAs and their registrations as part of the uninstallation procedure for the IBM WebSphere Portal Solution Installer. For more information, refer to the official documentation for the Solution Installer, which is a PDF file contained within the application that can be obtained from the IBM Lotus and WebSphere Portal Business Solutions Catalog. See also: si-setup.
si-setup
This task is executed as a part of the installation procedure for the IBM WebSphere Portal Solution Installer. After the SolutionInstaller.zip has extracted on a node, and the install script has been run, this task is then executed to set up and register the PAA offering directory that the Solution Installer uses. For more information, refer to the official documentation for the Solution Installer, which is a PDF file contained within the application that can be obtained from the IBM Lotus and WebSphere Portal Business Solutions Catalog. See also: si-remove-setup.
start-portal-server
Starts the portal server. Note that the portal admin user id and password should be set in wkplc.properties before executing this task.
Example:
./ConfigEngine.sh start-portal-server
stop-portal-server
Stops the portal server. Note that the portal admin user id and password should be set in wkplc.properties before executing this task.
Example:
./ConfigEngine.sh stop-portal-server
validate-database-connection
Typically ran after the validate-database-driver task and before the database-transfer task to validate successful connection to database.
Example:
ConfigEngine.bat validate-database-connection -DTransferDomainList=release,customization,community,jcr,feedback,likeminds
validate-database-driver
Typically ran before the database-transfer task to validate your database driver configuration.
Example:
ConfigEngine.bat validate-database-driver -DTransferDomainList=release,customization,community, jcr,feedback,likeminds
validate-federated-ldapValidates your LDAP server settings. Typically run before the wp-create-ldap task.validate-standalone-ldapValidates configuration settings for stand-alone LDAP.
Example:
ConfigEngine.bat validate-standalone-ldap -DWasPassword=wpsadmin -DparentProperties=Z:\helpers\wp_security_ids.properties
webdav-deploy-zip-file
Use this configuration task to manage theme artifacts and to deploy iWidgets. This task uploads archive or compressed files to portal WebDAV folders.
This task has parameters; please see IBM documentation: Task webdav-deploy-zip-file
wp-node-prep-vmm-db-secured-environment
wp-prep-vmm-db-secured-environment
wp-query-attribute-config
Run the ConfigEngine.bat wp-query-attribute-config -DWasPassword=password task, from the wp_profile_root/ConfigEngine directory, any time during the configuration process or at runtime to query an overview of the currently defined LDAP attributes. This task creates the availableAttributes.html report, located in the wp_profile_root/ConfigEngine/log directory. The report contains one table that lists the available attributes for Users (PersonAccount) and one table that lists the available attributes for Groups. For each configured repository there is a column that indicates if the attribute is flagged as unsupported or if the attribute is mapped to a different LDAP attribute.
wp-query-repository
Lists the names and types of configured user repositories.
wp-update-standalone-ldap-attribute-config
Applies the settings from wkplc.properties related to marking LDAP attributes as unsupported or mapping the portal attributes to attributes in your LDAP. For example, you might need to map the "ibm-primaryEmail" attribute that portal uses to the "mail" attribute in your own LDAP.
See: http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Mapping_attributes_on_Windows_in_a_clustered_environment_wp7. This task may do more, but at the time I wrote this, it was documented in this particular context.
wp-validate-federated-ldap-attribute-config
Validates that all defined attributes are available in the configured LDAP user registry.
About the author
