Data Exports
RAMP provides data export capabilities for extracting instance execution data, audit trails, and compliance documentation. Exports support post-execution reporting, regulatory compliance, and integration with external systems.
Export Scope
Section titled “Export Scope”Data exports in RAMP cover the following areas:
| Export Type | Content | Format |
|---|---|---|
| Instance data | Instance metadata, step statuses, completion results, variables, team assignments | JSON |
| Execution history | Step-by-step execution timeline with timestamps, performers, and durations | JSON |
| Audit trail | Complete audit log for an instance including all state changes, comments, and force actions | JSON |
| Attachments | All evidence files uploaded to steps during execution | Original file formats (within ZIP) |
Instance Data Export
Section titled “Instance Data Export”An instance data export captures the full state of an instance at the time of export, including all its steps, variables, team members, and metadata.
Exported Fields
Section titled “Exported Fields”Instance-level data:
| Field | Description |
|---|---|
| Title | Instance name |
| Status | Current instance status (Draft, Planned, Running, Completed, Cancelled) |
| Completion result | Success, Failed, or Cancelled |
| Template reference | Source template and version |
| Stage reference | Associated system stage |
| Planned start/end | Scheduled execution window |
| Actual start/end | Real execution timestamps |
| Owner | Instance owner user |
| Created by | User who created the instance |
Step-level data:
| Field | Description |
|---|---|
| Step title and content | Step description and instructions |
| Status | Step completion status (Completed, Skipped, Aborted, etc.) |
| Completion result | Granular result (Succeeded, OK with Complications, OK with Warnings, OK with Errors, Failed) |
| Start/end times | When the step was started and completed |
| Net runtime | Actual working time (excluding paused time) |
| Paused duration | Total time the step was paused |
| Assigned user | Who was assigned to the step |
| Actual performer | Who actually performed the step |
| Skip reason | Reason provided when a step was skipped |
| Attachments | List of attached files with metadata |
Variable data:
| Field | Description |
|---|---|
| Variable key | Variable name |
| Value | Current variable value |
| Filled by | User who set the value |
| Filled at | When the value was set |
Execution Reports
Section titled “Execution Reports”Execution reports provide a timeline view of how the instance was executed, useful for post-mortem analysis and compliance reviews.
Report Contents
Section titled “Report Contents”An execution report includes:
- Execution timeline: Chronological record of all step starts, completions, pauses, and resumes
- Runtime analysis: Planned vs. actual duration for each step, with variance calculations
- Force action summary: All force actions performed, with reasons and cascade effects
- Team participation: Which team members executed which steps
- Evidence summary: List of all attachments uploaded during execution
Generating a Report
Section titled “Generating a Report”- Navigate to the completed (or cancelled) instance
- Open the instance detail page
- Use the export option to generate the execution report
- Select the desired format
- Download the generated report
Audit Export
Section titled “Audit Export”The audit export extracts the complete audit trail for an instance, providing a compliance-ready record of all actions taken.
What Is Included
Section titled “What Is Included”| Entry Type | Details |
|---|---|
| Status changes | Every transition (Draft to Planned, Planned to Running, etc.) with timestamps and users |
| Step actions | All start, complete, pause, resume, skip, abort, and cancel actions |
| Force actions | Force Complete, Force Skip, Force Abort with reasons, consent, and cascade details |
| Comments and notes | All execution log comments, execution notes, and step notes |
| Team changes | Team member additions, removals, and role changes |
| Variable changes | Variable value modifications with old and new values |
| Attachment operations | File uploads and deletions with metadata |
| Approvals | Approval requests and decisions for “OK with Errors” results |
Each audit entry includes:
- Timestamp (UTC)
- User who performed the action
- Action type
- Old value (JSON)
- New value (JSON)
- Human-readable description
Export via CLI
Section titled “Export via CLI”For bulk exports or automated workflows, the RAMP CLI tool (RAMP.Cli) provides programmatic export through its backup commands. See Backup & Restore for detailed CLI usage.
Quick Reference
Section titled “Quick Reference”# Export a single instanceramp-cli backup object --type instance --id <instance-guid> --output export.json
# Export a full system with all templates and instancesramp-cli backup object --type system --id <system-guid> --output system-export.json
# Full database exportramp-cli backup full --output full-backup.json --format JsonExport Formats
Section titled “Export Formats”| Format | Extension | Best For |
|---|---|---|
| JSON | .json | Programmatic processing, API integration, human-readable review |
| ZIP | .zip | Archival with attachments; JSON data plus original files in a single archive |
Compliance Documentation
Section titled “Compliance Documentation”For organizations with regulatory requirements (SOX, ITIL, ISO 27001, etc.), RAMP exports provide the documentation trail needed for audits.
Key Compliance Data Points
Section titled “Key Compliance Data Points”| Requirement | RAMP Data Source |
|---|---|
| Who performed each action | User identity on every audit entry |
| When each action occurred | UTC timestamp on every audit entry |
| What changed | Old/new value JSON on audit entries |
| Why exceptions occurred | Mandatory reason on force actions and skip operations |
| Evidence of completion | Step attachments and completion results |
| Approval chain | Approval requests and decisions for “OK with Errors” results |
| Access control | Team assignments and role-based permissions |
Recommended Export Schedule
Section titled “Recommended Export Schedule”| Activity | Frequency | Purpose |
|---|---|---|
| Instance export after completion | Per instance | Permanent record of execution |
| Force action review | Quarterly | Compliance review of exceptions |
| API audit review | Monthly | Security monitoring |
| Full backup | Weekly/monthly | Disaster recovery |
Best Practices
Section titled “Best Practices”Export Completed Instances Promptly
Section titled “Export Completed Instances Promptly”Export instance data shortly after completion while all context is fresh. This ensures you have a complete record before any database maintenance or archival operations.
Include Attachments in Compliance Exports
Section titled “Include Attachments in Compliance Exports”When exporting for compliance purposes, use the ZIP format to include all evidence files alongside the structured data. This provides a self-contained compliance package.
Validate Exports
Section titled “Validate Exports”After creating an export, verify its contents using the CLI validate command:
ramp-cli validate --input export.json --mode copyThis confirms the export file is well-formed and complete.
Secure Export Files
Section titled “Secure Export Files”Export files may contain sensitive operational data. Store them in a secure location with appropriate access controls. Follow your organization’s data handling policies for retention and disposal.