Build a Release

 

+
Search Tips   |   Advanced Search

 

 

Overview

ReleaseBuilder compares XML configuration files, REV1 vs. REV2, creating an output file that contains the differences between the two. This differential output file can be imported into a Portal instance, leaving unchanged features unaffected.

Before running ReleaseBuilder, verify that the WebSphere Portal environments are configured to allow the configuration to be moved.

ReleaseBuilder should preferably be run on an integration or staging server. Running ReleaseBuilder on the production server is not advised because ReleaseBuilder will consume resources and affect portal services to users.

If you have a completely new installation of the staging server and the production server:

  1. Install the staging server, then install the production server

  2. Develop a release on the staging server

  3. Build the release on the staging server

  4. Empty portal contents on the production server by running the task...

    WPSconfig.sh action-empty-portal

  5. Import that release onto the production server.

If you already have a production server without a staging system:

  1. Export the release of the production server

  2. Install an empty staging server using one of the following two methods:

  3. Import the production release onto the staging server

  4. Develop and build a new release on the staging server

  5. Export that new release from the staging server

  6. Use ReleaseBuilder to generate the differential between the two releases

  7. Import the differential onto the production server

 

Procedure

XML configuration files are used by ReleaseBuilder to create a differences XML configuration file that will be used to transfer the new portal configuration from the staging server to the production server. To export the configurations of the servers, use the XML configuration interface.

  1. Export staging server (REV1) configuration

    Export the entire portal configuration (not including users, user's access control, or any other user configurations) of the staging server (REV1).

    1. On the staging server (REV1) change to the portal_server_root/bin directory. This is the directory that contains WebSphere Portal tools.

    2. Export the staging server (REV1) configuration using the XML configuration interface and the provided sample file named ExportRelease.xml...

      • UNIX:

        ./xmlaccess.sh -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV1_config.xml

      • Windows:

        xmlaccess.bat -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV1_config.xml

      • i5/OS:

        xmlaccess.sh -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV1_config.xml

      The exported configuration is stored in the XML file named stageREV1_config.xml.

  2. Develop and test new functions and portlets on the staging server. This phase is where functions are added or deleted. Note that this phase can last for a very long time. Ensure the staging server is fully tested and the portal is ready.

  3. Export staging server (REV2) configuration

    Export the entire portal configuration (not including users, user's access control, or any other user configurations) of the staging server (REV2).

    1. On the staging server (REV2) change to the portal_server_root/bin directory. This is the directory that contains WebSphere Portal.

    2. Export the staging server (REV2) configuration using the XML configuration interface and the provided sample file named ExportRelease.xml...

      • UNIX:

        ./xmlaccess.sh -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV2_config.xml

      • Windows:

        xmlaccess.bat -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV2_config.xml

      • i5/OS:

        xmlaccess.sh -in ExportRelease.xml -user wpsadmin -password wpsadminpwd -url http://stage.com/wps/config -out stageREV2_config.xml

      The exported configuration is stored in the XML file named stageREV2_config.xml

  4. If you have installed other portlets or applications additional to the ones shipped with the portal, make sure to copy the necessary WAR files from the staging server to the installation directory...

    portal_server_root/deployed/archive

    ...on the production server.

    As Windows limits the maximum path length to 260 characters, the name of the WAR file must be 25 characters or less. Installing a WAR file with a name that is more than 25 characters will result in an error.

  5. Analyze the REV1/REV2 staging server differences

    • UNIX/Windows:

      cd was_profile_root/bin
      ./stopServer.sh|bat WebSphere_Portal -user admin_userid -password admin_password
      ./releasebuilder.sh -inOld stageREV1_config.xml -inNew stageREV2_config.xml -out outputfile.xml

    • i5/OS:

      cd app_server_root/bin
      stopServer WebSphere_Portal -profileName profile_root -user admin_userid -password admin_password
      releasebuilder.sh -inOld stageREV1_config.xml -inNew stageREV2_config.xml -out outputfile.xml

    The resulting output configuration file will contain the additions and deletions to be imported onto the production server.

  6. The outputfile.xml which contains the differences between REV1 and REV2 portal server is then used to import these differences onto the production server

    If portlet parameters are deleted from a configuration, the output script generated by ReleaseBuilder does not remove those parameters on the target system

    XML files generated by ReleaseBuilder do not have any transaction levels set. To set a transaction level edit the XML file generated by ReleaseBuilder and add the transaction level to the XML file. To learn more about Transaction level and see a sample file, review The XML configuration interface and refer to the section XML configuration interface: reference.

 

Parent topic:

Staging to production

 

Related concepts

About ReleaseBuilder
Staging the portal to production

 

Related reference:

Manual steps prior to using ReleaseBuilder

 

Related information

Working with the XML configuration interface