View model details page

The Model details page displays the register configuration of a single data model. Administrators and data engineers use this page to view, manage, and configure registers of a model, including datasets, composition, validation, transformation and publishing.

Page layout

Header section

The header is the top area of the Model Details page. This area includes the model title, model version, status information, navigation buttons, and action controls.

The header includes:

• Title Area - Displays the model name as Model - Equipment Asset Register with a Model details subtitle.

• Back button - Exit the model details view and return to the complete Models List page. Use this when done viewing or editing a specific model. Selecting Back discards any unsaved changes without confirmation and returns you to the Models List. If the model is locked, it remains locked by you. Therefore appears as always enabled.

• Action Menu button - Opens a drop-down list containing primary model operations. This is your access point to all model management actions including downloading, publishing, validating, and managing the model lock status.

• These are the menu items:

  • Download

  • Publish

  • Validate

  • Lock (or Lock and Transform)

  • Unlock and Discard

    The menu dynamically shows or hides options based on your lock status and permissions and appears as always enabled.

• Model Information Row - Displays key metadata in labeled fields such as ID: REGI_ASSET_REG_001, Name: Equipment Asset Register, Version: 2.3, Created By: John Smith, and Locked By: John Smith (when locked). ID, Name, and Version are always visible and cannot be changed. Locked By only appears when locked.

Action menu

Use the action menu to access all primary operations for managing the model. The menu dynamically shows or hides options based on your current lock status and permissions, ensuring you only see actions that are available to you.

Understanding the action menu

The action menu is your primary control center for model management. Each action triggers specific operations on the backend, and the availability of each option depends on:

• Whether the model is currently locked.

• Who has the model locked (if anyone).

• Your permissions and role.

• The current state of the model (validated, has errors, etc.).

Menu items

Download

Exports the complete model configuration to a file that you can store, backup, or share with team members.

• Purpose: Export the model to a file.

• When to Use: Create backups before making changes, share models across teams, maintain version control, archive production models.

• Status: Always available, regardless of lock status or permissions.

• Result: Model file downloads to computer in standard format.

What is included in download: The download includes all model metadata (ID, name, version), all datasets and their configurations, column mappings, composition dependencies, and all settings configured in the model.

Follow these steps to download:

1. Navigate to the model details page.

2. Select the menu buttonin the header.

3. Select Download from the drop-down list.

   The model file starts downloading to your computer's default downloads folder. The file is ready for backup, sharing, or version control system storage.

Publish

Commits the model’s changes in ISM application. Publishing automatically releases the lock you have on the model.

• Purpose: Deploy model to production environment (automatically releases lock).

• When to Use: After completing all edits and validation, when you're confident the model is ready for use.

• Status: Enabled only when you have the model locked.

• Disabled When: Model is not locked by you, or model is not locked at all.

• Result: Model published to production, lock automatically released, version number increments.

Lock Release Behavior: When you publish, the system automatically releases your lock. This means the model returns to unlocked state, and other users can now lock it for editing. The edit icon is removed from the model row in the Models List.

Prerequisites for publishing

• Model must be locked by you (showing edit icon on model list).

• All required datasets must be configured.

• All required fields and mappings must be present.

Follow theseto publish:

4. Ensure you have the model locked (edit icon visible on model row in Models List).

5. Make all necessary changes to datasets, mappings, and configurations.

6. Review your changes and verify they are correct.

7. Validate the model to check for any issues (recommended but not required).

8. Select the menu buttonin the header.

9. Select Publish from the drop-down list.

   The model is published to the linked ISM product. Once model is published your lock is released.

What happens after publishing

• Lock releases automatically - model returns to unlocked state.

• Version number increments by one decimal.

• Your changes are now live and active in ISM product.

• Other users can now view the updated model.

• Other users can now lock the model for further editing.

Failure scenarios

• If publish fails due to validation errors, you can see a specific error message.

• Your lock remains in place so you can fix the issues and try again.

Validate

Register configuration validation is a comprehensive check performed on data pipeline mappings before they are used in production. The validation process ensures that the configuration is correct and functions as expected when processing actual data.

The validation process examines the following aspects of your register configuration:

• Required Field Validation

• Identification Configuration

• RegisterType-Specific Validation

• Column Reference Validation

• Dataset Structure Validation

  For detailed explanation of each type of validation, refer to View model validation.

Use the action menu and select Validate to run a comprehensive check and see all issues in detail.

Note: Validation requests can be reviewed in Requests tab.

Lock or Unlock and Discard

These two options are mutually exclusive, you see one or the other depending on current lock status. Locking grants you exclusive editing rights; unlocking releases the lock and discards unsaved changes.

Lock - Displayed when model is NOT locked.

Acquires an exclusive lock on the model for editing. Once locked, only you can make changes, other users can view but not edit.

• Purpose: Lock model for exclusive editing.

• Label Options

  • Lock - Standard lock operation.

  • Lock and Transform - Locks and transforms the model (if transformation is required in ISM).

• Status: Only visible when model is not currently locked.

• Visibility: Is displayed on the menu only if no one has the model locked.

• Result: Model locked by you, edit icon (edit) appears on model row in Models List, you can now edit.

Locking implies the following:

• Prevents other users from locking the model.

• Allows you exclusive editing access to all model components.

• Displays your name in Locked By field in model information row.

• Displays edit icon on the model row in the Models List.

• Keeps your lock active even if you leave the page (until you unlock or publish).

To lock and edit

10. View the Models List and locate the model you want to edit.

11. Verify the model is not locked (no lock or edit icon on the row).

12. Select on the model name to open its details page.

13. Select the menu buttonin the header.

14. Select Lock and Transform (if available) or Lock from the drop-down list.

    The Edit icon appears on model row in list and Locked By: [Your Name] appears in model information. You can now make changes to datasets, configuration, mappings

15. When editing is completed, select Publish to save and release lock.

16. Select Unlock and Discard to discard changes and release lock.

Lock duration: The lock remains until the following:

• You publish the model (lock automatically releases).

• You unlock and discard changes (lock releases).

• An administrator forces unlock (releases your lock).

Lock indicators: While you have a model locked:

• Edit icon (edit) is displayed on the model row in Models List.

• Locked By: [Your Name] displays in the Model Information Row on the details page.

• Publish and Unlock options become available in the action menu.

• Lock option is no longer available (replaced with Unlock option).

Unlock and discard - displayed when you have model locked

Releases your exclusive lock on the model and discards any changes made to the current version. After unlocking, other users can lock the model for editing.

• Purpose: Release lock and discard all unsaved changes without publishing.

• When to Use: Stop editing without saving changes, release lock to allow other users to edit, abandon failed edit session.

• Status: Only visible when you personally have the model locked.

• Visibility: Does not appear if model is unlocked or locked by someone else.

• Result: Lock released, all unsaved changes discarded, model returns to previous published state.

  Warning: This action can be destructive - all changes you made during this edit session are lost and cannot be recovered.

What unlocking and discarding does

• Releases your exclusive lock immediately.

• Discards all unsaved changes you made to datasets, mappings, configurations.

• Reverts model to the last published version.

• Removes your name from Locked By field.

• Removes Edit icon from model row in Models List.

• Allows other users to now lock the model.

Following are the steps to unlock and discard:

17. Ensure YOU have the model locked (edit icon is displayed on model row in list).

18. Select the menu buttonin the header.

19. Select Unlock and Discard from the drop-down list.

    The confirmation dialog appears asking you to confirm this destructive action.

20. Select Confirm (or Yes) in the dialog to proceed. System releases your lock immediately. All unsaved changes are permanently discarded. Model returns to previous published state. Other users can now lock the model

Before you unlock and discard, consider these:

• Consider if you want to save your changes, if yes, select Publish instead.

• Consider if you want to download the current state for reference.

• Review any changes you made that you do not want to lose.

• This action cannot be undone.

Lock release: After confirming unlock and discard

• Lock releases immediately.

• Edit icon is removed from model row.

• Locked By field is cleared in model information.

• Your browser may automatically refresh the page to show current state.

• Other users can now immediately lock the model.

Tab layout

The page contains two tabs for organizing model content:

• Datasets tab (default)

• Composition tab

Datasets tab

The Datasets tab shows all data sources and their associated datasets (registers).

Key components

Add Dataset button

• Purpose: Creates a new dataset/register.

• Enabled: Only when you have the model locked.

• Result: Opens dataset creation dialog.

  

Data source groups

Each data source is displayed as an expandable panel showing the data source name with a folder icon, followed by a count indicating how many datasets exist within that source. A Delete button appears next to the data source name when the source is active (not deleted).

• Data source name

• Number of datasets, if more datasets exist than shown

• Delete button for deleting the data source

• Deleted state indicator, if data source is deleted

Expand or collapse: Select pane header to show or hide datasets in this data source.

Dataset table

When a data source is expanded, a table of datasets is displayed:

Row actions

Enabled states:

• Edit: Enabled only if model is locked by you and dataset is not deleted.

• Delete: Enabled only if model is locked by you and dataset is not deleted.

• View: Always enabled unless dataset is deleted.

Load more buttons

• Purpose: Load additional datasets if more exist.

• Location: Below datasets table.

• Shows: When dataset list is truncated.

• Result: Loads next batch of datasets.

How to edit a dataset

21. Ensure you have model locked and expand data source containing dataset.

22. Select Edit button (edit icon) in Actions column.

    The dataset editor appears showing configuration and column mappings.

23. Perform relevant changes to dataset settings and mappings.

24. Save changes. Changes are applied to the model.

25. Publish to finalize changes.

Note: For detailed information about column mapping configuration, refer to the View model mapping topic.

How to Delete a Dataset

26. Ensure you have model locked and expand data source containing dataset.

27. Select Delete button in Actions column.

28. Select OK to confirm deletion. Dataset marked as deleted.

29. Publish to save changes.

Note: Deleted datasets cannot be edited or used in publishing

How to view a dataset:

30. Expand data source containing dataset.

31. Select View button in Actions column. Dataset viewer dialog opens in read-only mode.

32. Review dataset information (no editing possible in this view).

The dataset viewer displays the complete dataset information without allowing any modifications. This is useful for auditing, verification, and understanding the current state of a dataset without risking accidental changes.

Note: The viewer is read-only and provides informational access only. To modify dataset configuration, column mappings, or any settings, you must use the Edit action instead. Viewing does not require a lock on the model.

Composition tab

Displays the composition details: dependencies on other models/class libraries.

Composition Table