Unified Language User Guides
iCR User Guide 5.0
iCR User Guide 5.0
  • Table of contents
    • Introduction
    • Overview
    • Authorizing Access to Your Source Code
      • Authenticating GitHub Cloud Access Using OAuth
      • Authenticating GitHub Cloud Access Using PAT
      • Authenticating GitHub Enterprise Access Using OAuth
      • Authenticating GitHub Enterprise Access Using PAT
      • Authenticating GitLab Cloud Access Using OAuth
      • Authenticating GitLab Cloud Access Using PAT
      • Authenticating GitLab Enterprise Access Using OAuth
      • Authenticating GitLab Enterprise Access Using PAT
      • Authenticating Bitbucket Cloud Access using OAuth
    • Using the Navigator
      • Connecting to the Navigator
      • Setting your User Password
      • Updating your User Information
      • The Navigator top banner
      • The Analysis Engine status
      • Selecting Your Source Code
        • Using a cloud-based VCS
        • Selecting your branch
        • Using a private VCS
        • Using a local project
        • Limiting the files to be analyzed
      • Integrating with your bug tracking system
        • Integrating with Jira - Define Your Project
        • Integrating with Jira - Authorizing Access for iCR
        • Integrating with Jira - Connecting with iCR
    • Using the Analysis Engine
      • Initiating an analysis
      • Monitoring the analysis
      • Interrupting the analysis
    • Reviewing your results
      • Reviewer summary and filters
        • Filter by Severity
        • Filter by Category
        • Filter by CWE
        • Filter by OWASP
        • Filter by Directory
      • Reviewing a fix
      • Accepting a fix
        • Accepting a fix when integrated with your bug system
      • Rejecting a fix
        • Rejecting a fix when integrated with your bug system
      • Undoing a fix
        • Undoing a fix when integrated with your bug system
      • Rejected fix history
      • Providing feedback
      • Applying the fixes
      • Cases needing manual attention
      • Comparing Analyses
      • Capturing results for printing or sharing
      • Ending a reviewer session
    • When you are complete
    • Integrating iCR Into Your CI/CD Workflows
      • Jenkins Workflow
        • Installing the plugin
        • Configuring the plugin
          • Creating a Personal Access Token
          • Copying Your Repository's URL
        • Viewing the Results
      • GitHub Actions Workflow
        • GitHub Actions Overview
        • Preparing the GitHub Workflow
          • Environment Variables
          • User Supplied Secrets
          • Setting the User Defined Secrets Values
        • Executing the Workflow
      • GitLab CI/CD Workflow
        • GitLab CI/CD OverView
        • Configuring the GitLab Script variables
          • Environment Variables
          • User Supplied Variables
          • Creating a Personal Access Token
          • Setting the User Defined Variable Values
        • Executing the Workflow
      • Multiple Workflows
    • Appendix – Language Specific Fixer Lists
    • Appendix - Sample Bug Listing
    • Appendix - Getting a BitBucket App Password for JENKINS
Powered by GitBook
On this page
  1. Table of contents
  2. Using the Navigator

The Navigator top banner

PreviousUpdating your User InformationNextThe Analysis Engine status

Last updated 5 months ago

Once the User password is updated, you are presented with the Navigator Home screen. From here, you can select and open project repositories with your projects, analyze one of more branches of any of these projects and then, following analysis, you can review and apply corrections to flaws detected in those branches.

At the top of screen, on the right side, you see 5 icons:

The Settings icon is used to change or configure a number of optional properties for iCR.

  • The User's password can be updated using the Change Password setting. This was used when you first connected to the Navigator to change your password from the default.

  • Similarly, when you first accessed your VCS, you were prompted for OAuth credentials. Should you need to update those later, for example, if your IP address changed, you can use the Change GitHub/GitLab/Bitbucket credentials settings to update those.

  • You can add contact information using the Update Contact Info setting, if you choose to send OpenRefactory either crash information or other feedback about the operation of iCR.

These icons will be presented on all other screens in the application so that you can always logout at any time or provide feedback and get help. You may only change the settings from the Home Screen, however.

iCR supports . After using Jira to create a bug tracking project, set the Jira credentials using this setting.

Some users may decide that they want to of what source files iCR will analyze to a subset of their whole project. Use this to define that scope.

iCR may be triggered in a DevOps CI/CD workflow. In order to allow the workflow to access a User's repositories, . To support this, iCR provides a unique User Token for each User. To fetch your unique toekn, select the CI/CD Access Token option. This will display your unique token. Click on the clipboard icon to copy it onto the clipboard for pasting into your CI/CD configuration.

The Help icon will take you to the OpenRefactory Website where you can download help documents, and view the Video Tutorials to help you learn how to use iCR. Under the Help menu is also the About request. Selecting this will display the current operating version of the software.

The Feedback icon allows you to send your feedback to OpenRefactory. Your feedback helps us to improve the interface and also helps us to improve the quality of the service by getting feedback concerning potential false positives or improvements on the Fixers.

The License Usage icon presents a brief summary of the license status for this instance of iCR. Since the total capacity of an iCR server is limited by its subscription, you need to know if sufficient capacity remains to analyze your project(s). It provides a summary of the number of OpenRefactory Bundled Lines of Code (OBLoCs) that have been analyzed against this subscription to date, and how many are remaining in your subscription. Should you not have enough remaining capacity for your needs, you would need to contact your iCR server Administrator who needs to upgrade the capacity of this iCR server.

Finally, the Logout icon logs you out of iCR and returns you back to the welcome screen. To re-enter, you would, of course, have to enter your Username and password again.

integrating iCR into your Jira bug tracking system
limit the scope
User credentials must be supplied