Track solution changes over time.
Reference → Solution → Designer → Settings and Tools → Settings | Categories | Import Tags | Import Plugin | Export | History
The Solution History
Overview
The SolutionHistorypage records key editing events on the solution, specifically Build Commands, Publish operations, Import Wizard Operations, and
PlugInPlugin operations. It
allowallows users to review and open previous builds (if a Backup was enabled) and
managedmanage the
updatedupdates of Plugins added to
thethe solution.
On this page:Access: Solution → History
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
History Interface
Command Buttons
| Button | Function | Availability |
|---|
| Open Selected Build |
Update Selected Plugin: If a plugin is selected and it has a newer version, the contents is updated to the newer plugin version.
Solution History Table Columns
| Load previous version | When selected entry has backup | |
| Update Selected Plugin | Update to newer plugin version | When plugin has available update |
History Table
Table Columns
| Column | Description | Purpose |
|---|---|---|
| ID | Unique event identifier | Sequential tracking |
| VersionID | Solution version at event | Version tracking |
| EventSource | Type of operation | Build/Import/Plugin |
| SourceName | Module or component name | Identifies source |
| SourceSettings | Configuration details | Event parameters |
| PluginVersion | Version if plugin-related | Plugin tracking |
| VersionString | Full version string | Detailed version |
| ReadOnly | Edit protection status | Access control |
| HasUpdate | Update availability | Plugin updates |
| Locked | Editing lock status | Security |
| Preview | Event summary | Quick view |
| TargetModel | Affected solution model | Impact scope |
| ProductVersion | Product version used | Platform tracking |
| Build | Build |
Check out Working with DataGrid for general information about interaction with DataGrid.
Property | Description | |
|---|---|---|
ID | Identifies each event or entry uniquely in the solution's history. | |
VersionID | Specifies the version of the solution associated with the event. | |
EventSource | Indicates what triggered the event, like a user action or system process. | |
SourceName | Names the source (module or component) responsible for the event. | |
SourceSettings | Describes the source's configuration settings or parameters at the event time. | |
PluginVersion | Shows the version of the plugin involved in the event. | |
VersionString | Represents the version details, including build number or revision, as a string. | |
ReadOnly | Flags the item as read-only, preventing modifications. | |
HasUpdate | Signals if an update is available for the item. | |
Locked | Locks the item for editing or use, due to security or workflow reasons. | |
Preview | Provides a summary or preview of the event or changes. | |
TargetModel | Identifies the specific model or part of the solution affected by the event. | |
ProductVersion | Records the product or solution's overall version at the event time. | Build | Shows the solution’s build
| number at the time of the event. | Build identification | |
| BuildErrors | Lists any errors encountered during the event's build process. | |
UserID | Identifies the user who initiated or is associated with the event. | |
Username | Records the username of the individual associated with the event. | |
HasBackup | Indicates the existence of a backup for this specific event or solution state. | |
DateModified | Records the date and time of the event's last modification. | |
DateCreated | Records the date and time of the event's creation. | |
| Error count during build | Quality indicator | |
| UserID | User identifier | Audit trail |
| Username | User display name | Who performed |
| HasBackup | Backup availability | Recovery option |
| DateModified | Last modification | Change tracking |
| DateCreated | Event timestamp | When occurred |
Event Types
Tracked Events
| Event Source | Description | Creates Backup |
|---|---|---|
| Build | Solution build operation | Optional (configured) |
| Publish | Production deployment | Always |
| Import Tags | Tag import wizard completion | No |
| Import Plugin | Plugin added to solution | No |
| Plugin Update | Existing plugin updated | Before update |
| Export | Solution exported | No |
Build Management
Opening Previous Builds
To restore a previous build:
- Select Build Entry
- Must have HasBackup = true
- Shows backup icon
- Click Open Selected Build
- Prompts for confirmation
- Warns about current changes
- Restoration Process
- Current solution saved as recovery
- Selected build loaded
- History entry created
Build Information
Each build entry shows:
| Information | Description |
|---|---|
| Build Number | Sequential identifier. Build number at the time of the event. Only after the build the Build Number is incremented. |
| Build Time | When created |
| Build Errors | Problems encountered |
| Backup Status | If recoverable |
| User | Who initiated |
Plugin Management
Plugin History Tracking
The history maintains complete plugin lifecycle:
| Stage | Tracked Information |
|---|---|
| Initial Import | Version, date, user |
| Updates Applied | Old version → New version |
| Current State | Active version |
| Available Updates | HasUpdate flag |
Updating Plugins
Process for plugin updates:
- Identify Updates
- HasUpdate column = true
- Update button enabled
- Select Plugin Entry
- Click plugin history row
- Review current version
- Click Update Selected Plugin
- System creates backup
- Applies new version
- Records in history
Update Validation
Before updating:
- Current state backed up
- Dependencies checked
- Conflicts identified
- User confirmation required
History Filtering
View Options
Filter history by:
| Filter | Purpose | How to Apply |
|---|---|---|
| Event Type | Show specific operations | Column filter |
| Date Range | Time period | Date columns |
| User | Who made changes | Username filter |
| Has Backup | Recoverable events | Boolean filter |
| Has Errors | Problem events | BuildErrors > 0 |
Backup Management
Backup Storage
Backups stored in: Solution-Data\Backup\
| Backup Type | File Pattern | Retention |
|---|---|---|
| Build | Build_[ID]_[Date].dbsln | Per settings |
| Plugin Update | Plugin_[Name]_[Version].backup | Last 5 |
| Publish | Publish_[Version].zip | Permanent |
Backup Settings
Configured in Solution Settings:
| Setting | Options | Impact |
|---|---|---|
| Create Backup on Build | Yes/No | HasBackup status |
| Backup Retention | Days (1-365) | Auto-cleanup |
| Maximum Backups | Count (1-100) | Storage limit |
Audit Trail Features
Compliance Support
History provides:
| Feature | Purpose | Compliance |
|---|---|---|
| User Tracking | Who made changes | 21 CFR Part 11 |
| Timestamp | When changes occurred | Audit requirement |
| Change Details | What was modified | Traceability |
| Immutable Records | Cannot be deleted | Data integrity |
Export Options
History can be exported for:
- Audit reports
- Compliance documentation
- Change analysis
- Project documentation
Best Practices
Regular Review
- Check history weekly
- Monitor build errors
- Track plugin updates
- Review user activity
Backup Strategy
- Enable build backups for major changes
- Keep milestone builds
- Archive before updates
- Test restoration procedure
Plugin Management
- Document plugin sources
- Test updates in development
- Keep previous versions
- Track dependencies
Troubleshooting
| Issue | Cause | Solution |
|---|---|---|
| Can't open build | No backup exists | Check HasBackup column |
| Update fails | Version conflict | Check compatibility |
| History not showing | Filter active | Clear all filters |
| Backup missing | Not configured | Enable in settings |
| Plugin won't update | Modified locally | Manual merge required |
In this section...
| Page Tree | |
|---|---|
|
In this section:
| Page Tree | ||
|---|---|---|
|