Document Tutorial

This tutorial focuses on the creation, modification, and management of project documents within POLAR ICE. This includes SIPs and other custom types of documents. Click on the tabs below to display information in the Description window or the Helpful Hints window.
Description Helpful Hints
Document Validation

SIPs are complex documents which collect vast amounts of information. This information collection ensures your science project will have the best possible research support.

POLAR ICE provides validation utilities to ensure that you have answered all necessary questions, and that the data provided is as complete and accurate as possible.

There are two primary ways to "validate" your document:

  • Section by section as you proceed through the document
  • Complete document validation, validating every section in the document at one time
  • Depending upon the results of your validation, you may encounter different notification types. These types are outlined in "Validation Types".

    Validation Types

    There are three potential results returned from a validation request. On a section level they are:

  • Not Yet Complete - which means there are items that have errors.
  • Complete, But Warning(s) Found - which means the section technically is complete, but you may want to review some items to ensure that is truely how you would like your support request to exist.
  • Complete - which means the validation routine could not find anything invalid or potentially problematic with your support request.
  • There are three potential results return for individual items. These are:

  • Error - there was something wrong with the information provided to an item. A description following the Error notation tries to provide hints as to why something is incorrect.
  • Warning - there was an item that passed validation and is technically correct. However, there may be potential issues with the item as requested. A description following the Warning notation trieds to provide hints as to why something produced a warning.
  • Complete - all items in the section were valid.
  • It is important to note that validation will only provide verification of completed fields and approprate date or value ranges. It does not and cannot validate your entries to determine if the support request is feasible, or if the support request is garbage text you have entered. If you want the best possible support, it is imperative that you spend the time to fill out your document to the best of your ability by providing real information.

    Section by Section Validation

    Section-based validation typically is the most efficient way to validate your document. This involves validating your document as you step through each of your document's sections. Validating following this methodology assist you in several ways:

  • Reduces the overall number of issues you may have to address just prior to document submittal.
  • Enables you to address potential validation issues while the section topic is fresh in your head.
  • Speeds the overall completion of your document, as you will see visual notification that a section is complete.
  • Allows you to fill out your document over a period of several days with the confidence of knowing that you've addressed most issues in previously validated sections.
  • Begin Validation

    To begin section-level validation, click "Validate Section" in the Section Tools area of the left-gutter.

    section validation link image

    Wait For Validation To Begin

    The validation routine will begin and a popup window notifying you that validation is in progress will pop open:

    validation please wait image

    Validation Results

    Upon the completion of validation, you will be presented with a validation summary:

    validation results image

    Clicking on the sub-section name will take you directly to the page with errors. Each item in error will be outlined so you may address it.

    validation results for a single page image

    If you have errors in multiple sub-sections, you will have to address each sub-section individually, then re-run validation. Once validation is run again, you will see the error you just addressed is resolved. Then you can proceed to resolve issues in other sub-sections in the same manner.

    Complete Document Validation

    Running validation for your entire document is an extension of the section-based validation. Complete document validation occurs when one to two scenarios takes place :

  • You request a full document validation.
  • Your document is complete and you "submit" your document to NSF.
  • Full document validation

    To initiate a full-document validation request, click the "Submit/Validate Worksheet" link in the Worksheet Tools area of the left-gutter.

    worksheet validation link image

    The Validate and Sumit Worksheet page will appear. You have the option of validating your document without submittal to NSF, or to actually submit your document to NSF for review.

    Worksheet validation will take potentially much longer than section validation, since in essence the system is automatically stepping through each section for you and and running validation.

    Click "Validate Worksheet" to initiate full document validation. NOTE: Click "Validate Worksheet" once. Multiple button clicks will significantly delay the validation of your document!

    worksheet validation page iimage

    Wait For Validation To Begin

    Just as when validating a single section, the validation routine will begin and a popup window notifying you that validation is in progress will pop open:

    validation please wait image

    Validation Results

    Upon the completion of validation, you will be presented with a validation summary which encompasses the entire document. The look is similar to that of an individual section validation result.

    validation results image

    Clicking on the section or sub-section name will take you directly to the page with errors. Each item in error will be outlined so you may address it, just like section specific validation.

    validation results for a single page image

    If you have errors in multiple sections, you will have to address each error individually, then re-run validation. Once validation is run again, you will see the error(s) just addressed as resolved. Then you can proceed to resolve issues in other sections in the same manner.

    Next Tutorial Page...

    Continue to the next step in this tutorial...

    tutorial continue button

    Document Validation

    GENERAL

    • Do not use the "back" button of your browser to go back and review the list of invalid sections. This may cause data corruption. Treat your use of POLAR ICE just as you would with a banking application - you do not use the "back" button when transferring funds - you don't want your money to disappear! If you want to see the validation results, then run validation again.