webMethods Integration Server Service Profiler (ISSPROF)
================================================================================

Wrightia (c) 2006-2008 (www.wrightia.com)
README file for POSIX operating systems

1. Introduction
2. Install
3. Uninstall
4. Upgrading
5. Further Reading
6. Version History


1. Introduction
    The ISSPROF is a tool to collect and analyze runtime information about IS
    Services.
    It is intended to have a small footprint while running, be easy and fast to
    install and uninstall, and to require no configuration over the Services
    being profiled.


2. Installation
    Install the profiler by installing the following IS Packages, in the order
    they are presented:
        - WiaRoot.zip
        - WiaUtilities.zip
        - WiaServiceProfiler.zip

    The presented ZIP filenames may have a version suffix appended to its name.
    These suffixes are not indicated to have this readme file version
    independent.

    After installing the IS Packages the installation must be completed by
    configuring the Integration Server. Perform the following steps:
        a) Shutdown the IS;

        b) copy the folder 'serviceprofiler' from within the 'config' folder of the
           installed 'WiaServiceProfiler' IS Package, into the
           '<wm_dir>/IntegrationServer' folder;

        c) Save a copy of the file 'server.sh' as 'server.org.sh';

        d) Edit the script file 'server.sh' by inserting all the lines in the
           file
           '<wm_dir>/IntegrationServer/serviceprofiler/var/server.sh.include'
           into the 'server.sh' file at the point shown below with '---->'

            ...
      ---->
            CLASSPATH=$PREPEND_SYSTEM_CLASSPATH:$CLASSPATH:$APPEND_SYSTEM_CLASSPATH

            export LD_LIBRARY_PATH
            export SHLIB_PATH
            export LIBPATH
            export CLASSPATH

            ## .... run Integration Server
            ${JAVA_RUN} -DWM_HOME=${WM_HOME} -classpath ${CLASSPATH} ...
            ...

        e) Start the Integration Server;

        f) Set the tool License Key.
           Access the Service Profiler licensing page and set the License Key.

    The IS can be prevented from starting with the Service Profiler, without
    the need to uninstall it, by means of putting a file named ISSPROF_VOID in
    the '<wm_dir>/IntegrationServer' folder. The presence of this file skips
    the loading sequence. A direct result is having the functionality links in
    the tool menu disabled.

    IMPORTANT:  When installing webMethods upgrades (i.e., Service Packs) the
                server.sh script may be overwritten thus disabling the
                Service Profiler start-up.
                When this happens, just repeat the script edit step described
                above.


3. Uninstall
    To uninstall the tool:

        a) Shutdown the IS;

        b) Revert 'server.sh' to the saved 'server.org.sh', or just remove the
           lines inserted upon installation (refer to point 2 in this document);

        c) Delete the folder '<wm_dir>/IntegrationServer/serviceprofiler';

        d) Delete the folder for the package 'WiaServiceProfiler';

        e) Start the IS.

    Optionally, you can remove the IS Packages 'WiaUtilities' and 'WiaRoot'.


4. Upgrading
    Due to the nature of the tool, its architecture and the runtime behaviour,
    and also depending on the nature of the upgrade it may require steps beyond
    the simple (re)installation of an IS Package and/or patch.

    Due to the complexity of this subject, please refer to the User Guide for
    guidance.


5. Further Reading
    Reading the Profiling Whitepaper, included as part of the documentation of
    the installed 'WiaServiceProfiler' IS Package (see the Info package), is
    recommended as the next reading document.

    The About page includes an Abstract of the Service Profiler, and the Online
    Help is useful to check the way to use the tool.

    The User Guide is a more detailed documentation about using the Service
    Profiler, concerning all the aspects about using the tool.


6.  Version History
    v1.0
        - First release version.

    v1.0.1
        - Auto-paging of browsing snapshot tree with a large number of
          service nodes.

