Knowledge-Based Search's Guide

Download

Download the plug-in.

	Note
	https://github.com/TUBAME/migration-tool/releases

Unzip

Unzip the downloaded file. Unzipping the file creates the tubame.portability_* directory.

	Note
	The * part of the name varies with the version.

	Important
	Unzipping the file in Windows may fail due to path length limitations. If it fails, use a short path such as C:\temp for unzipping.

Set Python runtime.

Use a text editor to open resources/properties/application*.properties under the unzipped directory. As shown below, set the path where Python is installed.

# Example showing installation under Windows
PYTHON_RUNTIME_PATH=C:/Python27/python.exe
					

Install in Eclipse.

Move or copy the unzipped directory to the plugins directory under the Eclipse installation directory.

Confirm installation.

Select the Eclipse menu as shown below.

Help → About Eclipse → Installation Details → Plug-ins

Confirm that the Plug-in Id column contains the tubame.portability plug-in name.

Complete installation.

This completes the installation.

Start up Eclipse.

Start up the project creation wizard.

File → New → Project...

Create a Java Project.

Java Project → Next

Use the New Java Project wizard to make the appropriate settings required by the environment of the item to be ported to create a project.

Position the source files that need to be ported.

Position the source files that need to be ported in the created project.

	Note
	Position not only *.java, but also *.jar, *.xml, *.jsp, *.properties, *.xsd and all other files that are required for running the application.

	Note
	There is no need to make all the preparations required for a successful build.

Select search resource.

Right-click a resource you want to search and select the following menu.

tubame → Knowledge-Based Search

Set search conditions.

Make the following entries.

Conduct a search.

Click Finish to start the search.

Open the search result files.

Check the source code.

Check the visual check items.

Check the inquiry check items.

Link to the porting guideline.

Display the check list information.

Delete items that need not be ported.

Display work progress status.

Calculate the total number of lines.

Display the number of hits or all items.

Output a report.

Open the jbm file.

Double click the saved jbm file that contains the search results.

	Note
	This step is not necessary since the search result file automatically opens after a search has been conducted.

Check the screen for editing search results.

The screen for editing search results shows a list of items that may have to be ported. An overview of the displayed items is provided below. Double click a line to open an editor with an associated extension to display the relevant file.

	Note
	The Switch display button in the Eclipse toolbar allows you to switch between display of all search items and hit items.

Table 1. Items displayed in the screen for editing search results

Item	Description
No.	Number of the searched condition.
Hit count	The number of items that matched the search conditions.
Major item	-
Minor item	-
File name	Path from project route of the relevant file.
Line	Line number of the relevant file.
Degree of difficulty	Difficulty icons indicate the degree of difficulty that porting involves. Note There are the following classifications. High Requires major rewriting of the implementation involving major changes to the implementation, settings and other changes. Middle Requires minor rewriting of the implementation. Low Can be handled by minor rewriting that does not affect implementation. Unknown Unknown difficulty NOT_TRN Cannot be ported.
Guide chapter	The number of the chapter in the Portability Examination Guideline. Click an item to link to the Portability Examination Guideline. Note To use this feature, the HTML created using the Knowledge Manager must be placed in the resources/guide/index.html. The GUIDE_FILE_PATH parameter of the resources/properties/application*.properties can be used to change the location.
Visual check details	Describes the details of a visual check (indicated by 0 column width when initially displayed).
Inquiry check details	Describes the details of an inquiry check (indicated by 0 column width when initially displayed).
Visual status	Current status of visual check. Note There are the following classifications. Blank There is no need for a visual check. Not completed There are still items that require visual checking. Not checked The visual check has not been conducted. Completed The visual check has been completed. Checked (no need for porting) The visual check has been completed (the check determined that there were no issues). Checked (need to be ported) The visual check has been completed (the check determined that porting was required).
Inquiry status	Current status of inquiry check Note There are the following classifications. Blank There is no need for an inquiry check. Not completed There are still items that require inquiry checking. Not checked The inquiry check has not been conducted. Completed The inquiry check has been completed. Checked (no need for porting) The inquiry check has been completed (the check determined that there were no issues). Checked (need to be ported) The inquiry check has been completed (the check determined that porting is necessary).
Line count	The approximate number of lines that must be rewritten. Note There are the following classifications. Numeric value The approximate number of lines that must be rewritten. TODO: Code manually calculated by SE Items that should be calculated separately according to the commentary. Unknown Items that require separate calculation because the number of lines are not known. Checked (no need for porting) The inquiry check has been completed (the check determined that there were no issues). Checked (need to be ported) The inquiry check has been completed (the check determined that porting is necessary).
Line count basis	Provides a reason for why the stated number of lines need to be ported.
Total lines	Hit count times line count

Check using Checklist Information view.

The Checklist Information view allows you to check detailed information regarding items selected in the screen for editing search results. It allows you to check the following information.

Check using Work Status view.

The Work Status view allows you to check current edit work status.

Table 3. Items displayed in Work Status view

Item	Description
Current work status	Displays current work status. Note There are the following classifications. The check item work has been completed. Check visual check and inquiry check items. Unknown/TODO: Check code manually calculated by SE. Overwrite the file.
Current visual check/inquiry check status	Indicates the remaining and total number of items in the visual check status and inquiry check status displayed in the screen for editing search results.
Unknown/TODO: Rewriting status of code manually calculated by SE	Indicates the remaining and total number of items in the rewriting status of unknown items and rewriting status of code manually calculated by SE displayed in the screen for editing search results.

Check the visual status.

Items whose visual status has not been checked must be visually checked to determine whether or not they require porting. Check the relevant files to determine whether porting is required. When it becomes clear that porting is necessary, use the result to change the status of the visual status column. Right-click the relevant code to change the status to any of those listed below.

	Note
	There are the following classifications. Not checked Not checked Checked (no need for porting) No issues Checked (need to be ported) Porting is required

	Note
	Use the Shift and Ctrl keys to select multiple items. (Note that the above menu will not appear when lines not subject to visual checks are included in the selection range.)

Check the inquiry status.

It is necessary to make inquiries to the developer regarding items whose inquiry status has not been checked to determine whether they require porting. Contact the developer to check whether or not the relevant code requires porting. When it becomes clear that porting is necessary, use the result to change the status of the inquiry status column. Right-click the relevant code to change the status to any of those listed below.

	Note
	There are the following classifications. Not checked Not checked Checked (no need for porting) No issues Checked (need to be ported) Porting is required

	Note
	Use the Shift and Ctrl keys to select multiple items. (Note that the above menu will not appear when lines not subject to visual checks are included in the selection range.)

Delete items that need not be ported.

This feature allows you to delete items not related to porting from the screen. You can either select single lines to delete them one at a time or select all lines to delete them at one time.

	Note
	Use the Shift and Ctrl keys to select multiple items.

Export

Select Export to CSV from the Eclipse menu to output a CSV file.

Analyze CSV files.

This tool does not provide a tool for analyzing CSV files. The user should create an analyzing tool or some other suitable tool.

confirming the installed package

execute rpm command and confirm whether Python and lxml module are installed. When it is not installed, install it.

$ rpm –q python python-lxml
python-*
python-lxml-*
					

Installation

execute yum command and install Python and lxml module.

$ su -
# yum install python python-lxml
					

downloading the installer file.

download an installer from the following links.

	Note
	Python2.7.6： http://python.org/download/releases/2.7.6 lxml3.2.4： https://pypi.python.org/pypi/lxml/3.2.4

Python installation

run the installer "python-2.7.6.*.msi" and Follow the wizard instructions to install.

lxml installation

run the installer "lxml-3.2.4.*-py2.7.exe" and Follow the wizard instructions to install.