Skip to main content

Data Models Inventory

This document provides an inventory of the core data models in the Asset Valuer Pro application. Models are organized by their functional domain.

Core Domain Models

ModelFrontend FileBackend RepresentationDescription
Asset/API/Web/src/models/Asset.tsxMultiple DTOsThe central entity representing physical assets being valued
Component/API/Web/src/models/Component.tsxMultiple DTOsComponents that make up an asset
Job/API/Web/src/models/Job.tsxJobDtoA valuation job that includes one or more asset classes
ValuationProfile/API/Web/src/models/ValuationProfile.tsxValuationProfileWithScoresDtoConfiguration for how valuations are calculated
Client/API/Web/src/models/Client.tsxClientDtoOrganization that owns assets
User/API/Web/src/models/User.tsxApplicationUserDtoSystem user with various permissions
ModelFrontend FileBackend RepresentationDescription
AssetSummary/API/Web/src/models/AssetSummary.tsxAssetSummaryDtoSummarized asset information
ComponentSummary/API/Web/src/models/ComponentSummary.tsxComponentSummaryDtoSummarized component information
Content/API/Web/src/models/Content.tsxContentDtoContent items associated with assets
HierarchyNode/API/Web/src/models/HierarchyNode.tsxHierarchyNodeDtoNode in the asset/component hierarchy
Note/API/Web/src/models/Note.tsxNoteDtoNotes attached to assets
Image/API/Web/src/models/Image.tsxN/AImages associated with assets
Lease/API/Web/src/models/Lease.tsLeaseDtoLease information for assets
MaintenancePlan/API/Web/src/models/MaintenancePlan.tsxMaintenancePlanDtoMaintenance planning for assets

Assumption Models

ModelFrontend FileBackend RepresentationDescription
AssetAssumptions/API/Web/src/models/AssetAssumptions.tsxAssetAssumptionsDetailDtoValuation assumptions for assets
ComponentAssumptions/API/Web/src/models/ComponentAssumptions.tsxComponentAssumptionsDetailDtoValuation assumptions for components
InsuranceAssumptions/API/Web/src/models/InsuranceAssumptions.tsxInsuranceAssumptionsDtoInsurance-related assumptions
ComponentWithAssumptionValues/API/Web/src/models/ComponentWithAssumptionValues.tsxComponentWithAssumptionValuesDtoComponents with applied assumptions

Cost Models

ModelFrontend FileBackend RepresentationDescription
ReplacementCostSummary/API/Web/src/models/ReplacementCostSummary.tsxMultiple DTOsSummary of replacement costs
AssetReplacementCostExcelFileDtoN/AAssetReplacementCostExcelFileDtoAsset replacement costs for export
ComponentReplacementCostExcelFileDtoN/AComponentReplacementCostExcelFileDtoComponent replacement costs for export

Hierarchy and Classification Models

ModelFrontend FileBackend RepresentationDescription
HierarchyType/API/Web/src/models/HierarchyType.tsxN/AType of hierarchy (Asset or Component)
FinancialClass/API/Web/src/models/FinancialClass.tsxN/AFinancial classification of assets
ValuationClass/API/Web/src/models/ValuationClass.tsxValuationClassDtoClassification for valuation purposes

User and Organization Models

ModelFrontend FileBackend RepresentationDescription
Group/API/Web/src/models/Group.tsxGroupDtoUser group for permissions
Role/API/Web/src/models/Role.tsxApplicationRoleDtoUser role defining permissions
Subscription/API/Web/src/models/Subscription.tsxSubscriptionDtoClient subscription information
Address/API/Web/src/models/Address.tsxAddressDtoAddress information
Contact/API/Web/src/models/Contact.tsxContactDtoContact information

Import/Export Models

ModelFrontend FileBackend RepresentationDescription
ImportLogItem/API/Web/src/models/ImportLogItem.tsxImportLogDetailDtoLog entry for import operations
ImportResults/API/Web/src/models/ImportResults.tsxN/AResults of import operations
AssetExcelFileDtoN/AAssetExcelFileDtoAsset data for Excel export
LeaseExcelFileDtoN/ALeaseExcelFileDtoLease data for Excel export

Report Models

ModelFrontend FileBackend RepresentationDescription
SummaryReportDtoN/ASummaryReportDtoData for summary reports
MethodologyReportDtoN/AMethodologyReportDtoData for methodology reports
StratificationSummaryReportDtoN/AStratificationSummaryReportDtoData for stratification reports
ChangesReportDtoN/AChangesReportDtoData for changes reports

Priority Models

Based on business requirements and core functionality, the following models should be prioritized for detailed documentation:

  1. Asset - Central entity in the system
  2. Component - Key part of asset composition
  3. Job - Critical for valuation workflow
  4. ValuationProfile - Essential for valuation configuration
  5. AssetAssumptions/ComponentAssumptions - Important for valuation calculations