Knowledge Manager'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.knowhow_* 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.

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.knowhow plug-in name.

Complete installation.

This completes the installation.

Start up Eclipse.

Start up the project creation wizard.

File → New → Project...

Create a project.

Project → Next

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

Start up Perspective.

Window → Open Perspective → Other → Knowledge Manager

Initialize the tool.

Starting up Perspective automatically starts tool initialization. Please wait until initialization completes.

	Note
	Initializing XML marshal/unmarshal classes can take time.

	Note
	Initialization once started cannot be canceled. Clicking the Cancel button is ignored.

Create a Knowledge XML file.

File → New → Other → Knowledge XML file

	Note
	To open a created Knowledge XML file, right-click the file and select the menu as shown below. Open With → Other → Knowledge Editor

Work with Knowledge Entry view.

Use Knowledge Entry view to add, refer to, update and delete knowledge. Created knowledge can be used as an item to create documents and other data. Use either of the following methods to start up Knowledge Entry view.

Create an item group that builds knowledge.

Use the following steps to create items. Since there are no items to begin with, a category must be created.

(Select item) → Right-click → Registration menu → Start up registration wizard

	Note
	Only categories can be created when no item has been selected.

	Note
	In addition to the above methods, copy and paste can also be used to create items.

The following item types are used to build knowledge. A description of each item is given below.

Work with the Knowledge Editor.

This editor edits registered items and creates document configurations. The Knowledge editor contains the following tab types. A description of each tab is given below.

Table 2. Tab Types

Item	Description
Documentation	Enables editing of the chapter configuration of HTML documents to be created. After creating a heading, categories can be dragged and dropped from the Knowledge Entry view to configure a document.
Knowledge details	An editor that edits knowledge content in the DocBook#Article format. In the editor, you can right-click to insert tag templates. Important To prevent the creation of separate sections that corrupt the chapter configuration, the <section> tag cannot be used.
Check item	Allows you to edit check item information and search information selected in Knowledge Entry view.

The following describes check item information and search information data entries that are edited in the Check item tab.

Table 3. Check Item Information

Item	Description
Search process	Provide an overview of which port items registered as knowledge should be searched and how they should be searched.
Conduct a search	Select this checkbox to conduct searches using the Knowledge-Based Search.
Porting factor	Searches items that correspond to the reason for the need to port code.
Difficulty	Selects the difficulty of porting work. Note The criteria used for selection are described below. High Requires major rewriting of the implementation involving major changes to the implementation, settings and other changes. Medium Requires minor rewriting of the implementation. Low Can be handled by minor rewriting that does not affect implementation. Unknown Unknown difficulty Impossible to port Impossible to port
Difficulty details	Selects difficulty details of porting work. Note The criteria used for selection are described below. High Involves a high level of difficulty. Medium Involves a Medium level of difficulty. Low 1 Items that involve a low level of difficulty but cannot be processed by simple replacement. Low 2 Items that involve a low level of difficulty and can be processed by simple replacement. Unknown 1 Difficulty is unknown and JBoss does not have a function for determining difficulty. Unknown 2 Difficulty is unknown and it is not even known whether JBoss has an applicable function for determining difficulty. Impossible to port Involves a level of difficulty that makes Impossible to port.
Visual check	Enter criteria or investigation methods of visual checks when set logical search conditions are not enough to define items that need to be ported.
Inquiry check	Enter items to be checked with developers when the need for porting cannot be determined without checking with the developer.

Table 4. Search Information

Item	Description
Target search file	Enter the name of files subject to search. Regular expressions can be used in entries.
Search keyword 1	Enter the parameters that will be passed to the search module. Regular expressions and XPath entries can be made. Note The parameters that can be entered differ with the search module. Enter parameters using the search module overview as reference.
Search keyword 2	Enter the parameters that will be passed to the search module. Regular expressions and XPath entries can be made. Note The parameters that can be entered differ with the search module. Enter parameters using the search module overview as reference.
Search module	Select the module to search based on the search module overview. Note If not selected, the standard search function is used for the search. The standard search function performs searches using search keyword 1 and then search keyword 2 to search files found among Target search files.
Search Module overview	Displays a description of the search module overview.
Line count calculation	Select this checkbox when the value in the Line count field should be added as porting man-hours when a search returns a hit.
Reason for not calculating	Enter the reason when line count calculation should be ignored.
Unknown/TODO	When the line count is not finalized, select an applicable item.
Line count	Enter the rough number of lines that should be rewritten during porting.
Line count basis	Enter the reason for the entered line count.
Investigation details	Enter the investigation method for calculating the number of lines that will be rewritten.