Managing analysis projects

Scan and manage analysis projects by using the Z Understand container.

1. Create a project.
   1. Navigate to the Z Understand container folder in the Terminal by running the following command:

      cd /opt/wca4z-understand

   2. Optional: Run the build-cli.sh script without any parameters to see all the possible project-related actions and their syntax.
   3. Prepare the configuration file for the project creation. A list of sample files is provided in the config/projects/samples folder. Open the folder and list the available sample files by running the following command:

      cd config/projects/
      ls samples

   4. Clone the sample file that corresponds to the type of relational database server that you configured. For more information, see 4.d in the configuration instructions.
      For example, clone the sample file for Microsoft SQL Server by entering the following command:

      cp samples/new_proj_sql.ini .

   5. Open the cloned sample file by running the following command:

      vi new_proj_sql.ini

   6. Modify the file as follows:
      1. Press the i key on the keyboard to enable keyboard input in the editor.
      2. Replace the line comments, which represent the properties in the file, with actual values.
   7. Press the Escape key on the keyboard to exit insert mode. Then, save the file to disk and exit the editor by typing :wq and pressing the Enter key.
   8. Create a project by running the following command:

      cd ..
      ./cli.sh -c new_proj_sql.ini <PROJECT_NAME>

   A project folder is created under the projects/<PROJECT_NAME> folder.
2. Add files to the project.

   Creating the project also creates a specific folder structure that is named and organized by object type. Add the source files to be analyzed to the appropriate project folders. The list of project folders can differ according to the chosen settings during the project creation. For information about each folder type, see Adding files to project folders.

3. Scan the project.
   To do so, run the following command:

   ./cli.sh -b <PROJECT_NAME>

   The progress of the operation is displayed in the Terminal.

4. Private preview To run the semantic indexer, run the following command from the Terminal:

   ./cli.sh -si -api-key <API_KEY> <PROJECT_NAME>

   Note: <API_KEY> is an IBM Cloud® API key.
5. Analyze the project.
   To know how to analyze a project, see Analyzing Applications with IBM ADDI Analyze.

   Note: The installation of configuration of the Z Understand Linux container are explained in Installing and Configuring sections.

   Private preview You can analyze a project with the Z Understand Web UI. For more information, see Analyzing applications with the Z Understand Web UI (Private preview).