Sterling B2B Integrator Health Check. Technical Preview Guide

Transcription

1 Sterling B2B Integrator Health Check Technical Preview Guide

2 Table of Contents Foreword Install Running the Health Check tool via the UI Running the Health Check tool via the Command Line Submitting Feedback and Defects

3 Foreword: This is a Technical Preview of a tool that is not formally part of the SI product and is still under construction. The goal of the Technical Preview is to provide an early look at the IBM SI Health Check tool and receive early feedback. It should be noted that IBM does not formally support the Health Check tool but any feedback provided or defects found will help improve the quality of the tool. This Health Check tool release is for Technical Preview purposes only. It is being provided to get your feedback. This tool is not supported by IBM. Installation: WARNING: If this tool is installed on an SI instance of a version prior to any ifix installed on that instance will be removed due to a limitation in the Install Service and newer instances can install without removing any ifixes. 1. Navigate to the bin in the SI install directory. 2. Run the InstallService.(sh/cmd) script on the Health Check jar./installservice.sh <path to Health Check jar> 3. Start up SI using./run.sh. If SI was running during install you will need to restart it Running Health Check via the UI: 1. Ensure that SI is running and the Health Check jar has been installed. 2. Use a web browser to navigate to the address of the SI UI plus /healthcheck. <SI UI Address>/healthcheck 3. Log in with SI credentials, the landing page is the pre-run configuration page that may be used as described below: All tests are enabled by default. Click the run button in the top left hand corner in the top left to run the tool. Click the arrows preceding a scanner name to expand that scanner to see some of it s properties and subtests. Use the checkboxes to enable/disable scanners or individual subtests. A few select properties are displayed and can be changed in the UI, the rest may be changed by editing the healthcheck.properties file in the SI properties directory. Timeout values, listed in seconds may be changed via the UI. Running the tool generates PDF reports that may be downloaded. The generated PDF name may be changed via the top text box on the pre-run page as well as within the properties file. Scanners or individual subtests may be hidden or revealed using buttons along the top of the page. Scanner or individual subtests may be enabled/disabled using the enable/disable buttons along the top of the page as an alternative to the checkboxes. All the subtests of a scanner may be enabled/disabled using the enable/disable sub-tree buttons along the top of the page.

4 4. After clicking the run button, the run status box will appear. This box shows the status of the scans in progress, including errors, timeouts or tool failures. 5. When the testing has completed, click the view summary button in the top right corner of the run status box. 6. This will take you to the results page that may be used as described below: The landing page is a summary of all the issues that the tests detected ordered by severity. o This includes graphs to illustrate the distribution of issues. o All subtest results of the same type are grouped together and a count is shown. To see each individual subtest failure, use the results tab. Click the Tests tab at the very top of the page at any time to return to the pre-run configuration tab to launch another test run. In the blue bar directly below the test and results tab bar there will be a tab for every scanner that is reporting a result, use those tabs to filter by scanner. The default tab is all scanners. Click the download report button below the blue scanners tab to download a PDF report of all the results or only database related results. Switch to the results tab below the download report button to see the details returned by each individual subtest. o Click on each individual subtest result to receive additional information, including a recommended fix, displayed below the tabs. o To dynamically filter results, type the text you would like to filter for into the filter text-box below and to the right of the additional results information. Certain tests may produce graphs to illustrate results. If one of these has been generated, it can be viewed by clicking on the graph tab. The graph tab will be listed with the summary and results tabs if a graph has been generated. Running Health Check via the command line: 1. Ensure that SI is running and the Health Check jar has been installed. 2. Navigate to the bin in the SI install directory. 3. Run the healthcheck.(sh/cmd) in the manner described below. To display all available command line options run./healthcheck.sh/cmd h To run all scanners and tests run./healthcheck.sh/cmd ALL To run all the tests in a list of scanners run./healthcheck.sh S shortname1 shortname2 shortname3 where the shortnames are the scanner names displayed by running with the h parameter To run a specific set of tests run./healthcheck.sh T shortname1.testname1 shortname2.testname2 where the shortname.testnames are the scanner and test names displayed by running with the h parameter To change test properties navigate to the SI properties directory (<install_dir>/properties) and edit healthcheck.properties

5 Any time the tool is run, a PDF report of the results is generated at a location output at the end of the script running. NOTE: Database tests and JVM property tests cannot be run via the command line due to permissions issues for the database and the tool running in a separate JVM from SI. Submitting Feedback and Defects: To submit feedback or tool defects go to the Developer Works IBM B2Bi Health Check tool community, navigate to the forums section and choose the appropriate forum to post in. The community can be found at the following web address: