Instance Detail

The instance detail page is the central hub for viewing and managing a procedure execution. It provides a complete picture of the instance’s status, step progress, variables, team, and execution history.

Accessing the instance detail

Click on any instance row in the instance list to open its detail page. You can also navigate directly using the URL pattern /_instances/{instanceId}.

Page layout

The instance detail page is organized into several sections:

Header

The header bar shows:

• Instance title with edit capability (for Draft instances).
• Status badge — Color-coded indicator of the current lifecycle status (Draft, Planned, Running, Paused, Completed, Cancelled).
• Template and version — The source template name and version string, with a link to the template.
• System and stage — The managed system and stage assigned to this instance.
• Progress bar — Visual indicator showing completed steps vs. total steps with a percentage.
• Action buttons — Lifecycle actions based on the current status (Start, Pause, Resume, Cancel, Complete, Edit, etc.).

Action buttons

Available actions depend on the instance status:

Status	Available actions
Draft	Edit, Assign Version, Mark as Planned, Delete
Planned	Start, Edit, Cancel
Running	Pause, Cancel, Complete
Paused	Resume, Cancel
Completed	Archive, Clone
Cancelled	Archive, Clone

Tabs

The detail page uses a tabbed interface:

Steps tab

The Steps tab is the primary view showing all instance steps with their execution state.

Step list

Steps are displayed in a hierarchical list matching the template structure. Each step shows:

• Step number and title
• Status badge — Pending, Started, Running, Paused, Completed, Skipped, Cancelled, or Aborted
• Assigned user — Who is responsible for this step
• Duration — Estimated and actual execution time
• Progress — For parent steps, a summary of child step completion

View modes

Toggle between different display modes:

• Execution view — Shows steps with their current execution state, action buttons, and real-time progress.
• Design view — Shows the original template plan structure, useful for comparing the intended procedure against actual execution.
• Execution preview — A read-only preview showing how steps will appear during execution, including resolved virtual steps.

Step actions

Click on a step to expand its detail panel. From there you can:

• View step instructions with resolved variable values.
• Start, complete, pause, resume, skip, or abort the step (depending on status and permissions).
• Add comments and notes.
• Upload evidence attachments.
• View step execution history.

Variables tab

The Variables tab shows all template variables with their current values:

• Variable name — The placeholder name (e.g., {{ServerName}}).
• Value — The current value. Click to edit (for editable instances).
• Data type — String, Number, Date, Boolean, List, or StringList.
• Default value — The template-defined default.
• Required — Whether the variable must have a value.

Caution

Changing a StringList variable with an iteration mode (Parallel or Sequential) affects virtual step generation. RAMP automatically creates a snapshot before such changes so you can review the previous state.

Inline variable editing

Click on a variable value to edit it inline. For StringList variables, the editor provides a multi-line input where each line represents a list item.

Regenerate virtual steps

After modifying iteration variables, click Regenerate Virtual Steps to update the step tree with new virtual step instances.

Notes tab

Instance-level notes and comments, including:

• Inherited notes — Notes from the template and template version that were carried over at creation time.
• Instance notes — Notes added specifically to this instance.
• Comments — Threaded comments on the instance for team communication.

Execution Notes tab

During execution (Running/Paused status), a separate Execution Notes section provides:

• Execution log — A chronological feed of all execution events (step starts, completions, pauses, etc.).
• Execution notes — Notes specific to the current execution (separate from planning notes).
• Execution comments — Real-time communication between team members during execution.

Team tab

View and manage the instance team. See Instance Team for details.

History tab

View the instance audit trail showing all changes, status transitions, and user actions. See Snapshots for point-in-time state snapshots.

Instance upgrade

If a newer version of the template is published and approved, you can upgrade the instance:

1. An upgrade notification appears on the instance detail page when a newer version is available.
2. Click Upgrade to preview the changes.
3. Review the upgrade preview showing which steps are added, removed, modified, or unchanged.
4. Confirm the upgrade to apply the changes.

Note

Upgrading preserves step execution progress. Completed steps retain their status, and new steps from the updated version are added as Pending. A snapshot is automatically created before the upgrade.

Version chain

The instance detail shows a Version Chain Badge indicating the upgrade history. If an instance has been upgraded, you can see the chain of versions it has used.

Override settings

Instance Heads and Deputy Heads can override certain template step settings at the instance level:

Setting	Description
Planned Duration	Override the template’s estimated duration for a specific step
Skippable	Override whether a step can be skipped
Auto-Complete	Override the auto-complete behavior for parent steps

Overridden settings display a visual indicator to distinguish them from template defaults.

Real-time updates

The instance detail page receives real-time updates via SignalR:

• Step status changes appear immediately.
• Variable value updates are reflected in real-time.
• Team changes are visible without refreshing.
• Comments and notes from other users appear instantly.

Related topics

Instance List Browse and filter all instances

Instance Team Manage the instance execution team

Snapshots Point-in-time state snapshots