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

Wrightia (c) 2006-2009 (README file for Windows 2K, XP & 2003 Server)

1. Introduction
2. Install
3. IS running as Windows Service
4. Uninstall
5. Upgrading
6. Further Reading
7. 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) From v1.1 onwards this step is automatically performed when the
           'WiaServiceProfiler' IS Packagecopy the folder is installed;
           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.bat' as 'server.org.bat';

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

            ...
      ---->
            set CLASSPATH=%PREPEND_SYSTEM_CLASSPATH%;%CLASSPATH%;%APPEND_SYSTEM_CLASSPATH%
            set PATH=%PATH%;%IS_DIR%\support\win32;%IS_DIR%\jvm\bin\classic;%IS_DIR%\lib;

            rem
            rem Run as an NT service ? If so, save program arguments to Registry
            rem
            if "1%1"=="1-service" (
            ...

        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.bat script may be overwritten thus disabling the
                Service Profiler start-up.
                When this happens, just repeat the script edit step described
                above.

3. IS running as Windows Service
    There is no additional setting for using the Service Profiler on aIS is
    running as a Windows (NT, W2K, XP) Service.


4. Uninstall
    To uninstall the tool:

        a) Shutdown the IS;

        b) Revert 'server.bat' to the saved 'server.org.bat', 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'.


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


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