⚠️ This page has been archived

✅ New page with updated info: codeauditor.com

  1. Running SSW Code Auditor Wizard

    When you run the SSW Code Auditor there will be a step by step wizard to guide you through the audit process.

    Code Auditor Welcome Screen
    Figure: Run SSW Code Auditor.

    Select Job
    Figure: Select a predefined Job, or create a new one.

    Select Files
    Figure: Set files, folders and URLs to check.

    Select Rules
    Figure: Select the rules you want to run.

    Email Schedule
    Figure: Indicate where you'd like the report issued to.

    Start Process
    Figure: Press the start button.

    Start Process
    Figure: Command line.

    Figure: Select how you would like to view the Report and Finish.

  2. Creating New Rule

    To create a new rule for a Job:

    1. Select the designated Job and click next to the Rules Definition page
    2. Click Add on the bottom of the Rules list box
    3. Select "Create a new rule" from the radio option and enter name for the new rule
      Creating your rule
    4. Select the new rule from the Rules list box
    5. Enter a regular expression in the search-in field to filter the files this rule run on
    6. Enter the regular expression used by this rule
    7. Set if the regular expression should match in the scanned file
      Setting up your rule
    8. Describe what this rule is checking and why this rule exists
      Document your rule

  3. Create Regular Expression

    The following images show how to create your expression.

    Regular Expression Wizard
    Figure: SSW Code Auditor also comes with an easy to use yet powerful Regular Expression wizard. You can use it to build patterns if you are not familiar with regular expressions.

    Regular Expression Wizard 2
    Figure: For the advanced users, the wizard provides a complete testing ground for all the features of .NET Regular Expressions, as well as two test areas (sand box) for you to test in one go.

    Regular Expression Wizard 3
    Figure: Finally, the wizard also shows you any group matchings, this information is not directly used in Code Auditor, but it is quite useful elsewhere especially if you work with regular expressions quite a bit!

    Code Segment: If you want SSW Code Auditor to skip over code (i.e. you are intentionally transgressing some of your own rules) add the following code to the line above your code:
    <!--SSW Code Auditor - Ignore next line-->

    For more information on regular expressions see this page .

  4. Clearing Reports

    Sample Report
    Figure: SSW Code Auditor - Job Report