Module Settings
Customize the behavior of individual SPEAR modules. Each module can be configured independently to match your organization’s workflow.
Accessing Module Settings
Section titled “Accessing Module Settings”Navigate to Admin > Module Settings to configure each module:
| Module | Configuration Options |
|---|---|
| Sales & Scoping | Pipeline stages, scope templates |
| Project Management | Status workflows, templates |
| Operations | Severity definitions, asset types |
| Reporting | Section templates, export defaults |
| Metrics | Dashboard widgets, KPIs |
Sales & Scoping Settings
Section titled “Sales & Scoping Settings”Pipeline Configuration
Section titled “Pipeline Configuration”Customize the sales pipeline stages:
- Navigate to Admin > Module Settings > Sales
- Select Pipeline Stages
- Add, edit, or reorder stages:
| Default Stage | Description |
|---|---|
| Lead | Initial contact |
| Qualified | Requirements gathered |
| Proposal | SOW submitted |
| Negotiation | Terms being finalized |
| Won | Deal closed successfully |
| Lost | Deal not closed |
Scope Templates
Section titled “Scope Templates”Create reusable scoping templates:
- Navigate to Scope Templates
- Click Create Template
- Define:
- Template name
- Default services
- Pricing structure
- Terms and conditions
- Save template
SOW Settings
Section titled “SOW Settings”Configure Statement of Work generation:
| Setting | Description |
|---|---|
| Default Terms | Standard terms and conditions |
| Signature Options | Electronic signature settings |
| Numbering Format | SOW number format |
| Expiration Default | Default validity period |
Project Management Settings
Section titled “Project Management Settings”Project Status Workflow
Section titled “Project Status Workflow”Define project status transitions:
stateDiagram-v2
[*] --> Scoping
Scoping --> Scheduled
Scheduled --> InProgress
InProgress --> Review
Review --> InProgress : Revisions
Review --> Complete
Complete --> [*]
Configure at Admin > Module Settings > Projects > Status Workflow.
Project Templates
Section titled “Project Templates”Create project templates:
- Navigate to Project Templates
- Click Create Template
- Define:
- Template name
- Default sections
- Milestone schedule
- Resource allocation
- Save template
Scheduling Options
Section titled “Scheduling Options”| Setting | Description |
|---|---|
| Calendar Integration | External calendar sync |
| Resource Capacity | Team capacity settings |
| Auto-scheduling | Automatic date suggestions |
| Notifications | Schedule change alerts |
Operations Settings
Section titled “Operations Settings”Severity Definitions
Section titled “Severity Definitions”Customize vulnerability severity levels:
| Severity | Default Score Range | Color |
|---|---|---|
| Critical | 9.0 - 10.0 | Red |
| High | 7.0 - 8.9 | Orange |
| Medium | 4.0 - 6.9 | Yellow |
| Low | 0.1 - 3.9 | Blue |
| Info | 0.0 | Gray |
Modify at Admin > Module Settings > Operations > Severities.
Asset Types
Section titled “Asset Types”Define custom asset types:
- Navigate to Asset Types
- Click Add Type
- Configure:
- Type name
- Icon
- Custom fields
- Default values
- Save
Default Asset Types:
- Web Application
- API Endpoint
- Network Host
- Cloud Resource
- Mobile Application
- Physical Location
Import Mappings
Section titled “Import Mappings”Configure scanner import field mappings:
- Select scanner type
- Map scanner fields to SPEAR fields
- Set default values for missing fields
- Save mapping
Reporting Settings
Section titled “Reporting Settings”Section Templates
Section titled “Section Templates”Create reusable report section templates:
- Navigate to Section Templates
- Click Create Template
- Define:
- Template name
- Section type
- Default content
- Styling options
- Save template
Report Templates
Section titled “Report Templates”Configure complete report templates:
| Setting | Description |
|---|---|
| Default Sections | Sections included by default |
| Section Order | Default section ordering |
| Required Sections | Sections that cannot be removed |
| Conditional Sections | Sections based on service type |
Export Defaults
Section titled “Export Defaults”Set default export options:
| Setting | Default |
|---|---|
| Page Size | A4 |
| Orientation | Portrait |
| Include Cover | Yes |
| Include TOC | Yes |
| Header/Footer | Yes |
Finding Display
Section titled “Finding Display”Configure how findings appear in reports:
| Setting | Description |
|---|---|
| Severity Badge Style | Badge appearance |
| CVSS Display | Show/hide CVSS details |
| Evidence Format | How to display evidence |
| Remediation Style | Remediation section format |
Metrics Settings
Section titled “Metrics Settings”Dashboard Configuration
Section titled “Dashboard Configuration”Customize the metrics dashboard:
- Navigate to Admin > Module Settings > Metrics
- Select widgets to display:
- Project Status Overview
- Finding Severity Distribution
- Team Utilization
- Revenue Pipeline
- Time Tracking
KPI Definitions
Section titled “KPI Definitions”Define key performance indicators:
| KPI | Calculation |
|---|---|
| Average Project Duration | Total days / completed projects |
| Findings per Assessment | Total findings / assessments |
| Report Turnaround | Days from complete to delivered |
| Client Satisfaction | Average feedback score |
Report Scheduling
Section titled “Report Scheduling”Schedule automated metric reports:
- Navigate to Scheduled Reports
- Click Create Schedule
- Configure:
- Report type
- Recipients
- Frequency
- Format
- Enable schedule
Content Library Settings
Section titled “Content Library Settings”Categories
Section titled “Categories”Organize content library items:
- Navigate to Admin > Module Settings > Content Library
- Select Categories
- Add, edit, or remove categories
- Set category hierarchy
Templates
Section titled “Templates”Configure content templates:
| Setting | Description |
|---|---|
| Default Format | Template content format |
| Variables | Available merge variables |
| Approval Workflow | Review requirements |
Findings Library Settings
Section titled “Findings Library Settings”Categories
Section titled “Categories”Organize findings library:
- Navigate to Admin > Module Settings > Findings Library
- Configure categories for:
- Web Application
- Network
- Cloud
- Physical
- Custom categories
Standard Findings
Section titled “Standard Findings”Manage pre-built findings:
| Setting | Description |
|---|---|
| OWASP Mapping | Map to OWASP categories |
| CWE References | Common Weakness Enumeration |
| Default Remediation | Standard fix recommendations |
| Evidence Templates | Screenshot/code templates |
Shortcodes
Section titled “Shortcodes”Configure finding shortcodes:
- Navigate to Shortcodes
- Add custom shortcodes:
- Client name
- Assessment date
- Service type
- Custom variables
Notification Settings
Section titled “Notification Settings”Email Notifications
Section titled “Email Notifications”Configure per-module email notifications:
| Module | Notifications |
|---|---|
| Sales | New lead, SOW approved, deal won/lost |
| Projects | Status change, milestone due, assignment |
| Reports | Export complete, portal viewed, comment |
| Operations | Import complete, critical finding |
In-App Notifications
Section titled “In-App Notifications”Configure notification center:
| Setting | Description |
|---|---|
| Desktop Notifications | Browser notifications |
| Sound | Notification sound |
| Badge Count | Unread count display |
| Grouping | Group similar notifications |
Default Values
Section titled “Default Values”Global Defaults
Section titled “Global Defaults”Set organization-wide defaults:
| Setting | Description |
|---|---|
| Timezone | Default timezone |
| Date Format | Date display format |
| Currency | Default currency |
| Language | Default language |
Per-User Overrides
Section titled “Per-User Overrides”Users can override defaults in their profile settings.
Import/Export Settings
Section titled “Import/Export Settings”Export Configuration
Section titled “Export Configuration”Export module settings:
- Navigate to desired module settings
- Click Export Settings
- Download JSON configuration
Import Configuration
Section titled “Import Configuration”Import previously exported settings:
- Click Import Settings
- Upload JSON file
- Review changes
- Confirm import
Reset to Defaults
Section titled “Reset to Defaults”Reset module to default settings:
- Navigate to module settings
- Click Reset to Defaults
- Confirm reset
Best Practices
Section titled “Best Practices”Configuration Management
Section titled “Configuration Management”- Document custom settings
- Export settings before major changes
- Test changes in staging if possible
- Review settings after updates
Template Organization
Section titled “Template Organization”- Use descriptive names
- Group related templates
- Archive unused templates
- Version significant changes
Team Communication
Section titled “Team Communication”- Announce setting changes
- Document workflows
- Train users on new features
- Gather feedback regularly