Back to Top

WebSpherePortal8InstallBinary

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortal8InstallBinary
Category Websphere Portal v8

Run IBM Installation Manager to Install Portal or DMGR binaries.

Description

Calls the IBM Installation Manager to install the base binary files for either Portal or the Deployment Manager..

Restrictions

The response file must be prepared before hand, this can be contained within the package or on a external shared location.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installationManagerPath java.lang.String /opt/IBM/InstallationManager/eclipse/ false Path to IBM Installation manager .
logFilePath java.lang.String /tmp true Where you want the log file to go
portal_cellName java.lang.String @@cellName@@ true Response file variable: portal server cellName
portal_configEngineBinaryPath java.lang.String @@configEngineBinaryPath@@ true Response file variable: portal server ConfigEngine binary path
portal_configEngineProfilePath java.lang.String @@configEngineProfilePath@@ true Response file variable: portal server ConfigEngine profile path
portal_hostname java.lang.String @@dmgrHost@@ true Response file variable: portal server hostname
portal_installPath java.lang.String @@installPath@@ true Response file variable: portal base install path
portal_installtype java.lang.String base true Response file variable: portal server profile base, full , custom.
portal_locale java.lang.String en true Response file variable: default locale for the portal environment.
portal_nodeName java.lang.String @@nodeName@@ true Response file variable: portal server nodeName
portal_portalAdminPort java.lang.String @@portalAdminPort@@ true Response file variable: portal server admin port
portal_portalInstallPath java.lang.String @@portalInstallPath@@ true Response file variable: portal install directory.
portal_portalPort java.lang.String @@portalPort@@ true Response file variable: portal server port
portal_profile java.lang.String standard true Response file variable: portal server profile standard,
portal_profileName java.lang.String @@profileName@@ true Response file variable: portal server profile name
portal_profilePath java.lang.String @@profilePath@@ true Response file variable: portal server profile path
portal_userName java.lang.String @@portalUserName@@ true Response file variable: portal server admin user
portal_userPassword java.lang.String @@portalUserPassword@@ true Response file variable: portal server admin password
relativeToArchiveRoot java.lang.Boolean false true If true, the package is relative to the expanded archive.[true | false]
responseFilePath java.lang.String NONE false The path to your response file.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
was_installpath java.lang.String @@installPath@@/AppServer true Response file variable: WAS install path


Back to Top

WebSpherePortalCloneTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalCloneTask
Category Websphere Portal v8

Clone Portal Task

Description

The WebSphere Portal XML Configuration Interface Task, also known as XMLAccessTask, is a command line tool or utility that takes an XML file as input.
The XML file contains statements or instructions to modify a WebSphere Portal configuration.
The XMLAccess tool is a standalone tool and is packaged witin this plugin which allows it to run XMLAccess from one system against a remote Portal server, XMLAccess can be run from any host as long as a Java Runtime Environment (JRE) is installed
and the Portal server can be contacted over the network. WebSphere Portal does not have to be installed to run XMLAccess. As a matter of fact, IBM Support recommends that XMLAccess not be run on a production server,
because the JAVA process which invokes XMLAccess requires memory to run, in some cases, it would use a lot, especially with a lot of updates. The Task will run a normal XML Access on the source and target nodes then run them against the releaseBuilder tool and finally importing the results to the target node.

Usage

Provide all required parameters, sourceUrl and targetUrl are not optional but all other parameters will default to environment should they not be added to the to the Orchectration file.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
exportReleaseFile java.lang.String   false The xml file to be run as part of the task.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
portalUserName java.lang.String   false The Portal Admin username, will pick up form domain.xml but can be overriden here.
portalUserPassword java.lang.String   false The Portal Admin password, will pick up form domain.xml but can be overriden here.
relativeToArchiveRoot java.lang.String true true If ture, the package is relative to the expanded archive.[true | false]
releaseBuilderTask java.lang.String   true Path to the releaseBuilder script.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sourceUrl java.lang.String   false The URL of the source portal server on which the xmlaccess command must be run, this will be primary node of source Portal.
targetUrl java.lang.String   false The URL of the target portal server on which the xmlaccess command must be run, this will be primary node of target Portal.
tmpPath java.lang.String   true Path to a temp directory that can be used to store the xml results, usefull for debuging when you require the results external to the build directory.
xmlaccessPath java.lang.String   true Path to the xmlaccess script, this will default to the provided xmlAccess.sh in the package but can be overridden if required.


Back to Top

WebSpherePortalConfigureDMRGTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalConfigureDMRGTask
Category Websphere Portal v8

Configures the Deployment Manager.

Description

Task will configure and perpare the Deployment Manager for future Portal Cluster

Usage

The task will create the DMGR profile if it does not exist already. It will extract the fileForDmgr.zip which path is supplied in the task.
Next the task will augment the Profile for Portal management and automatically make the following changes:

  • - Increases the HTTP connection timeouts for the DMGR server
  • - Increases the SOAP connector timeout for JMX in the DMGR server
  • - Increases the JVM Maximum Heap size for the DMGR server
  • - Enables Application Security
  • - Creates a 'wpsadmins' group in the default file repository
  • - Adds your administrative user to the 'wpsadmins' group.
  • - Increases the soap timeout in the soap.client.props file.

It will finish by starting the Deployment Manager.

Attention

The create DMGR profile will create the default setting unless otherwise set in the task, see IBM documentation regarding manager profiles for the full list of parameters.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String wpsadmin true Admin user pass for the DMGR profile
adminUserName java.lang.String wpsadmin true Username for the DMGR profile.
cellName java.lang.String portalCell true Specifies the cell name of the profile. Use a unique cell name for each profile.
disableAddNode java.lang.Boolean false false This task disables adding the node, used if the task fails after the add node completes and you need to re-run.
enableAdminSecurity java.lang.String true true Enables administrative security. Valid values include true or false. The default value is false.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
filesForDmgr java.lang.String j2ee/config/filesForDmgr.zip false The package that contains the dmfr portal profile templates
installPath java.lang.String /opt/IBM/WebSphere/AppServer false Install path of the dmgr
nodeName java.lang.String portalNode true Specifies the node name of the profile.
profileName java.lang.String Dmgr01 false Dmgr profile name
profilePath java.lang.String /opt/IBM/WebSphere/AppServer/profiles/Dmgr01 false The path for the new DMGR progile.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
templatePath java.lang.String opt/IBM/WebSphere/AppServer/profileTemplates false The path to the templates for creating WebSphere profiles
tmpPath java.lang.String /tmp false A tem file location
userID java.lang.String   true The user who is used to run this task.


Back to Top

WebSpherePortalDatabaseMigrationTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalDatabaseMigrationTask
Category Websphere Portal v8

Migrates the Portal Server to a new Database.

Description

Populates the wkplc property files and transfers the databse to the new database..
This task will take in a helper property file and update all properties in the wkplc property file. "parentPropertiesSuffix" parameter specifies the location of a parent properties suffix file that you must package along with other deployment configuration,
The task will look for the parent property file in the format of env.cell.cluster.application.parentPropertiesSuffix, a property values set in the parent properties file will be copied to the main properties file, wkplc.properties.
The following properties for each schema below will be incerted in the wkplc properties.
  • db2.DbDriver=
  • db2.DbLibrary=
  • db2.JdbcProviderName=wpdbJDBC_xxxx
  • DbType=db2
  • DbName=fdbkdb
  • DbSchema=FEEDBACK
  • DataSourceName=wpdbDS_feedback
  • DbUrl=jdbc:db2://mydbserver.ibm.com:50000/fdbkdb:returnAlias=0;
  • DbUser=db2inst1
  • DbPassword=password
  • DbRuntimeUser=db2inst1
  • DbRuntimePassword=password
For more information about other databases that can be used with Portal, please visit the WebSphere Portal v8.0 Product Documentation for configuring external databases at this link and follow the instructions there as appropriate: WebSphere v8 Portal Documentation

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   false The admin user password
configEnginePath java.lang.String /opt/IBM/WebSphere/ConfigEngine/ConfigEngine.sh true The path to the ConfigEngine.sh, example /opt/IBM/WebSphere/ConfigEngine/ConfigEngine.sh.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
parentPropertiesSuffix java.lang.String db false Parent property files are stored in the config directory: env.cell.cluster.application.parentPropertiesSuffix. The suffix can be any name like security, database etc.. so it can be easily identified.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

WebSpherePortalDeployPortletsTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalDeployPortletsTask
Category Websphere Portal v8

Deploy Portlets

Description

Task deploys portlets to WebSphere Portal cluster or to a standalone server cell and runs provided XML access script to register the portets in portal database.
The task first runs a search and replace on the provided XML look for all matching key words provided by - "urlSearchKey" and replaces them with the path to the portlets wars files which is provided in parameter - "portletSourcePath".
Once find and replace is complete it will run the XML access command to import the portlets.

Usage

Provide all parmaters required, the XML access file that will be used to do the portlet imports needs to be manually modified before the task is run.
The key parameter for "urlSearchKey" must be inserted in the url tag - file://@PORTLETS_PATH@ where urlSearchKey was set to @PORTLETS_PATH@, this key will be replaced with your new "portletSourcePath"
If portlets are stored on shared or other filesystem please set relativeToArchiveRoot to false and provide the full path to the portlets.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configUrl java.lang.String   true The URL of the portal server on which the xmlaccess command must be run, generally the primary node. If left blank then will be picked up from domain.xml.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inFile java.lang.String   false The xml file to be run as part of the task.
outFile java.lang.String   true Optional xml file if you require the results saving.
portalUserName java.lang.String   true The Portal Admin username, will pick up form domain.xml but can be overriden here.
portalUserPassword java.lang.String   true The Portal Admin password, will pick up form domain.xml but can be overriden here.
portletSourcePath java.lang.String   true Path to the portlet war files, this will be replaced with the urlSearchKey.
relativeToArchiveRoot java.lang.Boolean false true If ture, the package is relative to the expanded archive.[true | false]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
urlSearchKey java.lang.String   true Search key that was incerted in the xml file for the url path to the location of the portlet war files. If files are stored in installableApps directory this can be left out.
xmlaccessPath java.lang.String   true The path to the xmlaccess script file within PortalServer. if one is not provided then the default one that is provided with the plugin will be used.


Back to Top

WebSpherePortalFederatePrimaryNodeTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalFederatePrimaryNodeTask
Category Websphere Portal v8

Federate the primary node.

Description

Task will configure and add the primary Portal node to the Deployment Manager cell and create the cluster.
The task will edit the /ConfigEngine/properties/wkplc.properties file and ensure all of the following properties are set appropriately for your environment:
  • WasUserid=
  • WasPassword=
  • PortalAdminPwd=
  • WasRemoteHostName=
  • WasSoapPort=
  • ServerName=WebSphere_Portal
  • PrimaryNode=true
  • ClusterName=PortalCluster

After the following task has been completed, you will have a functional one node cluster.

Usage

Ensure the time on your Portal primary node is within 5 minutes of the time on your Deployment Manager (DMGR).
Failure to do so will cause the addNode process to fail. 2. Ensure the DMGR is started.

IMPORTANT:

If the addNode script fails for any reason, you must complete the following steps before running addNode again:
a) Remove the node from the DMGR cell in case AddNode successfully completed that step before failing.
b) Login to the DMGR and do the following (these may not exist, depending on where the failure occurred):
  • i. Remove all Enterprise applications
  • ii. Remove the WebSphere_Portal server definition
  • iii. Remove the JDBC Provider information for WebSphere_Portal

Attention

If this task is run by a non root user make sure that the PortalServer root directory has write permissions, if not the task will halt untail it has the correct permissions. NOTE: For the primary node, you must leave ServerName as WebSphere_Portal. Do not change it to any other value.
NOTE: For the primary node, you must leave ServerName as WebSphere_Portal. Do not change it to any other value.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   ture Password for the dmgr.
adminUserName java.lang.String     Admin user for the dmgr.
configEnginePath java.lang.String   true The path to the ConfigEngine.sh, example /usr/IBM/WebSphere/ConfigEngine/ConfigEngine.sh.
disableAddNode java.lang.Boolean false true Flag to disable the add node section of the task, in case the Portal node has already been added to the DMGR.
dmgrHost java.lang.String localhost false Host name for the Deployment manager.
dmgrPort java.lang.String 8879 false Deployment manager soap port.
failOnError java.lang.Boolean true false The path to the UpdateInstaller.
parentPropertiesSuffix java.lang.String .dmgr false This file holds properties for the wkplc.properties file which are setup before deployment.
portalPassword java.lang.String   false Portal server password.
profilePath java.lang.String /opt/IBM/WebSphere/wp_profile true Profile path to WebSphere Portal bin directory
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

WebSpherePortalFederateSecondaryNodeTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalFederateSecondaryNodeTask
Category Websphere Portal v8

Federate Portal v8 Secondary nodes to the Deployment Manager.

Description

This section covers adding the additional node to the Deployment Manager cell and adding a new WebSphere_Portal server as a horizontal cluster member to the previously created cluster. Once this section is completed, you will have a functional multi-node horizontal cluster.. The task will edit the /ConfigEngine/properties/wkplc.properties file and ensure all of the following properties are set appropriately for your environment:
  • ProfileName=wp_profile
  • ProfileDirectory=/opt/IBM/WebSphere/wp_profile
  • WasUserid=
  • WasPassword=
  • PortalAdminPwd=
  • WasRemoteHostName=
  • WasSoapPort=
  • ServerName=WebSphere_Portal
  • PrimaryNode=true
  • ClusterName=PortalCluster

Attention

NOTE: For additional nodes, ServerName can be any value you want besides 'WebSphere_Portal'. This server will be created by the cluster-setup script.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   ture Password for the dmgr.
adminUserName java.lang.String     Admin user for the dmgr.
configEnginePath java.lang.String /opt/IBM/WebSphere/ConfigEngine true Path to the configEngine script
dmgrHost java.lang.String localhost true Host name for the Deployment manager.
dmgrPort java.lang.String 8803 true Deployment manager soap port.
failOnError java.lang.Boolean true false The path to the UpdateInstaller.
parentPropertiesSuffix java.lang.String .dmgr false This file holds properties for the wkplc.properties file which are setup before deployment.
portalPassword java.lang.String   true Portal server password.
profilePath java.lang.String /opt/IBM/WebSphere/wp_profile/bin true Profile path to WebSphere Portal bin directory
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

WebSpherePortalLocalConfigEngineTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalLocalConfigEngineTask
Category Websphere Portal v8

ConfigEngine Task runner

Description

Task runs a large number of supported ConfigEngine Task and takes a number of optional parameters depending on which task you are running.
This task will run ConfigEngine task on the deployment target only for example the primary node, if you require ConfigEngine tasks to run on a remote portal node please refer to the WebSpherePortalRemoteConfigEngineTask.

Usage

The task list below is a list of the supported tasks and some checks have been put in to check for required parameters and allows other optional parameters.

Restrictions

This task requires that standard prereq's are setup, please read the IBM documentation regarding the task you want to run.

Supported Tasks

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:

./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: http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Configuring_a_property_extension_database_on_Windows_wp7. 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

For the additional parameters that must be added to this command for proper function, please refer to the product documentation: Configuring OpenID authentication

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 creating the WebSphere Portal profile template in a clustered environment.

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, Changing the portal URI, 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 creating the WebSphere Portal profile template in a clustered environment.

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: Using the web content member fixer task
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.



Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configEngineCommand java.lang.String   false The ConfigEngine task to be run, must be from the supported list.
configEnginePath java.lang.String   true The path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
-Dlibrary java.lang.String   true The used with the deploy-deferred-profile-7002-theme task.
-DparentProperties java.lang.String   true The perant property file used to override or populate the wpklc properties.
-DPortalAdminPwd java.lang.String   true The Portal admin user, used with a number of tasks.
-DProxyConfigFileName java.lang.String   true The used with the checkin-wp-proxy-config task.
-DTransferDomainList java.lang.String   true The used with the validate-database-connection task.
-DVirtualPortalContext java.lang.String   true The used with the create-virtual-portal task.
-DVirtualPortalObjectId java.lang.String   true Theused with the modify-virtual-portal task.
-DVirtualPortalRealm java.lang.String   true The used with the create-virtual-portal task.
-DVirtualPortalTitle java.lang.String   true The used with the modify-virtual-portal task.
-DWasPassword java.lang.String   true The WAS admin user, used with a number of tasks.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
-TargetURI java.lang.String   true The used with the webdav-deploy-zip-file task.
-UpdateMode java.lang.String   true The used with the validate-database-driver task.
-VirtualPortalContext java.lang.String   true The used with the validate-database-driver task.
-VirtualPortalHost java.lang.String   true The used with the validate-database-driver task.
-ZipFileClassPath java.lang.String   true The used with the validate-database-driver task.
-ZipFilePath java.lang.String   true The used with the validate-database-driver task.


Back to Top

WebSpherePortalProfilesFromTemplatesNodeTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalProfilesFromTemplatesNodeTask
Category Websphere Portal v8

Create Portal v8 profiles from profilesTemplates.

Description

The task creates a new WebSphere Portal profile from the portalTemplates copied from the primary node.

Usage

Copy /profileTemplates/profileTemplates.zip from the Primary Portal node to the newly created /profileTemplates directory on the additional node.
Unzip the profileTemplates.zip file into the /profileTemplates directory on the additional node. Overwrite any duplicated files.
Update permissions on the profileTemplates directory by running the following command from the directory:

chmod 755 -R profileTemplates

Attention

NOTE: If you are using a non-root user, give this user temporary write access to the PortalServer directory.
NOTE: Do NOT use the same node name as your primary node or any other node that may already be part of the DMGR cell. You will be unable to add this node to the DMGR cell if the node names are identical.
NOTE: Do NOT use the same cell name as the DMGR cell.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellName java.lang.String portalCell true Specifies the cell name of the profile. Use a unique cell name for each profile.
dmgrHost java.lang.String localhost false Host name for the Deployment manager.
failOnError java.lang.Boolean true false The path to the UpdateInstaller.
installPath java.lang.String /opt/IBM/WebSphere/AppServer false WebSphere Application server install path.
nodeName java.lang.String Dmgr01 true Specifies the node name of the profile.
portalInstallPath java.lang.String /opt/IBM/WebSphere/PortalServer false WebSphere Portal server install path.
portalServerName java.lang.String /opt/IBM/WebSphere/PortalServer false WebSphere Portal server install path.
profileName java.lang.String Dmgr01 false Dmgr profile name
profilePath java.lang.String /opt/IBM/WebSphere/wp_profile true Profile path to WebSphere Portal bin directory
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
templatePath java.lang.String   false The path to the templates for creating WebSphere Portal profiles
userID java.lang.String   true The user who is used to run this task.


Back to Top

WebSpherePortalProfileTemplateTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal8.task.WebSpherePortalProfileTemplateTask
Category Websphere Portal v8

Create the WebSphere Portal profile template

Description

This task will create a backup of the primary node's wp_profile.
It will also enable the Portal profile templates within the WebSphere Application Server Profile Management tool.

This will allow you to create new Portal profiles in the future. Completing this step is a prerequisite for configuring the Deployment Manager and secondary nodes.

Attention

WARNING: The ConfigEngine scripts in this section will write to the PortalServer root directory.
By default, this directory is read/execute only (550). If you are using a non-root user, then this task will HALT until correct permissions are set.
Before executing as a non-root user, give temporary Write access to the PortalServer root directory for this user.
You can reset permissions after the scripts are completed.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   false Password for the dmgr.
adminUserName java.lang.String   true Admin user for the dmgr.
configEnginePath java.lang.String   true The path to the ConfigEngine.sh, example /opt/IBM/WebSphere/ConfigEngine/ConfigEngine.sh.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
installPath java.lang.String   false WAS home.
portalServerName java.lang.String /opt/IBM/WebSphere/PortalServer false WebSphere Portal server install path.
profilePath java.lang.String /opt/IBM/WebSphere/wp_profile false Profile path to WebSphere Portal bin directory
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
userID java.lang.String   true The user who is used to run this task.


Back to Top

WebSpherePortalRemoteConfigEngineTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalRemoteConfigEngineTask
Category Websphere Portal v8

ConfigEngine Task runner

Description

Task runs a large number of supported ConfigEngine Task and takes a number of optional parameters depending on which task you are running.
The only difference between this task and the WebSpherePortalLocalConfigEngineTask is that this will run remote ConfigEngine tasks on remote nodes providing the correct security details have been provided.

Usage

Supported Tasks

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:

./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: http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Configuring_a_property_extension_database_on_Windows_wp7. 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

For the additional parameters that must be added to this command for proper function, please refer to the product documentation: Configuring OpenID authentication

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 creating the WebSphere Portal profile template in a clustered environment.

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, Changing the portal URI, 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 creating the WebSphere Portal profile template in a clustered environment.

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: Using the web content member fixer task
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.



Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configEngineCommand java.lang.String   false The ConfigEngine task to be run, must be from the supported list.
configEnginePath java.lang.String   true The path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
-Dlibrary java.lang.String   true The used with the deploy-deferred-profile-7002-theme task.
-DparentProperties java.lang.String   true The perant property file used to override or populate the wpklc properties.
-DPortalAdminPwd java.lang.String   true The Portal admin user, used with a number of tasks.
-DProxyConfigFileName java.lang.String   true The used with the checkin-wp-proxy-config task.
-DTransferDomainList java.lang.String   true The used with the validate-database-connection task.
-DVirtualPortalContext java.lang.String   true The used with the create-virtual-portal task.
-DVirtualPortalObjectId java.lang.String   true Theused with the modify-virtual-portal task.
-DVirtualPortalRealm java.lang.String   true The used with the create-virtual-portal task.
-DVirtualPortalTitle java.lang.String   true The used with the modify-virtual-portal task.
-DWasPassword java.lang.String   true The WAS admin user, used with a number of tasks.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file false Local Identity file.
sshKnownHostsFile java.lang.String   true SSH Known Hosts File.
targetServerNames java.lang.String dmgrHost false Target DMGR hostname.
targetServerSshPassphrase java.lang.String ****** true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String ****** true Target SSH password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target serves.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.
-TargetURI java.lang.String   true The used with the webdav-deploy-zip-file task.
-UpdateMode java.lang.String   true The used with the validate-database-driver task.
-VirtualPortalContext java.lang.String   true The used with the validate-database-driver task.
-VirtualPortalHost java.lang.String   true The used with the validate-database-driver task.
-ZipFileClassPath java.lang.String   true The used with the validate-database-driver task.
-ZipFilePath java.lang.String   true The used with the validate-database-driver task.


Back to Top

WebSpherePortalRemoteDeployPortletsTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalRemoteDeployPortletsTask
Category Websphere Portal v8

Deploy Portlets Remotely

Description

Task deploys portlets to WebSphere Portal cluster or to a standalone server cell and runs provided XML access script to register the portets in portal database.
Difference from the WebSpherePortalDeployPortletsTask is that this task can be run from the Deployment Manager and deploy to a remote portal node.
The task first runs a search and replace on the provided XML look for all matching key words provided by - "urlSearchKey" and replaces them with the path to the portlets wars files which is provided in parameter - "portletSourcePath".
Once find and replace is complete it will run the XML access command to import the portlets.

Usage

Provide all parmaters required, the XML access file that will be used to do the portlet imports needs to be manually modified before the task is run.
The key parameter for "urlSearchKey" must be inserted in the url tag - file://@PORTLETS_PATH@/application.war where urlSearchKey was set to @PORTLETS_PATH@, this key will be replaced with your new "portletSourcePath"
If portlets are stored on shared or other filesystem please set relativeToArchiveRoot to false and provide the full path to the portlets.

Restrictions

This task requires that all portlet war files exist on any remote nodes, easiest is to run a secureCopyTask to copy the wars to the remote server first. TIP: If the portlet war files are copied to the remote node (Primary node) it is best to copy to installableApps Directory under PORTAL_HOME.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configUrl java.lang.String   true The URL of the portal server on which the xmlaccess command must be run, generally the primary node. If left blank then will be picked up from domain.xml.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inFile java.lang.String   false The xml file to be run as part of the task.
outFile java.lang.String   true Optional xml file if you require the results saving.
portalUserName java.lang.String   true The Portal Admin username, will pick up form domain.xml but can be overriden here.
portalUserPassword java.lang.String   true The Portal Admin password, will pick up form domain.xml but can be overriden here.
portletSourcePath java.lang.String   true Path to the portlet war files, this will be replaced with the urlSearchKey.
relativeToArchiveRoot java.lang.String false true If ture, the package is relative to the expanded archive.[true | false]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
sshIdentityFile java.lang.String /path/to/identity/file false Local Identity file.
sshKnownHostsFile java.lang.String   true SSH Known Hosts File.
targetServerNames java.lang.String dmgrHost false Target DMGR hostname.
targetServerSshPassphrase java.lang.String ****** true Target SSH passphrase (if required).
targetServerSshPassword java.lang.String ****** true Target SSH password (if required).
targetServerSshPort java.lang.String 22 false SSH Port on the target serves.
targetServerSshTimeout java.lang.String 1200000 false Timeout on the target server(s) in milliseconds.
targetServerSshUser java.lang.String sshUser false Target SSH user.
urlSearchKey java.lang.String   true Search key that was incerted in the xml file for the url path to the location of the portlet war files. If files are stored in installableApps directory this can be left out.
xmlaccessPath java.lang.String   true The path to the xmlaccess script file within PortalServer. if one is not provided then the default one that is provided with the plugin will be used.


Back to Top

WebSpherePortalStartServersTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalStartServersTask
Category Websphere Portal v8

Start servers and node agents.

Description

The task will start a server or a node agent.

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   false The admin password for the server.
adminUserName java.lang.String   true The Admin user for the server being started.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
profilePath java.lang.String @@profilePath@@ false The path the the profile path for this node.
serverName java.lang.String WebSphere_Portal false Name of the server that is to be started.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

WebSpherePortalStopServersTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalStopServersTask
Category Websphere Portal v8

Stop servers and node agents.

Description

The task will stop a server or a node agent.

Table of task Resources

Name Type Default Value Optional Description
adminPassword java.lang.String   true The admin password for the server.
adminUserName java.lang.String   true The Admin user for the server being started.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
profilePath java.lang.String @@profilePath@@ false The path the the profile path for this node.
serverName java.lang.String WebSphere_Portal false Name of the server that is to be stopped.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.


Back to Top

WebSpherePortalUpdateWKPLCPropertiesTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalUpdateWKPLCPropertiesTask
Category Websphere Portal v8

Updating the default wkplc properties

Description

The properties specified in the file wp_profile_root/ConfigEngine/properties/wkplc.properties work with the IBM® WebSphere® Portal configuration tasks.
Like the configuration tasks that are run, the specific properties required for installation and customized configuration will vary, depending on how you deploy WebSphere Portal and its components.

This task will take in a helper property file and update all properties in the wkplc property file. "parentPropertiesSuffix" parameter specifies the location of a parent properties suffix file that you must package along with other deployment configuration,
The task will look for the parent property file in the format of env.cell.cluster.application.parentPropertiesSuffix, a property values set in the parent properties file will be copied to the main properties file, wkplc.properties. Value is defined by the user.

Usage

Provide the required parameters and the parentPropertiesSuffix, all propery values can be provided in on large file but it is advisable to split these in to more manageable files.
For example have all database require properties in a file suffex env.cell.cluster.application.database, LDAP and security in one called env.cell.cluster.application.security....
The task can be run as many times as needed in the same Orchestration file.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configEnginePath java.lang.String   true The path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
parentPropertiesSuffix java.lang.String   true Parent property files are stored in the config directory: env.cell.cluster.application.parentPropertiesSuffix. The suffix can be anyname like security, database etc.. so it can be easly identified.
portalPassword java.lang.String   true The Portal Admin password, will pick up form domain.xml but can be overriden here.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
wasPassword java.lang.String   true The WAS admin password, will pick up form domain.xml but can be overriden here.


Back to Top

WebSpherePortalXMLAccessTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.task.WebSpherePortalXMLAccessTask
Category Websphere Portal v8

Run xmlAccess commands on local and remote servers.

Description

The WebSphere Portal XML Configuration Interface Task, also known as XMLAccessTask, is a command line tool or utility that takes an XML file as input.
The XML file contains statements or instructions to modify a WebSphere Portal configuration.
The XMLAccess tool is a standalone tool and is packaged witin this plugin which allows it to run XMLAccess from one system against a remote Portal server, XMLAccess can be run from any host as long as a Java Runtime Environment (JRE) is installed
and the Portal server can be contacted over the network. WebSphere Portal does not have to be installed to run XMLAccess. As a matter of fact, IBM Support recommends that XMLAccess not be run on a production server,
because the JAVA process which invokes XMLAccess requires memory to run, in some cases, it would use a lot, especially with a lot of updates. The Task has been configured with extra useful XSL transformation functionality, this allows users to dymanically write XMLAccess xml files at run time.
This is very useful for example when a user would like to delete all portlets that were installed using a pervious XML import file, by passing in preconfigured XSL file it will generate the exact XML delete file and run it therefore saving valueable time in manually creating the file.

Usage

Provide all required parameters, inFile is not optional but all other parameters will default to domain.xml should they not be added to the to the Orchectration file.
Out file is useful for debuging and when export tasks are required.

The task will run the supplied inFile as normal unless the optional XSL parameter is provided, only then will it run the transform function and run the newly created xml file.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
configUrl java.lang.String   true The URL of the portal server on which the xmlaccess command must be run, generally the primary node. If left blank then will be picked up from domain.xml.
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
inFile java.lang.String   false The xml file to be run as part of the task.
outFile java.lang.String   true Optional xml file if you require the results saving.
password java.lang.String   true The Portal Admin password, will pick up form domain.xml but can be overriden here.
relativeToArchiveRoot java.lang.Boolean false true If ture, the package is relative to the expanded archive.[true | false]
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
username java.lang.String   true The Portal Admin username, will pick up form domain.xml but can be overriden here.
xmlaccessPath java.lang.String   true Path to the xmlaccess script, this will default to the provided xmlAccess.sh in the package but can be overridden if required.
xsl java.lang.String   true This is an optional value, if added it will be used to transform the inFile to a new xml file. Example: creating a delete portlet xml file from a import portlet one.