Project Management

Creating a Project
Importing an Mobilgene/ODIN Project
Saving a Project
Opening a Project
Browsing Project Information
Generating Reports
Exporting Analyses in the Project

Creating a Project

HKSAT manages user data on a project basis and each project contains multiple modules and analyses.
A module is a set of source code and includes the information needed to compile.
Analysis has information about a specific analysis.
A module can be used in multiple analyses, and multiple modules can be used for an analysis.

To create a new project

Click File menu and then click New Project menu, or click New Project button in the toolbar.
Check the project name in Basic Setting and change it if necessary.

Project Settings Window
Check the author and change it if necessary.
Check the project directory and change it if necessary.
Select a compiler.
Click Create button to finish.

Project names are limited to a maximum of 32 characters
Project names can contain only a combination of English alphabets and numbers; spaces, special characters, and Unicode cannot be used.
Only compilers added in the compiler settings are displayed in the list.

A compiler must be selected to create a project.
If no compiler is in the compiler list, you must add one in Compiler Setting
Compilers supported by HKSAT can be found in Compiler Support

Importing an Mobilgene/ODIN Project

To import an Mobilgene/ODIN project, the project must be open. Otherwise, Mobilgene/ODIN Import menu is disabled.

On Project menu, select Import Mobilgene/ODIN Information.
If you select an Mobilgene/ODIN Project folder in the dialog box, a progress window appears and the import is performed.
When done, Completion Message window appears on the screen.
Click OK button to close it.

If you select an invalid folder, an Error Message appears and you must manually close the progress window.
If successful, the information is saved in the project folder.
Mobilgene/ODIN project information can be used for modules and analyses that are created only after the import.

Saving a Project

To save the current project

Select Save Project item from File menu, or click Save Project button in the toolbar.

The project is saved to the path specified during the creation.
HKSAT supports Save Project after an Analysis, which can modified in Configuring HKSAT.
To prevent a data loss, a periodic save is recommended.

Opening a Project

To open a project

Select Open Project item on File menu, or click Open Project button in the toolbar.
In Open window, select a project folder or select contents.tb2 file inside.
Click Open button.

Recent projects are convenient to open using Open Recent in File menu.
Project will not open if the project file is corrupted or if the module's source codes are moved or deleted from the registered locations.

Browsing Project Information

Project view

Displays project configuration, module information, and analysis information in a tree format.

Clicking a project node, a module node, or a analysis node displays the information in other views.
Double-clicking opens the information in other views.
Each node provides a context menu to handle it.

Project graph

Displays a project as a graph with the modules, the analyses, and the analysis results as nodes and their relations as edges.

Modules and module-less analyses are linked to the project with edge.
A module and each of their analyses are linked to the edge.
An analysis and the result are linked to the edge.
Each node displays a summary of the information.

A project graph can be displayed by double-clicking the project in the Project view.
Modules and analyses can be managed through the context menus.

Generating Reports

HKSAT supports two types of reports: a project report and a SW Test report.

Generated reports are saved in the project's Document directory.
The name of files are generated according to the type.

Generating a Project Report

To generate a project report

Select Generate Project Report menu item in Project menu, then an option window will appear.

The Project Report Window
Select modules and/or analyses.
Select Basic Info. options
Select a Report Format. HTML, PDF, MS Word, MS Excel, Markdown, Plain Text are supported.
Click Generate button, then a progress window appears and a report is generated.
When done, the generated report will be shown.

Microsoft Visual C++ 20xx Redistributable is required for the report generation feature, and if it is not installed, the figures may not be displayed.

Generating a SW Test Report

To generate a SW Test report

Select Generate SW Test Report menu item in Project menu, then an option window will appear.

The SW Test Report Window
Select analyses.
Select Basic Info options
Select a Report Format. HTML and PDF are supported.
Click Generate button, then a progress window appears and a report is generated.
When done, the generated report will be shown.

"Microsoft Visual C++ 20xx Redistributable" is required for the report generation feature, and if it is not installed, the picture may not be displayed.

Managing Reports

You can create, open, and delete reports in the report management window.

Select the Manage Report menu item in the Project menu.

The Manage Report Window
To open a report, just double click the report.
To create a report, click Add button in the toolbar.
To delete reports, select reports and click Remove button in the toolbar.

If Preferences - GUI Setting - RootFrame - Report View is enabled, the window will be displayed as a view.
The filter in the lower-left corner is applied, only reports of the selected type will be displayed.

Exporting Analyses in the Project

The analyses export feature is related to the integration of the HKSAT and CI/CD tools. It is used when you want to automatically perform the desired analysis from an already created HKSAT project using the CI/CD tool.

Select Export Project Analyses (CI/CD) from the Project menu.
In the first tab of the dialog box, select the analysis you want to perform with the CI/CD tool.

If you want to include the software change impact analysis in the export, in the second tab of the dialog box, specify the desired module and the branch name of the code repository where the past version of that module is stored.

Adding Software Change Impact Analysis Dialog

After specifying the file name to save the exported analysis information, click the Export button.

Refer to the HKSAT-Jenkins Integration Tutorial (Help section "Command-Line Interface", Chapter 3) for how to use the generated analysis information file.