Model
The RegScale Model CLI is designed to easily upload or bulk edit various data models/modules within RegScale via an excel spreadsheet. It currently supports assessments, issues, components, or assets. The Model CLI current supports the following functions:
new:
This function will create a local Excel spreadsheet for users to edit to be able to bulk create new records.
generate:
This function will build and populate an Excel spreadsheet of records with the selected RegScale Parent Id and RegScale Module for users to edit.
load:
This function uploads updated and new records to RegScale from the Excel spreadsheet created with the new function.
delete_files:
This function will delete files created by the process.
To use the Model CLI to bulk add issues as an example:
- Run the first command which creates a local spreadsheet template
regscale model new --model issue
- Complete/Save the template excel created with issues to upload. Ensure that required fields for each record type are completed:
Module | Required Fields |
---|---|
Assessments | Title, Lead Assessor, Assessment Type, Planned Start, Planned Finish, Status |
Issues | Title, Severity Level, Issue Owner, Identification, Due Date for Remediation, Status (if Status is Closed Date Completed is additionally required) |
Components | Title, Component Type, Component Owner, Status, Description, Default Control Assessment Schedule |
Control | Control Owner, Control Name, Control Title, Description |
Assets | Asset Name, Asset Owner, Status, Asset Category, Asset Type |
- Run the second command that creates the issue records based on the completed template
regscale model load --model issue
Updated 3 days ago