Back to Top

WebspherePortalBaseInstallTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebspherePortalBaseInstallTask
Category Websphere Portal v6.1

Run the base portal Install (CIP).

Description

Task to create IBM WebSphere Portal non clustered node.

Restrictions

h This task requires a pre packaging task take place to create a CIP using IBM Instalation Factory.
Follow the instructions in this link Cloning WebSphere Portal

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line.

NameTypeScopeDefault ValueOptionalDescription
installPathjava.lang.StringParameterBinary Installation pathfalseThe path to the binary installation.
adminUserNamejava.lang.StringParameterfalseAdmin user to be created for this cell (dmgr and node profile).
adminPasswordjava.lang.StringParameterfalseAdmin user password.
profileLocationjava.lang.StringParameterinstallPath/../cellIDtruePath to the created profile.
dmgrHostjava.lang.StringParameterfalseThe deployment manager hostname or ip address (Required for node profile only).
dmgrPortjava.lang.StringParameterfalse The deployment manager (SOAP) port (Required for node profile only).
startingPortjava.lang.StringParameterfalseStarting port for this profiles port range (dmgr and node profile).
hostNamejava.lang.StringParameterfalsehostname (dmgr and node profile).
cellIDjava.lang.StringParameterfalseId of the cell (dmgr and node profile).
iipOptionSetPrefixjava.lang.StringParameter|ResourceDerived from the deployed archive file nametrueA WebSphere version number, for example 6.1.0, 7.0.0 etc.

Profile creation

This parameter must be setup -portalInstallDir
                     			The below variables will be set automatically at deployment time as environment variables, there are used by the ant task
                     during the deployment process.
WP_INSTALL_SR
WP_INSTALL_DIR
WP_PROFILE_DIR

Example (profile path)

                     			The installPath is /usr/IBM/WebSphere 
The cellID is wascell01
The NodeProfile is wpprofile
The node profile will be : /usr/IBM/WebSpher/AppServer/profiles/node01

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cellSuffix java.lang.String Network true Use the CellID and append this to the Cell Name [dmgr only]
dmgrProfile java.lang.String DeploymentManager true Store the profile in this subdirectory [dmgr only]
dmgrSuffix java.lang.String _dm true The Dmgr Suffix
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
features java.lang.String NONE false The extras to install [NONE|EJB3|WEBSV|WEBSVEJB3] can be specified here or can be specified as a parameter, instead of a resource.
installPath java.lang.String   false The path to the binary installation.
NodeProfile java.lang.String AppServer true Store the profile in this subdirectory [Node only]
nodeSuffix java.lang.String Manager true The Node name suffix
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
type java.lang.String dmgr false The type of profile [dmgr or node].
userID java.lang.String   true The user who is used to run this task.


Back to Top

WebSpherePortalCloneTask

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

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 node and take the exported output and import it to the target node.

Usage

Provide all required parameters, inFile and outFile are not optional but all other parameters will default to domain.xml should they not be added to the to the Orchectration file.
The parameter "cleanTarget" is used if you require that the target environment be cleaned first, useful for removing unwanted resources.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
cleanTarget java.lang.String false true This is an optional value, that will clean the target environment by running ConfigEngine.sh empty-portal task.
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   false 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.
relativeToArchRoot 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.
sourceUrl java.lang.String   true 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   true The URL of the target portal server on which the xmlaccess command must be run, this will be primary node of target Portal.
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.


Back to Top

WebSpherePortalDatabaseMigrationTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalDatabaseMigrationTask
Category Websphere Portal v6.1

Migrate Portal Database

Description

ConfigEngine tasks to migrate the Portal Database.
The task is automatically coded to validate the database drivers and database connections, once passed validation checks it will run "database-transfer".

Usage

All three parameters in this task are optional as they will be retrieved from the environment domain xml if not passed in.
You have the option to overide the domain xml, this is useful if running ConfigEngine task on a secondary node where the path is different to primary node.

Restrictions

This task requires that standard prereq's are setup, please read the IBM documentation regarding migrating a Portal database.

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line:

NameTypeScopeDefault ValueOptionalDescription
ConfigEnginePathjava.lang.StringParametertrueThe path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
wasPasswordjava.lang.StringParameterfalseWAS Admin user password.
portalPasswordjava.lang.StringParameterfalsePortal Admin user password.

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.
portalPassword java.lang.String   true Portal Admin user password.
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 WAS Admin user password.


Back to Top

WebSpherePortalDeployPortletsTask

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

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 relativeToArchRoot 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
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.
portletSourcePath java.lang.String   true Path to the portlet war files, this will be replaced with the urlSearchKey.
relativeToArchRoot 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.
url 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.
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.
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.
username java.lang.String   true The Portal Admin username, will pick up form domain.xml but can be overriden here.


Back to Top

WebSpherePortalDeployThemesSkinsTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalDeployThemesSkinsTask
Category Websphere Portal v6.1

Deploy Portal Themes and Skins

Description

Theme and skin JSPs are managed as part of the main IBM® WebSphere® Portal enterprise application and are thus part of the WebSphere Portal EAR file.
The WebSphere Portal EAR file must be updated and redeployed when adding new themes and skins.
Failure to do this could cause the custom themes and skins to be deleted when the EAR file is subsequently updated.

Task deploys a theme/skin to the WebSphere Portal cluster or to a standalone server cell, its first exports the WPS.ear to a tmp location and expands it.
It will then look for themes/skins with the suppiled extension and extract them into the correct directories within the WPS.ear.. /wps.war/themes/html & /wps.war/skins/html
Once all themes/skins have been deployed it will collapse and redeploy the WPS.ear into the deployment manager.

It is reconmended running this task before any WebSphere Deployment Tasks as these can automatically restart and force a sync between all the nodes, other wise you will need to restart the Deployment Manager.

Usage

Provide all parmaters required, themsePath and skinPath can be within the deployment package or on a shared file system.
If on shared or other filesystem please set relativeToArchRoot to false.
The themes and skins must be packaged up in either [tar | jar | zip] and the extension used must be supplied via the "extension" parameter, the task will then search for files with this ext in the provided paths and extract them into the WPS.ear.

Resources

The following resources may be set on this task:

Table of task Resources

Name Type Default Value Optional Description
earExpanderScriptPath java.lang.String   true The path to the EarExpander.sh, example /usr/IBM/WebSphere/AppServer/bin/EarExpander.sh.
extension java.lang.String   false The extension type of the packaged themes and skins [ tar | zip | jar ]
failOnError java.lang.Boolean true false This task will not fail the deployment on error if set to false.
relativeToArchRoot java.lang.String false true If ture, the package is relative to the expanded archive.[true | false]
skinPath java.lang.String   false The path to the packaged skins, can be relative to archive root, or full path on the file system, depends on relativeToArchRoot setting.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
themesPath java.lang.String   false The path to the packaged themes, can be relative to archive root, or full path on the file system, depends on relativeToArchRoot setting.
wasPassword java.lang.String   true WAS Admin user password.
wasUSer java.lang.String   true WAS Admin user password.
wsadminPath java.lang.String   true The path to the wsadmin.sh, example /usr/IBM/WebSphere/AppServer/bin/wsadmin.sh.


Back to Top

WebSpherePortalEnableSecurityTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalEnableSecurityTask
Category Websphere Portal v6.1

Enable Security Standalone for LDAP

Description

ConfigEngine tasks to enable security for standalone LDAP.
The task is automatically coded to validate the LDAP configutation, once passed validation checks it will run "wp-modify-ldap-security".

Usage

All three parameters in this task are optional as they will be retrieved from the environment domain xml if not passed in.
You have the option to overide the domain xml, this is useful if running ConfigEngine task on a secondary node where the path is different to primary node.

Restrictions

This task requires that standard prereq's are setup, please read the IBM documentation regarding enabling portal security.

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line:

NameTypeScopeDefault ValueOptionalDescription
ConfigEnginePathjava.lang.StringParametertrueThe path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
wasPasswordjava.lang.StringParameterfalseWAS Admin user password.
portalPasswordjava.lang.StringParameterfalsePortal Admin user password.

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.
portalPassword java.lang.String   true Portal Admin user password.
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 WAS Admin user password.


Back to Top

WebSpherePortalExportInstallWPSEarTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalExportInstallWPSEarTask
Category Websphere Portal v6.1

Export and Install an Ear

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 relativeToArchRoot 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
earFile java.lang.String   false The ear file name that is to be extracted or imported.
earFileRelativePath java.lang.String false true If ture, the package is relative to the expanded archive.[true | false]
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.
wasPassword java.lang.String   true WAS Admin user password.
wasUSer java.lang.String   true WAS Admin user password.
wsadminPath java.lang.String   true The path to the wsadmin.sh, example /usr/IBM/WebSphere/AppServer/bin/wsadmin.sh.


Back to Top

WebSpherePortalFederateNodeTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalFederateNodeTask
Category Websphere Portal v6.1

Federate Portal node.

Description

ConfigEngine tasks to federate the portal node to the WebSphere Deployment Manager.
The task is automatically coded to to run all cluster pre and post federation tasks and if cpmpleted successfully it will configure the cluster setup.

Usage

All three parameters in this task are optional as they will be retrieved from the environment domain xml if not passed in.
You have the option to overide the domain xml, this is useful if running ConfigEngine task on a secondary node where the path is different to primary node.

Restrictions

This task requires that standard prereq's are setup, please read the IBM documentation regarding node federation.

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line:

NameTypeScopeDefault ValueOptionalDescription
ConfigEnginePathjava.lang.StringParametertrueThe path to the ConfigEngine.sh, example /usr/IBM/WebSphere/AppServer/node01/ConfigEngine/ConfigEngine.sh.
wasPasswordjava.lang.StringParameterfalseWAS Admin user password.
portalPasswordjava.lang.StringParameterfalsePortal Admin user password.

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.
portalPassword java.lang.String   true Portal Admin user password.
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 WAS Admin user password.


Back to Top

WebSpherePortalGatherFilesForDMGRTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalGatherFilesForDMGRTask
Category Websphere Portal v6.1

Gather Tasks for the Dmgr

Description

This task is designed to run on the primary node as part of a Portal binary installation and is required before the node federation is run.
It will run the the ConfigEngine task "collect-files-for-dmgr" and providing the correct connections setting have been provided it will attempt to expand each of the files in the filesForDmgr.zip file into the proper location on the Deployment Manager based on the directory names within the zip file.
The directory names in the zip file are based on the typical default directory names.
The directory called "AppServer/profiles/Dmgr01" is used to identify the Deployment Manager profile root, and the "AppServer" directory is used to identify the Deployment Manager installation root directory.
If the Deployment Manager was installed into the default directory (AppServer) and the profile was created in the default directory (AppServer/profiles/Dmgr01), then the zip file can be expanded directly into the directory above the AppServer directory; for example /IBM/WebSphere.

Usage

Provide the required parameters besed on the security setup between the node and the deployment manager, Some parameters will automatically extracted from domain.xml as default but can be set in the 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.
profilePath java.lang.String   false The path to the node profile, example /usr/IBM/WebSphere/AppServer/node01/.
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.
wasPassword java.lang.String   true WAS Admin user password.
wasUSer java.lang.String   true WAS Admin user password.


Back to Top

WebSpherePortalInstallFixpackTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalInstallFixpackTask
Category Websphere Portal v6.1

Install a fix/fixPack.

Description

Update Portal via fix or Fixpack..

Usage

Fill in the correct parameters as they would be passed on the command line as per IBM instructions, which parameters are required will depended on the fix type [fix | fixpack].
Example parameters:
                     			updatePortal fix
-installDir
-fix
-install | -uninstall | -uninstallAll
-fixDir
-fixes
-fixJars
-fixDetails
updatePortal fixpack
-installDir
-fix
-install | -uninstall | -uninstallAll
-fixpackDir
-fixDetails

Restrictions

This task requires that standard prereq's are setup, please read the IBM documentation regarding installing fixpacks: WAS_HOME must be set in your environment file.

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line:

NameTypeScopeDefault ValueOptionalDescription
updateInstallerPathjava.lang.StringParameterfalseThe path to the UpdateInstaller.
UIrelativeToArchRootjava.lang.StringParameterfalseIf ture, the UpdateInstaller is relative to the expanded archive.
FixrelativeToArchRootjava.lang.StringParameterfalseIf ture, the fixpack is relative to the expanded archive.
fixTypejava.lang.StringParameterfixPackfalseThe type of update being installed, fix or fixpack
fixDirectoryjava.lang.StringParameterfalseSpecifies the fully qualified directory where unpacked fixs and fixpacks are.
fixesjava.lang.StringParameterfalseInterim fix only. Specifies the list of space-delimited interim fixes to install or uninstall.
fixJarsjava.lang.StringParameterfalseInterim fix only. Specifies the list of space-delimited fix JAR files to install or uninstall.
fixpackDirjava.lang.StringParameterfalseFix pack only. Specifies the fully qualified directory where you downloaded and unpacked the fix packs.
fixPackIDjava.lang.StringParameterfalseFix pack only. Specifies the ID of the fix pack to install or uninstall. The value must not include the .jar extension.


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 The path to the UpdateInstaller.
fixDirectory java.lang.String   false Specifies the fully qualified directory where unpacked fixs and fixpacks are.
fixes java.lang.String true false Interim fix only. Specifies the list of space-delimited interim fixes to install or uninstall.
fixJars java.lang.String   true Interim fix only. Specifies the list of space-delimited fix JAR files to install or uninstall.
fixpackDir java.lang.String true true Fix pack only. Specifies the fully qualified directory where you downloaded and unpacked the fix packs.
fixPackID java.lang.String   true Fix pack only. Specifies the ID of the fix pack to install or uninstall. The value must not include the .jar extension.
FIXrelativeToArchRoot java.lang.String false true If true, the fixpack is relative to the expanded archive.
fixType java.lang.String   false The type of update being installed, fix or fixpack.
skipOnFailure java.lang.String Previous Task Name true Skip current task based on the name of the previous task whether has failed or not.
UIrelativeToArchRoot java.lang.String false true If ture, the UpdateInstaller is relative to the expanded archive.
updateInstallerPath java.lang.String   false This task will not fail the deployment on error if set to false.


Back to Top

WebSpherePortalInstallUpdateInstallerTask

Class Name com.midvision.rapiddeploy.plugins.products.ibm.was.portal.portal61.task.WebSpherePortalInstallUpdateInstallerTask
Category Websphere Portal v6.1

Install Portal UpdateInstaller.

Description

Task to install the IBM UpdateInstaller used to upgrade and install fix packs to Portal.

Usage

Provide the installation path to where UpdateInstaller is required to be installed, standard is in the /UpdateInstaller directory but it can be installed anywhere on the filesystem.
Provide the UpdateInstaller package in either jar, tar or zip format, thsi can be in you deployment package or in a shared filesystem, if outside the package the relativeToArchRoot must be set to true and full path provided.

Parameters and properties

These parameters may be set on the Environment Installation panel in the RapidDeploy GUI, or passed to the orchestration on the command line:

NameTypeScopeDefault ValueOptionalDescription
updateInstallerPathjava.lang.StringParameterUpdateInstaller Environment Installation pathfalseThe path to the installation of the UpdateInstaller, example: /usr/IBM/PortalServer/UpdateInstaller.
updateInstallerPackagejava.lang.StringParameterfalseThis is the path to the UpdateInstaller package that you want installed, it can be packaged as a [tar|jar|zip].
relativeToArchRootjava.lang.StringParameterfalseIf ture, the package is relative to the expanded archive.

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.
relativeToArchRoot java.lang.String false true If true, 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.
updateInstallerPackage java.lang.String   true The package location for UpdateInstaller [tar | jar | zip ]
updateInstallerPath java.lang.String   false The install path for UpdateInstaller.


Back to Top

WebSpherePortalLocalConfigEngineTask

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

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

WebSpherePortalRemoteConfigEngineTask

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

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.portal61.task.WebSpherePortalRemoteDeployPortletsTask
Category Websphere Portal v6.1

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@ 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 relativeToArchRoot 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
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.
portletSourcePath java.lang.String   true Path to the portlet war files, this will be replaced with the urlSearchKey.
relativeToArchRoot 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.
url 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.
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.
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.
username java.lang.String   true The Portal Admin username, will pick up form domain.xml but can be overriden here.


Back to Top

WebSpherePortalUpdateWKPLCPropertiesTask

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

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.portal61.task.WebSpherePortalXMLAccessTask
Category Websphere Portal v6.1

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
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.
relativeToArchRoot 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.
url 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.
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.