Web Console Guide

Procedure

1. Navigate to the MTA Download page and download the web console Local install & OpenShift file.

2. Extract the .zip file to a directory of your choice.

   Note

   If you are installing on a Windows operating system:

   1. Extract the .zip file to a folder named mta to avoid a Path too long error.
   2. If a Confirm file replace window is displayed during extraction, click Yes to all.

   The installation directory is referred to as <MTA_HOME> in this guide.

3. Start the web console:

   • Linux operating system:

     $ <MTA_HOME>/run_mta.sh

   • Windows operating system:

     C:\<MTA_HOME>\run_mta.bat

4. Open a browser and navigate to http://localhost:8080/mta-web. The web console login page is displayed in your browser.

   Figure 2.1. Web console login page

   

   The default user is mta and the default password is password.

Procedure

1. In the web console, click Projects.
2. Click Create project.
3. Enter a unique name for the project, an optional description, and click Next.

4. To upload applications, click the Upload tab, click Browse, select the application files you want to upload, and click Close.

   Uploading applications stores them directly on the MTA server.

5. To register a server path, click the Server path tab and enter the Server-side path of the application in the field.

   Registering the server path of an application ensures that MTA always uses the latest version.

6. Click Next.

7. Click one or more transformation targets.

   
8. Click Next.
9. Select packages and click > to include them in the analysis.
10. Click Next.

11. If you want to add a custom rule, click Add rule.

    See the Rules Development Guide for more information.

    • To upload a ruleset file, click the Upload tab, click Browse, select one or more files, and click Close.

      A ruleset file must have an .mta.xml or .windup.xml extension. The uploaded file is stored on the MTA server.

    • To register the server path of a ruleset file, click the Server path tab, enter the Rules path, and click Save.

      Registering the server path ensures that the MTA server always uses the latest version of the ruleset files.

12. Click Next.

13. If you want to add a custom label, click Add label.

    • To upload a labelset file, click the Upload tab, click Browse, select one or more files, and click Close.

      A labelset file must have an .mta.label.xml or .windup.label.xml extension. The uploaded file is stored on the MTA server.

    • To register a server path, click the Server path tab, enter the Labels path of the label files in the field, and click Save.

      Registering the server path ensures that the MTA server always uses the latest version of the labelset files.

14. Click Next.

15. Review the following Advanced options and make any necessary changes:

    • Target
    • Source
    • Exclude tags: Rules with these tags are not processed.
    • Additional classpath: Enter a space-delimited list of additional .jar files or directories so that they are available for decompilation or other analysis.
    • Application name
    • Mavenize group ID
    • Ignore path: Enter a path for files to exclude from analysis.
    • Export CSV: Exports the report data as a CSV file.
    • Disable Tattletale: Disables generation of a Tattletale report for each application.
    • Class Not Found analysis: Enables analysis of Java files that are not available on the class path. This option should not be used if some classes are unavailable for analysis.
    • Compatible Files report: Generating a Compatible Files report might take a long time for large applications.
    • Exploded app: The input directory contains the unpackaged source files of an application.
    • Keep work dirs: Retains temporary files, for example, the graph database or extracted archive files, for debugging purposes.
    • Skip reports: HTML reports are not generated. Must be enabled if you enabled Export CSV.
    • Allow network access: This option reduces performance.
    • Mavenize: Creates a Maven project directory structure based on the structure and content of the application.
    • Source mode: Application files are raw source files, not compiled binaries.
16. Click Next.

17. Review your project and click Save or Save and run.

    The project is displayed in the Projects screen.

Procedure

1. In the web console, click Analysis results.
2. Select a project.
3. Click Run analysis.

Procedure

1. In the web console, click Analysis results.

   
2. Select a project from the list.

3. Click the number of the analysis you want to review.

   The results are displayed in the Results screen, which contains two tabs: Details and Logs.

Procedure

1. In the web console, click Analysis results.

2. Click the Reports icon beside the analysis you want to investigate.

   The All applications screen of the reports is displayed.

   

Procedure

1. In the web console, click Analysis configuration.

   
2. Select a Project.
3. Click the appropriate tabs and make your changes.

4. Click Save or Save and run.

   The project is displayed in the Projects screen.

Procedure

1. In the web console, click Rules configuration.
2. Click Add rules.

3. To upload a ruleset file, click the Upload tab, click Browse, select one or more files, and click Close.

   A ruleset file must have an .mta.xml or .windup.xml extension. The uploaded file is stored on the MTA server.

4. To register the server path of a ruleset file, click the Server path tab, enter the Rules path, and click Save.

   Registering the server path ensures that the MTA server always uses the latest version of the ruleset files.

   The Custom rules list displays the rules.

Procedure

1. In the web console, click Labels configuration.
2. Click Add label.

3. To upload a labelset file, click the Upload tab, click Browse, select one or more files, and click Close.

   A labelset file must have an .mta.label.xml or .windup.label.xml extension. The uploaded file is stored on the MTA server.

4. To register the server path of a labelset file, click the Server path tab, enter the Labels path, and click Save.

   Registering the server path ensures that the MTA server always uses the latest version of the labelset files.

   The Custom labels list displays the labels.

1. Make sure that the web console is running.

2. Open the Red Hat Single Sign-On administration console.

   • For a .zip installation:

     1. Navigate to http://localhost:8080/auth/ in a browser.
     2. Select Administration Console to access the Red Hat Single Sign-On administration console.

   • For an OpenShift installation:

     1. Navigate to <OPENSHIFT_URL>/console/project/mta/overview in a browser.

        Note

        If you renamed the OpenShift project when deploying, replace mta with the name of your project.

     2. Click the link in the SSO HTTPS application and add "/auth" to the end of the URL.
     3. Select Administration Console to access the Red Hat Single Sign-On administration console.
3. Log in with the default credentials of admin and password.
4. In the upper left corner, select the Master realm from the drop down.
5. In the left-side navigation menu, select Users and then click View all users.
6. From the admin user’s row, click Edit.
7. Select the Credentials tab.
8. Enter the new password in the New Password and Password Confirmation fields.
9. Change the Temporary field to OFF to not require the user to change the password upon next login.
10. Click Reset Password and then click Change password in the popup.

1. Make sure that the web console is running.

2. Open the Red Hat Single Sign-On administration console.

   • For a .zip installation:

     1. Navigate to http://localhost:8080/auth/ in a browser.
     2. Select Administration Console to access the Red Hat Single Sign-On administration console.

   • For an OpenShift installation:

     1. Navigate to <OPENSHIFT_URL>/console/project/mta/overview in a browser.

        Note

        If you renamed the OpenShift project when deploying, replace mta with the name of your project.

     2. Click the link in the SSO HTTPS application and add "/auth" to the end of the URL.
     3. Select Administration Console to access the Red Hat Single Sign-On administration console.
3. Log in with an administrative user’s credentials. The default credentials are admin and password.
4. In the upper left corner, select the mta realm from the drop down.
5. From the left-side navigation menu, select Users and then click View all users.
6. From the mta user’s row, click Delete and confirm.

1. Make sure that the web console is running.

2. Open the Red Hat Single Sign-On administration console.

   • For a .zip installation:

     1. Navigate to http://localhost:8080/auth/ in a browser.
     2. Select Administration Console to access the Red Hat Single Sign-On administration console.

   • For an OpenShift installation:

     1. Navigate to <OPENSHIFT_URL>/console/project/mta/overview in a browser.

        Note

        If you renamed the OpenShift project when deploying, replace mta with the name of your project.

     2. Click the link in the SSO HTTPS application and add "/auth" to the end of the URL.
     3. Select Administration Console to access the Red Hat Single Sign-On administration console.
3. Log in with an administrative user’s credentials. The default credentials are admin and password.
4. In the upper left corner, select the mta realm from the drop down.
5. From the left-side navigation menu, select Users and then click Add user.
6. Enter the Username, First Name, Last Name, and any other required fields and click Save.
7. Once the user has been added, select the Credentials tab.
8. Enter a temporary password in the New Password and Password Confirmation fields, and leave the Temporary field set to ON.
9. Click Reset Password and then click Change password in the confirmation popup.