webMethods Integration Server Service Profiler (ISSPROF) v1.3
================================================================================

Wrightia (c) 2006-2012 (README file for POSIX operating systems)

1. Introduction
2. Installation
    2.1 Instructions for webMethods versions prior to v8.2
    2.2 Instructions for webMethods versions from v8.2 onwards
3. Uninstall
4. Upgrading
5. Further Reading


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.

    Depending on the version of the IS where you are installing this tool,
    follow the instructions in the corresponding sub-section.

2.1 Instructions for webMethods versions prior to v8.2
    After installing the IS Packages the installation must be completed by
    configuring the Integration Server. Perform the following steps:
        a) Shutdown the IS;

        b) Edit the startup script;
           Save a copy of the file 'server.sh' as 'server.org.sh';

           Edit the script file 'server.sh' and insert a call to a 'setenv.sh'
           script at the point shown below with '---->' and as indicated.

            ...
      ----> . "${WORK_DIR}"/serviceprofiler/bin/setenv.sh

            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} ...
            ...

        d) Start the Integration Server;

        e) 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.


2.2 Instructions for webMethods versions from v8.2 onwards
    The webMethods v8.2 shell scripts introduce the segregation of starting
    the JVM into a specific script: '<wm_dir>/profiles/IS/bin/start_runtime.sh'.
    So, with this version it is not the 'server.sh' that has to be edited, but
    rather the 'start_runtime.sh'.

    Save a copy of the file 'start_runtime.sh' as 'start_runtime.org.sh';

    To continue using the 'server.sh' to start the IS, all there is to do is
    to add the line...

            . "${WORK_DIR}"/serviceprofiler/bin/setenv.sh

    ... right before the Java command line in 'start_runtime.sh', like this:

        else
            . "${WORK_DIR}"/serviceprofiler/bin/setenv.sh
            echo "Starting as an application using Java because it is not set to use Tanuki Wrapper."
            ${JAVA_RUN} ${JAVA_OPTS} ${JAVA_SYSPROPS} -jar ${OSGI_FRAMEWORK_JAR} -debug -consoleLog -configuration ${OSGI_CONFIGURATION_AREA} $*
        fi

    To the use of the Tanuki wrapper, the preparation scripts already create
    the necessary configuration settings and add them to the
    '<wm_dir>/profiles/IS/confguration/wrapper.conf'. A copy of the file
    is saved before the changes are made with the name 'wrapper.conf.beforeissprof'.


3. Uninstall
    To uninstall the tool:

        a) Shutdown the IS;

        b) Revert the edited start-up scripts back to their saved originals,
           or just remove the lines inserted upon installation (refer to point
           2 in this document);
           Depending on the IS version, which files are these may vary.

        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 is recommended as the next reading document.
    This document is available for download from Wrightia's website. A direct
    link to it is provided in the installed 'WiaServiceProfiler' IS Package
    (see the Info package),

    The About page includes an Abstract of the Service Profiler, and links to
    Release Notes and Version History.
    The Online Help is useful to quickly 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.

