Filters

Search Results ()

Search Results ()

    All Plugins (147)

    Quick Info

    Product
    HCL Launch
    Type
    plugin
    Compatibility
    Created by
    HCL Software
    Published Date
    March 12th, 2021
    Last Updated
    April 14th, 2022

    Description

    WebSphere Portal is a framework that includes a runtime server, services, tools, and other features. WebSphere Portal is used to integrate enterprises into a single, customizable interface called a portal. An enterprise portal combines components, applications, processes, and content from a wide variety of sources into a unified presentation, which users can access from a wide variety of devices.

    Quick Info

    Product
    HCL Launch
    Type
    plugin
    Compatibility
    Created by
    HCL Software
    Published Date
    March 12th, 2021
    Last Updated
    April 14th, 2022

    launch-websphereportal-8.1100783.zip

    Uploaded: 10-Mar-2021 14:13

    Summary

    The WebSphere Portal plugin provides steps that you can use to automate deployment of artifacts and automate running commands. Use the plugin to complete the following tasks on WebSphere Portal cells: deploy artifacts (such as themes, skins, and PAA files), run ConfigEngine commands, and run XML Access scripts.

    The following steps provide an overview of the process to follow.

    1. Create resources. If you use topology discovery, one resource with the PortalServer resource role is created. Manually populate resources by creating components under the PortalServer resource to represent deployable artifacts (themes, PAA files, WAR files, ConfigEngine commands, XMLAccess scripts).
    2. Define properties for the resources.
    3. Define components, applications, and environments to automate deployment.
    4. Deploy.

    This plugin includes one or more steps, click Steps for step details and properties.

    Compatibility

    The plugin works with WebSphere Portal versions 6.1, 6.1.5, 7.0, 8.0, 8.5 and 9.0. Both ND and stand-alone topologies are supported.

    Installation

    See Installing plugins in HCL Launch for installing and removing plugins.

    History

    The following table describes the changes made in each plugin version.

    Plugin history details
    Version Description
    8 Fixes APAR PH27880 – BLANK CONTEXT ROOT NOT WORKING

    Usage

    The WebSphere Portal plugin stores the XML access script in the following file:

    agent_home_directory/var/work/component_name/xmlAccessScript.xml

    The output of the XML access command is written to the xmlAccessScript_out.xml file.

    Before you begin

    • The HCL Launch agent must be installed on the system that hosts the Portal Node.
    • If WebSphere Portal Server is deployed in a directory other than the default directory, you must set a property on the agent before you can run the WebSphere Topology Discovery step.
      1. Go to Resources > Agents > agent-name > Configuration > Agent Properties.
      2. Add a property that is named wsadmin.path.
      3. Set wsadmin.path to the fully qualified path to the wsadmin script including the script name.

    Procedure

    1. Install the WebSphere Application Server Deployment plugin. Skip this step if the plugin is already installed.
    2. Add an agent.
      1. Hover your mouse over the row for the resource group, click Actions, and then select Add Agent.
      2. Wait 10 30 seconds, then click Refresh. A twistie is now next to the agent. When you expand it, a subresource cell, WebSphereCell, is displayed.
      3. Hover your mouse over the row, then click Edit.
      4. Enter values for the following properties.
        • WebSphere Profile Path
        • WebSphere User
        • WebSphere Password.
          If this value is left blank, soap.properties is used to locate the password for the user.

        Leave the Cell Name property blank.

        Note: The SOAP port that is defined in the cell properties must match the WasSoapPort property that is defined in the wkplc.properties file.

      5. Click Save.
    3. On the Resources page, click the Actions push button that is associated with the WebSphereCell resource, and then click Configure using WebSphere Topology Discovery. The discovery step runs. This step might take several minutes. A log is displayed to show progress.
    4. When the discovery process completes, close the log window, and then refresh the resource tree. Resources that represent the WebSphere Application Server components are displayed in the resource tree.
    5. Define properties for the WebSphere_Portal resource, which is located under cell_name/Nodes/node_name/Portal Servers in the resource tree. Click the resource, then the Configuration tab, then Resource Properties. The Edit Resource window is displayed, with Role set to PortalServer. The heading of the properties table is Role Properties: PortalServer.
      • For ND topology, define the properties for Portal Cluster, Portal Primary Node, and Portal Secondary Node resources.
      • For a stand-alone topology, define the properties for the Portal Node resource.

      Define the following properties:

      • portal.home: Portal installation directory, by default /opt/IBM/WebSphere/PortalServer
      • portal.profile.home: Portal profile directory, by default /opt/IBM/WebSphere/wp_profile
      • portal.admin.user: Portal administrator user name, by default wpsadmin
      • portal.admin.password: Portal administrator password, by default wpsadmin
      • portal.config.port: Portal configuration port, by default 10039
      • websphere.password: WebSphere administrator password

      Note: The portal.config.port property must match the XmlAccessPort property that is defined in the wkplc_comp.properties file.

    6. Create components for the resources. You need one component for each resource to deploy.
    7. Add the components to the resources.
      1. Go to the resource.
      2. Select Actions > Add Component.
      3. Select the component to use.
    8. Create the application.
      1. Go to Applications.
      2. Click Create New Application (if one does not exist). You can also use an existing application that is attached to the cell to manage.
      3. Enter an application name, then click Save.
      4. Click the Components tab, then add the component that was created by the template generation procedure.
    9. Create an application environment.
      1. In the Resources page, click Create New Environment.
      2. Enter an environment name, then click Save.
      3. Go to the environment editor.
      4. Click the environment name, then click Add Base Resource. Choose the group for your exemplar cell and environment.
    10. Create a component process of type Deployment to deploy a Portal WAR file.
      1. On the component page, click Processes, and then click Create Process. The Create Process window is displayed.
      2. Specify a name for the process, select Deployment in the Process Type list, and then click Save.
      3. Add a Download Artifacts step and then a Deploy Portal WAR step to the process.

        If you edit the Deploy Portal WAR process step, and then select Show Hidden Properties, you can see that the step properties correspond to the properties that you defined in step 5 previously.

      4. Save the process.
    11. Create an application process to install the component.
      1. On the application page, click Processes, and then click Create Process. The Create Process window is displayed.
      2. Drag the Install Component step onto the process editor.
      3. Select the component and component process that you created previously.
      4. Click Save.
      5. Save the process.
    12. To test the newly created component, run the application process on your environment.

    Open WebSphere Portal, and then search for the portlet by name. The portlet is displayed. You can now add the portlet to a page.

    Steps

    The following process steps are available in the WebSphere Portal plugin.

    Deploy Portal WAR

    Deploys a WAR on a WebSphere Portal server

    Input properties for the Deploy Portal WAR step
    Name Type Description Required
    Application WAR file name String The name of the application WAR file. If left blank, the name of the component is used. No
    Application context root String Specify the applications context root. If left blank, /wps/${Application display
    name} is used as the default application context root
    No
    Application display name String Specify application display name in the administative console. If left blank, the default display name used is constructed using the uid of the application mentioned in the portlet.xml file in the WAR. The logic to construct the display name is to replace all whitespace characters in the uid by an underscore character _ and prefix PA_ to it No
    Portal Server context root String Specify the portal servers context root. If left blank, /wps is used as the default portal server context root No
    Use soap.client.props file Boolean Use soap.client.props file for Portal administrator credential No
    Virtual Portal context String If deploying the WAR on a virtual portal, specify the virtual portal context root No
    Virtual Portal hostname String If deploying the WAR on a virtual portal, specify the virtual portal hostname No
    WebSphere Portal server installation home String Portal installation home No
    WebSphere Portal server profile home String Portal server profile home No
    WebSphere portal server administrator password Password WebSphere portal server administrator user password No
    WebSphere portal server administrator username String WebSphere portal server administrator username No
    WebSphere portal server configuration port String WebSphere portal server configuration port No

    Deploy Theme

    Deploys the static contents of a theme along with the related skins on a WebSphere Portal server

    Input properties for the Deploy Theme step
    Name Type Description Required
    Portal Server context root String Specify the portal servers context root. If left blank, /wps is used as the default portal server context root No
    Theme context root String The context root of the web application representing the theme. If left blank, the name of the WAR/ZIP filename containing the theme artifacts is used. No
    Theme default skin String The uniquename of the skin to be used as the default skin for this theme. If left blank, the first child directory of the themes/skins directory is used. No
    Theme layout directory String The directory in the theme WAR/ZIP file under the /themes directory that contains
    the theme layout details
    No
    Theme resource root String The resource root entry for the theme. If left blank, the name of the WAR/ZIP filename containing the theme artifacts is used. No
    Theme static content file name String The name of the file containing the theme static contents. Valid file extensions are.war and .zip. The default extension is .war. If left blank, the name of the component is used. No
    Theme template directory String The name of the directory in the theme WAR/ZIP file that contains the theme template. All theme templates are usually placed under the /themes directory in the WAR/ZIP file. If left blank, the first child directory of the /themes directory is used. No
    Theme title String The theme title in different locales of choice. Format: LOCALE=TITLE,[LOCALE=TITLE]. Supply the theme title in different locales as a comma separated list of locale title pairs. All leading and trailing whitespace characters in the pairs will be ignored. If left blank, the default locale used is en and title is set to the name of the component. No
    Theme unique name String The uniquename for this theme within the Portal server. If left blank, the uniquename is computed as follows the string com.ibm.urbancode.customTheme. is prefixed to the WAR/ZIP filename containing the theme artifacts. No
    Use soap.client.props file Boolean Use soap.client.props file for Portal administrator credential No
    Virtual Portal context String If invoking on a virtual portal, specify the virtual portal context root No
    Virtual Portal hostname String If invoking on a virtual portal, specify the virtual portal hostname No
    WebSphere Portal server installation home String Portal installation home No
    WebSphere Portal server profile home String Portal server profile home No
    WebSphere portal server administrator password Password WebSphere portal server administrator user password No
    WebSphere portal server administrator username String WebSphere portal server administrator username No
    WebSphere portal server configuration port String WebSphere portal server configuration port No

    Execute ConfigEngine command

    Executes the specified ConfigEngine command on a WebSphere Portal server

    Input properties for the Execute ConfigEngine command step
    Name Type Description Required
    ConfigEngine command String The ConfigEngine command to execute. If left blank, the component name is used No
    Options String Format: NAME=VALUE,[NAME=VALUE]. Supply the name value pairs to be used as arguments
    to the ConfigEngine tool. This argument can be supplied multiple times for all of
    the additional parameters used by the ConfigEngine. All leading and trailing whitespace
    characters in the name value will be ignored. Do not specify the WAS and Portal administrator
    credentials here.
    No
    Use wkplc.properties file Boolean If selected, the wkplc.properties file is used to read WAS and Portal administrator
    passwords from
    No
    WebSphere Portal server profile home String Portal server profile home No
    WebSphere application server administrator password Password WebSphere application server administrator user password No
    WebSphere portal server administrator password Password WebSphere portal server administrator user password No

    Install PAA

    Installs a portal application archive (.paa) on a WebSphere Portal server

    Input properties for the Install PAA step
    Name Type Description Required
    Additional CommandLine Arguments String New line separated list of additional commandline arguments to pass to the deploy-paa command (i.e. -DforceDeploy=true) No
    Assembly name String Name of the portal assembly to deploy. If left blank, the name of the component is used No
    Create WCM properties file Boolean If selected, the WCM properties file is created in the paa/${appName} directory No
    Maximum time in minutes to wait for node synchronization String If installing on a clustered environment, define this value for the deploy-paa task No
    Maximum time in minutes to wait for wplc-wait-for-sync-to-complete task String If installing on a clustered environment, define this value for the deploy-paa task No
    PAA filename String Name of the .paa file to install. If left blank, the name of the component is used No
    Use wkplc.properties file Boolean If selected, the wkplc.properties file is used to read WAS and Portal administrator passwords from No
    Virtual Portal context String If installing on a virtual portal, include the virtual portal context No
    Virtual Portal host name String If installing on a virtual portal, include the virtual portal host name No
    WebSphere Portal server profile home String Portal server profile home No
    WebSphere application server administrator password Password WebSphere application server administrator user password No
    WebSphere portal server administrator password Password WebSphere portal server administrator user password No

    Invoke XMLAccess script

    Executes an XMLAccess script on a WebSphere Portal server

    Input properties for the Invoke XMLAccess script step
    Name Type Description Required
    Portal Server context root String Specify the portal servers context root. If left blank, /wps is used as the default
    portal server context root
    No
    Use soap.client.props file Boolean Use soap.client.props file for Portal administrator credential No
    Virtual Portal context String If invoking on a virtual portal, specify the virtual portal context root No
    Virtual Portal hostname String If invoking on a virtual portal, specify the virtual portal hostname No
    WebSphere Portal server profile home String Portal server profile home No
    WebSphere portal server administrator password Password WebSphere portal server administrator user password No
    WebSphere portal server administrator username String WebSphere portal server administrator username No
    WebSphere portal server configuration port String WebSphere portal server configuration port No
    XML script file name String The name of the file containing the XML script for XMLAccess tool. If left blank,
    the name of the component is used.
    No