Getting Started with the OSCAL Content Registry

Introduction

The OSCAL Content Registry is used to store and share OSCAL content amongst the OSCAL community.

You can search and filter OSCAL content registry using the Documents search bar to find what you need. When users view an individual file, the content registry summarizes details from the OSCAL content's metadata, such as the content owner, OSCAL version, document version and last modified date.

You can also view and export the raw JSON version of the OSCAL content or open the content using viewer.oscal.io.

The link to specific OSCAL content is persistent and may be bookmarked or shared.

If you register an account and log in, you will also have the ability to upload files to the content registry, as well as bookmark files for later reference.

Signing In

You may register a new account using your email address, or use a Google account to login. Select the SIGN IN button at the top right of the page.

If you are using a registered email address, enter your credentials in the email address and password fields. If you are using a Google account, select the Continue with Google button and follow the Google prompts for authentication.

Once you are logged in, the navigation menu will include a new Account choice beneath Documents. Also the SIGN IN button is replaced with a SIGN OUT button.

View Profile

To view your account details, select Profile in the horizontal navigation menu.

Uploading Documents

Preparing a Document for Upload

The OSCAL Content Registry only accepts valid OSCAL content. Please ensure the following before uploading your content:

• File names must have a .json extension.
• Files must contain valid OSCAL content
• Files should be in UTF-8. While other formats may work, only UTF-8 has been tested.
• Files should have a party in the metadata associated with the owner, creator or prepared-for role. This allows the OSCAL Content Registry to display the owner information in the summary field at the top as well as offering a consistent way for users of this content to identify the original owner.
• Files should have a party in the metadata associated with the author or prepared-by role. This allows the OSCAL Content Registry to display the content information in the summary field at the top (not yet implemented) as well as offering a consistent way for users of this content to identify the person or organization that put the content in OSCAL format.

Performing the Upload

In order to upload a document, you must be signed in to the content registry as a contributor or admin. See Signing In if you have not done so.

Navigate to My Documents in the horizontal navigation bar. Select the UPLOAD Document button if this is your first document or you can select Upload New Document on the top right of the page.

A card to Upload New Documents will appear. Either select within the box to choose files via your local file manager or drag-and-drop files into the rectangle.

Once you have selected the document you desire to upload, it will automatically be placed in a queue to upload. Upon successful upload, a green card will appear beneath the upload area that will allow you to access said document.

If you receive a red Error when uploading a file, the upload of that file was unsuccessful. Reasons for this include:

• the file did not have a .json extension.
• the file does not contain valid OSCAL content
• the file is too large (we currently have a 10MB limit and are working to expand that)

Documents Screen

Browse Documents by selecting the "Browse" button at the top right of the screen or by using the search bar to find specific documents.

Changing the layout

You have the option to view documents by rows (list view) or in a card layout (grid view). To change the viewing layout, use the icons at the top right of the documents content.

Filtering

You have a variety of options to filter the documents appearing on screen, including the type of document and a fuzzy word match for titles and owners of the document.

Above the documents area, use the search field with the magnifying glass icon, to enter text to search for a specific document's title or owner. The documents will be filtered live when typing into the search field.

Apply the filters by using the filter check boxes to the left of the document content or by selecting the chips at the top of the documents page.

Opening a document

To open a desired document, select the row/card the content appears within.

Viewing & Interacting with a Document

Once you have opened a document, you will be greeted with a screen displaying the general information about the document, including the title, owners, and metadata.

Favorite a document

To "favorite" a document, select the favorite button that appears above the document's title, to the right of the document type chip. You can "unfavorite" the document by selecting the icon again.

To view your favorited documents, select Browse from the top right corner, then select the Favorites Only filter. Here, you can examine documents you have bookmarked in a list/grid view.

View the document in OSCAL Viewer

Use the OSCAL VIEWER button to open the document directly in
viewer.oscal.io.

OSCAL Content format

You have the ability to view the raw JSON content of a document. To view, select the button View JSON that appears below the document information.

Optionally, you can also export the document by selecting the Download JSON button below the document information.

Deleting a document

If you are the owner of the document, you can remove the document from appearing in the content registry by selecting the red trash can button labeled "Delete" at the right corner of the document card. You will no longer be able to view or interact with this document.