U.S. flag   An official website of the United States government
Dot gov

Official websites use .gov
A .gov website belongs to an official government organization in the United States.

Https

Secure .gov websites use HTTPS
A lock (Dot gov) or https:// means you've safely connected to the .gov website. Share sensitive information only on official, secure websites.

National Online Informative References Program OLIR

OLIR Validation Tool

Download: IR8278A Validation Tool (Download 17.2 MB) Latest Version: 3.22 Released: September 17, 2021

SHA3-256:  ccd73e694e85328d32449ceefe2acd5e172603bfb15766f2d0474f25557c8c4d

The National Cybersecurity Online Informative References (OLIR) Validation Tool ensures syntactic compliance of the Focal Document templates to the instructions and definitions described within the NIST Interagency Report (IR) 8278A, National Cybersecurity Online Informative References (OLIR) Program: Submission Guidance for OLIR Developers.

Focal Document JSON Schema

  • Focal Documents Schema (.json)This JSON schema is intended for use in developing a JSON file format of an OLIR

Validation Tool Prerequisites

  • Java must be installed on your machine. 
  • The Validation Tool requires Java version 8 or higher
  • The spreadsheet must be in the .xlsx file format
  • IR8278A Validation requires that no new columns are added to the template however, new rows can be added as needed detailed in NIST IR 8278A Specification.

Running the Program

Option A – Folder View

  1. Download the jar file to a folder (note the output files will be generated in the same folder as the jar file executable.
  2. Double click on the jar file to run it.
  3. The program will prompt via pop-up dialog box for the file path of the spreadsheet to test.
  4. After providing the file path, press ENTER, the dialog box will disappear and the program will begin executing.
  5. When the program is complete, two results files will be placed in the same directory as the jar executable: CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt
  6. Two results files will be placed in the same directory as the jar executable named, CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt which is a more verbose reporting file and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt containing only compliance violations of the IR8278A specification.

Option B – Command Line Interface (CLI)

  1. Download the jar file to a folder (note the output files will be generated in the same folder as the jar file executable.
  2. Open Terminal or Command Line and navigate to the directory containing the jar file executable.
  3. Use the command: java -jar [Program Name].jar [Reference Spreadsheet File Path]
  4. Press ENTER and the program will begin running.
  5. When the program is finished, the Command Line/Terminal window will display “Program is complete” along with basic statistics totals such as passes, errors and warnings.
  6. Two results files will be placed in the same directory as the jar executable: CompleteValidationReport<FN>YYYY-MM-DDTHH:MM:SS.txt which is a more verbose reporting file and ErrorFileResults<FN>YYYY-MM-DDTHH:MM:SS.txt containing only compliance violations of the IR8278 specification.

Created September 08, 2020, Updated September 30, 2021