✕
JSON Physical Model
Schema for:
Model name: IBPDI Real Estate CDM V1.0
Author:
Version:
File name: IBPDI Real Estate CDM V1.0.json
File path: /Users/joshuathiele/Desktop/IBPDI/CDM/CDM_V1.0/IBPDI Real Estate CDM V1.0.json
Printed On: Fri Sep 17 2021 18:03:21 GMT+0200 (Central European Summer Time)
Created with: Hackolade - Polyglot data modeling for NoSQL databases, storage formats, REST APIs, and JSON in RDBMS
1. Model
2. Groups
3. Relationships
- 3.1 fk Account. to IndividualAccount.
- 3.2 fk Address. to AddressBuilding.
- 3.3 fk Address. to AddressContact.
- 3.4 fk Address. to AddressLand.
- 3.5 fk Address. to AddressOrganisation.
- 3.6 fk Address. to AddressRentalUnit.
- 3.7 fk Address. to AddressSite.
- 3.8 fk AreaMeasurement. to AreaMeasurementBuilding.
- 3.9 fk AreaMeasurement. to AreaMeasurementFloor.
- 3.10 fk AreaMeasurement. to AreaMeasurementLand.
- 3.11 fk AreaMeasurement. to AreaMeasurementSite.
- 3.12 fk AreaMeasurement. to AreaMeasurementSpace.
- 3.13 fk AreaMeasurement. to AreaMeasurementUnit.
- 3.14 fk AreaMeasurement. to RentalUnitAreaMeasurement.
- 3.15 fk Building. to AddressBuilding.
- 3.16 fk Building. to AreaMeasurementBuilding.
- 3.17 fk Building. to CertificateBuilding.
- 3.18 fk Building. to ClimateBuilding.
- 3.19 fk Building. to ComponentBuilding.
- 3.20 fk Building. to CostCenterBuilding.
- 3.21 fk Building. to EmissionFactorBuilding.
- 3.22 fk Building. to Floor.
- 3.23 fk Building. to GhgEmissionBuilding.
- 3.24 fk Building. to IndividualAccountBuilding.
- 3.25 fk Building. to OperationalMeasurementBuilding.
- 3.26 fk Building. to PortfolioBuilding.
- 3.27 fk Building. to RentalUnitBuilding.
- 3.28 fk Building. to RoleBuilding.
- 3.29 fk Building. to SustainabilityIndicator.
- 3.30 fk Building. to UnitBuilding.
- 3.31 fk Building. to ValuationBuilding.
- 3.32 fk Certificate. to CertificateBuilding.
- 3.33 fk Certificate. to CertificateComponent.
- 3.34 fk Certificate. to CertificateSystem.
- 3.35 fk Certificate. to CertificateValuation.
- 3.36 fk Climate. to ClimateBuilding.
- 3.37 fk Climate. to ClimateSite.
- 3.38 fk Component. to CertificateComponent.
- 3.39 fk Component. to ComponentBuilding.
- 3.40 fk Component. to ComponentFloor.
- 3.41 fk Component. to ComponentSite.
- 3.42 fk Component. to ComponentSpace.
- 3.43 fk Component. to ComponentSystem.
- 3.44 fk Component. to ComponentUnit.
- 3.45 fk Contact. to AddressContact.
- 3.46 fk Contact. to RoleContact.
- 3.47 fk CostCenter. to CostCenterBuilding.
- 3.48 fk CostCenter. to CostCenterPortfolio.
- 3.49 fk CostCenter. to CostCenterRentalUnit.
- 3.50 fk CostCenter. to CostCenterSite.
- 3.51 fk CostCenter. to Transaction.
- 3.52 fk EmissionFactor. to EmissionFactorBuilding.
- 3.53 fk EmissionFactor. to EmissionFactorOperationalMeasurement.
- 3.54 fk EmissionFactor. to EmissionFactorRole.
- 3.55 fk EmissionFactor. to EmissionFactorSite.
- 3.56 fk EmissionFactor. to GhgEmissionEmissionFactor.
- 3.57 fk EmissionFactor. to SustainabilityIndicatorEmissionFactor.
- 3.58 fk Floor. to AreaMeasurementFloor.
- 3.59 fk Floor. to ComponentFloor.
- 3.60 fk Floor. to OperationalMeasurementFloor.
- 3.61 fk Floor. to RentalUnitFloor.
- 3.62 fk Floor. to Space.
- 3.63 fk Floor. to UnitFloor.
- 3.64 fk GhgEmission. to GhgEmissionBuilding.
- 3.65 fk GhgEmission. to GhgEmissionEmissionFactor.
- 3.66 fk GhgEmission. to GhgEmissionSite.
- 3.67 fk IndividualAccount. to IndividualAccountBuilding.
- 3.68 fk IndividualAccount. to IndividualAccountPortfolio.
- 3.69 fk IndividualAccount. to IndividualAccountSite.
- 3.70 fk IndividualAccount. to Portfolio.
- 3.71 fk IndividualAccount. to Transaction.
- 3.72 fk IndividualAccount. to ValuationIndividualAccount.
- 3.73 fk Land. to AddressLand.
- 3.74 fk Land. to AreaMeasurementLand.
- 3.75 fk Land. to OperationalMeasurementLand.
- 3.76 fk Land. to PortfolioLand.
- 3.77 fk Land. to RentalUnitLand.
- 3.78 fk Land. to RoleLand.
- 3.79 fk Land. to UnitLand.
- 3.80 fk Land. to ValuationLand.
- 3.81 fk OperationalMeasurement. to EmissionFactorOperationalMeasurement.
- 3.82 fk OperationalMeasurement. to GhgEmission.
- 3.83 fk OperationalMeasurement. to OperationalMeasurementBuilding.
- 3.84 fk OperationalMeasurement. to OperationalMeasurementFloor.
- 3.85 fk OperationalMeasurement. to OperationalMeasurementLand.
- 3.86 fk OperationalMeasurement. to OperationalMeasurementRole.
- 3.87 fk OperationalMeasurement. to OperationalMeasurementSite.
- 3.88 fk OperationalMeasurement. to OperationalMeasurementSpace.
- 3.89 fk OperationalMeasurement. to OperationalMeasurementUnit.
- 3.90 fk OperationalMeasurement. to ValuationOperationalMeasurement.
- 3.91 fk Organisation. to AddressOrganisation.
- 3.92 fk Organisation. to Contact.
- 3.93 fk Organisation. to CostCenter.
- 3.94 fk Organisation. to IndividualAccount.
- 3.95 fk Organisation. to RoleOrganisation.
- 3.96 fk Portfolio. to CostCenterPortfolio.
- 3.97 fk Portfolio. to IndividualAccount.
- 3.98 fk Portfolio. to PortfolioBuilding.
- 3.99 fk Portfolio. to PortfolioLand.
- 3.100 fk Portfolio. to PortfolioSite.
- 3.101 fk Portfolio. to PortfolioStrategy.
- 3.102 fk Portfolio. to PortfolioUnit.
- 3.103 fk Portfolio. to RolePortfolio.
- 3.104 fk Portfolio. to RolePortfolioStrategy.
- 3.105 fk RentalContract. to RentalContractRentalUnit.
- 3.106 fk RentalContract. to RentalContractRole.
- 3.107 fk RentalContract. to RentalOption.
- 3.108 fk RentalContract. to RentalPayment.
- 3.109 fk RentalPayment. to Dunning.
- 3.110 fk RentalUnit. to AddressRentalUnit.
- 3.111 fk RentalUnit. to CostCenterRentalUnit.
- 3.112 fk RentalUnit. to RentalContractRentalUnit.
- 3.113 fk RentalUnit. to RentalUnitAreaMeasurement.
- 3.114 fk RentalUnit. to RentalUnitBuilding.
- 3.115 fk RentalUnit. to RentalUnitFloor.
- 3.116 fk RentalUnit. to RentalUnitLand.
- 3.117 fk RentalUnit. to RentalUnitSpace.
- 3.118 fk RentalUnit. to RentalUnitUnit.
- 3.119 fk RentalUnit. to RoleRentalUnit.
- 3.120 fk RentalUnit. to TenantCommunication.
- 3.121 fk Role. to EmissionFactorRole.
- 3.122 fk Role. to OperationalMeasurementRole.
- 3.123 fk Role. to RentalContractRole.
- 3.124 fk Role. to RoleBuilding.
- 3.125 fk Role. to RoleContact.
- 3.126 fk Role. to RoleLand.
- 3.127 fk Role. to RoleOrganisation.
- 3.128 fk Role. to RolePortfolio.
- 3.129 fk Role. to RolePortfolioStrategy.
- 3.130 fk Role. to RoleRentalUnit.
- 3.131 fk Role. to RoleSite.
- 3.132 fk Role. to RoleValuation.
- 3.133 fk Role. to TenantCommunicationRole.
- 3.134 fk Servitudes. to Land.
- 3.135 fk Site. to AddressSite.
- 3.136 fk Site. to AreaMeasurementSite.
- 3.137 fk Site. to Building.
- 3.138 fk Site. to ClimateSite.
- 3.139 fk Site. to ComponentSite.
- 3.140 fk Site. to CostCenterSite.
- 3.141 fk Site. to EmissionFactorSite.
- 3.142 fk Site. to GhgEmissionSite.
- 3.143 fk Site. to IndividualAccountSite.
- 3.144 fk Site. to Land.
- 3.145 fk Site. to OperationalMeasurementSite.
- 3.146 fk Site. to PortfolioSite.
- 3.147 fk Site. to RoleSite.
- 3.148 fk Site. to UnitSite.
- 3.149 fk Space. to AreaMeasurementSpace.
- 3.150 fk Space. to ComponentSpace.
- 3.151 fk Space. to OperationalMeasurementSpace.
- 3.152 fk Space. to RentalUnitSpace.
- 3.153 fk Space. to UnitSpace.
- 3.154 fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor.
- 3.155 fk System. to CertificateSystem.
- 3.156 fk System. to ComponentSystem.
- 3.157 fk TenantCommunication. to TenantCommunicationRole.
- 3.158 fk Type. to Component.
- 3.159 fk Unit. to AreaMeasurementUnit.
- 3.160 fk Unit. to ComponentUnit.
- 3.161 fk Unit. to OperationalMeasurementUnit.
- 3.162 fk Unit. to PortfolioUnit.
- 3.163 fk Unit. to RentalUnitUnit.
- 3.164 fk Unit. to UnitBuilding.
- 3.165 fk Unit. to UnitFloor.
- 3.166 fk Unit. to UnitLand.
- 3.167 fk Unit. to UnitSite.
- 3.168 fk Unit. to UnitSpace.
- 3.169 fk Valuation. to CertificateValuation.
- 3.170 fk Valuation. to RoleValuation.
- 3.171 fk Valuation. to ValuationBuilding.
- 3.172 fk Valuation. to ValuationIndividualAccount.
- 3.173 fk Valuation. to ValuationLand.
- 3.174 fk Valuation. to ValuationOperationalMeasurement.
1. Model
1.1 Model IBPDI Real Estate CDM V1.0
1.1.1 IBPDI Real Estate CDM V1.0 Entity Relationship Diagram
1.1.2 IBPDI Real Estate CDM V1.0 Properties
1.1.2.1 Details tab
| Property | Value |
| Model name | IBPDI Real Estate CDM V1.0 |
| Technical name | |
| Description | |
| Author | |
| DB vendor | JSON |
| DB version | draft-04 |
| Version | |
| Comments | |
| Synchronization Id | |
| Lineage |
1.1.3 IBPDI Real Estate CDM V1.0 DB Definitions
2. Groups
2.1 Group DigitalTwin
2.1.1 DigitalTwin Properties
| Property | Value |
| Group name | DigitalTwin |
| Technical name | |
| Activated | true |
| Description | Comprising all information regarding a building such as area measurements, installed equipment etc. |
| Comments |
2.1.2 DigitalTwin Documents
2.1.2.1 Document AreaMeasurement
2.1.2.1.1 AreaMeasurement Tree Diagram
2.1.2.1.2 AreaMeasurement Properties
| Property | Value |
| Document name | AreaMeasurement |
| Technical name | ArMsrmnt |
| Activated | true |
| Id | |
| Description | Information about the area measurements within the physical building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.1.3 AreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Standard | string | true | Area measurement standard | ||
| Type | string | true | Type of the standard area | ||
| Value | number | true | Value of measurement | [{"dataType":"float"}] | |
| Unit | string | true | Unit area is measured with | ||
| ValidFrom | date-time | true | Date measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.1.3.1 Field AreaMeasurementId
2.1.2.1.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | AM-CH-SE-2312 |
| Comments |
2.1.2.1.3.2 Field Standard
2.1.2.1.3.2.1 Standard properties
| Property | Value |
| Name | Standard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Area measurement standard |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | DIN 277-1,MFG,IPMS,RICS,BOMA,NA |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Din 277-1 |
| Comments |
2.1.2.1.3.3 Field Type
2.1.2.1.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the standard area |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Gross floor area,Construction area,Net room area,Circulation area,Net usable area,Technical area,Living/residence area,Office area,Production/laboratory area,Storage/distribution/selling area,Education/teaching/culture area,Healing/care area,Other uses,Rentable exclusion,Rentable area,Rentable area common occupancy,Rentable area exclusive occupancy,Gross external area,External Wall area,Gross internal area,A-Vertical penetrations,B-Structural elements,C-Technical services,D-Hygiene areas,E-Circulation areas,F-Amenities,G-Workspace,H-Other areas,Boundary area,Rentable area common occupancy,Building amenity area,Building service area,Floor service area,Rentable area exclusive occupancy,Tenant ancillary area,Tenant area,Major vertical penetrations,Occupant Storage area,Parking area,Unenclosed Building Feature: Covered Gallery,Vacant area,NA |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | G-Workspace |
| Comments |
2.1.2.1.3.4 Field Value
2.1.2.1.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | Vl |
| Activated | true |
| Id | |
| Description | Value of measurement |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 230.45 |
| Comments | [{"dataType":"float"}] |
2.1.2.1.3.5 Field Unit
2.1.2.1.3.5.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | Unt |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit area is measured with |
| Format | |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | m²,ft² |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | m² |
| Comments |
2.1.2.1.3.6 Field ValidFrom
2.1.2.1.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.1.3.7 Field ValidUntil
2.1.2.1.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date measurement is not valid anymore /needs to be renewed in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.1.4 AreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurement",
"description": "Information about the area measurements within the physical building",
"additionalProperties": false,
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Standard": {
"type": "string",
"description": "Area measurement standard",
"enum": [
"DIN 277-1",
"MFG",
"IPMS",
"RICS",
"BOMA",
"NA"
],
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"Type": {
"type": "string",
"description": "Type of the standard area",
"enum": [
"Gross floor area",
"Construction area",
"Net room area",
"Circulation area",
"Net usable area",
"Technical area",
"Living/residence area",
"Office area",
"Production/laboratory area",
"Storage/distribution/selling area",
"Education/teaching/culture area",
"Healing/care area",
"Other uses",
"Rentable exclusion",
"Rentable area",
"Rentable area common occupancy",
"Rentable area exclusive occupancy",
"Gross external area",
"External Wall area",
"Gross internal area",
"A-Vertical penetrations",
"B-Structural elements",
"C-Technical services",
"D-Hygiene areas",
"E-Circulation areas",
"F-Amenities",
"G-Workspace",
"H-Other areas",
"Boundary area",
"Rentable area common occupancy",
"Building amenity area",
"Building service area",
"Floor service area",
"Rentable area exclusive occupancy",
"Tenant ancillary area",
"Tenant area",
"Major vertical penetrations",
"Occupant Storage area",
"Parking area",
"Unenclosed Building Feature: Covered Gallery",
"Vacant area",
"NA"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vl": {
"type": "number",
"title": "Value",
"description": "Value of measurement",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"Unt": {
"type": "string",
"title": "Unit",
"description": "Unit area is measured with",
"enum": [
"m²",
"ft²"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date measurement is not valid anymore /needs to be renewed in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"AreaMeasurementId",
"Standard",
"Type",
"Vl",
"Unt",
"ValidFrom",
"ValidUntil"
]
}2.1.2.1.5 AreaMeasurement JSON data
{
"AreaMeasurementId": "AM-CH-SE-2312",
"Standard": "Din 277-1",
"Type": "G-Workspace",
"Vl": 230.45,
"Unt": "m²",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.1.2.2 Document AreaMeasurementBuilding
2.1.2.2.1 AreaMeasurementBuilding Tree Diagram
2.1.2.2.2 AreaMeasurementBuilding Properties
| Property | Value |
| Document name | AreaMeasurementBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.2.3 AreaMeasurementBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.2.3.1 Field AreaMeasurementId
2.1.2.2.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementBuilding. |
| Cardinality | 0..1 |
| Sample | AM-CH-SE-23123 |
| Comments |
2.1.2.2.3.2 Field BuildingId
2.1.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to AreaMeasurementBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.2.4 AreaMeasurementBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementBuilding",
"description": "Linking entity between AreaMeasurement and Building",
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AreaMeasurementId",
"BuildingId"
]
}2.1.2.2.5 AreaMeasurementBuilding JSON data
{
"AreaMeasurementId": "AM-CH-SE-23123",
"BuildingId": "SE-CH-2341"
}2.1.2.3 Document AreaMeasurementFloor
2.1.2.3.1 AreaMeasurementFloor Tree Diagram
2.1.2.3.2 AreaMeasurementFloor Properties
| Property | Value |
| Document name | AreaMeasurementFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Floor |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.3.3 AreaMeasurementFloor Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| FloorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.3.3.1 Field AreaMeasurementId
2.1.2.3.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementFloor. |
| Cardinality | 0..1 |
| Sample | AM-CH-SE-231231 |
| Comments |
2.1.2.3.3.2 Field FloorId
2.1.2.3.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to AreaMeasurementFloor. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.3.4 AreaMeasurementFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementFloor",
"description": "Linking entity between AreaMeasurement and Floor",
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"AreaMeasurementId",
"FloorId"
]
}2.1.2.3.5 AreaMeasurementFloor JSON data
{
"AreaMeasurementId": "AM-CH-SE-231231",
"FloorId": "SE-CH-F-01"
}2.1.2.4 Document AreaMeasurementLand
2.1.2.4.1 AreaMeasurementLand Tree Diagram
2.1.2.4.2 AreaMeasurementLand Properties
| Property | Value |
| Document name | AreaMeasurementLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Land |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.4.3 AreaMeasurementLand Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.4.3.1 Field AreaMeasurementId
2.1.2.4.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementLand. |
| Cardinality | 0..1 |
| Sample | RE-AT-052 |
| Comments |
2.1.2.4.3.2 Field LandId
2.1.2.4.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to AreaMeasurementLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.1.2.4.4 AreaMeasurementLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementLand",
"description": "Linking entity between AreaMeasurement and Land",
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AreaMeasurementId",
"LandId"
]
}2.1.2.4.5 AreaMeasurementLand JSON data
{
"AreaMeasurementId": "RE-AT-052",
"LandId": "RE-AT-05"
}2.1.2.5 Document AreaMeasurementSite
2.1.2.5.1 AreaMeasurementSite Tree Diagram
2.1.2.5.2 AreaMeasurementSite Properties
| Property | Value |
| Document name | AreaMeasurementSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Site |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.5.3 AreaMeasurementSite Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.5.3.1 Field AreaMeasurementId
2.1.2.5.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementSite. |
| Cardinality | 0..1 |
| Sample | AM-CH-SE-2312 |
| Comments |
2.1.2.5.3.2 Field SiteId
2.1.2.5.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to AreaMeasurementSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.1.2.5.4 AreaMeasurementSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementSite",
"description": "Linking entity between AreaMeasurement and Site",
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"AreaMeasurementId",
"SiteId"
]
}2.1.2.5.5 AreaMeasurementSite JSON data
{
"AreaMeasurementId": "AM-CH-SE-2312",
"SiteId": "AE-DE-02"
}2.1.2.6 Document AreaMeasurementSpace
2.1.2.6.1 AreaMeasurementSpace Tree Diagram
2.1.2.6.2 AreaMeasurementSpace Properties
| Property | Value |
| Document name | AreaMeasurementSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Space |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.6.3 AreaMeasurementSpace Fields
| Field | Type | Req | Key | Description | Comments |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SpaceId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.6.3.1 Field AreaMeasurementId
2.1.2.6.3.1.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementSpace. |
| Cardinality | 0..1 |
| Sample | AM-CH-SE-2312312 |
| Comments |
2.1.2.6.3.2 Field SpaceId
2.1.2.6.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | Foreign Key |
| Relationship name | fk Space. to AreaMeasurementSpace. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.6.4 AreaMeasurementSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementSpace",
"description": "Linking entity between AreaMeasurement and Space",
"properties": {
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"AreaMeasurementId",
"SpaceId"
]
}2.1.2.6.5 AreaMeasurementSpace JSON data
{
"AreaMeasurementId": "AM-CH-SE-2312312",
"SpaceId": "SE-CH-F-01-21"
}2.1.2.7 Document AreaMeasurementUnit
2.1.2.7.1 AreaMeasurementUnit Tree Diagram
2.1.2.7.2 AreaMeasurementUnit Properties
| Property | Value |
| Document name | AreaMeasurementUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between AreaMeasurement and Unit |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.7.3 AreaMeasurementUnit Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.7.3.1 Field UnitId
2.1.2.7.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to AreaMeasurementUnit. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.7.3.2 Field AreaMeasurementId
2.1.2.7.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to AreaMeasurementUnit. |
| Cardinality | 0..1 |
| Sample | Am-UN-SE-CH-2341-02 |
| Comments |
2.1.2.7.4 AreaMeasurementUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AreaMeasurementUnit",
"description": "Linking entity between AreaMeasurement and Unit",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"AreaMeasurementId"
]
}2.1.2.7.5 AreaMeasurementUnit JSON data
{
"UnitId": "UN-SE-CH-2341-02",
"AreaMeasurementId": "Am-UN-SE-CH-2341-02"
}2.1.2.8 Document Building
2.1.2.8.1 Building Tree Diagram
2.1.2.8.2 Building Properties
| Property | Value |
| Document name | Building |
| Technical name | |
| Activated | true |
| Id | |
| Description | A building represents a structure that provides shelter for its occupants or contents and stands in one place. The building is also used to provide a basic element within the spatial structure hierarchy for the components of a building project (together with site, storey, and space) |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.8.3 Building Fields
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Reference to the Site which the building belongs to | |
| Name | string | true | User specific building name e.g: EMEA Headquarter, Office Berlin | ||
| BuildingCode | string | false | User specific Building Code | ||
| PrimaryTypeOfBuilding | string | true | Type of building use | ||
| SecondaryTypeOfBuilding | string | true | Second type of building use | ||
| EnergyEfficiencyClass | string | false | Energy Efficiency Class of Building | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ConstructionYear | date-time | false | Year of construction in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| YearOfLastRefurbishment | date-time | false | Year of last refurbishment took place in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| MonumentProtection | boolean | false | The building is declared to be an ancient monument with national importance by the government | ||
| TypeOfOwnership | string | true | Is the building owned or leased. | ||
| SelfUse | boolean | false | Is building self used or not (Y/N) | ||
| TenantStructure | string | true | Is there multiple tenants in the building or only one | ||
| ParkingSpaces | integer | false | Number of parking spaces | ||
| PrimaryEnergyType | string | false | Type of energy used | ||
| PrimaryWaterType | string | false | Type of water used | ||
| PrimaryHeatingType | string | false | Primary Type of heating | ||
| SecondaryHeatingType | string | false | Secondary Type of heating | ||
| AirConditioning | boolean | false | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) |
2.1.2.8.3.1 Field BuildingId
2.1.2.8.3.1.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.8.3.2 Field SiteId
2.1.2.8.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Site which the building belongs to |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to Building. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.1.2.8.3.3 Field Name
2.1.2.8.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific building name e.g: EMEA Headquarter, Office Berlin |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | HQ Berlin |
| Comments |
2.1.2.8.3.4 Field BuildingCode
2.1.2.8.3.4.1 BuildingCode properties
| Property | Value |
| Name | BuildingCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Building Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BC001 |
| Comments |
2.1.2.8.3.5 Field PrimaryTypeOfBuilding
2.1.2.8.3.5.1 PrimaryTypeOfBuilding properties
| Property | Value |
| Name | PrimaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of building use |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Shopping Center,Retail, Strip Mall,Retail, Lifestyle Center,Retail, Warehouse,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Low-Rise Office,Office, Mid-Rise Office,Office, High-Rise Office,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Residential Multi-Family,Residential, Low-Rise Multi-Family,Residential, Mid-Rise Multi-Family,Residential, High-Rise Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Hotel,Lodging, Leisure & Recreation,Lodging, Leisure & Recreation, Indoor Arena,Lodging, Leisure & Recreation, Fitness Center,Lodging, Leisure & Recreation, Performing Arts,Lodging, Leisure & Recreation, Swimming Center,Lodging, Leisure & Recreation, Museum/Gallery,Lodging, Leisure & Recreation, Other,Education,Education, School,Education, University,Education, Library,Education, Other,Technology/Science,Technology/Science, Data Center,Technology/Science, Laboratory/Life sciences,Technology/Science, Other,Healthcare,Healthcare, Healthcare Center,Healthcare, Senior Homes,Healthcare, Other,Mixed Use,Mixed Use, Office/Retail,Mixed Use, Office/Residential,Mixed Use, Office/Industrial,Mixed Use, Other,Other,Other, Parking (Indoors),Other, Self-Storage |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Industrial, Industrial Park |
| Comments |
2.1.2.8.3.6 Field SecondaryTypeOfBuilding
2.1.2.8.3.6.1 SecondaryTypeOfBuilding properties
| Property | Value |
| Name | SecondaryTypeOfBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Second type of building use |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Retail,Retail, High Street,Retail, Retail Centers,Retail, Shopping Center,Retail, Strip Mall,Retail, Lifestyle Center,Retail, Warehouse,Retail, Restaurants/Bars,Retail, Other,Office,Office, Corporate,Office, Low-Rise Office,Office, Mid-Rise Office,Office, High-Rise Office,Office, Medical Office,Office, Business Park,Office, Other,Industrial,Industrial, Distribution Warehouse,Industrial, Industrial Park,Industrial, Manufacturing,Industrial, Other,Residential,Residential, Residential Multi-Family,Residential, Low-Rise Multi-Family,Residential, Mid-Rise Multi-Family,Residential, High-Rise Multi-Family,Residential, Family Homes,Residential, Student Housing,Residential, Retirement Living,Residential, Other,Hotel,Lodging, Leisure & Recreation,Lodging, Leisure & Recreation, Indoor Arena,Lodging, Leisure & Recreation, Fitness Center,Lodging, Leisure & Recreation, Performing Arts,Lodging, Leisure & Recreation, Swimming Center,Lodging, Leisure & Recreation, Museum/Gallery,Lodging, Leisure & Recreation, Other,Education,Education, School,Education, University,Education, Library,Education, Other,Technology/Science,Technology/Science, Data Center,Technology/Science, Laboratory/Life sciences,Technology/Science, Other,Healthcare,Healthcare, Healthcare Center,Healthcare, Senior Homes,Healthcare, Other,Mixed Use,Mixed Use, Office/Retail,Mixed Use, Office/Residential,Mixed Use, Office/Industrial,Mixed Use, Other,Other,Other, Parking (Indoors),Other, Self-Storage |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Industrial, Manufacturing |
| Comments |
2.1.2.8.3.7 Field EnergyEfficiencyClass
2.1.2.8.3.7.1 EnergyEfficiencyClass properties
| Property | Value |
| Name | EnergyEfficiencyClass |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Energy Efficiency Class of Building |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | C |
| Comments |
2.1.2.8.3.8 Field ValidFrom
2.1.2.8.3.8.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | VldFrm |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.8.3.9 Field ValidUntil
2.1.2.8.3.9.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | Vldntl |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.8.3.10 Field ConstructionYear
2.1.2.8.3.10.1 ConstructionYear properties
| Property | Value |
| Name | ConstructionYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of construction in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.8.3.11 Field YearOfLastRefurbishment
2.1.2.8.3.11.1 YearOfLastRefurbishment properties
| Property | Value |
| Name | YearOfLastRefurbishment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Year of last refurbishment took place in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00. |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.8.3.12 Field MonumentProtection
2.1.2.8.3.12.1 MonumentProtection properties
| Property | Value |
| Name | MonumentProtection |
| Technical name | |
| Activated | true |
| Id | |
| Description | The building is declared to be an ancient monument with national importance by the government |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.8.3.13 Field TypeOfOwnership
2.1.2.8.3.13.1 TypeOfOwnership properties
| Property | Value |
| Name | TypeOfOwnership |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is the building owned or leased. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Owner,Tenant |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Owner |
| Comments |
2.1.2.8.3.14 Field SelfUse
2.1.2.8.3.14.1 SelfUse properties
| Property | Value |
| Name | SelfUse |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is building self used or not (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.8.3.15 Field TenantStructure
2.1.2.8.3.15.1 TenantStructure properties
| Property | Value |
| Name | TenantStructure |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Is there multiple tenants in the building or only one |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Single-tenant,Multi-tenant |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Single-tenant |
| Comments |
2.1.2.8.3.16 Field ParkingSpaces
2.1.2.8.3.16.1 ParkingSpaces properties
| Property | Value |
| Name | ParkingSpaces |
| Technical name | |
| Activated | true |
| Id | |
| Description | Number of parking spaces |
| Type | integer |
| Min value | 0 |
| Excl min | |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 89 |
| Comments |
2.1.2.8.3.17 Field PrimaryEnergyType
2.1.2.8.3.17.1 PrimaryEnergyType properties
| Property | Value |
| Name | PrimaryEnergyType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of energy used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Natural Gas,Coal,Nuclear,Petroleum,Hydropower,Wind,Biomass,Geothermal,Solar |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.1.2.8.3.18 Field PrimaryWaterType
2.1.2.8.3.18.1 PrimaryWaterType properties
| Property | Value |
| Name | PrimaryWaterType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of water used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.1.2.8.3.19 Field PrimaryHeatingType
2.1.2.8.3.19.1 PrimaryHeatingType properties
| Property | Value |
| Name | PrimaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Primary Type of heating |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | District heating,Natural gas,Oil-based fuels,Solar thermal,Unspecified,Heat pump,Electricity (radiator) |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | District Heating |
| Comments |
2.1.2.8.3.20 Field SecondaryHeatingType
2.1.2.8.3.20.1 SecondaryHeatingType properties
| Property | Value |
| Name | SecondaryHeatingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Secondary Type of heating |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | District heating,Natural gas,Oil-based fuels,Solar thermal,Unspecified,Heat pump,Electricity (radiator) |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Solar thermal |
| Comments |
2.1.2.8.3.21 Field AirConditioning
2.1.2.8.3.21.1 AirConditioning properties
| Property | Value |
| Name | AirConditioning |
| Technical name | |
| Activated | true |
| Id | |
| Description | Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.8.4 Building JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Building",
"description": "A building represents a structure that provides shelter for its occupants or contents and stands in one place. The building is also used to provide a basic element within the spatial structure hierarchy for the components of a building project (together with site, storey, and space)",
"additionalProperties": false,
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Std": {
"type": "string",
"title": "SiteId",
"description": "Reference to the Site which the building belongs to",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "User specific building name e.g: EMEA Headquarter, Office Berlin",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingCode": {
"type": "string",
"description": "User specific Building Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryTypeOfBuilding": {
"type": "string",
"description": "Type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Shopping Center",
"Retail, Strip Mall",
"Retail, Lifestyle Center",
"Retail, Warehouse",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Low-Rise Office",
"Office, Mid-Rise Office",
"Office, High-Rise Office",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Residential Multi-Family",
"Residential, Low-Rise Multi-Family",
"Residential, Mid-Rise Multi-Family",
"Residential, High-Rise Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Hotel",
"Lodging, Leisure & Recreation",
"Lodging, Leisure & Recreation, Indoor Arena",
"Lodging, Leisure & Recreation, Fitness Center",
"Lodging, Leisure & Recreation, Performing Arts",
"Lodging, Leisure & Recreation, Swimming Center",
"Lodging, Leisure & Recreation, Museum/Gallery",
"Lodging, Leisure & Recreation, Other",
"Education",
"Education, School",
"Education, University",
"Education, Library",
"Education, Other",
"Technology/Science",
"Technology/Science, Data Center",
"Technology/Science, Laboratory/Life sciences",
"Technology/Science, Other",
"Healthcare",
"Healthcare, Healthcare Center",
"Healthcare, Senior Homes",
"Healthcare, Other",
"Mixed Use",
"Mixed Use, Office/Retail",
"Mixed Use, Office/Residential",
"Mixed Use, Office/Industrial",
"Mixed Use, Other",
"Other",
"Other, Parking (Indoors)",
"Other, Self-Storage"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryTypeOfBuilding": {
"type": "string",
"description": "Second type of building use",
"enum": [
"Retail",
"Retail, High Street",
"Retail, Retail Centers",
"Retail, Shopping Center",
"Retail, Strip Mall",
"Retail, Lifestyle Center",
"Retail, Warehouse",
"Retail, Restaurants/Bars",
"Retail, Other",
"Office",
"Office, Corporate",
"Office, Low-Rise Office",
"Office, Mid-Rise Office",
"Office, High-Rise Office",
"Office, Medical Office",
"Office, Business Park",
"Office, Other",
"Industrial",
"Industrial, Distribution Warehouse",
"Industrial, Industrial Park",
"Industrial, Manufacturing",
"Industrial, Other",
"Residential",
"Residential, Residential Multi-Family",
"Residential, Low-Rise Multi-Family",
"Residential, Mid-Rise Multi-Family",
"Residential, High-Rise Multi-Family",
"Residential, Family Homes",
"Residential, Student Housing",
"Residential, Retirement Living",
"Residential, Other",
"Hotel",
"Lodging, Leisure & Recreation",
"Lodging, Leisure & Recreation, Indoor Arena",
"Lodging, Leisure & Recreation, Fitness Center",
"Lodging, Leisure & Recreation, Performing Arts",
"Lodging, Leisure & Recreation, Swimming Center",
"Lodging, Leisure & Recreation, Museum/Gallery",
"Lodging, Leisure & Recreation, Other",
"Education",
"Education, School",
"Education, University",
"Education, Library",
"Education, Other",
"Technology/Science",
"Technology/Science, Data Center",
"Technology/Science, Laboratory/Life sciences",
"Technology/Science, Other",
"Healthcare",
"Healthcare, Healthcare Center",
"Healthcare, Senior Homes",
"Healthcare, Other",
"Mixed Use",
"Mixed Use, Office/Retail",
"Mixed Use, Office/Residential",
"Mixed Use, Office/Industrial",
"Mixed Use, Other",
"Other",
"Other, Parking (Indoors)",
"Other, Self-Storage"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiencyClass": {
"type": "string",
"description": "Energy Efficiency Class of Building",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"VldFrm": {
"type": "string",
"title": "ValidFrom",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Vldntl": {
"type": "string",
"title": "ValidUntil",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ConstructionYear": {
"type": "string",
"description": "Year of construction in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"format": "date-time"
},
"YearOfLastRefurbishment": {
"type": "string",
"description": "Year of last refurbishment took place in yyyy-mm-ddThh:mm:ssZ form (conform ISO 8061). In case only year exists use yyyy-01-01 00:00:00.",
"format": "date-time"
},
"MonumentProtection": {
"type": "boolean",
"description": "The building is declared to be an ancient monument with national importance by the government"
},
"TypeOfOwnership": {
"type": "string",
"description": "Is the building owned or leased.",
"enum": [
"Owner",
"Tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SelfUse": {
"type": "boolean",
"description": "Is building self used or not (Y/N)"
},
"TenantStructure": {
"type": "string",
"description": "Is there multiple tenants in the building or only one",
"enum": [
"Single-tenant",
"Multi-tenant"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParkingSpaces": {
"type": "integer",
"description": "Number of parking spaces",
"maximum": 9999,
"minimum": 0
},
"PrimaryEnergyType": {
"type": "string",
"description": "Type of energy used",
"minLength": 1,
"maxLength": 50,
"enum": [
"Natural Gas",
"Coal",
"Nuclear",
"Petroleum",
"Hydropower",
"Wind",
"Biomass",
"Geothermal",
"Solar"
],
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWaterType": {
"type": "string",
"description": "Type of water used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryHeatingType": {
"type": "string",
"description": "Primary Type of heating",
"enum": [
"District heating",
"Natural gas",
"Oil-based fuels",
"Solar thermal",
"Unspecified",
"Heat pump",
"Electricity (radiator)"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryHeatingType": {
"type": "string",
"description": "Secondary Type of heating",
"enum": [
"District heating",
"Natural gas",
"Oil-based fuels",
"Solar thermal",
"Unspecified",
"Heat pump",
"Electricity (radiator)"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AirConditioning": {
"type": "boolean",
"description": "Does the building have air conditioning (Y/N) (Needed for precise future emissions projection of building)"
}
},
"required": [
"BuildingId",
"Std",
"Name",
"PrimaryTypeOfBuilding",
"SecondaryTypeOfBuilding",
"VldFrm",
"Vldntl",
"TypeOfOwnership",
"TenantStructure"
]
}2.1.2.8.5 Building JSON data
{
"BuildingId": "SE-CH-2341",
"Std": "AE-DE-02",
"Name": "HQ Berlin",
"BuildingCode": "BC001",
"PrimaryTypeOfBuilding": "Industrial, Industrial Park",
"SecondaryTypeOfBuilding": "Industrial, Manufacturing",
"EnergyEfficiencyClass": "C",
"VldFrm": "2011-06-14T04:12:36.123Z",
"Vldntl": "2011-06-14T04:12:36.123Z",
"ConstructionYear": "2011-06-14T04:12:36.123Z",
"YearOfLastRefurbishment": "2011-06-14T04:12:36.123Z",
"MonumentProtection": true,
"TypeOfOwnership": "Owner",
"SelfUse": true,
"TenantStructure": "Single-tenant",
"ParkingSpaces": 89,
"PrimaryEnergyType": "dtdS",
"PrimaryWaterType": "'BgthBJuQ1H8ZodnN,HugyRbS_wf",
"PrimaryHeatingType": "District Heating",
"SecondaryHeatingType": "Solar thermal",
"AirConditioning": true
}2.1.2.9 Document Certificate
2.1.2.9.1 Certificate Tree Diagram
2.1.2.9.2 Certificate Properties
| Property | Value |
| Document name | Certificate |
| Technical name | |
| Activated | true |
| Id | |
| Description | Any official document related to building, equipment, system etc. |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.9.3 Certificate Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Certificate | ||
| Type | string | true | Type of Certificate e.g: LEED, BREEAM, DGNB | ||
| Value | string | true | Score, Grade if applicable for the certificate | ||
| IssuingDate | date-time | false | Date certificate was issued in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"DateTime"}] | |
| ValidFrom | date-time | true | Date certificate is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date certificate expires in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| CertificateUrl | string | false | Certificate Url | ||
| DocumentId | string | false | Link to document | does not exist yet |
2.1.2.9.3.1 Field CertificateId
2.1.2.9.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.9.3.2 Field Name
2.1.2.9.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Certificate |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | DGNB Platin |
| Comments |
2.1.2.9.3.3 Field Type
2.1.2.9.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Certificate e.g: LEED, BREEAM, DGNB |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | LEED |
| Comments |
2.1.2.9.3.4 Field Value
2.1.2.9.3.4.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Score, Grade if applicable for the certificate |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Platin |
| Comments |
2.1.2.9.3.5 Field IssuingDate
2.1.2.9.3.5.1 IssuingDate properties
| Property | Value |
| Name | IssuingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate was issued in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"DateTime"}] |
2.1.2.9.3.6 Field ValidFrom
2.1.2.9.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.9.3.7 Field ValidUntil
2.1.2.9.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date certificate expires in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.9.3.8 Field CertificateUrl
2.1.2.9.3.8.1 CertificateUrl properties
| Property | Value |
| Name | CertificateUrl |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Certificate Url |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.1.2.9.3.9 Field DocumentId
2.1.2.9.3.9.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to document |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | does not exist yet |
2.1.2.9.4 Certificate JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Certificate",
"description": "Any official document related to building, equipment, system etc.",
"additionalProperties": false,
"properties": {
"CertificateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Certificate",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Certificate e.g: LEED, BREEAM, DGNB",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "string",
"description": "Score, Grade if applicable for the certificate",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"IssuingDate": {
"type": "string",
"description": "Date certificate was issued in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidFrom": {
"type": "string",
"description": "Date certificate is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date certificate expires in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"CertificateUrl": {
"type": "string",
"description": "Certificate Url",
"minLength": 1,
"maxLength": 200
},
" DocumentId": {
"type": "string",
"description": "Link to document",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"Name",
"Type",
"Value",
"ValidFrom",
"ValidUntil"
]
}2.1.2.9.5 Certificate JSON data
{
"CertificateId": "CE-B8-2414",
"Name": "DGNB Platin",
"Type": "LEED",
"Value": "Platin",
"IssuingDate": "2011-06-14T04:12:36.123Z",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"CertificateUrl": "Lorem",
" DocumentId": "okW4-f*D7OB"
}2.1.2.10 Document CertificateBuilding
2.1.2.10.1 CertificateBuilding Tree Diagram
2.1.2.10.2 CertificateBuilding Properties
| Property | Value |
| Document name | CertificateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between certificate and building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.10.3 CertificateBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.10.3.1 Field CertificateId
2.1.2.10.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | Foreign Key |
| Relationship name | fk Certificate. to CertificateBuilding. |
| Cardinality | 0..n |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.10.3.2 Field BuildingId
2.1.2.10.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to CertificateBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.10.4 CertificateBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateBuilding",
"description": "Linking entity between certificate and building",
"properties": {
"CertificateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"BuildingId"
]
}2.1.2.10.5 CertificateBuilding JSON data
{
"CertificateId": "CE-B8-2414",
"BuildingId": "SE-CH-2341"
}2.1.2.11 Document CertificateComponent
2.1.2.11.1 CertificateComponent Tree Diagram
2.1.2.11.2 CertificateComponent Properties
| Property | Value |
| Document name | CertificateComponent |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between certificate and component |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.11.3 CertificateComponent Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.11.3.1 Field CertificateId
2.1.2.11.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | Foreign Key |
| Relationship name | fk Certificate. to CertificateComponent. |
| Cardinality | 0..n |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.11.3.2 Field ComponentId
2.1.2.11.3.2.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to CertificateComponent. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.11.4 CertificateComponent JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateComponent",
"description": "Linking entity between certificate and component",
"properties": {
"CertificateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ComponentId"
]
}2.1.2.11.5 CertificateComponent JSON data
{
"CertificateId": "CE-B8-2414",
"ComponentId": "C-01"
}2.1.2.12 Document CertificateSystem
2.1.2.12.1 CertificateSystem Tree Diagram
2.1.2.12.2 CertificateSystem Properties
| Property | Value |
| Document name | CertificateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between certificate and system |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.12.3 CertificateSystem Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SystemId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.12.3.1 Field CertificateId
2.1.2.12.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | Foreign Key |
| Relationship name | fk Certificate. to CertificateSystem. |
| Cardinality | 0..n |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.12.3.2 Field SystemId
2.1.2.12.3.2.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | Foreign Key |
| Relationship name | fk System. to CertificateSystem. |
| Cardinality | 0..n |
| Sample | S-17281 |
| Comments |
2.1.2.12.4 CertificateSystem JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateSystem",
"description": "Linking entity between certificate and system",
"properties": {
"CertificateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"SystemId"
]
}2.1.2.12.5 CertificateSystem JSON data
{
"CertificateId": "CE-B8-2414",
"SystemId": "S-17281"
}2.1.2.13 Document CertificateValuation
2.1.2.13.1 CertificateValuation Tree Diagram
2.1.2.13.2 CertificateValuation Properties
| Property | Value |
| Document name | CertificateValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between certificate and valuation |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.13.3 CertificateValuation Fields
| Field | Type | Req | Key | Description | Comments |
| CertificateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.13.3.1 Field CertificateId
2.1.2.13.3.1.1 CertificateId properties
| Property | Value |
| Name | CertificateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Certificate |
| Foreign field | CertificateId |
| Relationship type | Foreign Key |
| Relationship name | fk Certificate. to CertificateValuation. |
| Cardinality | 0..n |
| Sample | CE-B8-2414 |
| Comments |
2.1.2.13.3.2 Field ValuationId
2.1.2.13.3.2.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to CertificateValuation. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.1.2.13.4 CertificateValuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CertificateValuation",
"description": "Linking entity between certificate and valuation",
"properties": {
"CertificateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CertificateId",
"ValuationId"
]
}2.1.2.13.5 CertificateValuation JSON data
{
"CertificateId": "CE-B8-2414",
"ValuationId": "V021"
}2.1.2.14 Document Component
2.1.2.14.1 Component Tree Diagram
2.1.2.14.2 Component Properties
| Property | Value |
| Document name | Component |
| Technical name | |
| Activated | true |
| Id | |
| Description | Component [component, part, apparatus] is a named and individually defined physical object and may require management efforts such as inspections, maintenance, service, or replacement during the use phase |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.14.3 Component Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ComponentTypeId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Counter | integer | false | Counter of component | ||
| ConditionStatus | string | true | Condition of component | ||
| DurationLifeYear | integer | true | Life span of component in years | [{"dataType":"integer16"}] | |
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SerialNumber | string | true | Serial number of component | ||
| TagNumber | string | false | Tag number |
2.1.2.14.3.1 Field ComponentId
2.1.2.14.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | C-01 |
| Comments |
2.1.2.14.3.2 Field ComponentTypeId
2.1.2.14.3.2.1 ComponentTypeId properties
| Property | Value |
| Name | ComponentTypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | ComponentType |
| Foreign field | ComponentTypeId |
| Relationship type | Foreign Key |
| Relationship name | fk Type. to Component. |
| Cardinality | 1..n |
| Sample | T-2615 |
| Comments |
2.1.2.14.3.3 Field Counter
2.1.2.14.3.3.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Description | Counter of component |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.1.2.14.3.4 Field ConditionStatus
2.1.2.14.3.4.1 ConditionStatus properties
| Property | Value |
| Name | ConditionStatus |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Condition of component |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Defect,Good,Not Available |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Good |
| Comments |
2.1.2.14.3.5 Field DurationLifeYear
2.1.2.14.3.5.1 DurationLifeYear properties
| Property | Value |
| Name | DurationLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Description | Life span of component in years |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
2.1.2.14.3.6 Field WarrantyGuarantor
2.1.2.14.3.6.1 WarrantyGuarantor properties
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Apple |
| Comments |
2.1.2.14.3.7 Field WarrantyStartDate
2.1.2.14.3.7.1 WarrantyStartDate properties
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.14.3.8 Field SerialNumber
2.1.2.14.3.8.1 SerialNumber properties
| Property | Value |
| Name | SerialNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Serial number of component |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | xan51425612 |
| Comments |
2.1.2.14.3.9 Field TagNumber
2.1.2.14.3.9.1 TagNumber properties
| Property | Value |
| Name | TagNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Tag number |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 27465192 |
| Comments |
2.1.2.14.4 Component JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Component",
"description": "Component [component, part, apparatus] is a named and individually defined physical object and may require management efforts such as inspections, maintenance, service, or replacement during the use phase",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ComponentTypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of component",
"minimum": 1,
"maximum": 99999
},
"ConditionStatus": {
"type": "string",
"description": "Condition of component",
"enum": [
"Defect",
"Good",
"Not Available"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DurationLifeYear": {
"type": "integer",
"description": "Life span of component in years",
"minimum": 1,
"maximum": 99
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"SerialNumber": {
"type": "string",
"description": "Serial number of component",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TagNumber": {
"type": "string",
"description": "Tag number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"ComponentTypeId",
"ConditionStatus",
"DurationLifeYear",
"WarrantyGuarantor",
"WarrantyStartDate",
"SerialNumber"
]
}2.1.2.14.5 Component JSON data
{
"ComponentId": "C-01",
"ComponentTypeId": "T-2615",
"Counter": 21301,
"ConditionStatus": "Good",
"DurationLifeYear": 10,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2011-06-14T04:12:36.123Z",
"SerialNumber": "xan51425612",
"TagNumber": "27465192"
}2.1.2.15 Document ComponentBuilding
2.1.2.15.1 ComponentBuilding Tree Diagram
2.1.2.15.2 ComponentBuilding Properties
| Property | Value |
| Document name | ComponentBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.15.3 ComponentBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.15.3.1 Field ComponentId
2.1.2.15.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentBuilding. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.15.3.2 Field BuildingId
2.1.2.15.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to ComponentBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.15.4 ComponentBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentBuilding",
"description": "Linking entity between component and building",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"BuildingId"
]
}2.1.2.15.5 ComponentBuilding JSON data
{
"ComponentId": "C-01",
"BuildingId": "SE-CH-2341"
}2.1.2.16 Document ComponentFloor
2.1.2.16.1 ComponentFloor Tree Diagram
2.1.2.16.2 ComponentFloor Properties
| Property | Value |
| Document name | ComponentFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and floor |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.16.3 ComponentFloor Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| FloorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.16.3.1 Field ComponentId
2.1.2.16.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentFloor. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.16.3.2 Field FloorId
2.1.2.16.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to ComponentFloor. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.16.4 ComponentFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentFloor",
"description": "Linking entity between component and floor",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"FloorId"
]
}2.1.2.16.5 ComponentFloor JSON data
{
"ComponentId": "C-01",
"FloorId": "SE-CH-F-01"
}2.1.2.17 Document ComponentSite
2.1.2.17.1 ComponentSite Tree Diagram
2.1.2.17.2 ComponentSite Properties
| Property | Value |
| Document name | ComponentSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and site |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.17.3 ComponentSite Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.17.3.1 Field ComponentId
2.1.2.17.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentSite. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.17.3.2 Field SiteId
2.1.2.17.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to ComponentSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.1.2.17.4 ComponentSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSite",
"description": "Linking entity between component and site",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SiteId"
]
}2.1.2.17.5 ComponentSite JSON data
{
"ComponentId": "C-01",
"SiteId": "AE-DE-02"
}2.1.2.18 Document ComponentSpace
2.1.2.18.1 ComponentSpace Tree Diagram
2.1.2.18.2 ComponentSpace Properties
| Property | Value |
| Document name | ComponentSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and space |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.18.3 ComponentSpace Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SpaceId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.18.3.1 Field ComponentId
2.1.2.18.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentSpace. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.18.3.2 Field SpaceId
2.1.2.18.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | Foreign Key |
| Relationship name | fk Space. to ComponentSpace. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.18.4 ComponentSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSpace",
"description": "Linking entity between component and space",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SpaceId"
]
}2.1.2.18.5 ComponentSpace JSON data
{
"ComponentId": "C-01",
"SpaceId": "SE-CH-F-01-21"
}2.1.2.19 Document ComponentSystem
2.1.2.19.1 ComponentSystem Tree Diagram
2.1.2.19.2 ComponentSystem Properties
| Property | Value |
| Document name | ComponentSystem |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and system |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.19.3 ComponentSystem Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SystemId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.19.3.1 Field ComponentId
2.1.2.19.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentSystem. |
| Cardinality | 1..n |
| Sample | C-01 |
| Comments |
2.1.2.19.3.2 Field SystemId
2.1.2.19.3.2.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | System |
| Foreign field | SystemId |
| Relationship type | Foreign Key |
| Relationship name | fk System. to ComponentSystem. |
| Cardinality | 1..n |
| Sample | S-17281 |
| Comments |
2.1.2.19.4 ComponentSystem JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentSystem",
"description": "Linking entity between component and system",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"SystemId"
]
}2.1.2.19.5 ComponentSystem JSON data
{
"ComponentId": "C-01",
"SystemId": "S-17281"
}2.1.2.20 Document ComponentType
2.1.2.20.1 ComponentType Tree Diagram
2.1.2.20.2 ComponentType Properties
| Property | Value |
| Document name | ComponentType |
| Technical name | |
| Activated | true |
| Id | |
| Description | Type is a specification for components including information on equipment, product types and materials |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.20.3 ComponentType Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentTypeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of product | ||
| Class | string | true | Class component belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of type | ||
| Manufacturer | string | true | Name of manufacturer | ||
| ManufacturerCode | string | false | Manufacturer code | ||
| ExpectedLifeYear | integer | false | Life span of product in years | [{"dataType":"integer16"}] | |
| MaintenanceGroup | string | false | Maintenance group | ||
| MaintenanceRelevance | string | false | Relevance of maintenance | ||
| UrlLibrary | string | false | Product website | ||
| CeIdentification | string | false | European identification number |
2.1.2.20.3.1 Field ComponentTypeId
2.1.2.20.3.1.1 ComponentTypeId properties
| Property | Value |
| Name | ComponentTypeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | T-2615 |
| Comments |
2.1.2.20.3.2 Field Name
2.1.2.20.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of product |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Door |
| Comments |
2.1.2.20.3.3 Field Class
2.1.2.20.3.3.1 Class properties
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class component belongs to |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Door |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
2.1.2.20.3.4 Field Counter
2.1.2.20.3.4.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Description | Counter of type |
| Type | integer |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 12 |
| Comments |
2.1.2.20.3.5 Field Manufacturer
2.1.2.20.3.5.1 Manufacturer properties
| Property | Value |
| Name | Manufacturer |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of manufacturer |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Bosch |
| Comments |
2.1.2.20.3.6 Field ManufacturerCode
2.1.2.20.3.6.1 ManufacturerCode properties
| Property | Value |
| Name | ManufacturerCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Manufacturer code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | B6274519 |
| Comments |
2.1.2.20.3.7 Field ExpectedLifeYear
2.1.2.20.3.7.1 ExpectedLifeYear properties
| Property | Value |
| Name | ExpectedLifeYear |
| Technical name | |
| Activated | true |
| Id | |
| Description | Life span of product in years |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 99 |
| Excl max | |
| Multiple of | |
| Unit | years |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 10 |
| Comments | [{"dataType":"integer16"}] |
2.1.2.20.3.8 Field MaintenanceGroup
2.1.2.20.3.8.1 MaintenanceGroup properties
| Property | Value |
| Name | MaintenanceGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Maintenance group |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.1.2.20.3.9 Field MaintenanceRelevance
2.1.2.20.3.9.1 MaintenanceRelevance properties
| Property | Value |
| Name | MaintenanceRelevance |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Relevance of maintenance |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | High,Medium,Low |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | High |
| Comments |
2.1.2.20.3.10 Field UrlLibrary
2.1.2.20.3.10.1 UrlLibrary properties
| Property | Value |
| Name | UrlLibrary |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Product website |
| Format | |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke |
| Comments |
2.1.2.20.3.11 Field CeIdentification
2.1.2.20.3.11.1 CeIdentification properties
| Property | Value |
| Name | CeIdentification |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | European identification number |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | CE 0123 |
| Comments |
2.1.2.20.4 ComponentType JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentType",
"description": "Type is a specification for components including information on equipment, product types and materials",
"properties": {
"ComponentTypeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of product",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class component belongs to",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Counter": {
"type": "integer",
"description": "Counter of type",
"minimum": 0,
"maximum": 999999
},
"Manufacturer": {
"type": "string",
"description": "Name of manufacturer",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ManufacturerCode": {
"type": "string",
"description": "Manufacturer code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ExpectedLifeYear": {
"type": "integer",
"description": "Life span of product in years",
"minimum": 1,
"maximum": 99
},
"MaintenanceGroup": {
"type": "string",
"description": "Maintenance group",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"MaintenanceRelevance": {
"type": "string",
"description": "Relevance of maintenance",
"enum": [
"High",
"Medium",
"Low"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UrlLibrary": {
"type": "string",
"description": "Product website",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CeIdentification": {
"type": "string",
"description": "European identification number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentTypeId",
"Name",
"Class",
"Counter",
"Manufacturer"
]
}2.1.2.20.5 ComponentType JSON data
{
"ComponentTypeId": "T-2615",
"Name": "Door",
"Class": "Door",
"Counter": 12,
"Manufacturer": "Bosch",
"ManufacturerCode": "B6274519",
"ExpectedLifeYear": 10,
"MaintenanceGroup": "D0_wtoCo,Ij5",
"MaintenanceRelevance": "High",
"UrlLibrary": "www.siemens-home.bsh-group.com/de/produkte/kuehlschraenke-gefrierschraenke",
"CeIdentification": "CE 0123"
}2.1.2.21 Document ComponentUnit
2.1.2.21.1 ComponentUnit Tree Diagram
2.1.2.21.2 ComponentUnit Properties
| Property | Value |
| Document name | ComponentUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between component and unit |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.21.3 ComponentUnit Fields
| Field | Type | Req | Key | Description | Comments |
| ComponentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.21.3.1 Field ComponentId
2.1.2.21.3.1.1 ComponentId properties
| Property | Value |
| Name | ComponentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Component |
| Foreign field | ComponentId |
| Relationship type | Foreign Key |
| Relationship name | fk Component. to ComponentUnit. |
| Cardinality | 0..n |
| Sample | C-01 |
| Comments |
2.1.2.21.3.2 Field UnitId
2.1.2.21.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to ComponentUnit. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.21.4 ComponentUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ComponentUnit",
"description": "Linking entity between component and unit",
"properties": {
"ComponentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ComponentId",
"UnitId"
]
}2.1.2.21.5 ComponentUnit JSON data
{
"ComponentId": "C-01",
"UnitId": "UN-SE-CH-2341-02"
}2.1.2.22 Document Floor
2.1.2.22.1 Floor Tree Diagram
2.1.2.22.2 Floor Properties
| Property | Value |
| Document name | Floor |
| Technical name | |
| Activated | true |
| Id | |
| Description | The floor has an elevation and typically represents a (nearly) horizontal aggregation of spaces that are vertically bound |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.22.3 Floor Fields
| Field | Type | Req | Key | Description | Comments |
| FloorId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Reference to the Building which the Floor belongs to | |
| Name | string | true | Name of floor | ||
| FloorCode | string | false | User specific Floor Code | ||
| FloorNumber | integer | true | Number of floor | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.22.3.1 Field FloorId
2.1.2.22.3.1.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.22.3.2 Field BuildingId
2.1.2.22.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | Bldngd |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Building which the Floor belongs to |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to Floor. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.22.3.3 Field Name
2.1.2.22.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of floor |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | EG |
| Comments |
2.1.2.22.3.4 Field FloorCode
2.1.2.22.3.4.1 FloorCode properties
| Property | Value |
| Name | FloorCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Floor Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | F003 |
| Comments |
2.1.2.22.3.5 Field FloorNumber
2.1.2.22.3.5.1 FloorNumber properties
| Property | Value |
| Name | FloorNumber |
| Technical name | |
| Activated | true |
| Id | |
| Description | Number of floor |
| Type | integer |
| Min value | -300 |
| Excl min | |
| Max value | 300 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 121 |
| Comments |
2.1.2.22.3.6 Field ValidFrom
2.1.2.22.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.22.3.7 Field ValidUntil
2.1.2.22.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.22.4 Floor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Floor",
"description": "The floor has an elevation and typically represents a (nearly) horizontal aggregation of spaces that are vertically bound",
"additionalProperties": false,
"properties": {
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Bldngd": {
"type": "string",
"title": "BuildingId",
"description": "Reference to the Building which the Floor belongs to",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of floor",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorCode": {
"type": "string",
"description": "User specific Floor Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorNumber": {
"type": "integer",
"description": "Number of floor",
"minimum": -300,
"maximum": 300
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"FloorId",
"Bldngd",
"Name",
"FloorNumber",
"ValidFrom",
"ValidUntil"
]
}2.1.2.22.5 Floor JSON data
{
"FloorId": "SE-CH-F-01",
"Bldngd": "SE-CH-2341",
"Name": "EG",
"FloorCode": "F003",
"FloorNumber": 121,
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.1.2.23 Document Land
2.1.2.23.1 Land Tree Diagram
2.1.2.23.2 Land Properties
| Property | Value |
| Document name | Land |
| Technical name | |
| Activated | true |
| Id | |
| Description | A defined area of land, possibly covered with water, on which the project construction is to be completed or already completed |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.23.3 Land Fields
| Field | Type | Req | Key | Description | Comments |
| LandId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Reference to the site which the land belongs to | |
| ServitudeId | string | false | fk | Reference to the Servitude which belongs to the land | |
| Name | string | true | Name of Land e.g: park, garden, parking | ||
| LandCode | string | false | User specific Land Code | ||
| Type | string | true | Type of land | ||
| LandCoverage | string | true | Development level of land | ||
| LandParcelNr | string | false | District/Zoning number registered for the Plot of land | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| GeorefId | string | false | A reference to Guid from the geo-coordinate entity | does not exist yet |
2.1.2.23.3.1 Field LandId
2.1.2.23.3.1.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | RE-AT-05 |
| Comments |
2.1.2.23.3.2 Field SiteId
2.1.2.23.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | Std |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the site which the land belongs to |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to Land. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.1.2.23.3.3 Field ServitudeId
2.1.2.23.3.3.1 ServitudeId properties
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the Servitude which belongs to the land |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | Servitudes |
| Foreign field | ServitudeId |
| Relationship type | Foreign Key |
| Relationship name | fk Servitudes. to Land. |
| Cardinality | 0..1 |
| Sample | SE-DE-05 |
| Comments |
2.1.2.23.3.4 Field Name
2.1.2.23.3.4.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Land e.g: park, garden, parking |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Parking Main Building |
| Comments |
2.1.2.23.3.5 Field LandCode
2.1.2.23.3.5.1 LandCode properties
| Property | Value |
| Name | LandCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Land Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | LE3021 |
| Comments |
2.1.2.23.3.6 Field Type
2.1.2.23.3.6.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of land |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Agricultural,Recreational,Industrial,Non-industrial,Traffic |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | industrial |
| Comments |
2.1.2.23.3.7 Field LandCoverage
2.1.2.23.3.7.1 LandCoverage properties
| Property | Value |
| Name | LandCoverage |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Development level of land |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Fully,Partially,Not covered |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Partially |
| Comments |
2.1.2.23.3.8 Field LandParcelNr
2.1.2.23.3.8.1 LandParcelNr properties
| Property | Value |
| Name | LandParcelNr |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | District/Zoning number registered for the Plot of land |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 00087/000 |
| Comments |
2.1.2.23.3.9 Field ValidFrom
2.1.2.23.3.9.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.23.3.10 Field ValidUntil
2.1.2.23.3.10.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.23.3.11 Field GeorefId
2.1.2.23.3.11.1 GeorefId properties
| Property | Value |
| Name | GeorefId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | A reference to Guid from the geo-coordinate entity |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | GR-02-01 |
| Comments | does not exist yet |
2.1.2.23.4 Land JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Land",
"description": "A defined area of land, possibly covered with water, on which the project construction is to be completed or already completed",
"additionalProperties": false,
"properties": {
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Std": {
"type": "string",
"title": "SiteId",
"description": "Reference to the site which the land belongs to",
"maxLength": 50,
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ServitudeId": {
"type": "string",
"description": "Reference to the Servitude which belongs to the land",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Land e.g: park, garden, parking",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCode": {
"type": "string",
"description": "User specific Land Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of land",
"enum": [
"Agricultural",
"Recreational",
"Industrial",
"Non-industrial",
"Traffic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandCoverage": {
"type": "string",
"description": "Development level of land",
"enum": [
"Fully",
"Partially",
"Not covered"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandParcelNr": {
"type": "string",
"description": "District/Zoning number registered for the Plot of land",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"GeorefId": {
"type": "string",
"description": "A reference to Guid from the geo-coordinate entity",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"LandId",
"Std",
"Name",
"Type",
"LandCoverage",
"ValidFrom",
"ValidUntil"
]
}2.1.2.23.5 Land JSON data
{
"LandId": "RE-AT-05",
"Std": "AE-DE-02",
"ServitudeId": "SE-DE-05",
"Name": "Parking Main Building",
"LandCode": "LE3021",
"Type": "industrial",
"LandCoverage": "Partially",
"LandParcelNr": "00087/000",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"GeorefId": "GR-02-01"
}2.1.2.24 Document Servitudes
2.1.2.24.1 Servitudes Tree Diagram
2.1.2.24.2 Servitudes Properties
| Property | Value |
| Document name | Servitudes |
| Technical name | |
| Activated | true |
| Id | |
| Description | The subjection of property to an easement |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.24.3 Servitudes Fields
| Field | Type | Req | Key | Description | Comments |
| ServitudeId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of servitude | ||
| ValidFrom | date-time | true | Date servitude starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date servitude ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.24.3.1 Field ServitudeId
2.1.2.24.3.1.1 ServitudeId properties
| Property | Value |
| Name | ServitudeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | SE-DE-05 |
| Comments |
2.1.2.24.3.2 Field Type
2.1.2.24.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of servitude |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Easements,Covenants,Profits |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Easements |
| Comments |
2.1.2.24.3.3 Field ValidFrom
2.1.2.24.3.3.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.24.3.4 Field ValidUntil
2.1.2.24.3.4.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date servitude ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.24.4 Servitudes JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Servitudes",
"description": "The subjection of property to an easement",
"additionalProperties": false,
"properties": {
"ServitudeId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of servitude ",
"enum": [
"Easements",
"Covenants",
"Profits"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date servitude starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date servitude ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"ServitudeId",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.1.2.24.5 Servitudes JSON data
{
"ServitudeId": "SE-DE-05",
"Type": "Easements",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.1.2.25 Document Site
2.1.2.25.1 Site Tree Diagram
2.1.2.25.2 Site Properties
| Property | Value |
| Document name | Site |
| Technical name | |
| Activated | true |
| Id | |
| Description | Grouping of multiple buildings and lands |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.25.3 Site Fields
| Field | Type | Req | Key | Description | Comments |
| SiteId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Site | ||
| SiteCode | string | false | User specific Site Code | ||
| Type | string | true | Type of site | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.25.3.1 Field SiteId
2.1.2.25.3.1.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | AE-DE-02 |
| Comments |
2.1.2.25.3.2 Field Name
2.1.2.25.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Site |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Siemensstadt |
| Comments |
2.1.2.25.3.3 Field SiteCode
2.1.2.25.3.3.1 SiteCode properties
| Property | Value |
| Name | SiteCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Site Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | SB001 |
| Comments |
2.1.2.25.3.4 Field Type
2.1.2.25.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of site |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Education,Health Care,Hotel,Industrial,Lodging, Leisure & Recreation,Mixed Use,Office,Residential,Retail,Technology/Science,Other |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Office |
| Comments |
2.1.2.25.3.5 Field ValidFrom
2.1.2.25.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.25.3.6 Field ValidUntil
2.1.2.25.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.25.4 Site JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Site",
"description": "Grouping of multiple buildings and lands",
"additionalProperties": false,
"properties": {
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Site",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteCode": {
"type": "string",
"description": "User specific Site Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of site",
"enum": [
"Education",
"Health Care",
"Hotel",
"Industrial",
"Lodging, Leisure & Recreation",
"Mixed Use",
"Office",
"Residential",
"Retail",
"Technology/Science",
"Other"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"SiteId",
"Name",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.1.2.25.5 Site JSON data
{
"SiteId": "AE-DE-02",
"Name": "Siemensstadt",
"SiteCode": "SB001",
"Type": "Office",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.1.2.26 Document Space
2.1.2.26.1 Space Tree Diagram
2.1.2.26.2 Space Properties
| Property | Value |
| Document name | Space |
| Technical name | |
| Activated | true |
| Id | |
| Description | A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.26.3 Space Fields
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| FloorId | string | true | fk | Reference to the floor which the space belongs to | |
| Name | string | true | Name of space | ||
| SpaceCode | string | false | User specific Space Code | ||
| SpaceNumber | number | false | Number of space | [{"dataType":"float"}] | |
| Type | string | true | Type of space | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SpaceHeightUsable | number | false | Usable Height of space | [{"dataType":"float"}] | |
| SpaceHeight | number | false | Actual space height e.g: 3.6 m | [{"dataType":"float"}] | |
| SpaceVolumeGross | number | false | Gross volume of space including surrounding walls | [{"dataType":"float"}] | |
| SpaceVolumeNet | number | false | Gross volume of space excluding surrounding walls | [{"dataType":"float"}] | |
| PrimaryFloorMaterial | string | false | Material of floor | ||
| PrimaryWallMaterial | string | false | Material of wall | ||
| PrimaryCeilingMaterial | string | false | Material of ceiling e.g: cement | ||
| Rentability | boolean | false | Status of the space is eligible for renting out (Y/N) | ||
| EffectZonesHeating | number | false | Area that is heated | [{"dataType":"float"}] | |
| EffectZonesCooling | number | false | Area that is cooled | [{"dataType":"float"}] | |
| EffectZonesVentilation | number | false | Area that is ventilated | [{"dataType":"float"}] | |
| ClimateHeated | boolean | false | Define if space is climate heated (Y/N) | ||
| ClimateCooled | boolean | false | Define if space is climate cooled (Y/N) | ||
| CoUseArea | boolean | false | Is the space used by multiple tenants (Y/N) | ||
| MaximumOccupancy | integer | false | Define maximum occupancy of space | ||
| VentilationType | string | false | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery |
2.1.2.26.3.1 Field SpaceId
2.1.2.26.3.1.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.26.3.2 Field FloorId
2.1.2.26.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to the floor which the space belongs to |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to Space. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.26.3.3 Field Name
2.1.2.26.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of space |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Meeting room 3c |
| Comments |
2.1.2.26.3.4 Field SpaceCode
2.1.2.26.3.4.1 SpaceCode properties
| Property | Value |
| Name | SpaceCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Space Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | MR003 |
| Comments |
2.1.2.26.3.5 Field SpaceNumber
2.1.2.26.3.5.1 SpaceNumber properties
| Property | Value |
| Name | SpaceNumber |
| Technical name | |
| Activated | true |
| Id | |
| Description | Number of space |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 3.2 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.6 Field Type
2.1.2.26.3.6.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of space |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Residential,Office,Industrial,Retail,Storage,Parking space,Shaft,Staircase,Other |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Office |
| Comments |
2.1.2.26.3.7 Field ValidFrom
2.1.2.26.3.7.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.26.3.8 Field ValidUntil
2.1.2.26.3.8.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.26.3.9 Field SpaceHeightUsable
2.1.2.26.3.9.1 SpaceHeightUsable properties
| Property | Value |
| Name | SpaceHeightUsable |
| Technical name | |
| Activated | true |
| Id | |
| Description | Usable Height of space |
| Type | number |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Unit | m |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2.3 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.10 Field SpaceHeight
2.1.2.26.3.10.1 SpaceHeight properties
| Property | Value |
| Name | SpaceHeight |
| Technical name | |
| Activated | true |
| Id | |
| Description | Actual space height e.g: 3.6 m |
| Type | number |
| Min value | 2 |
| Excl min | |
| Max value | 999 |
| Excl max | |
| Multiple of | |
| Unit | m |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2.11 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.11 Field SpaceVolumeGross
2.1.2.26.3.11.1 SpaceVolumeGross properties
| Property | Value |
| Name | SpaceVolumeGross |
| Technical name | |
| Activated | true |
| Id | |
| Description | Gross volume of space including surrounding walls |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | m³ |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1083.27 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.12 Field SpaceVolumeNet
2.1.2.26.3.12.1 SpaceVolumeNet properties
| Property | Value |
| Name | SpaceVolumeNet |
| Technical name | |
| Activated | true |
| Id | |
| Description | Gross volume of space excluding surrounding walls |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | m³ |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1200.21 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.13 Field PrimaryFloorMaterial
2.1.2.26.3.13.1 PrimaryFloorMaterial properties
| Property | Value |
| Name | PrimaryFloorMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of floor |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Timber,Laminate,Vinyl,Bamboo,Cork,Tile (porcelain or ceramic),Tile (natural stone),Carpet,Rubber,Poured floors (mastic asphalt and polymeric) |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Timber |
| Comments |
2.1.2.26.3.14 Field PrimaryWallMaterial
2.1.2.26.3.14.1 PrimaryWallMaterial properties
| Property | Value |
| Name | PrimaryWallMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of wall |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Timber,Paint,Tiles,Glass,Brick,Metal,Vinyl,Stone,Concrete,Ceramic Tiles,Plastic |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Concrete |
| Comments |
2.1.2.26.3.15 Field PrimaryCeilingMaterial
2.1.2.26.3.15.1 PrimaryCeilingMaterial properties
| Property | Value |
| Name | PrimaryCeilingMaterial |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Material of ceiling e.g: cement |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;,\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Timber,Glypsum,Vinyl,Fibre-cement |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Timber |
| Comments |
2.1.2.26.3.16 Field Rentability
2.1.2.26.3.16.1 Rentability properties
| Property | Value |
| Name | Rentability |
| Technical name | |
| Activated | true |
| Id | |
| Description | Status of the space is eligible for renting out (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.26.3.17 Field EffectZonesHeating
2.1.2.26.3.17.1 EffectZonesHeating properties
| Property | Value |
| Name | EffectZonesHeating |
| Technical name | |
| Activated | true |
| Id | |
| Description | Area that is heated |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Unit | m² |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1231.16 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.18 Field EffectZonesCooling
2.1.2.26.3.18.1 EffectZonesCooling properties
| Property | Value |
| Name | EffectZonesCooling |
| Technical name | |
| Activated | true |
| Id | |
| Description | Area that is cooled |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Unit | m² |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 40.55 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.19 Field EffectZonesVentilation
2.1.2.26.3.19.1 EffectZonesVentilation properties
| Property | Value |
| Name | EffectZonesVentilation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Area that is ventilated |
| Type | number |
| Min value | 0 |
| Excl min | true |
| Max value | 9999 |
| Excl max | |
| Multiple of | |
| Unit | m² |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 122.98 |
| Comments | [{"dataType":"float"}] |
2.1.2.26.3.20 Field ClimateHeated
2.1.2.26.3.20.1 ClimateHeated properties
| Property | Value |
| Name | ClimateHeated |
| Technical name | |
| Activated | true |
| Id | |
| Description | Define if space is climate heated (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.26.3.21 Field ClimateCooled
2.1.2.26.3.21.1 ClimateCooled properties
| Property | Value |
| Name | ClimateCooled |
| Technical name | |
| Activated | true |
| Id | |
| Description | Define if space is climate cooled (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.26.3.22 Field CoUseArea
2.1.2.26.3.22.1 CoUseArea properties
| Property | Value |
| Name | CoUseArea |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is the space used by multiple tenants (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.1.2.26.3.23 Field MaximumOccupancy
2.1.2.26.3.23.1 MaximumOccupancy properties
| Property | Value |
| Name | MaximumOccupancy |
| Technical name | |
| Activated | true |
| Id | |
| Description | Define maximum occupancy of space |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 99999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 10 |
| Comments |
2.1.2.26.3.24 Field VentilationType
2.1.2.26.3.24.1 VentilationType properties
| Property | Value |
| Name | VentilationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Exhaust,Supply,Balanced,Heat-recovery |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Exhaust |
| Comments |
2.1.2.26.4 Space JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Space",
"description": "A space represents an area or volume bounded actually or theoretically. Spaces are areas or volumes that provide for certain functions within a building",
"additionalProperties": false,
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Reference to the floor which the space belongs to",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of space",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceCode": {
"type": "string",
"description": "User specific Space Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceNumber": {
"type": "number",
"description": "Number of space",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 99999
},
"Type": {
"type": "string",
"description": "Type of space",
"enum": [
"Residential",
"Office",
"Industrial",
"Retail",
"Storage",
"Parking space",
"Shaft",
"Staircase",
"Other"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"SpaceHeightUsable": {
"type": "number",
"description": "Usable Height of space",
"minimum": 2,
"maximum": 999
},
"SpaceHeight": {
"type": "number",
"description": "Actual space height e.g: 3.6 m",
"minimum": 2,
"maximum": 999
},
"SpaceVolumeGross": {
"type": "number",
"description": "Gross volume of space including surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"SpaceVolumeNet": {
"type": "number",
"description": "Gross volume of space excluding surrounding walls",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 999999
},
"PrimaryFloorMaterial": {
"type": "string",
"description": "Material of floor",
"enum": [
"Timber",
"Laminate",
"Vinyl",
"Bamboo",
"Cork",
"Tile (porcelain or ceramic)",
"Tile (natural stone)",
"Carpet",
"Rubber",
"Poured floors (mastic asphalt and polymeric)"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryWallMaterial": {
"type": "string",
"description": "Material of wall",
"enum": [
"Timber",
"Paint",
"Tiles",
"Glass",
"Brick",
"Metal",
"Vinyl",
"Stone",
"Concrete",
"Ceramic Tiles",
"Plastic"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"PrimaryCeilingMaterial": {
"type": "string",
"description": "Material of ceiling e.g: cement",
"enum": [
"Timber",
"Glypsum",
"Vinyl",
"Fibre-cement"
],
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;,\\$%!\\?\\0-\\cZ]+$"
},
"Rentability": {
"type": "boolean",
"description": "Status of the space is eligible for renting out (Y/N)"
},
"EffectZonesHeating": {
"type": "number",
"description": "Area that is heated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesCooling": {
"type": "number",
"description": "Area that is cooled",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"EffectZonesVentilation": {
"type": "number",
"description": "Area that is ventilated",
"minimum": 0,
"exclusiveMinimum": true,
"maximum": 9999
},
"ClimateHeated": {
"type": "boolean",
"description": "Define if space is climate heated (Y/N)"
},
"ClimateCooled": {
"type": "boolean",
"description": "Define if space is climate cooled (Y/N)"
},
"CoUseArea": {
"type": "boolean",
"description": "Is the space used by multiple tenants (Y/N)"
},
"MaximumOccupancy": {
"type": "integer",
"description": "Define maximum occupancy of space",
"minimum": 1,
"maximum": 99999
},
"VentilationType": {
"type": "string",
"description": "Define the ventilation type e.g: exhaust, supply, balanced, and heat-recovery",
"enum": [
"Exhaust",
"Supply",
"Balanced",
"Heat-recovery"
],
"minLength": 1,
"maxLength": 50
}
},
"required": [
"SpaceId",
"FloorId",
"Name",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.1.2.26.5 Space JSON data
{
"SpaceId": "SE-CH-F-01-21",
"FloorId": "SE-CH-F-01",
"Name": "Meeting room 3c",
"SpaceCode": "MR003",
"SpaceNumber": 3.2,
"Type": "Office",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"SpaceHeightUsable": 2.3,
"SpaceHeight": 2.11,
"SpaceVolumeGross": 1083.27,
"SpaceVolumeNet": 1200.21,
"PrimaryFloorMaterial": "Timber",
"PrimaryWallMaterial": "Concrete",
"PrimaryCeilingMaterial": "Timber",
"Rentability": true,
"EffectZonesHeating": 1231.16,
"EffectZonesCooling": 40.55,
"EffectZonesVentilation": 122.98,
"ClimateHeated": true,
"ClimateCooled": true,
"CoUseArea": true,
"MaximumOccupancy": 10,
"VentilationType": "Exhaust"
}2.1.2.27 Document System
2.1.2.27.1 System Tree Diagram
2.1.2.27.2 System Properties
| Property | Value |
| Document name | System |
| Technical name | |
| Activated | true |
| Id | |
| Description | Entirety of manageable components with a common function (supply air of a ventilation system) |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.27.3 System Fields
| Field | Type | Req | Key | Description | Comments |
| SystemId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of system | ||
| Class | string | true | Class system belongs to | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes | |
| Counter | integer | true | Counter of system | ||
| WarrantyGuarantor | string | true | Warranty Guarantor | ||
| WarrantyStartDate | date-time | true | Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.27.3.1 Field SystemId
2.1.2.27.3.1.1 SystemId properties
| Property | Value |
| Name | SystemId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | S-17281 |
| Comments |
2.1.2.27.3.2 Field Name
2.1.2.27.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of system |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Assembly system |
| Comments |
2.1.2.27.3.3 Field Class
2.1.2.27.3.3.1 Class properties
| Property | Value |
| Name | Class |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Class system belongs to |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | A |
| Comments | All classes need to be added according to CAFM-Connect_Equipment_catalogue_DIN276_w_Attributes |
2.1.2.27.3.4 Field Counter
2.1.2.27.3.4.1 Counter properties
| Property | Value |
| Name | Counter |
| Technical name | |
| Activated | true |
| Id | |
| Description | Counter of system |
| Type | integer |
| Min value | 0 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 12 |
| Comments |
2.1.2.27.3.5 Field WarrantyGuarantor
2.1.2.27.3.5.1 WarrantyGuarantor properties
| Property | Value |
| Name | WarrantyGuarantor |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty Guarantor |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Apple |
| Comments |
2.1.2.27.3.6 Field WarrantyStartDate
2.1.2.27.3.6.1 WarrantyStartDate properties
| Property | Value |
| Name | WarrantyStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.27.4 System JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "System",
"description": "Entirety of manageable components with a common function (supply air of a ventilation system) ",
"properties": {
"SystemId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of system",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Class": {
"type": "string",
"description": "Class system belongs to",
"minLength": 1,
"maxLength": 200
},
"Counter": {
"type": "integer",
"description": "Counter of system",
"minimum": 0,
"maximum": 999999
},
"WarrantyGuarantor": {
"type": "string",
"description": "Warranty Guarantor ",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"WarrantyStartDate": {
"type": "string",
"description": "Warranty start date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"SystemId",
"Name",
"Class",
"Counter",
"WarrantyGuarantor",
"WarrantyStartDate"
]
}2.1.2.27.5 System JSON data
{
"SystemId": "S-17281",
"Name": "Assembly system",
"Class": "A",
"Counter": 12,
"WarrantyGuarantor": "Apple",
"WarrantyStartDate": "2011-06-14T04:12:36.123Z"
}2.1.2.28 Document Unit
2.1.2.28.1 Unit Tree Diagram
2.1.2.28.2 Unit Properties
| Property | Value |
| Document name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Description | A unit is a physical quantity, with a value of one, which is used as a standard in terms of which other quantities are expressed. In the case of a building it can be a grouping of areas, spaces, floors, etc. |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.1.2.28.3 Unit Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of Unit e.g: part of building, rental unit | ||
| Name | string | true | Name of unit | ||
| Code | string | false | User-specific code for unit | ||
| ValidFrom | date-time | true | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.1.2.28.3.1 Field UnitId
2.1.2.28.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.28.3.2 Field Type
2.1.2.28.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Unit e.g: part of building, rental unit |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | East Wing |
| Comments |
2.1.2.28.3.3 Field Name
2.1.2.28.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of unit |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | East Wing |
| Comments |
2.1.2.28.3.4 Field Code
2.1.2.28.3.4.1 Code properties
| Property | Value |
| Name | Code |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User-specific code for unit |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | C602 |
| Comments |
2.1.2.28.3.5 Field ValidFrom
2.1.2.28.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.28.3.6 Field ValidUntil
2.1.2.28.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.1.2.28.4 Unit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Unit",
"description": "A unit is a physical quantity, with a value of one, which is used as a standard in terms of which other quantities are expressed. In the case of a building it can be a grouping of areas, spaces, floors, etc.",
"additionalProperties": false,
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of Unit e.g: part of building, rental unit",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Code": {
"type": "string",
"description": "User-specific code for unit",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "The records can be used from this date onwards in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "The records can be used until this date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"UnitId",
"Type",
"Name",
"ValidFrom",
"ValidUntil"
]
}2.1.2.28.5 Unit JSON data
{
"UnitId": "UN-SE-CH-2341-02",
"Type": "East Wing",
"Name": "East Wing",
"Code": "C602",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.1.2.29 Document UnitBuilding
2.1.2.29.1 UnitBuilding Tree Diagram
2.1.2.29.2 UnitBuilding Properties
| Property | Value |
| Document name | UnitBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Unit and Building |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.29.3 UnitBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.29.3.1 Field BuildingId
2.1.2.29.3.1.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to UnitBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.1.2.29.3.2 Field UnitId
2.1.2.29.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to UnitBuilding. |
| Cardinality | 0..1 |
| Sample | UN-SE-CH-2341 |
| Comments |
2.1.2.29.4 UnitBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitBuilding",
"description": "Linking entity between Unit and Building",
"properties": {
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"BuildingId",
"UnitId"
]
}2.1.2.29.5 UnitBuilding JSON data
{
"BuildingId": "SE-CH-2341",
"UnitId": "UN-SE-CH-2341"
}2.1.2.30 Document UnitFloor
2.1.2.30.1 UnitFloor Tree Diagram
2.1.2.30.2 UnitFloor Properties
| Property | Value |
| Document name | UnitFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Unit and Floor |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.30.3 UnitFloor Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| FloorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.30.3.1 Field UnitId
2.1.2.30.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to UnitFloor. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-F-01 |
| Comments |
2.1.2.30.3.2 Field FloorId
2.1.2.30.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to UnitFloor. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.1.2.30.4 UnitFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitFloor",
"description": "Linking entity between Unit and Floor",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"FloorId"
]
}2.1.2.30.5 UnitFloor JSON data
{
"UnitId": "UN-SE-CH-F-01",
"FloorId": "SE-CH-F-01"
}2.1.2.31 Document UnitLand
2.1.2.31.1 UnitLand Tree Diagram
2.1.2.31.2 UnitLand Properties
| Property | Value |
| Document name | UnitLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Unit and Land |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.31.3 UnitLand Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.31.3.1 Field UnitId
2.1.2.31.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to UnitLand. |
| Cardinality | 0..1 |
| Sample | UN-RE-AT-05 |
| Comments |
2.1.2.31.3.2 Field LandId
2.1.2.31.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to UnitLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.1.2.31.4 UnitLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitLand",
"description": "Linking entity between Unit and Land",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"LandId"
]
}2.1.2.31.5 UnitLand JSON data
{
"UnitId": "UN-RE-AT-05",
"LandId": "RE-AT-05"
}2.1.2.32 Document UnitSite
2.1.2.32.1 UnitSite Tree Diagram
2.1.2.32.2 UnitSite Properties
| Property | Value |
| Document name | UnitSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Unit and Site |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.32.3 UnitSite Fields
| Field | Type | Req | Key | Description | Comments |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.32.3.1 Field UnitId
2.1.2.32.3.1.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to UnitSite. |
| Cardinality | 0..1 |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.32.3.2 Field SiteId
2.1.2.32.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to UnitSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.1.2.32.4 UnitSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitSite",
"description": "Linking entity between Unit and Site",
"properties": {
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"UnitId",
"SiteId"
]
}2.1.2.32.5 UnitSite JSON data
{
"UnitId": "UN-SE-CH-2341-02",
"SiteId": "AE-DE-02"
}2.1.2.33 Document UnitSpace
2.1.2.33.1 UnitSpace Tree Diagram
2.1.2.33.2 UnitSpace Properties
| Property | Value |
| Document name | UnitSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Unit and Space |
| Group | DigitalTwin |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.1.2.33.3 UnitSpace Fields
| Field | Type | Req | Key | Description | Comments |
| SpaceId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.1.2.33.3.1 Field SpaceId
2.1.2.33.3.1.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | Foreign Key |
| Relationship name | fk Space. to UnitSpace. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01-21 |
| Comments |
2.1.2.33.3.2 Field UnitId
2.1.2.33.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to UnitSpace. |
| Cardinality | 0..1 |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.1.2.33.4 UnitSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "UnitSpace",
"description": "Linking entity between Unit and Space",
"properties": {
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"SpaceId",
"UnitId"
]
}2.1.2.33.5 UnitSpace JSON data
{
"SpaceId": "SE-CH-F-01-21",
"UnitId": "UN-SE-CH-2341-02"
}2.2 Group EnergyAndResources
2.2.1 EnergyAndResources Properties
| Property | Value |
| Group name | EnergyAndResources |
| Technical name | |
| Activated | true |
| Description | Comprising all energy and resource consumption related data |
| Comments |
2.2.2 EnergyAndResources Documents
2.2.2.1 Document Climate
2.2.2.1.1 Climate Tree Diagram
2.2.2.1.2 Climate Properties
| Property | Value |
| Document name | Climate |
| Technical name | |
| Activated | true |
| Id | |
| Description | Regional information on past and future amount of heating and cooling degree days (for potential climate normalisation and projection of energy demand) |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.1.3 Climate Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| Experiment | string | false | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 | ||
| TemporalResolution | string | false | Temporal resolution of data (can be the time period over which raw data is aggregated) | ||
| SpatialResolution | string | false | Spatial resolution of data | ||
| GlobalCirculationModel | string | false | Global circulation model used | ||
| RegionalClimateModel | string | false | Regional climate model used | ||
| SimulationVersion | string | false | Run number of certain climate model or model combination | ||
| EnsembleMember | string | false | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' | ||
| Value | number | true | Value of observed variable | [{"dataType":"float"}] | |
| Unit | string | true | Unit of observed value | ||
| ValidFrom | date-time | true | Date observation starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date observation ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| LocationType | string | true | Type of spatial reference e.g. Zip code or geographic coordinates | ||
| CoordinateSystem | string | false | Specific coordinate system used | ||
| Location | string | false | Localisation of observed data in case of non-grid location types | ||
| Latitude | number | false | Latitude coordinate in case of geographic coordinates | [{"dataType":"float"}] | |
| Longitude | number | false | Longitude coordinate in case of geographic coordinates | [{"dataType":"float"}] | |
| PosX | integer | false | Horizontal coordinate in case of projected coordinates | ||
| PosY | integer | false | Vertical coordinate in case of projected coordinates | ||
| Variable | string | true | Observed variable |
2.2.2.1.3.1 Field ClimateId
2.2.2.1.3.1.1 ClimateId properties
| Property | Value |
| Name | ClimateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 075a2983-a8e5-4ea8-a354-6a88b311bfdb |
| Comments | [{"dataType":"guid"}] |
2.2.2.1.3.2 Field Experiment
2.2.2.1.3.2.1 Experiment properties
| Property | Value |
| Name | Experiment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6 |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Historical |
| Comments |
2.2.2.1.3.3 Field TemporalResolution
2.2.2.1.3.3.1 TemporalResolution properties
| Property | Value |
| Name | TemporalResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Temporal resolution of data (can be the time period over which raw data is aggregated) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | monthly |
| Comments |
2.2.2.1.3.4 Field SpatialResolution
2.2.2.1.3.4.1 SpatialResolution properties
| Property | Value |
| Name | SpatialResolution |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Spatial resolution of data |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 0.11 degree x 0.11 degree |
| Comments |
2.2.2.1.3.5 Field GlobalCirculationModel
2.2.2.1.3.5.1 GlobalCirculationModel properties
| Property | Value |
| Name | GlobalCirculationModel |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Global circulation model used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | MPI-M-MPI-ESM-LR |
| Comments |
2.2.2.1.3.6 Field RegionalClimateModel
2.2.2.1.3.6.1 RegionalClimateModel properties
| Property | Value |
| Name | RegionalClimateModel |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Regional climate model used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | AWI-HIRHAM5 |
| Comments |
2.2.2.1.3.7 Field SimulationVersion
2.2.2.1.3.7.1 SimulationVersion properties
| Property | Value |
| Name | SimulationVersion |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Run number of certain climate model or model combination |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.1.3.8 Field EnsembleMember
2.2.2.1.3.8.1 EnsembleMember properties
| Property | Value |
| Name | EnsembleMember |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1' |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | r1i1p1 |
| Comments |
2.2.2.1.3.9 Field Value
2.2.2.1.3.9.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of observed variable |
| Type | number |
| Min value | 1 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 28462827.85 |
| Comments | [{"dataType":"float"}] |
2.2.2.1.3.10 Field Unit
2.2.2.1.3.10.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of observed value |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | °C |
| Comments |
2.2.2.1.3.11 Field ValidFrom
2.2.2.1.3.11.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.1.3.12 Field ValidUntil
2.2.2.1.3.12.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date observation ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.1.3.13 Field LocationType
2.2.2.1.3.13.1 LocationType properties
| Property | Value |
| Name | LocationType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of spatial reference e.g. Zip code or geographic coordinates |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | NUTS3,Zip Code,Geographic coordinates,Projected coordinates |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Geographic coordinates |
| Comments |
2.2.2.1.3.14 Field CoordinateSystem
2.2.2.1.3.14.1 CoordinateSystem properties
| Property | Value |
| Name | CoordinateSystem |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific coordinate system used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.1.3.15 Field Location
2.2.2.1.3.15.1 Location properties
| Property | Value |
| Name | Location |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Localisation of observed data in case of non-grid location types |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | DE27C |
| Comments |
2.2.2.1.3.16 Field Latitude
2.2.2.1.3.16.1 Latitude properties
| Property | Value |
| Name | Latitude |
| Technical name | |
| Activated | true |
| Id | |
| Description | Latitude coordinate in case of geographic coordinates |
| Type | number |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 38.8951 |
| Comments | [{"dataType":"float"}] |
2.2.2.1.3.17 Field Longitude
2.2.2.1.3.17.1 Longitude properties
| Property | Value |
| Name | Longitude |
| Technical name | |
| Activated | true |
| Id | |
| Description | Longitude coordinate in case of geographic coordinates |
| Type | number |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | -77.0364 |
| Comments | [{"dataType":"float"}] |
2.2.2.1.3.18 Field PosX
2.2.2.1.3.18.1 PosX properties
| Property | Value |
| Name | PosX |
| Technical name | |
| Activated | true |
| Id | |
| Description | Horizontal coordinate in case of projected coordinates |
| Type | integer |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.1.3.19 Field PosY
2.2.2.1.3.19.1 PosY properties
| Property | Value |
| Name | PosY |
| Technical name | |
| Activated | true |
| Id | |
| Description | Vertical coordinate in case of projected coordinates |
| Type | integer |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.1.3.20 Field Variable
2.2.2.1.3.20.1 Variable properties
| Property | Value |
| Name | Variable |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Observed variable |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | HDD |
| Comments |
2.2.2.1.4 Climate JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Climate",
"description": "Regional information on past and future amount of heating and cooling degree days (for potential climate normalisation and projection of energy demand)",
"properties": {
"ClimateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Experiment": {
"type": "string",
"description": "Type of simulation of regional climate model e.g. Historical, Evaluation, RCP2.6",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TemporalResolution": {
"type": "string",
"description": "Temporal resolution of data (can be the time period over which raw data is aggregated)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpatialResolution": {
"type": "string",
"description": "Spatial resolution of data",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"GlobalCirculationModel": {
"type": "string",
"description": "Global circulation model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RegionalClimateModel": {
"type": "string",
"description": "Regional climate model used",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SimulationVersion": {
"type": "string",
"description": "Run number of certain climate model or model combination",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnsembleMember": {
"type": "string",
"description": "Information on members of a model ensemble and changed conditions ('realisation', 'initialisation', 'physics'). Control member; 'r1i1p1'",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of observed variable",
"minimum": 1,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of observed value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date observation starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date observation ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"LocationType": {
"type": "string",
"description": "Type of spatial reference e.g. Zip code or geographic coordinates",
"minLength": 1,
"enum": [
"NUTS3",
"Zip Code",
"Geographic coordinates",
"Projected coordinates"
],
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CoordinateSystem": {
"type": "string",
"description": "Specific coordinate system used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Location": {
"type": "string",
"description": "Localisation of observed data in case of non-grid location types",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Latitude": {
"type": "number",
"description": "Latitude coordinate in case of geographic coordinates"
},
"Longitude": {
"type": "number",
"description": "Longitude coordinate in case of geographic coordinates"
},
"PosX": {
"type": "integer",
"description": "Horizontal coordinate in case of projected coordinates"
},
"PosY": {
"type": "integer",
"description": "Vertical coordinate in case of projected coordinates"
},
"Variable": {
"type": "string",
"description": "Observed variable",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateId",
"Value",
"Unit",
"ValidFrom",
"ValidUntil",
"LocationType",
"Variable"
]
}2.2.2.1.5 Climate JSON data
{
"ClimateId": "075a2983-a8e5-4ea8-a354-6a88b311bfdb",
"Experiment": "Historical",
"TemporalResolution": "monthly",
"SpatialResolution": "0.11 degree x 0.11 degree",
"GlobalCirculationModel": "MPI-M-MPI-ESM-LR",
"RegionalClimateModel": "AWI-HIRHAM5",
"SimulationVersion": "W_U8kp1N2",
"EnsembleMember": "r1i1p1",
"Value": 28462827.85,
"Unit": "°C",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"LocationType": "Geographic coordinates",
"CoordinateSystem": "@5.1ycGR#u",
"Location": "DE27C",
"Latitude": 38.8951,
"Longitude": -77.0364,
"PosX": -46,
"PosY": 41,
"Variable": "HDD"
}2.2.2.2 Document ClimateBuilding
2.2.2.2.1 ClimateBuilding Tree Diagram
2.2.2.2.2 ClimateBuilding Properties
| Property | Value |
| Document name | ClimateBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Climate and Building |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.2.3 ClimateBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.2.3.1 Field ClimateId
2.2.2.2.3.1.1 ClimateId properties
| Property | Value |
| Name | ClimateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Climate |
| Foreign field | ClimateId |
| Relationship type | Foreign Key |
| Relationship name | fk Climate. to ClimateBuilding. |
| Cardinality | 0..n |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.2.3.2 Field BuildingId
2.2.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to ClimateBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.2.4 ClimateBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateBuilding",
"description": "Linking entity between Climate and Building",
"properties": {
"ClimateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateId",
"BuildingId"
]
}2.2.2.2.5 ClimateBuilding JSON data
{
"ClimateId": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}2.2.2.3 Document ClimateSite
2.2.2.3.1 ClimateSite Tree Diagram
2.2.2.3.2 ClimateSite Properties
| Property | Value |
| Document name | ClimateSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Climate and Site |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.3.3 ClimateSite Fields
| Field | Type | Req | Key | Description | Comments |
| ClimateId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.3.3.1 Field ClimateId
2.2.2.3.3.1.1 ClimateId properties
| Property | Value |
| Name | ClimateId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Climate |
| Foreign field | ClimateId |
| Relationship type | Foreign Key |
| Relationship name | fk Climate. to ClimateSite. |
| Cardinality | 0..n |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.3.3.2 Field SiteId
2.2.2.3.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to ClimateSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.2.2.3.4 ClimateSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ClimateSite",
"description": "Linking entity between Climate and Site",
"properties": {
"ClimateId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ClimateId",
"SiteId"
]
}2.2.2.3.5 ClimateSite JSON data
{
"ClimateId": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}2.2.2.4 Document EmissionFactor
2.2.2.4.1 EmissionFactor Tree Diagram
2.2.2.4.2 EmissionFactor Properties
| Property | Value |
| Document name | EmissionFactor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Emission factors that are applied to convert energy consumption data into greenhouse gas emissions. The entity also includes global warming potential data for non-CO2 greenhouse gases in order to calculate CO2-equivalents (CO2e) |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.2.2.4.3 EmissionFactor Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| Name | string | false | User specific emission factor name (this can also be the name of a scenario) | ||
| Country | string | true | Country in which the emission factor is valid | ||
| Type | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | true | Value of emission factor | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission factor in terms of kgCO2e per unit of resource consumption | ||
| Source | string | false | Source of emission factor e.g. 'International Energy Agency' | ||
| SpaceType | string | false | Differentiated emission factor for certain space type (within a building) | ||
| Region | string | false | Areas that are broadly divided by physical characteristics, human impact characteristics, and the interaction of humanity and the environment | ||
| City | string | false | Any official settlement including cities, towns, villages, hamlets, localities, etc. |
2.2.2.4.3.1 Field EmissionFactorId
2.2.2.4.3.1.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.4.3.2 Field Name
2.2.2.4.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific emission factor name (this can also be the name of a scenario) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BM default |
| Comments |
2.2.2.4.3.3 Field Country
2.2.2.4.3.3.1 Country properties
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Country in which the emission factor is valid |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Germany |
| Comments |
2.2.2.4.3.4 Field Type
2.2.2.4.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Format | |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & consumed,REC,Natural gas (standard mix),Green natural gas,Oil-based fuels,District heating,District cooling,Biomass,Solar thermal,Reclaimed water,Water discharge,Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Solar thermal |
| Comments |
2.2.2.4.3.5 Field ValidFrom
2.2.2.4.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.4.3.6 Field ValidUntil
2.2.2.4.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.4.3.7 Field Value
2.2.2.4.3.7.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of emission factor |
| Type | number |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2638593.12 |
| Comments | [{"dataType":"float"}] |
2.2.2.4.3.8 Field Unit
2.2.2.4.3.8.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission factor in terms of kgCO2e per unit of resource consumption |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | kgCO2e/kWh,kgCO2e/kg,kgCO2e/m³ |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | kgCO2e/kg |
| Comments |
2.2.2.4.3.9 Field Source
2.2.2.4.3.9.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of emission factor e.g. 'International Energy Agency' |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | International Energy Agency |
| Comments |
2.2.2.4.3.10 Field SpaceType
2.2.2.4.3.10.1 SpaceType properties
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Differentiated emission factor for certain space type (within a building) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Landlord space |
| Comments |
2.2.2.4.3.11 Field Region
2.2.2.4.3.11.1 Region properties
| Property | Value |
| Name | Region |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Areas that are broadly divided by physical characteristics, human impact characteristics, and the interaction of humanity and the environment |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Bavaria |
| Comments |
2.2.2.4.3.12 Field City
2.2.2.4.3.12.1 City properties
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Any official settlement including cities, towns, villages, hamlets, localities, etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Berlin |
| Comments |
2.2.2.4.4 EmissionFactor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactor",
"description": "Emission factors that are applied to convert energy consumption data into greenhouse gas emissions. The entity also includes global warming potential data for non-CO2 greenhouse gases in order to calculate CO2-equivalents (CO2e)",
"additionalProperties": false,
"properties": {
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Name": {
"type": "string",
"description": "User specific emission factor name (this can also be the name of a scenario)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Country": {
"type": "string",
"description": "Country in which the emission factor is valid",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & consumed",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Oil-based fuels",
"District heating",
"District cooling",
"Biomass",
"Solar thermal",
"Reclaimed water",
"Water discharge",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of emission factor",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission factor in terms of kgCO2e per unit of resource consumption",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e/kWh",
"kgCO2e/kg",
"kgCO2e/m³"
]
},
"Source": {
"type": "string",
"description": "Source of emission factor e.g. 'International Energy Agency'",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceType": {
"type": "string",
"description": "Differentiated emission factor for certain space type (within a building)",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Region": {
"type": "string",
"description": "Areas that are broadly divided by physical characteristics, human impact characteristics, and the interaction of humanity and the environment",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"description": "Any official settlement including cities, towns, villages, hamlets, localities, etc.",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorId",
"Country",
"Type",
"ValidFrom",
"ValidUntil",
"Value"
]
}2.2.2.4.5 EmissionFactor JSON data
{
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e",
"Name": "BM default",
"Country": "Germany",
"Type": "Solar thermal",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"Value": 2638593.12,
"Unit": "kgCO2e/kg",
"Source": "International Energy Agency",
"SpaceType": "Landlord space",
"Region": "Bavaria",
"City": "Berlin"
}2.2.2.5 Document EmissionFactorBuilding
2.2.2.5.1 EmissionFactorBuilding Tree Diagram
2.2.2.5.2 EmissionFactorBuilding Properties
| Property | Value |
| Document name | EmissionFactorBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between EmissionFactor and Building |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.5.3 EmissionFactorBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.5.3.1 Field EmissionFactorId
2.2.2.5.3.1.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to EmissionFactorBuilding. |
| Cardinality | 0..1 |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.5.3.2 Field BuildingId
2.2.2.5.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to EmissionFactorBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.5.4 EmissionFactorBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorBuilding",
"description": "Linking entity between EmissionFactor and Building",
"properties": {
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorId",
"BuildingId"
]
}2.2.2.5.5 EmissionFactorBuilding JSON data
{
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e",
"BuildingId": "SE-CH-2341"
}2.2.2.6 Document EmissionFactorOperationalMeasurement
2.2.2.6.1 EmissionFactorOperationalMeasurement Tree Diagram
2.2.2.6.2 EmissionFactorOperationalMeasurement Properties
| Property | Value |
| Document name | EmissionFactorOperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between EmissionFactor and OperationalMeasurement |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.6.3 EmissionFactorOperationalMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
2.2.2.6.3.1 Field EmissionFactorId
2.2.2.6.3.1.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to EmissionFactorOperationalMeasurement. |
| Cardinality | 0..n |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.6.3.2 Field OperationalMeasurementId
2.2.2.6.3.2.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to EmissionFactorOperationalMeasurement. |
| Cardinality | 0..n |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.6.4 EmissionFactorOperationalMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorOperationalMeasurement",
"description": "Linking entity between EmissionFactor and OperationalMeasurement",
"properties": {
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"EmissionFactorId",
"OperationalMeasurementId"
]
}2.2.2.6.5 EmissionFactorOperationalMeasurement JSON data
{
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e",
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6"
}2.2.2.7 Document EmissionFactorRole
2.2.2.7.1 EmissionFactorRole Tree Diagram
2.2.2.7.2 EmissionFactorRole Properties
| Property | Value |
| Document name | EmissionFactorRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between EmissionFactor and Role |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.7.3 EmissionFactorRole Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| RoleId | string | true | fk | Link to role |
2.2.2.7.3.1 Field EmissionFactorId
2.2.2.7.3.1.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to EmissionFactorRole. |
| Cardinality | 0..1 |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.7.3.2 Field RoleId
2.2.2.7.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to role |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to EmissionFactorRole. |
| Cardinality | 0..1 |
| Sample | R-01 |
| Comments |
2.2.2.7.4 EmissionFactorRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorRole",
"description": "Linking entity between EmissionFactor and Role",
"properties": {
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Link to role",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorId",
"RoleId"
]
}2.2.2.7.5 EmissionFactorRole JSON data
{
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e",
"RoleId": "R-01"
}2.2.2.8 Document EmissionFactorSite
2.2.2.8.1 EmissionFactorSite Tree Diagram
2.2.2.8.2 EmissionFactorSite Properties
| Property | Value |
| Document name | EmissionFactorSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between EmissionFactor and Site |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.8.3 EmissionFactorSite Fields
| Field | Type | Req | Key | Description | Comments |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.8.3.1 Field EmissionFactorId
2.2.2.8.3.1.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to EmissionFactorSite. |
| Cardinality | 0..1 |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.8.3.2 Field SiteId
2.2.2.8.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to EmissionFactorSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.2.2.8.4 EmissionFactorSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "EmissionFactorSite",
"description": "Linking entity between EmissionFactor and Site",
"properties": {
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$",
"minLength": 36,
"maxLength": 36
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"EmissionFactorId",
"SiteId"
]
}2.2.2.8.5 EmissionFactorSite JSON data
{
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e",
"SiteId": "AE-DE-02"
}2.2.2.9 Document GhgEmission
2.2.2.9.1 GhgEmission Tree Diagram
2.2.2.9.2 GhgEmission Properties
| Property | Value |
| Document name | GhgEmission |
| Technical name | |
| Activated | true |
| Id | |
| Description | Greenhouse gas (Ghg) emissions (in CO2e) corresponding to individual operational measurements. |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.2.2.9.3 GhgEmission Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| OperationalMeasurementId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| ParentId | string | false | Parent (Guid) of entity | [{"dataType":"guid"}] | |
| Name | string | false | Name of individual emission value (user-provided) | ||
| EmissionScope | string | true | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol | ||
| ReportingType | string | false | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| Type | string | true | General source of emission e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| LifeCycleAssessment | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of individual emission | [{"dataType":"float"}] | |
| Unit | string | false | Unit of emission value: kgCO2e | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
2.2.2.9.3.1 Field GhgEmissionId
2.2.2.9.3.1.1 GhgEmissionId properties
| Property | Value |
| Name | GhgEmissionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments | [{"dataType":"guid"}] |
2.2.2.9.3.2 Field OperationalMeasurementId
2.2.2.9.3.2.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to GhgEmission. |
| Cardinality | 1..n |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.9.3.3 Field ParentId
2.2.2.9.3.3.1 ParentId properties
| Property | Value |
| Name | ParentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of entity |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | ef3f9faf-48c5-4609-ae0a-43340d9369c4 |
| Comments | [{"dataType":"guid"}] |
2.2.2.9.3.4 Field Name
2.2.2.9.3.4.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual emission value (user-provided) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Biom¸ll |
| Comments |
2.2.2.9.3.5 Field EmissionScope
2.2.2.9.3.5.1 EmissionScope properties
| Property | Value |
| Name | EmissionScope |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | 1,2,3,Unspecified |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2 |
| Comments |
2.2.2.9.3.6 Field ReportingType
2.2.2.9.3.6.1 ReportingType properties
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Location-based,Market-based |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Market-based |
| Comments |
2.2.2.9.3.7 Field Type
2.2.2.9.3.7.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General source of emission e.g. energy, water or waste |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Energy,Fugitive,Waste,Water discharge,Water supply |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Waste |
| Comments |
2.2.2.9.3.8 Field SubType
2.2.2.9.3.8.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Format | |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Non-hazardous waste |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Solar thermal |
| Comments |
2.2.2.9.3.9 Field LifeCycleAssessment
2.2.2.9.3.9.1 LifeCycleAssessment properties
| Property | Value |
| Name | LifeCycleAssessment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | B4 |
| Comments |
2.2.2.9.3.10 Field ValidFrom
2.2.2.9.3.10.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.9.3.11 Field ValidUntil
2.2.2.9.3.11.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.9.3.12 Field Value
2.2.2.9.3.12.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of individual emission |
| Type | number |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 354678233.32 |
| Comments | [{"dataType":"float"}] |
2.2.2.9.3.13 Field Unit
2.2.2.9.3.13.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of emission value: kgCO2e |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | kgCO2e |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | kgCO2e |
| Comments |
2.2.2.9.3.14 Field Accuracy
2.2.2.9.3.14.1 Accuracy properties
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Calculated based on estimated data,Calculated based on metered data,Calculated based on extrapolated data,Calculated based on planed data,Calculated based on simulated data,Calculated based on data with unspecified accuracy,Calculated based on projected estimated data,Calculated based on projected metered data,Calculated based on projected extrapolated data,Calculated based on projected planned data,Calculated based on projected simulated data,Calculated based on projected data with unspecified accuracy,Estimated,Metered,Extrapolated,Planned,Unspecified,Simulated,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on data with unspecified accuracy,Projection based on simulated data,Missing,Calculated based on data with unspecified accuracy,Calculated based on projected data with unspecified accuracy,Retrofit scenario |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Missing |
| Comments |
2.2.2.9.4 GhgEmission JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmission",
"description": "Greenhouse gas (Ghg) emissions (in CO2e) corresponding to individual operational measurements.",
"additionalProperties": false,
"properties": {
"GhgEmissionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"ParentId": {
"type": "string",
"description": "Parent (Guid) of entity",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Name": {
"type": "string",
"description": "Name of individual emission value (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EmissionScope": {
"type": "string",
"description": "Emission scope 1, 2 or 3 according to the Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"1",
"2",
"3",
"Unspecified"
]
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based"
]
},
"Type": {
"type": "string",
"description": "General source of emission e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Fugitive",
"Waste",
"Water discharge",
"Water supply"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Non-hazardous waste"
]
},
"LifeCycleAssessment": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of individual emission",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of emission value: kgCO2e",
"enum": [
"kgCO2e"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Calculated based on estimated data",
"Calculated based on metered data",
"Calculated based on extrapolated data",
"Calculated based on planed data",
"Calculated based on simulated data",
"Calculated based on data with unspecified accuracy",
"Calculated based on projected estimated data",
"Calculated based on projected metered data",
"Calculated based on projected extrapolated data",
"Calculated based on projected planned data",
"Calculated based on projected simulated data",
"Calculated based on projected data with unspecified accuracy",
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Unspecified",
"Simulated",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on data with unspecified accuracy",
"Projection based on simulated data",
"Missing",
"Calculated based on data with unspecified accuracy",
"Calculated based on projected data with unspecified accuracy",
"Retrofit scenario"
]
}
},
"required": [
"GhgEmissionId",
"EmissionScope",
"Type",
"SubType",
"ValidFrom",
"ValidUntil",
"Accuracy"
]
}2.2.2.9.5 GhgEmission JSON data
{
"GhgEmissionId": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"ParentId": "ef3f9faf-48c5-4609-ae0a-43340d9369c4",
"Name": "Biom¸ll",
"EmissionScope": "2",
"ReportingType": "Market-based",
"Type": "Waste",
"SubType": "Solar thermal",
"LifeCycleAssessment": "B4",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"Value": 354678233.32,
"Unit": "kgCO2e",
"Accuracy": "Missing"
}2.2.2.10 Document GhgEmissionBuilding
2.2.2.10.1 GhgEmissionBuilding Tree Diagram
2.2.2.10.2 GhgEmissionBuilding Properties
| Property | Value |
| Document name | GhgEmissionBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between GhgEmission and Building |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.10.3 GhgEmissionBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.10.3.1 Field GhgEmissionId
2.2.2.10.3.1.1 GhgEmissionId properties
| Property | Value |
| Name | GhgEmissionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | GhgEmission |
| Foreign field | GhgEmissionId |
| Relationship type | Foreign Key |
| Relationship name | fk GhgEmission. to GhgEmissionBuilding. |
| Cardinality | 0..1 |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments | [{"dataType":"guid"}] |
2.2.2.10.3.2 Field BuildingId
2.2.2.10.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to GhgEmissionBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.10.4 GhgEmissionBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionBuilding",
"description": "Linking entity between GhgEmission and Building",
"properties": {
"GhgEmissionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionId",
"BuildingId"
]
}2.2.2.10.5 GhgEmissionBuilding JSON data
{
"GhgEmissionId": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"BuildingId": "SE-CH-2341"
}2.2.2.11 Document GhgEmissionEmissionFactor
2.2.2.11.1 GhgEmissionEmissionFactor Tree Diagram
2.2.2.11.2 GhgEmissionEmissionFactor Properties
| Property | Value |
| Document name | GhgEmissionEmissionFactor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between GhgEmission and EmissionFactor |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.11.3 GhgEmissionEmissionFactor Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
2.2.2.11.3.1 Field GhgEmissionId
2.2.2.11.3.1.1 GhgEmissionId properties
| Property | Value |
| Name | GhgEmissionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | GhgEmission |
| Foreign field | GhgEmissionId |
| Relationship type | Foreign Key |
| Relationship name | fk GhgEmission. to GhgEmissionEmissionFactor. |
| Cardinality | 0..1 |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments | [{"dataType":"guid"}] |
2.2.2.11.3.2 Field EmissionFactorId
2.2.2.11.3.2.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to GhgEmissionEmissionFactor. |
| Cardinality | 0..n |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.11.4 GhgEmissionEmissionFactor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionEmissionFactor",
"description": "Linking entity between GhgEmission and EmissionFactor",
"properties": {
"GhgEmissionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"GhgEmissionId",
"EmissionFactorId"
]
}2.2.2.11.5 GhgEmissionEmissionFactor JSON data
{
"GhgEmissionId": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e"
}2.2.2.12 Document GhgEmissionSite
2.2.2.12.1 GhgEmissionSite Tree Diagram
2.2.2.12.2 GhgEmissionSite Properties
| Property | Value |
| Document name | GhgEmissionSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between GhgEmission and Site |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.12.3 GhgEmissionSite Fields
| Field | Type | Req | Key | Description | Comments |
| GhgEmissionId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.12.3.1 Field GhgEmissionId
2.2.2.12.3.1.1 GhgEmissionId properties
| Property | Value |
| Name | GhgEmissionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | GhgEmission |
| Foreign field | GhgEmissionId |
| Relationship type | Foreign Key |
| Relationship name | fk GhgEmission. to GhgEmissionSite. |
| Cardinality | 0..1 |
| Sample | ba4900a3-8c7c-4966-9cd3-a5889f309c40 |
| Comments | [{"dataType":"guid"}] |
2.2.2.12.3.2 Field SiteId
2.2.2.12.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to GhgEmissionSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.2.2.12.4 GhgEmissionSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "GhgEmissionSite",
"description": "Linking entity between GhgEmission and Site",
"properties": {
"GhgEmissionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"GhgEmissionId",
"SiteId"
]
}2.2.2.12.5 GhgEmissionSite JSON data
{
"GhgEmissionId": "ba4900a3-8c7c-4966-9cd3-a5889f309c40",
"SiteId": "AE-DE-02"
}2.2.2.13 Document OperationalMeasurement
2.2.2.13.1 OperationalMeasurement Tree Diagram
2.2.2.13.2 OperationalMeasurement Properties
| Property | Value |
| Document name | OperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | Represents individual data on energy consumption, water consumption/withdrawal, waste output or fugitive emissions including various further information (procured by, subtypes, purpose, covered time period) |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.2.2.13.3 OperationalMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| ParentId | string | false | Parent (Guid) of entity | [{"dataType":"guid"}] | |
| Purpose | string | true | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas | ||
| Accuracy | string | true | Information on accuracy of value e.g. 'metered' or 'extrapolated' | ||
| Type | string | true | General type of operational measurement e.g. energy, water or waste | ||
| SubType | string | true | Specific type of operational measurement e.g. district heating or water discharge | ||
| Name | string | false | Name of individual operational measurement. (user-provided) | ||
| Value | number | false | Value of individual operational measurement | [{"dataType":"float"}] | |
| Unit | string | false | Unit of operational measurement e.g. 'kWh' or 'm³' | ||
| ProcuredBy | string | false | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol | ||
| SpaceType | string | true | Reference to specific space type (or 'whole building') | ||
| LifeCycleAssessment | string | false | Related life cycle assessment stage according to ISO 14040 | ||
| PostingDate | date-time | false | Date of measurement posting in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| MeasurementDate | date-time | false | Date of measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| SensorId | string | false | Unique identifier either coming from previous system otherwise it needs to be define |
2.2.2.13.3.1 Field OperationalMeasurementId
2.2.2.13.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.13.3.2 Field ParentId
2.2.2.13.3.2.1 ParentId properties
| Property | Value |
| Name | ParentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Parent (Guid) of entity |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | c7175705-411f-4548-90d4-f58740fc2d30 |
| Comments | [{"dataType":"guid"}] |
2.2.2.13.3.3 Field Purpose
2.2.2.13.3.3.1 Purpose properties
| Property | Value |
| Name | Purpose |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Space heating,Water heating,Heating (unspecified),Cooling,Lighting,Elevator,Appliances,Other,Unspecified,Heat pump |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Space heating |
| Comments |
2.2.2.13.3.4 Field Accuracy
2.2.2.13.3.4.1 Accuracy properties
| Property | Value |
| Name | Accuracy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on accuracy of value e.g. 'metered' or 'extrapolated' |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | Estimated,Metered,Extrapolated,Planned,Simulated,Unspecified,Projection based on estimated data,Projection based on metered data,Projection based on extrapolated data,Projection based on planned data,Projection based on simulated data,Projection based on data with unspecified accuracy,Missing |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Extrapolated |
| Comments |
2.2.2.13.3.5 Field Type
2.2.2.13.3.5.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | General type of operational measurement e.g. energy, water or waste |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Energy,Water,Waste,Fugitive |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Waste |
| Comments |
2.2.2.13.3.6 Field SubType
2.2.2.13.3.6.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Specific type of operational measurement e.g. district heating or water discharge |
| Format | |
| Pattern | [^<>\[\]\{\}\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | Electricity from grid (green electricity contract),Electricity self-generated & exported,Electricity self-generated & consumed,Electricity (unspecified),REC,Natural gas (standard mix),Green natural gas,Natural gas (unspecified),Oil-based fuels,Fuel (unspecified),District heating,District cooling,Biomass,Solar thermal,Fresh water (municipal water supply),Ground water (collected on site),Rain water (collected on site),Reclaimed water,Water discharge,Water consumption (unspecified),Recyclable or reusable waste,Non-recyclable waste (to be burned),Biodegradable,Hazardous waste,Waste (unspecified),Electricity from grid (normal contract),Carbon dioxide (CO2),Methane (CH4),Nitrous oxide (N20),R-11|CFC-11 | Trichlorofluoromethane (CCI3F),R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2),R-13 | CFC-13 | Chlorodifluoromethane (CCIF3),R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3),R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4),R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5),R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3),R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2),R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4),R-10 | Carbon tetrachloride (CCl4),Bromomethane | Methyl bromide (CH3Br),R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3),R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F),R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2),R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3),R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4),R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F),R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2),R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5),R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5),R-23 | HFC-23 | ,R-32 | HFC-32 | ,R-41 | HFC-41 | ,R-125 | HFC-125 | ,R-134 | HFC-134 | ,R-134a | HFC-134a | ,R-143 | HFC-143 | ,R-143a | HFC-143a | ,R-152 | HFC-152 | ,R-152a | HFC-152a | ,R-161 | HFC-161 | ,R-227ea | HFC-227ea | ,R-236cb | HFC-236cb | ,R-236ea | HFC-236ea | ,R-236fa | HFC-236fa | ,R-245ca | HFC-245ca | ,R-245fa | HFC-245fa | ,R-365mfc | HFC-365mfc | ,R-43-10mee | HFC-43-10mee | ,Sulfur hexafluoride (SF6),Nitrogen trifluoride (NF3),Water supply,Non-hazardous waste |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Solar thermal |
| Comments |
2.2.2.13.3.7 Field Name
2.2.2.13.3.7.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of individual operational measurement. (user-provided) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.13.3.8 Field Value
2.2.2.13.3.8.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of individual operational measurement |
| Type | number |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1234.3476 |
| Comments | [{"dataType":"float"}] |
2.2.2.13.3.9 Field Unit
2.2.2.13.3.9.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of operational measurement e.g. 'kWh' or 'm³' |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | |
| Max length | |
| Default | |
| Enum | kWh,m³,kg |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.2.2.13.3.10 Field ProcuredBy
2.2.2.13.3.10.1 ProcuredBy properties
| Property | Value |
| Name | ProcuredBy |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Procured by third party,Self-procured,Unspecified |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Self-procured |
| Comments |
2.2.2.13.3.11 Field SpaceType
2.2.2.13.3.11.1 SpaceType properties
| Property | Value |
| Name | SpaceType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to specific space type (or 'whole building') |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Shared services/Common spaces,Tenant space,Landlord space,Whole building,Unspecified,Shared services,Common spaces |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Landlord space |
| Comments |
2.2.2.13.3.12 Field LifeCycleAssessment
2.2.2.13.3.12.1 LifeCycleAssessment properties
| Property | Value |
| Name | LifeCycleAssessment |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Related life cycle assessment stage according to ISO 14040 |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | A1,A2,A3,A4,A5,B1,B2,B3,B4,B5,B6,B7,C1,C2,C3,C4,D |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | B4 |
| Comments |
2.2.2.13.3.13 Field PostingDate
2.2.2.13.3.13.1 PostingDate properties
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement posting in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.13.3.14 Field MeasurementDate
2.2.2.13.3.14.1 MeasurementDate properties
| Property | Value |
| Name | MeasurementDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.13.3.15 Field ValidFrom
2.2.2.13.3.15.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.13.3.16 Field ValidUntil
2.2.2.13.3.16.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.13.3.17 Field SensorId
2.2.2.13.3.17.1 SensorId properties
| Property | Value |
| Name | SensorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | IHSG-73619283 |
| Comments |
2.2.2.13.4 OperationalMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurement",
"description": "Represents individual data on energy consumption, water consumption/withdrawal, waste output or fugitive emissions including various further information (procured by, subtypes, purpose, covered time period)",
"additionalProperties": false,
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"ParentId": {
"type": "string",
"description": "Parent (Guid) of entity",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"Purpose": {
"type": "string",
"description": "Specific purpose of resource consumption e.g. 'space heating' in case of burning natural gas",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Space heating",
"Water heating",
"Heating (unspecified)",
"Cooling",
"Lighting",
"Elevator",
"Appliances",
"Other",
"Unspecified",
"Heat pump"
]
},
"Accuracy": {
"type": "string",
"description": "Information on accuracy of value e.g. 'metered' or 'extrapolated'",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 75,
"enum": [
"Estimated",
"Metered",
"Extrapolated",
"Planned",
"Simulated",
"Unspecified",
"Projection based on estimated data",
"Projection based on metered data",
"Projection based on extrapolated data",
"Projection based on planned data",
"Projection based on simulated data",
"Projection based on data with unspecified accuracy",
"Missing"
]
},
"Type": {
"type": "string",
"description": "General type of operational measurement e.g. energy, water or waste",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"Water",
"Waste",
"Fugitive"
]
},
"SubType": {
"type": "string",
"description": "Specific type of operational measurement e.g. district heating or water discharge",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Electricity from grid (green electricity contract)",
"Electricity self-generated & exported",
"Electricity self-generated & consumed",
"Electricity (unspecified)",
"REC",
"Natural gas (standard mix)",
"Green natural gas",
"Natural gas (unspecified)",
"Oil-based fuels",
"Fuel (unspecified)",
"District heating",
"District cooling",
"Biomass",
"Solar thermal",
"Fresh water (municipal water supply)",
"Ground water (collected on site)",
"Rain water (collected on site)",
"Reclaimed water",
"Water discharge",
"Water consumption (unspecified)",
"Recyclable or reusable waste",
"Non-recyclable waste (to be burned)",
"Biodegradable",
"Hazardous waste",
"Waste (unspecified)",
"Electricity from grid (normal contract)",
"Carbon dioxide (CO2)",
"Methane (CH4)",
"Nitrous oxide (N20)",
"R-11|CFC-11 | Trichlorofluoromethane (CCI3F)",
"R-12 | CFC-12 | Dichlorofluoromethane (CCI2F2)",
"R-13 | CFC-13 | Chlorodifluoromethane (CCIF3)",
"R-113 | CFC-113 | 1,1,2-Trichloro-1,2,2-trifluoroethane (C2CI3F3)",
"R-114 | CFC-114 | Halon-242 | 1,2-Dichlorotetrafluoroethane (C2Cl2F4)",
"R-115 | CFC-115 | Chloropentafluoroethane (C2ClF5)",
"R13 B1 | Halon-1301 | Bromotrifluoromethane (CBrF3)",
"R-12B1 | Halon-1211 | Bromochlorodifluoromethane (CBrCIF2)",
"R 114B2 | Halon-2402 | 1,2-Dibromotetrafluoroethane (C2Br2F4)",
"R-10 | Carbon tetrachloride (CCl4)",
"Bromomethane | Methyl bromide (CH3Br)",
"R-140a | 1,1,1- Trichloroethane | Methyl chloroform (C2H3Cl3)",
"R-21 | HCFC-21 | Dichlorofluoromethane (CHCl2F)",
"R-22 | HCFC-22 | Chlorodifluoromethane (CHClF2)",
"R-123 | HCFC-123 | 2,2-Dichloro-1,1,1-trifluoroethane (C2Cl2F3)",
"R-124 | HCFC-124| 1-Chloro-1,2,2,2-tetrafluoroethane (C2ClF4)",
"R-141b | HCFC-141b |1,1,-Dichloro-1-1-fluoroethane (C2H3Cl2F)",
"R-142b | HCFC-142b | 1-Chloro-1,1,-difluoroethane (C2ClF2)",
"R-225ca | HCFC-225ca | 3.3-dichloro-1,1,1,2,2-pentafluoropropane (C3HCl2F5)",
"R-225cb | HCFC-225cb | 1,3-Dichloro-1,1,2,2,3-pentafluoropropane (C3HCl2F5)",
"R-23 | HFC-23 | ",
"R-32 | HFC-32 | ",
"R-41 | HFC-41 | ",
"R-125 | HFC-125 | ",
"R-134 | HFC-134 | ",
"R-134a | HFC-134a | ",
"R-143 | HFC-143 | ",
"R-143a | HFC-143a | ",
"R-152 | HFC-152 | ",
"R-152a | HFC-152a | ",
"R-161 | HFC-161 | ",
"R-227ea | HFC-227ea | ",
"R-236cb | HFC-236cb | ",
"R-236ea | HFC-236ea | ",
"R-236fa | HFC-236fa | ",
"R-245ca | HFC-245ca | ",
"R-245fa | HFC-245fa | ",
"R-365mfc | HFC-365mfc | ",
"R-43-10mee | HFC-43-10mee | ",
"Sulfur hexafluoride (SF6)",
"Nitrogen trifluoride (NF3)",
"Water supply",
"Non-hazardous waste"
]
},
"Name": {
"type": "string",
"description": "Name of individual operational measurement. (user-provided)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Value": {
"type": "number",
"description": "Value of individual operational measurement",
"minimum": -100000000000000000,
"maximum": 100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of operational measurement e.g. 'kWh' or 'm³'",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kWh",
"m³",
"kg"
]
},
"ProcuredBy": {
"type": "string",
"description": "Information on operational control ('who bought it?') of resource consumption according to Greenhouse Gas Protocol",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Procured by third party",
"Self-procured",
"Unspecified"
]
},
"SpaceType": {
"type": "string",
"description": "Reference to specific space type (or 'whole building')",
"enum": [
"Shared services/Common spaces",
"Tenant space",
"Landlord space",
"Whole building",
"Unspecified",
"Shared services",
"Common spaces"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LifeCycleAssessment": {
"type": "string",
"description": "Related life cycle assessment stage according to ISO 14040",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"A1",
"A2",
"A3",
"A4",
"A5",
"B1",
"B2",
"B3",
"B4",
"B5",
"B6",
"B7",
"C1",
"C2",
"C3",
"C4",
"D"
]
},
"PostingDate": {
"type": "string",
"description": "Date of measurement posting in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"MeasurementDate": {
"type": "string",
"description": "Date of measurement was taken in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"SensorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"Purpose",
"Accuracy",
"Type",
"SubType",
"SpaceType",
"ValidFrom",
"ValidUntil"
]
}2.2.2.13.5 OperationalMeasurement JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"ParentId": "c7175705-411f-4548-90d4-f58740fc2d30",
"Purpose": "Space heating",
"Accuracy": "Extrapolated",
"Type": "Waste",
"SubType": "Solar thermal",
"Name": "@DsjBCaSQzbe,DV.bd'elP-YsjNwNkv,B@R gGFgV1orcJ8JpVt*FB9U13nFS2,08EkdiQOYWUuv7iExS03tQz`ewZ I1__eq8wa#hoTX6Hgaq",
"Value": 1234.3476,
"Unit": "eWm5WrMXgUgUs1V/A4S5oz/-KE",
"ProcuredBy": "Self-procured",
"SpaceType": "Landlord space",
"LifeCycleAssessment": "B4",
"PostingDate": "2011-06-14T04:12:36.123Z",
"MeasurementDate": "2011-06-14T04:12:36.123Z",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"SensorId": "IHSG-73619283"
}2.2.2.14 Document OperationalMeasurementBuilding
2.2.2.14.1 OperationalMeasurementBuilding Tree Diagram
2.2.2.14.2 OperationalMeasurementBuilding Properties
| Property | Value |
| Document name | OperationalMeasurementBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Building |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.14.3 OperationalMeasurementBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.14.3.1 Field OperationalMeasurementId
2.2.2.14.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementBuilding. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.14.3.2 Field BuildingId
2.2.2.14.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to OperationalMeasurementBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.14.4 OperationalMeasurementBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementBuilding",
"description": "Linking entity between OperationalMeasurement and Building",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"BuildingId"
]
}2.2.2.14.5 OperationalMeasurementBuilding JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"BuildingId": "SE-CH-2341"
}2.2.2.15 Document OperationalMeasurementFloor
2.2.2.15.1 OperationalMeasurementFloor Tree Diagram
2.2.2.15.2 OperationalMeasurementFloor Properties
| Property | Value |
| Document name | OperationalMeasurementFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Floor |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.15.3 OperationalMeasurementFloor Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| FloorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.15.3.1 Field OperationalMeasurementId
2.2.2.15.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementFloor. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.15.3.2 Field FloorId
2.2.2.15.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to OperationalMeasurementFloor. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.2.2.15.4 OperationalMeasurementFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementFloor",
"description": "Linking entity between OperationalMeasurement and Floor",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"FloorId"
]
}2.2.2.15.5 OperationalMeasurementFloor JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"FloorId": "SE-CH-F-01"
}2.2.2.16 Document OperationalMeasurementLand
2.2.2.16.1 OperationalMeasurementLand Tree Diagram
2.2.2.16.2 OperationalMeasurementLand Properties
| Property | Value |
| Document name | OperationalMeasurementLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Land |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.16.3 OperationalMeasurementLand Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.16.3.1 Field OperationalMeasurementId
2.2.2.16.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementLand. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.16.3.2 Field LandId
2.2.2.16.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to OperationalMeasurementLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.2.2.16.4 OperationalMeasurementLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementLand",
"description": "Linking entity between OperationalMeasurement and Land",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"LandId"
]
}2.2.2.16.5 OperationalMeasurementLand JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"LandId": "RE-AT-05"
}2.2.2.17 Document OperationalMeasurementRole
2.2.2.17.1 OperationalMeasurementRole Tree Diagram
2.2.2.17.2 OperationalMeasurementRole Properties
| Property | Value |
| Document name | OperationalMeasurementRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Role |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.17.3 OperationalMeasurementRole Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.17.3.1 Field OperationalMeasurementId
2.2.2.17.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementRole. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.17.3.2 Field RoleId
2.2.2.17.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to OperationalMeasurementRole. |
| Cardinality | 0..1 |
| Sample | R-01 |
| Comments |
2.2.2.17.4 OperationalMeasurementRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementRole",
"description": "Linking entity between OperationalMeasurement and Role",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"RoleId"
]
}2.2.2.17.5 OperationalMeasurementRole JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"RoleId": "R-01"
}2.2.2.18 Document OperationalMeasurementSite
2.2.2.18.1 OperationalMeasurementSite Tree Diagram
2.2.2.18.2 OperationalMeasurementSite Properties
| Property | Value |
| Document name | OperationalMeasurementSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Site |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.18.3 OperationalMeasurementSite Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.18.3.1 Field OperationalMeasurementId
2.2.2.18.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementSite. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.18.3.2 Field SiteId
2.2.2.18.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to OperationalMeasurementSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.2.2.18.4 OperationalMeasurementSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSite",
"description": "Linking entity between OperationalMeasurement and Site",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"SiteId"
]
}2.2.2.18.5 OperationalMeasurementSite JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"SiteId": "AE-DE-02"
}2.2.2.19 Document OperationalMeasurementSpace
2.2.2.19.1 OperationalMeasurementSpace Tree Diagram
2.2.2.19.2 OperationalMeasurementSpace Properties
| Property | Value |
| Document name | OperationalMeasurementSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Space |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.19.3 OperationalMeasurementSpace Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| SpaceId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.19.3.1 Field OperationalMeasurementId
2.2.2.19.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementSpace. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.19.3.2 Field SpaceId
2.2.2.19.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | Foreign Key |
| Relationship name | fk Space. to OperationalMeasurementSpace. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01-21 |
| Comments |
2.2.2.19.4 OperationalMeasurementSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementSpace",
"description": "Linking entity between OperationalMeasurement and Space",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"SpaceId"
]
}2.2.2.19.5 OperationalMeasurementSpace JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"SpaceId": "SE-CH-F-01-21"
}2.2.2.20 Document OperationalMeasurementUnit
2.2.2.20.1 OperationalMeasurementUnit Tree Diagram
2.2.2.20.2 OperationalMeasurementUnit Properties
| Property | Value |
| Document name | OperationalMeasurementUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between OperationalMeasurement and Unit |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.20.3 OperationalMeasurementUnit Fields
| Field | Type | Req | Key | Description | Comments |
| OperationalMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.2.2.20.3.1 Field OperationalMeasurementId
2.2.2.20.3.1.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to OperationalMeasurementUnit. |
| Cardinality | 0..1 |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.2.2.20.3.2 Field UnitId
2.2.2.20.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to OperationalMeasurementUnit. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.2.2.20.4 OperationalMeasurementUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "OperationalMeasurementUnit",
"description": "Linking entity between OperationalMeasurement and Unit",
"properties": {
"OperationalMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"OperationalMeasurementId",
"UnitId"
]
}2.2.2.20.5 OperationalMeasurementUnit JSON data
{
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6",
"UnitId": "UN-SE-CH-2341-02"
}2.2.2.21 Document SustainabilityIndicator
2.2.2.21.1 SustainabilityIndicator Tree Diagram
2.2.2.21.2 SustainabilityIndicator Properties
| Property | Value |
| Document name | SustainabilityIndicator |
| Technical name | |
| Activated | true |
| Id | |
| Description | Sustainability-related information on building-level: energy consumption, net energy demand, carbon emissions (total, separated in emissions scopes, market- and location-based, alignment with targets, excess emissions, carbon costs and penalties) |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.21.3 SustainabilityIndicator Fields
| Field | Type | Req | Key | Description | Comments |
| SustainabilityIndicatorId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| BuildingId | string | true | fk | Identifier of building | |
| Category | string | true | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs | ||
| Type | string | false | Type of sustainability indicator e.g. absolute or intensity figures or stranding | ||
| SubType | string | false | Subtype of sustainability indicator e.g. net-energy or emission scope | ||
| Source | string | false | Operational source of energy or emission figures e.g. electricity or water | ||
| ReferenceArea | string | false | Reference area of building used as denominator in intensity calculation | ||
| ReportingType | string | false | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based | ||
| BaseYear | date-time | false | Base year of values projected into the future in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. | [{"dataType":"dateTime"}] | |
| Value | number | false | Value of sustainability indicator | [{"dataType":"float"}] | |
| Unit | string | false | Unit of sustainability indicator value | ||
| ValidFrom | date-time | true | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.2.2.21.3.1 Field SustainabilityIndicatorId
2.2.2.21.3.1.1 SustainabilityIndicatorId properties
| Property | Value |
| Name | SustainabilityIndicatorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 8462d997-6fd2-439e-88d0-d3b2e19517c8 |
| Comments | [{"dataType":"guid"}] |
2.2.2.21.3.2 Field BuildingId
2.2.2.21.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Identifier of building |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to SustainabilityIndicator. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.2.2.21.3.3 Field Category
2.2.2.21.3.3.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Costs,Energy,Ghg,Area |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Energy |
| Comments |
2.2.2.21.3.4 Field Type
2.2.2.21.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of sustainability indicator e.g. absolute or intensity figures or stranding |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Absolute,Intensity,Excess emissions,Stranding,Target |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Excess emissions |
| Comments |
2.2.2.21.3.5 Field SubType
2.2.2.21.3.5.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of sustainability indicator e.g. net-energy or emission scope |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Total,Scope 1,Scope 2,Scope 3,Unspecified scope,Net energy,Consumption,Renewable on-site,Renewable including off-site,CRREM 1.5°C,CRREM 2°C |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Unspecified scope |
| Comments |
2.2.2.21.3.6 Field Source
2.2.2.21.3.6.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Operational source of energy or emission figures e.g. electricity or water |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Energy,All,Fuels,Electricity,District heating,District cooling,Fugitive,Water supply,Water discharge,Water,Waste,District heating & fuel |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Electricity |
| Comments |
2.2.2.21.3.7 Field ReferenceArea
2.2.2.21.3.7.1 ReferenceArea properties
| Property | Value |
| Name | ReferenceArea |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference area of building used as denominator in intensity calculation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Net rentable area,Gross internal area |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Gross internal area |
| Comments |
2.2.2.21.3.8 Field ReportingType
2.2.2.21.3.8.1 ReportingType properties
| Property | Value |
| Name | ReportingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Location-based,Market-based |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Market-based |
| Comments |
2.2.2.21.3.9 Field BaseYear
2.2.2.21.3.9.1 BaseYear properties
| Property | Value |
| Name | BaseYear |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Base year of values projected into the future in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00. |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.21.3.10 Field Value
2.2.2.21.3.10.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of sustainability indicator |
| Type | number |
| Min value | -100000000000000000 |
| Excl min | |
| Max value | 100000000000000000 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 546372812.24 |
| Comments | [{"dataType":"float"}] |
2.2.2.21.3.11 Field Unit
2.2.2.21.3.11.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of sustainability indicator value |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | kgCO2e,kgCO2e/m²,kWh,kWh/m²,€,m² |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | kWh/m² |
| Comments |
2.2.2.21.3.12 Field ValidFrom
2.2.2.21.3.12.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.21.3.13 Field ValidUntil
2.2.2.21.3.13.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.2.2.21.4 SustainabilityIndicator JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SustainabilityIndicator",
"description": "Sustainability-related information on building-level: energy consumption, net energy demand, carbon emissions (total, separated in emissions scopes, market- and location-based, alignment with targets, excess emissions, carbon costs and penalties)",
"properties": {
"SustainabilityIndicatorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"BuildingId": {
"type": "string",
"description": "Identifier of building",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Category": {
"type": "string",
"description": "Overall category of sustainability indicator e.g. energy, greenhouse gas emissions or costs",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Costs",
"Energy",
"Ghg",
"Area"
]
},
"Type": {
"type": "string",
"description": "Type of sustainability indicator e.g. absolute or intensity figures or stranding",
"enum": [
"Absolute",
"Intensity",
"Excess emissions",
"Stranding",
"Target"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SubType": {
"type": "string",
"description": "Subtype of sustainability indicator e.g. net-energy or emission scope",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Total",
"Scope 1",
"Scope 2",
"Scope 3",
"Unspecified scope",
"Net energy",
"Consumption",
"Renewable on-site",
"Renewable including off-site",
"CRREM 1.5°C",
"CRREM 2°C"
]
},
"Source": {
"type": "string",
"description": "Operational source of energy or emission figures e.g. electricity or water",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Energy",
"All",
"Fuels",
"Electricity",
"District heating",
"District cooling",
"Fugitive",
"Water supply",
"Water discharge",
"Water",
"Waste",
"District heating & fuel"
]
},
"ReferenceArea": {
"type": "string",
"description": "Reference area of building used as denominator in intensity calculation",
"enum": [
"Net rentable area",
"Gross internal area"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ReportingType": {
"type": "string",
"description": "Approach of reporting emissions e.g. from 'green electricity consumption': Market-based or location-based",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Location-based",
"Market-based"
]
},
"BaseYear": {
"type": "string",
"description": "Base year of values projected into the future in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061). In case no exact date is used please use xxxx-01-01 00:00:00.",
"format": "date-time"
},
"Value": {
"type": "number",
"description": "Value of sustainability indicator",
"maximum": 100000000000000000,
"minimum": -100000000000000000
},
"Unit": {
"type": "string",
"description": "Unit of sustainability indicator value",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"kgCO2e",
"kgCO2e/m²",
"kWh",
"kWh/m²",
"€",
"m²"
]
},
"ValidFrom": {
"type": "string",
"description": "Date validity starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date validity ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"SustainabilityIndicatorId",
"BuildingId",
"Category",
"ValidFrom",
"ValidUntil"
]
}2.2.2.21.5 SustainabilityIndicator JSON data
{
"SustainabilityIndicatorId": "8462d997-6fd2-439e-88d0-d3b2e19517c8",
"BuildingId": "SE-CH-2341",
"Category": "Energy",
"Type": "Excess emissions",
"SubType": "Unspecified scope",
"Source": "Electricity",
"ReferenceArea": "Gross internal area",
"ReportingType": "Market-based",
"BaseYear": "2011-06-14T04:12:36.123Z",
"Value": 546372812.24,
"Unit": "kWh/m²",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.2.2.22 Document SustainabilityIndicatorEmissionFactor
2.2.2.22.1 SustainabilityIndicatorEmissionFactor Tree Diagram
2.2.2.22.2 SustainabilityIndicatorEmissionFactor Properties
| Property | Value |
| Document name | SustainabilityIndicatorEmissionFactor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between SustainabilityIndicator and EmissionFactor |
| Group | EnergyAndResources |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.2.2.22.3 SustainabilityIndicatorEmissionFactor Fields
| Field | Type | Req | Key | Description | Comments |
| SustainabilityIndicatorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
| EmissionFactorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be define | [{"dataType":"guid"}] |
2.2.2.22.3.1 Field SustainabilityIndicatorId
2.2.2.22.3.1.1 SustainabilityIndicatorId properties
| Property | Value |
| Name | SustainabilityIndicatorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | SustainabilityIndicator |
| Foreign field | SustainabilityIndicatorId |
| Relationship type | Foreign Key |
| Relationship name | fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor. |
| Cardinality | 0..1 |
| Sample | 8462d997-6fd2-439e-88d0-d3b2e19517c8 |
| Comments | [{"dataType":"guid"}] |
2.2.2.22.3.2 Field EmissionFactorId
2.2.2.22.3.2.1 EmissionFactorId properties
| Property | Value |
| Name | EmissionFactorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be define |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | EmissionFactor |
| Foreign field | EmissionFactorId |
| Relationship type | Foreign Key |
| Relationship name | fk EmissionFactor. to SustainabilityIndicatorEmissionFactor. |
| Cardinality | 0..n |
| Sample | eb40c43b-8950-47b5-902f-0adac685f19e |
| Comments | [{"dataType":"guid"}] |
2.2.2.22.4 SustainabilityIndicatorEmissionFactor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "SustainabilityIndicatorEmissionFactor",
"description": "Linking entity between SustainabilityIndicator and EmissionFactor",
"properties": {
"SustainabilityIndicatorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
},
"EmissionFactorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be define",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"SustainabilityIndicatorId",
"EmissionFactorId"
]
}2.2.2.22.5 SustainabilityIndicatorEmissionFactor JSON data
{
"SustainabilityIndicatorId": "8462d997-6fd2-439e-88d0-d3b2e19517c8",
"EmissionFactorId": "eb40c43b-8950-47b5-902f-0adac685f19e"
}2.3 Group Financials
2.3.1 Financials Properties
| Property | Value |
| Group name | Financials |
| Technical name | |
| Activated | true |
| Description | |
| Comments | Comprises all financial related data |
2.3.2 Financials Documents
2.3.2.1 Document Account
2.3.2.1.1 Account Tree Diagram
2.3.2.1.2 Account Properties
| Property | Value |
| Document name | Account |
| Technical name | |
| Activated | true |
| Id | |
| Description | IBPDI defined account number based on standardised chart of account |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.1.3 Account Fields
| Field | Type | Req | Key | Description | Comments |
| AccountId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Account name | ||
| Project | string | true | Account type (project aligned with RICS naming convention) | ||
| Category | string | true | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) | ||
| Group | string | true | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| Version | string | true | Account version |
2.3.2.1.3.1 Field AccountId
2.3.2.1.3.1.1 AccountId properties
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1100132415 |
| Comments |
2.3.2.1.3.2 Field Name
2.3.2.1.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account name |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Maintenance Expenditures |
| Comments |
2.3.2.1.3.3 Field Project
2.3.2.1.3.3.1 Project properties
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account type (project aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Assets,Liabilities,Equity,Revenue,Expenses,Other (Non-Operating) Income and expenses |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Assets |
| Comments |
2.3.2.1.3.4 Field Category
2.3.2.1.3.4.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account category according to IBPDI charts of accounts (category aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Costs |
| Comments |
2.3.2.1.3.5 Field Group
2.3.2.1.3.5.1 Group properties
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account group according IBPDI charts of accounts (group aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Equipment |
| Comments |
2.3.2.1.3.6 Field ValidFrom
2.3.2.1.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.1.3.7 Field ValidUntil
2.3.2.1.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.1.3.8 Field StatementType
2.3.2.1.3.8.1 StatementType properties
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | BalanceStatement,P&L |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | P&L |
| Comments |
2.3.2.1.3.9 Field RecordType
2.3.2.1.3.9.1 RecordType properties
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Debit,Credit |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Debit |
| Comments |
2.3.2.1.3.10 Field Version
2.3.2.1.3.10.1 Version properties
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Account version |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 01.1 |
| Comments |
2.3.2.1.4 Account JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Account",
"description": "IBPDI defined account number based on standardised chart of account",
"properties": {
"AccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Name": {
"type": "string",
"description": "Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Account type (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Assets",
"Liabilities",
"Equity",
"Revenue",
"Expenses",
"Other (Non-Operating) Income and expenses"
],
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Account category according to IBPDI charts of accounts (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Account group according IBPDI charts of accounts (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"Version": {
"type": "string",
"description": "Account version",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AccountId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version"
]
}2.3.2.1.5 Account JSON data
{
"AccountId": "1100132415",
"Name": "Maintenance Expenditures",
"Project": "Assets",
"Category": "Costs",
"Group": "Equipment",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"StatementType": "P&L",
"RecordType": "Debit",
"Version": "01.1"
}2.3.2.2 Document CostCenter
2.3.2.2.1 CostCenter Tree Diagram
2.3.2.2.2 CostCenter Properties
| Property | Value |
| Document name | CostCenter |
| Technical name | |
| Activated | true |
| Id | |
| Description | Function or department within a company which is not directly going to generate revenues and profits to the company but is still incurring expenses to the company for its operations |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.2.3 CostCenter Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OrganisationId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of cost center | ||
| Type | string | false | Type of cost center |
2.3.2.2.3.1 Field CostCenterId
2.3.2.2.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 189000006 |
| Comments |
2.3.2.2.3.2 Field OrganisationId
2.3.2.2.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to CostCenter. |
| Cardinality | 1 |
| Sample | BM2016271 |
| Comments |
2.3.2.2.3.3 Field Name
2.3.2.2.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of cost center |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Service Cost Center |
| Comments |
2.3.2.2.3.4 Field Type
2.3.2.2.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of cost center |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Service |
| Comments |
2.3.2.2.4 CostCenter JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenter",
"description": "Function or department within a company which is not directly going to generate revenues and profits to the company but is still incurring expenses to the company for its operations",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of cost center",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of cost center",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"Name"
]
}2.3.2.2.5 CostCenter JSON data
{
"CostCenterId": "189000006",
"OrganisationId": "BM2016271",
"Name": "Service Cost Center",
"Type": "Service"
}2.3.2.3 Document CostCenterBuilding
2.3.2.3.1 CostCenterBuilding Tree Diagram
2.3.2.3.2 CostCenterBuilding Properties
| Property | Value |
| Document name | CostCenterBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between CostCenter and Building |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.3.3 CostCenterBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.3.3.1 Field CostCenterId
2.3.2.3.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to CostCenterBuilding. |
| Cardinality | 0..n |
| Sample | 189000006 |
| Comments |
2.3.2.3.3.2 Field BuildingId
2.3.2.3.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to CostCenterBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.3.2.3.4 CostCenterBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterBuilding",
"description": "Linking entity between CostCenter and Building",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"BuildingId"
]
}2.3.2.3.5 CostCenterBuilding JSON data
{
"CostCenterId": "189000006",
"BuildingId": "SE-CH-2341"
}2.3.2.4 Document CostCenterPortfolio
2.3.2.4.1 CostCenterPortfolio Tree Diagram
2.3.2.4.2 CostCenterPortfolio Properties
| Property | Value |
| Document name | CostCenterPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between CostCenter and Portfolio |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.4.3 CostCenterPortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.4.3.1 Field CostCenterId
2.3.2.4.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to CostCenterPortfolio. |
| Cardinality | 0..n |
| Sample | 189000006 |
| Comments |
2.3.2.4.3.2 Field PortfolioId
2.3.2.4.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to CostCenterPortfolio. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.3.2.4.4 CostCenterPortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterPortfolio",
"description": "Linking entity between CostCenter and Portfolio",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"PortfolioId"
]
}2.3.2.4.5 CostCenterPortfolio JSON data
{
"CostCenterId": "189000006",
"PortfolioId": "PF-03-01"
}2.3.2.5 Document CostCenterRentalUnit
2.3.2.5.1 CostCenterRentalUnit Tree Diagram
2.3.2.5.2 CostCenterRentalUnit Properties
| Property | Value |
| Document name | CostCenterRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between CostCenter and RentalUnit |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.5.3 CostCenterRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.5.3.1 Field CostCenterId
2.3.2.5.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to CostCenterRentalUnit. |
| Cardinality | 0..n |
| Sample | 189000006 |
| Comments |
2.3.2.5.3.2 Field RentalUnitId
2.3.2.5.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to CostCenterRentalUnit. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.3.2.5.4 CostCenterRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterRentalUnit",
"description": "Linking entity between CostCenter and RentalUnit",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"RentalUnitId"
]
}2.3.2.5.5 CostCenterRentalUnit JSON data
{
"CostCenterId": "189000006",
"RentalUnitId": "B-RU-10293"
}2.3.2.6 Document CostCenterSite
2.3.2.6.1 CostCenterSite Tree Diagram
2.3.2.6.2 CostCenterSite Properties
| Property | Value |
| Document name | CostCenterSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between CostCenter and Site |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.6.3 CostCenterSite Fields
| Field | Type | Req | Key | Description | Comments |
| CostCenterId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.6.3.1 Field CostCenterId
2.3.2.6.3.1.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to CostCenterSite. |
| Cardinality | 0..n |
| Sample | 189000006 |
| Comments |
2.3.2.6.3.2 Field SiteId
2.3.2.6.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to CostCenterSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.3.2.6.4 CostCenterSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "CostCenterSite",
"description": "Linking entity between CostCenter and Site",
"properties": {
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"CostCenterId",
"SiteId"
]
}2.3.2.6.5 CostCenterSite JSON data
{
"CostCenterId": "189000006",
"SiteId": "AE-DE-02"
}2.3.2.7 Document IndividualAccount
2.3.2.7.1 IndividualAccount Tree Diagram
2.3.2.7.2 IndividualAccount Properties
| Property | Value |
| Document name | IndividualAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | Company account number based on specific chart of account |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.7.3 IndividualAccount Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| AccountId | string | false | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OrganisationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Individual Account name | ||
| Project | string | true | Individual Account project (project aligned with RICS naming convention) | ||
| Category | string | true | Individual Account category (category aligned with RICS naming convention) | ||
| Group | string | true | Individual Account group (group aligned with RICS naming convention) | ||
| ValidFrom | date-time | true | Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StatementType | string | true | Statement type (Balance statement or P&L account) | ||
| RecordType | string | true | Record type (Debit or Credit) | ||
| GAAP | string | false | GAAP type used (if applicable) | ||
| Version | string | true | Individual account version |
2.3.2.7.3.1 Field IndividualAccountId
2.3.2.7.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1890627182 |
| Comments |
2.3.2.7.3.2 Field AccountId
2.3.2.7.3.2.1 AccountId properties
| Property | Value |
| Name | AccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | Account |
| Foreign field | AccountId |
| Relationship type | Foreign Key |
| Relationship name | fk Account. to IndividualAccount. |
| Cardinality | 0..n |
| Sample | 1100132415 |
| Comments |
2.3.2.7.3.3 Field OrganisationId
2.3.2.7.3.3.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to IndividualAccount. |
| Cardinality | 0..n |
| Sample | BM2016271 |
| Comments |
2.3.2.7.3.4 Field Name
2.3.2.7.3.4.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account name |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Maintenance Costs |
| Comments |
2.3.2.7.3.5 Field Project
2.3.2.7.3.5.1 Project properties
| Property | Value |
| Name | Project |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account project (project aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Expenditures |
| Comments |
2.3.2.7.3.6 Field Category
2.3.2.7.3.6.1 Category properties
| Property | Value |
| Name | Category |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account category (category aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Maintenance Costs |
| Comments |
2.3.2.7.3.7 Field Group
2.3.2.7.3.7.1 Group properties
| Property | Value |
| Name | Group |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual Account group (group aligned with RICS naming convention) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Equipment |
| Comments |
2.3.2.7.3.8 Field ValidFrom
2.3.2.7.3.8.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.7.3.9 Field ValidUntil
2.3.2.7.3.9.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.7.3.10 Field StatementType
2.3.2.7.3.10.1 StatementType properties
| Property | Value |
| Name | StatementType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Statement type (Balance statement or P&L account) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | BalanceStatement,P&L |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | P&L |
| Comments |
2.3.2.7.3.11 Field RecordType
2.3.2.7.3.11.1 RecordType properties
| Property | Value |
| Name | RecordType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Record type (Debit or Credit) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Debit,Credit |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Debit |
| Comments |
2.3.2.7.3.12 Field GAAP
2.3.2.7.3.12.1 GAAP properties
| Property | Value |
| Name | GAAP |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | GAAP type used (if applicable) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | IFRS |
| Comments |
2.3.2.7.3.13 Field Version
2.3.2.7.3.13.1 Version properties
| Property | Value |
| Name | Version |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Individual account version |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 01.1 |
| Comments |
2.3.2.7.4 IndividualAccount JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccount",
"description": "Company account number based on specific chart of account",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Individual Account name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Project": {
"type": "string",
"description": "Individual Account project (project aligned with RICS naming convention)",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 50
},
"Category": {
"type": "string",
"description": "Individual Account category (category aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Group": {
"type": "string",
"description": "Individual Account group (group aligned with RICS naming convention)",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Validity of Individual Account in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"StatementType": {
"type": "string",
"description": "Statement type (Balance statement or P&L account)",
"enum": [
"BalanceStatement",
"P&L"
],
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RecordType": {
"type": "string",
"description": "Record type (Debit or Credit)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Debit",
"Credit"
]
},
"GAAP": {
"type": "string",
"description": "GAAP type used (if applicable)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Version": {
"type": "string",
"description": "Individual account version",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"OrganisationId",
"Name",
"Project",
"Category",
"Group",
"ValidFrom",
"ValidUntil",
"StatementType",
"RecordType",
"Version"
]
}2.3.2.7.5 IndividualAccount JSON data
{
"IndividualAccountId": "1890627182",
"AccountId": "1100132415",
"OrganisationId": "BM2016271",
"Name": "Maintenance Costs",
"Project": "Expenditures",
"Category": "Maintenance Costs",
"Group": "Equipment",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"StatementType": "P&L",
"RecordType": "Debit",
"GAAP": "IFRS",
"Version": "01.1"
}2.3.2.8 Document IndividualAccountBuilding
2.3.2.8.1 IndividualAccountBuilding Tree Diagram
2.3.2.8.2 IndividualAccountBuilding Properties
| Property | Value |
| Document name | IndividualAccountBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between IndividualAccount and Building |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.8.3 IndividualAccountBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.8.3.1 Field IndividualAccountId
2.3.2.8.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to IndividualAccountBuilding. |
| Cardinality | 0..n |
| Sample | 1890627182 |
| Comments |
2.3.2.8.3.2 Field BuildingId
2.3.2.8.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to IndividualAccountBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.3.2.8.4 IndividualAccountBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountBuilding",
"description": "Linking entity between IndividualAccount and Building",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"BuildingId"
]
}2.3.2.8.5 IndividualAccountBuilding JSON data
{
"IndividualAccountId": "1890627182",
"BuildingId": "SE-CH-2341"
}2.3.2.9 Document IndividualAccountPortfolio
2.3.2.9.1 IndividualAccountPortfolio Tree Diagram
2.3.2.9.2 IndividualAccountPortfolio Properties
| Property | Value |
| Document name | IndividualAccountPortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between IndividualAccount and Portfolio |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.9.3 IndividualAccountPortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.9.3.1 Field IndividualAccountId
2.3.2.9.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Cardinality | 0..n |
| Sample | 1890627182 |
| Comments |
2.3.2.9.3.2 Field PortfolioId
2.3.2.9.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to IndividualAccount. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.3.2.9.4 IndividualAccountPortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountPortfolio",
"description": "Linking entity between IndividualAccount and Portfolio",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"PortfolioId"
]
}2.3.2.9.5 IndividualAccountPortfolio JSON data
{
"IndividualAccountId": "1890627182",
"PortfolioId": "PF-03-01"
}2.3.2.10 Document IndividualAccountSite
2.3.2.10.1 IndividualAccountSite Tree Diagram
2.3.2.10.2 IndividualAccountSite Properties
| Property | Value |
| Document name | IndividualAccountSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between IndividualAccount and Site |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.10.3 IndividualAccountSite Fields
| Field | Type | Req | Key | Description | Comments |
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.3.2.10.3.1 Field IndividualAccountId
2.3.2.10.3.1.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to IndividualAccountSite. |
| Cardinality | 0..n |
| Sample | 1890627182 |
| Comments |
2.3.2.10.3.2 Field SiteId
2.3.2.10.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to IndividualAccountSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.3.2.10.4 IndividualAccountSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "IndividualAccountSite",
"description": "Linking entity between IndividualAccount and Site",
"properties": {
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"IndividualAccountId",
"SiteId"
]
}2.3.2.10.5 IndividualAccountSite JSON data
{
"IndividualAccountId": "1890627182",
"SiteId": "AE-DE-02"
}2.3.2.11 Document Transaction
2.3.2.11.1 Transaction Tree Diagram
2.3.2.11.2 Transaction Properties
| Property | Value |
| Document name | Transaction |
| Technical name | |
| Activated | true |
| Id | |
| Description | Individual transaction or account balance at specific reporting date |
| Group | Financials |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.3.2.11.3 Transaction Fields
| Field | Type | Req | Key | Description | Comments |
| TransactionId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| CostCenterId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of transaction | ||
| BookingType | string | true | Booking type | ||
| Value | integer | true | Cost/Income value of specific transaction | [{"dataType":"decimal"}] | |
| BookingCurrency | string | true | Currency of booking | ||
| PostingDate | date-time | true | Date transaction is posted in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| DocumentId | string | false | Unique identifier either coming from previous system otherwise it needs to be defined | does not exist yet |
2.3.2.11.3.1 Field TransactionId
2.3.2.11.3.1.1 TransactionId properties
| Property | Value |
| Name | TransactionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 887332968 |
| Comments |
2.3.2.11.3.2 Field IndividualAccountId
2.3.2.11.3.2.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to Transaction. |
| Cardinality | 1..n |
| Sample | 1890627182 |
| Comments |
2.3.2.11.3.3 Field CostCenterId
2.3.2.11.3.3.1 CostCenterId properties
| Property | Value |
| Name | CostCenterId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | CostCenter |
| Foreign field | CostCenterId |
| Relationship type | Foreign Key |
| Relationship name | fk CostCenter. to Transaction. |
| Cardinality | 1..n |
| Sample | 189000006 |
| Comments |
2.3.2.11.3.4 Field Type
2.3.2.11.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of transaction |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | Actual,Budget,Forecast |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Actual |
| Comments |
2.3.2.11.3.5 Field BookingType
2.3.2.11.3.5.1 BookingType properties
| Property | Value |
| Name | BookingType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Booking type |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | debit,credit |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | debit |
| Comments |
2.3.2.11.3.6 Field Value
2.3.2.11.3.6.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Cost/Income value of specific transaction |
| Type | integer |
| Min value | -999999999 |
| Excl min | |
| Max value | 999999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1325.21 |
| Comments | [{"dataType":"decimal"}] |
2.3.2.11.3.7 Field BookingCurrency
2.3.2.11.3.7.1 BookingCurrency properties
| Property | Value |
| Name | BookingCurrency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of booking |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.3.2.11.3.8 Field PostingDate
2.3.2.11.3.8.1 PostingDate properties
| Property | Value |
| Name | PostingDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date transaction is posted in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.3.2.11.3.9 Field DocumentId
2.3.2.11.3.9.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | does not exist yet |
2.3.2.11.4 Transaction JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Transaction",
"description": "Individual transaction or account balance at specific reporting date",
"properties": {
"TransactionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CostCenterId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of transaction",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"Actual",
"Budget",
"Forecast"
]
},
"BookingType": {
"type": "string",
"description": "Booking type",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"enum": [
"debit",
"credit"
]
},
"Value": {
"type": "integer",
"description": "Cost/Income value of specific transaction",
"minimum": -999999999,
"maximum": 999999999
},
"BookingCurrency": {
"type": "string",
"description": "Currency of booking",
"minLength": 1,
"maxLength": 50
},
"PostingDate": {
"type": "string",
"description": "Date transaction is posted in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"DocumentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TransactionId",
"IndividualAccountId",
"CostCenterId",
"Type",
"BookingType",
"Value",
"BookingCurrency",
"PostingDate"
]
}2.3.2.11.5 Transaction JSON data
{
"TransactionId": "887332968",
"IndividualAccountId": "1890627182",
"CostCenterId": "189000006",
"Type": "Actual",
"BookingType": "debit",
"Value": 1325.21,
"BookingCurrency": "€",
"PostingDate": "2011-06-14T04:12:36.123Z",
"DocumentId": "dy2juS_apI',11,5FU9Hm48dQI`D1"
}2.4 Group OrganisationalManagement
2.4.1 OrganisationalManagement Properties
| Property | Value |
| Group name | OrganisationalManagement |
| Technical name | |
| Activated | true |
| Description | Comprising data about organisations, business partners, service providers and addresses |
| Comments |
2.4.2 OrganisationalManagement Documents
2.4.2.1 Document Address
2.4.2.1.1 Address Tree Diagram
2.4.2.1.2 Address Properties
| Property | Value |
| Document name | Address |
| Technical name | |
| Activated | true |
| Id | |
| Description | Collection of information used to give the location of a building, apartment, or other structure or a plot of land |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.4.2.1.3 Address Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of address | ||
| StreetName | string | true | Name of the street | ||
| HouseNumber | string | false | House number of the street | ||
| AdditionalInformation | string | false | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. | ||
| ApartmentOrUnit | string | false | Unit number | ||
| District | string | false | Boroughs or districts within a city that serve some official purpose | ||
| City | string | true | Any official settlement including cities, towns, villages, hamlets, localities, etc. | ||
| PostalCode | string | false | Postal codes used for mail sorting | ||
| StateProvincePrefecture | string | false | First-level administrative division, depending on the continent or country if might be named differently. | ||
| Country | string | true | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
2.4.2.1.3.1 Field AddressId
2.4.2.1.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | AD-9281928 |
| Comments |
2.4.2.1.3.2 Field Type
2.4.2.1.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of address |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Postal address |
| Comments |
2.4.2.1.3.3 Field StreetName
2.4.2.1.3.3.1 StreetName properties
| Property | Value |
| Name | StreetName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of the street |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 150 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Friedrichsstraße |
| Comments |
2.4.2.1.3.4 Field HouseNumber
2.4.2.1.3.4.1 HouseNumber properties
| Property | Value |
| Name | HouseNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | House number of the street |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 78a |
| Comments |
2.4.2.1.3.5 Field AdditionalInformation
2.4.2.1.3.5.1 AdditionalInformation properties
| Property | Value |
| Name | AdditionalInformation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Building A |
| Comments |
2.4.2.1.3.6 Field ApartmentOrUnit
2.4.2.1.3.6.1 ApartmentOrUnit properties
| Property | Value |
| Name | ApartmentOrUnit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit number |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | C602 |
| Comments |
2.4.2.1.3.7 Field District
2.4.2.1.3.7.1 District properties
| Property | Value |
| Name | District |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Boroughs or districts within a city that serve some official purpose |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Brooklyn |
| Comments |
2.4.2.1.3.8 Field City
2.4.2.1.3.8.1 City properties
| Property | Value |
| Name | City |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Any official settlement including cities, towns, villages, hamlets, localities, etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Berlin |
| Comments |
2.4.2.1.3.9 Field PostalCode
2.4.2.1.3.9.1 PostalCode properties
| Property | Value |
| Name | PostalCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Postal codes used for mail sorting |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 15 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 10117 |
| Comments |
2.4.2.1.3.10 Field StateProvincePrefecture
2.4.2.1.3.10.1 StateProvincePrefecture properties
| Property | Value |
| Name | StateProvincePrefecture |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First-level administrative division, depending on the continent or country if might be named differently. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Bayern |
| Comments |
2.4.2.1.3.11 Field Country
2.4.2.1.3.11.1 Country properties
| Property | Value |
| Name | Country |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sovereign nations and their dependent territories, anything with an ISO-3166 code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Germany |
| Comments |
2.4.2.1.4 Address JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Address",
"description": "Collection of information used to give the location of a building, apartment, or other structure or a plot of land",
"additionalProperties": false,
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of address",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StreetName": {
"type": "string",
"description": "Name of the street",
"minLength": 1,
"maxLength": 150,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"HouseNumber": {
"type": "string",
"description": "House number of the street",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AdditionalInformation": {
"type": "string",
"description": "Additional information that can not be displayed in the other attributes such as Building, Door Nr. etc. ",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ApartmentOrUnit": {
"type": "string",
"description": "Unit number",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"District": {
"type": "string",
"description": "Boroughs or districts within a city that serve some official purpose",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"City": {
"type": "string",
"description": "Any official settlement including cities, towns, villages, hamlets, localities, etc.",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PostalCode": {
"type": "string",
"description": "Postal codes used for mail sorting",
"minLength": 1,
"maxLength": 15,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StateProvincePrefecture": {
"type": "string",
"description": "First-level administrative division, depending on the continent or country if might be named differently.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Country": {
"type": "string",
"description": "Sovereign nations and their dependent territories, anything with an ISO-3166 code",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"Type",
"StreetName",
"City",
"Country"
]
}2.4.2.1.5 Address JSON data
{
"AddressId": "AD-9281928",
"Type": "Postal address",
"StreetName": "Friedrichsstraße",
"HouseNumber": "78a",
"AdditionalInformation": "Building A",
"ApartmentOrUnit": "C602",
"District": "Brooklyn",
"City": "Berlin",
"PostalCode": "10117",
"StateProvincePrefecture": "Bayern",
"Country": "Germany"
}2.4.2.2 Document AddressBuilding
2.4.2.2.1 AddressBuilding Tree Diagram
2.4.2.2.2 AddressBuilding Properties
| Property | Value |
| Document name | AddressBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and Building |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.2.3 AddressBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.2.3.1 Field AddressId
2.4.2.2.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressBuilding. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.2.3.2 Field BuildingId
2.4.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to AddressBuilding. |
| Cardinality | 1 |
| Sample | SE-CH-2341 |
| Comments |
2.4.2.2.4 AddressBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressBuilding",
"description": "Linking entity between Address and Building",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"AddressId",
"BuildingId"
]
}2.4.2.2.5 AddressBuilding JSON data
{
"AddressId": "AD-9281928",
"BuildingId": "SE-CH-2341"
}2.4.2.3 Document AddressContact
2.4.2.3.1 AddressContact Tree Diagram
2.4.2.3.2 AddressContact Properties
| Property | Value |
| Document name | AddressContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and Contact |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.3.3 AddressContact Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ContactId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.3.3.1 Field AddressId
2.4.2.3.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressContact. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.3.3.2 Field ContactId
2.4.2.3.3.2.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Contact |
| Foreign field | ContactId |
| Relationship type | Foreign Key |
| Relationship name | fk Contact. to AddressContact. |
| Cardinality | 0..n |
| Sample | BP-00441 |
| Comments |
2.4.2.3.4 AddressContact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressContact",
"description": "Linking entity between Address and Contact",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"ContactId"
]
}2.4.2.3.5 AddressContact JSON data
{
"AddressId": "AD-9281928",
"ContactId": "BP-00441"
}2.4.2.4 Document AddressLand
2.4.2.4.1 AddressLand Tree Diagram
2.4.2.4.2 AddressLand Properties
| Property | Value |
| Document name | AddressLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and Land |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.4.3 AddressLand Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.4.3.1 Field AddressId
2.4.2.4.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressLand. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.4.3.2 Field LandId
2.4.2.4.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to AddressLand. |
| Cardinality | 1 |
| Sample | RE-AT-05 |
| Comments |
2.4.2.4.4 AddressLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressLand",
"description": "Linking entity between Address and Land",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"LandId"
]
}2.4.2.4.5 AddressLand JSON data
{
"AddressId": "AD-9281928",
"LandId": "RE-AT-05"
}2.4.2.5 Document AddressOrganisation
2.4.2.5.1 AddressOrganisation Tree Diagram
2.4.2.5.2 AddressOrganisation Properties
| Property | Value |
| Document name | AddressOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and Organisation |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.5.3 AddressOrganisation Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OrganisationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.5.3.1 Field AddressId
2.4.2.5.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressOrganisation. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.5.3.2 Field OrganisationId
2.4.2.5.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to AddressOrganisation. |
| Cardinality | 0..n |
| Sample | BM2016271 |
| Comments |
2.4.2.5.4 AddressOrganisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressOrganisation",
"description": "Linking entity between Address and Organisation",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"OrganisationId"
]
}2.4.2.5.5 AddressOrganisation JSON data
{
"AddressId": "AD-9281928",
"OrganisationId": "BM2016271"
}2.4.2.6 Document AddressRentalUnit
2.4.2.6.1 AddressRentalUnit Tree Diagram
2.4.2.6.2 AddressRentalUnit Properties
| Property | Value |
| Document name | AddressRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and RentalUnit |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.6.3 AddressRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.6.3.1 Field AddressId
2.4.2.6.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressRentalUnit. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.6.3.2 Field RentalUnitId
2.4.2.6.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to AddressRentalUnit. |
| Cardinality | 1 |
| Sample | B-RU-10293 |
| Comments |
2.4.2.6.4 AddressRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressRentalUnit",
"description": "Linking entity between Address and RentalUnit",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"RentalUnitId"
]
}2.4.2.6.5 AddressRentalUnit JSON data
{
"AddressId": "AD-9281928",
"RentalUnitId": "B-RU-10293"
}2.4.2.7 Document AddressSite
2.4.2.7.1 AddressSite Tree Diagram
2.4.2.7.2 AddressSite Properties
| Property | Value |
| Document name | AddressSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Address and Site |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.7.3 AddressSite Fields
| Field | Type | Req | Key | Description | Comments |
| AddressId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.7.3.1 Field AddressId
2.4.2.7.3.1.1 AddressId properties
| Property | Value |
| Name | AddressId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Address |
| Foreign field | AddressId |
| Relationship type | Foreign Key |
| Relationship name | fk Address. to AddressSite. |
| Cardinality | 0..n |
| Sample | AD-9281928 |
| Comments |
2.4.2.7.3.2 Field SiteId
2.4.2.7.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to AddressSite. |
| Cardinality | 1 |
| Sample | AE-DE-02 |
| Comments |
2.4.2.7.4 AddressSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "AddressSite",
"description": "Linking entity between Address and Site",
"properties": {
"AddressId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"AddressId",
"SiteId"
]
}2.4.2.7.5 AddressSite JSON data
{
"AddressId": "AD-9281928",
"SiteId": "AE-DE-02"
}2.4.2.8 Document Contact
2.4.2.8.1 Contact Tree Diagram
2.4.2.8.2 Contact Properties
| Property | Value |
| Document name | Contact |
| Technical name | |
| Activated | true |
| Id | |
| Description | Contact details |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.4.2.8.3 Contact Fields
| Field | Type | Req | Key | Description | Comments |
| ContactId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OrganisationId | string | false | fk | Link to organisation | |
| Salutation | string | false | Title of Business Partner | ||
| JobTitle | string | false | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns | ||
| FirstName | string | true | First Name of Business Partner or responsible contact person | ||
| LastName | string | true | Surname of Business Partner or responsible contact person | ||
| EmployeeId | string | false | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation | ||
| false | Email address of contact person | ||||
| Telephone | string | false | Phone number of contact person | ||
| Fax | string | false | Fax number of contact person | ||
| ValidFrom | date-time | false | For internal reference to recored employed since in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | For internal reference to recored employed until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.4.2.8.3.1 Field ContactId
2.4.2.8.3.1.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BP-00441 |
| Comments |
2.4.2.8.3.2 Field OrganisationId
2.4.2.8.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Link to organisation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to Contact. |
| Cardinality | 0..n |
| Sample | BM2016271 |
| Comments |
2.4.2.8.3.3 Field Salutation
2.4.2.8.3.3.1 Salutation properties
| Property | Value |
| Name | Salutation |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Title of Business Partner |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Dipl. -Ing. |
| Comments |
2.4.2.8.3.4 Field JobTitle
2.4.2.8.3.4.1 JobTitle properties
| Property | Value |
| Name | JobTitle |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Head of sales |
| Comments |
2.4.2.8.3.5 Field FirstName
2.4.2.8.3.5.1 FirstName properties
| Property | Value |
| Name | FirstName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | First Name of Business Partner or responsible contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Randolph |
| Comments |
2.4.2.8.3.6 Field LastName
2.4.2.8.3.6.1 LastName properties
| Property | Value |
| Name | LastName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Surname of Business Partner or responsible contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Müller |
| Comments |
2.4.2.8.3.7 Field EmployeeId
2.4.2.8.3.7.1 EmployeeId properties
| Property | Value |
| Name | EmployeeId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | E-172831 |
| Comments |
2.4.2.8.3.8 Field Email
2.4.2.8.3.8.1 Email properties
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Email address of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | [email protected] |
| Comments |
2.4.2.8.3.9 Field Telephone
2.4.2.8.3.9.1 Telephone properties
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 017663425123 |
| Comments |
2.4.2.8.3.10 Field Fax
2.4.2.8.3.10.1 Fax properties
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 22228888 |
| Comments |
2.4.2.8.3.11 Field ValidFrom
2.4.2.8.3.11.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed since in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.8.3.12 Field ValidUntil
2.4.2.8.3.12.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | For internal reference to recored employed until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | false |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.8.4 Contact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Contact",
"description": "Contact details",
"additionalProperties": false,
"properties": {
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Link to organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Salutation": {
"type": "string",
"description": "Title of Business Partner",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JobTitle": {
"type": "string",
"description": "Job title of the contact to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FirstName": {
"type": "string",
"description": "First Name of Business Partner or responsible contact person",
"minLength": 1,
"maxLength": 100,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LastName": {
"type": "string",
"description": "Surname of Business Partner or responsible contact person",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 100
},
"EmployeeId": {
"type": "string",
"description": "Employee ID or number for the contact for reference in orders, service cases, or other communications with the contact's organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"description": "Email address of contact person",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of contact person",
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1
},
"Fax": {
"type": "string",
"description": "Fax number of contact person",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "For internal reference to recored employed since in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "For internal reference to recored employed until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"ContactId",
"FirstName",
"LastName"
]
}2.4.2.8.5 Contact JSON data
{
"ContactId": "BP-00441",
"OrganisationId": "BM2016271",
"Salutation": "Dipl. -Ing.",
"JobTitle": "Head of sales",
"FirstName": "Randolph",
"LastName": "Müller",
"EmployeeId": "E-172831",
"Email": "[email protected]",
"Telephone": "017663425123",
"Fax": "22228888",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z"
}2.4.2.9 Document Organisation
2.4.2.9.1 Organisation Tree Diagram
2.4.2.9.2 Organisation Properties
| Property | Value |
| Document name | Organisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Information about organisations (internal and external) |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.9.3 Organisation Fields
| Field | Type | Req | Key | Description | Comments |
| OrganisationId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ParentId | string | false | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Name | string | true | Name of organization | ||
| Industry | string | false | Industry of organisation | ||
| false | Email address of contact person | ||||
| Telephone | string | false | Phone number of contact person | ||
| Fax | string | false | Fax number of contact person | ||
| VatNumber | string | true | Vat number of organisation | ||
| LegalEntity | boolean | false | Is the organisation an legal entity (Y/N) | ||
| FiscalYearStartDate | date-time | true | Start date of fiscal year for organisation in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.4.2.9.3.1 Field OrganisationId
2.4.2.9.3.1.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BM2016271 |
| Comments |
2.4.2.9.3.2 Field ParentId
2.4.2.9.3.2.1 ParentId properties
| Property | Value |
| Name | ParentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BM2016271 |
| Comments |
2.4.2.9.3.3 Field Name
2.4.2.9.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of organization |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | BuildingMinds |
| Comments |
2.4.2.9.3.4 Field Industry
2.4.2.9.3.4.1 Industry properties
| Property | Value |
| Name | Industry |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Industry of organisation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Service Provider |
| Comments |
2.4.2.9.3.5 Field Email
2.4.2.9.3.5.1 Email properties
| Property | Value |
| Name | |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Email address of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 100 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | [email protected] |
| Comments |
2.4.2.9.3.6 Field Telephone
2.4.2.9.3.6.1 Telephone properties
| Property | Value |
| Name | Telephone |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Phone number of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 112 |
| Comments |
2.4.2.9.3.7 Field Fax
2.4.2.9.3.7.1 Fax properties
| Property | Value |
| Name | Fax |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Fax number of contact person |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 22228888 |
| Comments |
2.4.2.9.3.8 Field VatNumber
2.4.2.9.3.8.1 VatNumber properties
| Property | Value |
| Name | VatNumber |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Vat number of organisation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | DE123456789 |
| Comments |
2.4.2.9.3.9 Field LegalEntity
2.4.2.9.3.9.1 LegalEntity properties
| Property | Value |
| Name | LegalEntity |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is the organisation an legal entity (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.4.2.9.3.10 Field FiscalYearStartDate
2.4.2.9.3.10.1 FiscalYearStartDate properties
| Property | Value |
| Name | FiscalYearStartDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Start date of fiscal year for organisation in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.4.2.9.4 Organisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Organisation",
"description": "Information about organisations (internal and external)",
"properties": {
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ParentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of organization",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Industry": {
"type": "string",
"description": "Industry of organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Email": {
"type": "string",
"description": "Email address of contact person",
"minLength": 1,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"maxLength": 100,
"format": "email"
},
"Telephone": {
"type": "string",
"description": "Phone number of contact person",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Fax": {
"type": "string",
"description": "Fax number of contact person",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"VatNumber": {
"type": "string",
"description": "Vat number of organisation",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LegalEntity": {
"type": "boolean",
"description": "Is the organisation an legal entity (Y/N)"
},
"FiscalYearStartDate": {
"type": "string",
"description": "Start date of fiscal year for organisation in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"OrganisationId",
"Name",
"VatNumber",
"FiscalYearStartDate"
]
}2.4.2.9.5 Organisation JSON data
{
"OrganisationId": "BM2016271",
"ParentId": "BM2016271",
"Name": "BuildingMinds",
"Industry": "Service Provider",
"Email": "[email protected]",
"Telephone": "112",
"Fax": "22228888",
"VatNumber": "DE123456789",
"LegalEntity": true,
"FiscalYearStartDate": "2011-06-14T04:12:36.123Z"
}2.4.2.10 Document Role
2.4.2.10.1 Role Tree Diagram
2.4.2.10.2 Role Properties
| Property | Value |
| Document name | Role |
| Technical name | |
| Activated | true |
| Id | |
| Description | Defining the role of the organisation or contact |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.10.3 Role Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of role |
2.4.2.10.3.1 Field RoleId
2.4.2.10.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | R-01 |
| Comments |
2.4.2.10.3.2 Field Type
2.4.2.10.3.2.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of role |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.4.2.10.4 Role JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Role",
"description": "Defining the role of the organisation or contact",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of role",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"Type"
]
}2.4.2.10.5 Role JSON data
{
"RoleId": "R-01",
"Type": "uG8Tel86Ih3IZtFHJIab9a0ufpMe"
}2.4.2.11 Document RoleBuilding
2.4.2.11.1 RoleBuilding Tree Diagram
2.4.2.11.2 RoleBuilding Properties
| Property | Value |
| Document name | RoleBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Building |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.11.3 RoleBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.11.3.1 Field RoleId
2.4.2.11.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleBuilding. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.11.3.2 Field BuildingId
2.4.2.11.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to RoleBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.4.2.11.4 RoleBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleBuilding",
"description": "Linking entity between Role and Building",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"BuildingId"
]
}2.4.2.11.5 RoleBuilding JSON data
{
"RoleId": "R-01",
"BuildingId": "SE-CH-2341"
}2.4.2.12 Document RoleContact
2.4.2.12.1 RoleContact Tree Diagram
2.4.2.12.2 RoleContact Properties
| Property | Value |
| Document name | RoleContact |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Contact |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.12.3 RoleContact Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ContactId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.12.3.1 Field RoleId
2.4.2.12.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleContact. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.12.3.2 Field ContactId
2.4.2.12.3.2.1 ContactId properties
| Property | Value |
| Name | ContactId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Contact |
| Foreign field | ContactId |
| Relationship type | Foreign Key |
| Relationship name | fk Contact. to RoleContact. |
| Cardinality | 0..n |
| Sample | BP-00441 |
| Comments |
2.4.2.12.4 RoleContact JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleContact",
"description": "Linking entity between Role and Contact",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContactId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ContactId"
]
}2.4.2.12.5 RoleContact JSON data
{
"RoleId": "R-01",
"ContactId": "BP-00441"
}2.4.2.13 Document RoleLand
2.4.2.13.1 RoleLand Tree Diagram
2.4.2.13.2 RoleLand Properties
| Property | Value |
| Document name | RoleLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Land |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.13.3 RoleLand Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.13.3.1 Field RoleId
2.4.2.13.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleLand. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.13.3.2 Field LandId
2.4.2.13.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to RoleLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.4.2.13.4 RoleLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleLand",
"description": "Linking entity between Role and Land",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"LandId"
]
}2.4.2.13.5 RoleLand JSON data
{
"RoleId": "R-01",
"LandId": "RE-AT-05"
}2.4.2.14 Document RoleOrganisation
2.4.2.14.1 RoleOrganisation Tree Diagram
2.4.2.14.2 RoleOrganisation Properties
| Property | Value |
| Document name | RoleOrganisation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Organisation |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.14.3 RoleOrganisation Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OrganisationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.14.3.1 Field RoleId
2.4.2.14.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleOrganisation. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.14.3.2 Field OrganisationId
2.4.2.14.3.2.1 OrganisationId properties
| Property | Value |
| Name | OrganisationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Organisation |
| Foreign field | OrganisationId |
| Relationship type | Foreign Key |
| Relationship name | fk Organisation. to RoleOrganisation. |
| Cardinality | 0..n |
| Sample | BM2016271 |
| Comments |
2.4.2.14.4 RoleOrganisation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleOrganisation",
"description": "Linking entity between Role and Organisation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OrganisationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"OrganisationId"
]
}2.4.2.14.5 RoleOrganisation JSON data
{
"RoleId": "R-01",
"OrganisationId": "BM2016271"
}2.4.2.15 Document RolePortfolio
2.4.2.15.1 RolePortfolio Tree Diagram
2.4.2.15.2 RolePortfolio Properties
| Property | Value |
| Document name | RolePortfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Portfolio |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.15.3 RolePortfolio Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.15.3.1 Field RoleId
2.4.2.15.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RolePortfolio. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.15.3.2 Field PortfolioId
2.4.2.15.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to RolePortfolio. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.4.2.15.4 RolePortfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolio",
"description": "Linking entity between Role and Portfolio",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioId"
]
}2.4.2.15.5 RolePortfolio JSON data
{
"RoleId": "R-01",
"PortfolioId": "PF-03-01"
}2.4.2.16 Document RolePortfolioStrategy
2.4.2.16.1 RolePortfolioStrategy Tree Diagram
2.4.2.16.2 RolePortfolioStrategy Properties
| Property | Value |
| Document name | RolePortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and PortfolioStrategy |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.16.3 RolePortfolioStrategy Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| PortfolioStrategyId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.16.3.1 Field RoleId
2.4.2.16.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RolePortfolioStrategy. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.16.3.2 Field PortfolioStrategyId
2.4.2.16.3.2.1 PortfolioStrategyId properties
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to RolePortfolioStrategy. |
| Cardinality | 0..n |
| Sample | x01 |
| Comments |
2.4.2.16.4 RolePortfolioStrategy JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RolePortfolioStrategy",
"description": "Linking entity between Role and PortfolioStrategy",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioStrategyId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"PortfolioStrategyId"
]
}2.4.2.16.5 RolePortfolioStrategy JSON data
{
"RoleId": "R-01",
"PortfolioStrategyId": "x01"
}2.4.2.17 Document RoleRentalUnit
2.4.2.17.1 RoleRentalUnit Tree Diagram
2.4.2.17.2 RoleRentalUnit Properties
| Property | Value |
| Document name | RoleRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and RentalUnit |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.17.3 RoleRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.17.3.1 Field RoleId
2.4.2.17.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleRentalUnit. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.17.3.2 Field RentalUnitId
2.4.2.17.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RoleRentalUnit. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.4.2.17.4 RoleRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleRentalUnit",
"description": "Linking entity between Role and RentalUnit",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"RentalUnitId"
]
}2.4.2.17.5 RoleRentalUnit JSON data
{
"RoleId": "R-01",
"RentalUnitId": "B-RU-10293"
}2.4.2.18 Document RoleSite
2.4.2.18.1 RoleSite Tree Diagram
2.4.2.18.2 RoleSite Properties
| Property | Value |
| Document name | RoleSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Site |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.18.3 RoleSite Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.18.3.1 Field RoleId
2.4.2.18.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleSite. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.18.3.2 Field SiteId
2.4.2.18.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to RoleSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.4.2.18.4 RoleSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleSite",
"description": "Linking entity between Role and Site",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"SiteId"
]
}2.4.2.18.5 RoleSite JSON data
{
"RoleId": "R-01",
"SiteId": "AE-DE-02"
}2.4.2.19 Document RoleValuation
2.4.2.19.1 RoleValuation Tree Diagram
2.4.2.19.2 RoleValuation Properties
| Property | Value |
| Document name | RoleValuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Role and Valuation |
| Group | OrganisationalManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.4.2.19.3 RoleValuation Fields
| Field | Type | Req | Key | Description | Comments |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.4.2.19.3.1 Field RoleId
2.4.2.19.3.1.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RoleValuation. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.4.2.19.3.2 Field ValuationId
2.4.2.19.3.2.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to RoleValuation. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.4.2.19.4 RoleValuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RoleValuation",
"description": "Linking entity between Role and Valuation",
"properties": {
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RoleId",
"ValuationId"
]
}2.4.2.19.5 RoleValuation JSON data
{
"RoleId": "R-01",
"ValuationId": "V021"
}2.5 Group PortfolioAndAssetManagement
2.5.1 PortfolioAndAssetManagement Properties
| Property | Value |
| Group name | PortfolioAndAssetManagement |
| Technical name | |
| Activated | true |
| Description | Comprises all data around a real estate portfolio, the underlying strategy and the valuation |
| Comments |
2.5.2 PortfolioAndAssetManagement Documents
2.5.2.1 Document Portfolio
2.5.2.1.1 Portfolio Tree Diagram
2.5.2.1.2 Portfolio Properties
| Property | Value |
| Document name | Portfolio |
| Technical name | |
| Activated | true |
| Id | |
| Description | Grouping of real estate assets |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.5.2.1.3 Portfolio Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Portfolio | ||
| PortfolioCode | string | false | User specific Portfolio Code e.g: MR003 | ||
| Type | string | true | Type of the Portfolio | ||
| AssetCategory | string | false | Describes the asset category | ||
| OwnershipType | string | false | Describes the ownership structure of the portfolio | ||
| ValidFrom | date-time | true | Date portfolio was set up in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date the maturity of the portfolio has been reached in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PrimaryUsageType | string | false | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| SecondaryUsageType | string | false | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) | ||
| MarketValue | integer | false | Current market value of Portfolio | [{"dataType":"decimal"}] | |
| Currency | string | false | Main/default currency of portfolio (depending on user it should be able to change this) |
2.5.2.1.3.1 Field PortfolioId
2.5.2.1.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | PF-03-01 |
| Comments |
2.5.2.1.3.2 Field IndividualAccountId
2.5.2.1.3.2.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to Portfolio. |
| Cardinality | 0..n |
| Sample | 1890627182 |
| Comments |
2.5.2.1.3.3 Field Name
2.5.2.1.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Portfolio |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | South Germany |
| Comments |
2.5.2.1.3.4 Field PortfolioCode
2.5.2.1.3.4.1 PortfolioCode properties
| Property | Value |
| Name | PortfolioCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific Portfolio Code e.g: MR003 |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | GS-012 |
| Comments |
2.5.2.1.3.5 Field Type
2.5.2.1.3.5.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of the Portfolio |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.1.3.6 Field AssetCategory
2.5.2.1.3.6.1 AssetCategory properties
| Property | Value |
| Name | AssetCategory |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the asset category |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Tangible |
| Comments |
2.5.2.1.3.7 Field OwnershipType
2.5.2.1.3.7.1 OwnershipType properties
| Property | Value |
| Name | OwnershipType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Describes the ownership structure of the portfolio |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Freehold |
| Comments |
2.5.2.1.3.8 Field ValidFrom
2.5.2.1.3.8.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date portfolio was set up in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.1.3.9 Field ValidUntil
2.5.2.1.3.9.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date the maturity of the portfolio has been reached in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.1.3.10 Field PrimaryUsageType
2.5.2.1.3.10.1 PrimaryUsageType properties
| Property | Value |
| Name | PrimaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Financial Assets |
| Comments |
2.5.2.1.3.11 Field SecondaryUsageType
2.5.2.1.3.11.1 SecondaryUsageType properties
| Property | Value |
| Name | SecondaryUsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Freehold |
| Comments |
2.5.2.1.3.12 Field MarketValue
2.5.2.1.3.12.1 MarketValue properties
| Property | Value |
| Name | MarketValue |
| Technical name | |
| Activated | true |
| Id | |
| Description | Current market value of Portfolio |
| Type | integer |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2617281.27 |
| Comments | [{"dataType":"decimal"}] |
2.5.2.1.3.13 Field Currency
2.5.2.1.3.13.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main/default currency of portfolio (depending on user it should be able to change this) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.5.2.1.4 Portfolio JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Portfolio",
"description": "Grouping of real estate assets",
"additionalProperties": false,
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of Portfolio ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"PortfolioCode": {
"type": "string",
"description": "User specific Portfolio Code e.g: MR003",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 70
},
"Type": {
"type": "string",
"description": "Type of the Portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 75
},
"AssetCategory": {
"type": "string",
"description": "Describes the asset category",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OwnershipType": {
"type": "string",
"description": "Describes the ownership structure of the portfolio",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"ValidFrom": {
"type": "string",
"description": "Date portfolio was set up in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date the maturity of the portfolio has been reached in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"PrimaryUsageType": {
"type": "string",
"description": "Definition of the primary usage type/asset class of the portfolio (individual by portfolio owner)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SecondaryUsageType": {
"type": "string",
"description": "Definition of the secondary usage type/asset class of the portfolio (individual by portfolio owner)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"MarketValue": {
"type": "integer",
"description": "Current market value of Portfolio",
"minimum": -999999999999,
"maximum": 999999999999
},
"Currency": {
"type": "string",
"description": "Main/default currency of portfolio (depending on user it should be able to change this)",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"IndividualAccountId",
"Name",
"Type",
"ValidFrom",
"ValidUntil"
]
}2.5.2.1.5 Portfolio JSON data
{
"PortfolioId": "PF-03-01",
"IndividualAccountId": "1890627182",
"Name": "South Germany",
"PortfolioCode": "GS-012",
"Type": "O7iU4ReXKzXvi8WZJ-9 HR7m,Jg4xg990A",
"AssetCategory": "Tangible",
"OwnershipType": "Freehold",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"PrimaryUsageType": "Financial Assets",
"SecondaryUsageType": "Freehold",
"MarketValue": 2617281.27,
"Currency": "€"
}2.5.2.2 Document PortfolioBuilding
2.5.2.2.1 PortfolioBuilding Tree Diagram
2.5.2.2.2 PortfolioBuilding Properties
| Property | Value |
| Document name | PortfolioBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Portfolio and Building |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.2.3 PortfolioBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.2.3.1 Field PortfolioId
2.5.2.2.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioBuilding. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.5.2.2.3.2 Field BuildingId
2.5.2.2.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to PortfolioBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.5.2.2.4 PortfolioBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioBuilding",
"description": "Linking entity between Portfolio and Building",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"BuildingId"
]
}2.5.2.2.5 PortfolioBuilding JSON data
{
"PortfolioId": "PF-03-01",
"BuildingId": "SE-CH-2341"
}2.5.2.3 Document PortfolioLand
2.5.2.3.1 PortfolioLand Tree Diagram
2.5.2.3.2 PortfolioLand Properties
| Property | Value |
| Document name | PortfolioLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Portfolio and Land |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.3.3 PortfolioLand Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.3.3.1 Field PortfolioId
2.5.2.3.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioLand. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.5.2.3.3.2 Field LandId
2.5.2.3.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to PortfolioLand. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.5.2.3.4 PortfolioLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioLand",
"description": "Linking entity between Portfolio and Land",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"LandId"
]
}2.5.2.3.5 PortfolioLand JSON data
{
"PortfolioId": "PF-03-01",
"LandId": "AE-DE-02"
}2.5.2.4 Document PortfolioSite
2.5.2.4.1 PortfolioSite Tree Diagram
2.5.2.4.2 PortfolioSite Properties
| Property | Value |
| Document name | PortfolioSite |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Portfolio and Site |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.4.3 PortfolioSite Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SiteId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.4.3.1 Field PortfolioId
2.5.2.4.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioSite. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.5.2.4.3.2 Field SiteId
2.5.2.4.3.2.1 SiteId properties
| Property | Value |
| Name | SiteId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Site |
| Foreign field | SiteId |
| Relationship type | Foreign Key |
| Relationship name | fk Site. to PortfolioSite. |
| Cardinality | 0..n |
| Sample | AE-DE-02 |
| Comments |
2.5.2.4.4 PortfolioSite JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioSite",
"description": "Linking entity between Portfolio and Site",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SiteId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"SiteId"
]
}2.5.2.4.5 PortfolioSite JSON data
{
"PortfolioId": "PF-03-01",
"SiteId": "AE-DE-02"
}2.5.2.5 Document PortfolioStrategy
2.5.2.5.1 PortfolioStrategy Tree Diagram
2.5.2.5.2 PortfolioStrategy Properties
| Property | Value |
| Document name | PortfolioStrategy |
| Technical name | |
| Activated | true |
| Id | |
| Description | Strategy and strategic targets for the use of real estate assets in a portfolio |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.5.3 PortfolioStrategy Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioStrategyId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of Strategy (user specific) | ||
| InvestmentType | string | false | Type of Strategy | ||
| ValidFrom | date-time | true | Date Strategy was implemented in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date strategy has to be adapted by in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| StrategyObjectiveTargetsSteering | string | true | Steering target type of Portfolio Strategy | ||
| StrategyObjectiveValuesSteering | number | true | Value of the portfolio strategy steering targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnitSteering | string | true | Unit of strategy objective values steering | ||
| StrategyObjectiveTargets | string | false | Target type of Portfolio Strategy | ||
| StrategyObjectiveValues | number | false | Value of the portfolio strategy targets | [{"dataType":"float"}] | |
| StrategyObjectiveUnit | string | false | Unit of strategy objective values | ||
| Source | string | false | Source of Portfolio strategy |
2.5.2.5.3.1 Field PortfolioStrategyId
2.5.2.5.3.1.1 PortfolioStrategyId properties
| Property | Value |
| Name | PortfolioStrategyId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | x01 |
| Comments |
2.5.2.5.3.2 Field PortfolioId
2.5.2.5.3.2.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioStrategy. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.5.2.5.3.3 Field Name
2.5.2.5.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Strategy (user specific) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Core longterm value add |
| Comments |
2.5.2.5.3.4 Field InvestmentType
2.5.2.5.3.4.1 InvestmentType properties
| Property | Value |
| Name | InvestmentType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Strategy |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Value add |
| Comments |
2.5.2.5.3.5 Field ValidFrom
2.5.2.5.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date Strategy was implemented in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.5.3.6 Field ValidUntil
2.5.2.5.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date strategy has to be adapted by in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.5.3.7 Field StrategyObjectiveTargetsSteering
2.5.2.5.3.7.1 StrategyObjectiveTargetsSteering properties
| Property | Value |
| Name | StrategyObjectiveTargetsSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Steering target type of Portfolio Strategy |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Equity target |
| Comments |
2.5.2.5.3.8 Field StrategyObjectiveValuesSteering
2.5.2.5.3.8.1 StrategyObjectiveValuesSteering properties
| Property | Value |
| Name | StrategyObjectiveValuesSteering |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of the portfolio strategy steering targets |
| Type | number |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 6378123.45 |
| Comments | [{"dataType":"float"}] |
2.5.2.5.3.9 Field StrategyObjectiveUnitSteering
2.5.2.5.3.9.1 StrategyObjectiveUnitSteering properties
| Property | Value |
| Name | StrategyObjectiveUnitSteering |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values steering |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.5.2.5.3.10 Field StrategyObjectiveTargets
2.5.2.5.3.10.1 StrategyObjectiveTargets properties
| Property | Value |
| Name | StrategyObjectiveTargets |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Target type of Portfolio Strategy |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Equity target |
| Comments |
2.5.2.5.3.11 Field StrategyObjectiveValues
2.5.2.5.3.11.1 StrategyObjectiveValues properties
| Property | Value |
| Name | StrategyObjectiveValues |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of the portfolio strategy targets |
| Type | number |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 8000000 |
| Comments | [{"dataType":"float"}] |
2.5.2.5.3.12 Field StrategyObjectiveUnit
2.5.2.5.3.12.1 StrategyObjectiveUnit properties
| Property | Value |
| Name | StrategyObjectiveUnit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of strategy objective values |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.5.2.5.3.13 Field Source
2.5.2.5.3.13.1 Source properties
| Property | Value |
| Name | Source |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Source of Portfolio strategy |
| Format | |
| Pattern | [^<>\[\]\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Europe branch |
| Comments |
2.5.2.5.4 PortfolioStrategy JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioStrategy",
"description": "Strategy and strategic targets for the use of real estate assets in a portfolio",
"properties": {
"PortfolioStrategyId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Name": {
"type": "string",
"description": "Name of Strategy (user specific)",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"InvestmentType": {
"type": "string",
"description": "Type of Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date Strategy was implemented in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date strategy has to be adapted by in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"StrategyObjectiveTargetsSteering": {
"type": "string",
"description": "Steering target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValuesSteering": {
"type": "number",
"description": "Value of the portfolio strategy steering targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnitSteering": {
"type": "string",
"description": "Unit of strategy objective values steering",
"minLength": 1,
"maxLength": 50
},
"StrategyObjectiveTargets": {
"type": "string",
"description": "Target type of Portfolio Strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"StrategyObjectiveValues": {
"type": "number",
"description": "Value of the portfolio strategy targets",
"minimum": -999999999999,
"maximum": 999999999999
},
"StrategyObjectiveUnit": {
"type": "string",
"description": "Unit of strategy objective values",
"minLength": 1,
"maxLength": 50
},
"Source": {
"type": "string",
"description": "Source of Portfolio strategy",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioStrategyId",
"PortfolioId",
"Name",
"ValidFrom",
"ValidUntil",
"StrategyObjectiveTargetsSteering",
"StrategyObjectiveValuesSteering",
"StrategyObjectiveUnitSteering"
]
}2.5.2.5.5 PortfolioStrategy JSON data
{
"PortfolioStrategyId": "x01",
"PortfolioId": "PF-03-01",
"Name": "Core longterm value add",
"InvestmentType": "Value add",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"StrategyObjectiveTargetsSteering": "Equity target",
"StrategyObjectiveValuesSteering": 6378123.45,
"StrategyObjectiveUnitSteering": "€",
"StrategyObjectiveTargets": "Equity target",
"StrategyObjectiveValues": 8000000,
"StrategyObjectiveUnit": "€",
"Source": "Europe branch"
}2.5.2.6 Document PortfolioUnit
2.5.2.6.1 PortfolioUnit Tree Diagram
2.5.2.6.2 PortfolioUnit Properties
| Property | Value |
| Document name | PortfolioUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Portfolio and Unit |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.6.3 PortfolioUnit Fields
| Field | Type | Req | Key | Description | Comments |
| PortfolioId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.6.3.1 Field PortfolioId
2.5.2.6.3.1.1 PortfolioId properties
| Property | Value |
| Name | PortfolioId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Portfolio |
| Foreign field | PortfolioId |
| Relationship type | Foreign Key |
| Relationship name | fk Portfolio. to PortfolioUnit. |
| Cardinality | 0..n |
| Sample | PF-03-01 |
| Comments |
2.5.2.6.3.2 Field UnitId
2.5.2.6.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to PortfolioUnit. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.5.2.6.4 PortfolioUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "PortfolioUnit",
"description": "Linking entity between Portfolio and Unit",
"properties": {
"PortfolioId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"PortfolioId",
"UnitId"
]
}2.5.2.6.5 PortfolioUnit JSON data
{
"PortfolioId": "PF-03-01",
"UnitId": "UN-SE-CH-2341-02"
}2.5.2.7 Document Valuation
2.5.2.7.1 Valuation Tree Diagram
2.5.2.7.2 Valuation Properties
| Property | Value |
| Document name | Valuation |
| Technical name | |
| Activated | true |
| Id | |
| Description | Financial valuation of buildings or whole portfolios |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.7.3 Valuation Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| PreviousValuationId | string | false | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| Name | string | true | Name of valuation | ||
| Type | string | true | Type of valuation | ||
| ValidFrom | date-time | true | Date valuation is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date valuation has to be redone in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Description | string | false | Description of valuation implementation | ||
| Text | string | false | Text field | ||
| Keywords | string | false | Important keywords | ||
| Url | string | false | URL if existent | ||
| JurisdictionType | string | false | Type of Jurisdiction | ||
| ProfessionalStandard | string | false | Name of professional valuation standard used | ||
| AccountingStandard | string | false | Name of Accounting standard used | ||
| JurisdictionStandard | string | false | Name of Jurisdiction type used | ||
| Value | integer | true | Value of Valuation | [{"dataType":"decimal"}] | |
| Unit | string | true | Unit of valuation | ||
| Assumptions | string | false | Concluded assumptions | ||
| SpecialAssumptions | string | false | Concluded special assumptions | ||
| Constrains | string | false | Existing constrains | ||
| Approach | string | false | Valuation approach | ||
| MaintenanceBacklog | boolean | false | Does a maintenance backlog exist (Y/N) | ||
| SingleTenant | boolean | false | Valuation of single tenant building (Y/N) | ||
| DiscountRate | number | false | Discount rate included | [{"dataType":"float"}] | |
| DiscountPremiums | number | false | Discount premiums included | [{"dataType":"float"}] | |
| Uncertainty | string | false | LoV for uncertainty | ||
| Liquidity | number | false | Amount of cash | [{"dataType":"decimal"}] | |
| SpaceEfficiency | string | false | Space usage efficiency | ||
| EnergyEfficiency | string | false | Stating the energy efficiency class | ||
| DocumentId | string | false | Unique identifier either coming from previous system otherwise it needs to be defined | does not exist yet |
2.5.2.7.3.1 Field ValuationId
2.5.2.7.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | V021 |
| Comments |
2.5.2.7.3.2 Field PreviousValuationId
2.5.2.7.3.2.1 PreviousValuationId properties
| Property | Value |
| Name | PreviousValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | V020 |
| Comments |
2.5.2.7.3.3 Field Name
2.5.2.7.3.3.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of valuation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Comparative Valuation |
| Comments |
2.5.2.7.3.4 Field Type
2.5.2.7.3.4.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of valuation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 75 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Comparative method |
| Comments |
2.5.2.7.3.5 Field ValidFrom
2.5.2.7.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.7.3.6 Field ValidUntil
2.5.2.7.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date valuation has to be redone in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.5.2.7.3.7 Field Description
2.5.2.7.3.7.1 Description properties
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of valuation implementation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.8 Field Text
2.5.2.7.3.8.1 Text properties
| Property | Value |
| Name | Text |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Text field |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.9 Field Keywords
2.5.2.7.3.9.1 Keywords properties
| Property | Value |
| Name | Keywords |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Important keywords |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.10 Field Url
2.5.2.7.3.10.1 Url properties
| Property | Value |
| Name | Url |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | URL if existent |
| Format | |
| Pattern | [^<>\[\]\{\}\|\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.11 Field JurisdictionType
2.5.2.7.3.11.1 JurisdictionType properties
| Property | Value |
| Name | JurisdictionType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of Jurisdiction |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | RICS valuation |
| Comments |
2.5.2.7.3.12 Field ProfessionalStandard
2.5.2.7.3.12.1 ProfessionalStandard properties
| Property | Value |
| Name | ProfessionalStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of professional valuation standard used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.13 Field AccountingStandard
2.5.2.7.3.13.1 AccountingStandard properties
| Property | Value |
| Name | AccountingStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Accounting standard used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | IFRS |
| Comments |
2.5.2.7.3.14 Field JurisdictionStandard
2.5.2.7.3.14.1 JurisdictionStandard properties
| Property | Value |
| Name | JurisdictionStandard |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of Jurisdiction type used |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Local legislation |
| Comments |
2.5.2.7.3.15 Field Value
2.5.2.7.3.15.1 Value properties
| Property | Value |
| Name | Value |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of Valuation |
| Type | integer |
| Min value | -999999999999 |
| Excl min | |
| Max value | 999999999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"decimal"}] |
2.5.2.7.3.16 Field Unit
2.5.2.7.3.16.1 Unit properties
| Property | Value |
| Name | Unit |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unit of valuation |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.5.2.7.3.17 Field Assumptions
2.5.2.7.3.17.1 Assumptions properties
| Property | Value |
| Name | Assumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded assumptions |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.18 Field SpecialAssumptions
2.5.2.7.3.18.1 SpecialAssumptions properties
| Property | Value |
| Name | SpecialAssumptions |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Concluded special assumptions |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.19 Field Constrains
2.5.2.7.3.19.1 Constrains properties
| Property | Value |
| Name | Constrains |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Existing constrains |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.20 Field Approach
2.5.2.7.3.20.1 Approach properties
| Property | Value |
| Name | Approach |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Valuation approach |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.21 Field MaintenanceBacklog
2.5.2.7.3.21.1 MaintenanceBacklog properties
| Property | Value |
| Name | MaintenanceBacklog |
| Technical name | |
| Activated | true |
| Id | |
| Description | Does a maintenance backlog exist (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.5.2.7.3.22 Field SingleTenant
2.5.2.7.3.22.1 SingleTenant properties
| Property | Value |
| Name | SingleTenant |
| Technical name | |
| Activated | true |
| Id | |
| Description | Valuation of single tenant building (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.5.2.7.3.23 Field DiscountRate
2.5.2.7.3.23.1 DiscountRate properties
| Property | Value |
| Name | DiscountRate |
| Technical name | |
| Activated | true |
| Id | |
| Description | Discount rate included |
| Type | number |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Unit | % |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 7.29 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.24 Field DiscountPremiums
2.5.2.7.3.24.1 DiscountPremiums properties
| Property | Value |
| Name | DiscountPremiums |
| Technical name | |
| Activated | true |
| Id | |
| Description | Discount premiums included |
| Type | number |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Unit | % |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 2.87 |
| Comments | [{"dataType":"float"}] |
2.5.2.7.3.25 Field Uncertainty
2.5.2.7.3.25.1 Uncertainty properties
| Property | Value |
| Name | Uncertainty |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | LoV for uncertainty |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.26 Field Liquidity
2.5.2.7.3.26.1 Liquidity properties
| Property | Value |
| Name | Liquidity |
| Technical name | |
| Activated | true |
| Id | |
| Description | Amount of cash |
| Type | number |
| Min value | |
| Excl min | |
| Max value | |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 4539.27 |
| Comments | [{"dataType":"decimal"}] |
2.5.2.7.3.27 Field SpaceEfficiency
2.5.2.7.3.27.1 SpaceEfficiency properties
| Property | Value |
| Name | SpaceEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Space usage efficiency |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.5.2.7.3.28 Field EnergyEfficiency
2.5.2.7.3.28.1 EnergyEfficiency properties
| Property | Value |
| Name | EnergyEfficiency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Stating the energy efficiency class |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | A |
| Comments |
2.5.2.7.3.29 Field DocumentId
2.5.2.7.3.29.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | does not exist yet |
2.5.2.7.4 Valuation JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Valuation",
"description": "Financial valuation of buildings or whole portfolios",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"PreviousValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of valuation ",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"Type": {
"type": "string",
"description": "Type of valuation",
"minLength": 1,
"maxLength": 75,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date valuation is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date valuation has to be redone in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Description": {
"type": "string",
"description": "Description of valuation implementation",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Text": {
"type": "string",
"description": "Text field",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Keywords": {
"type": "string",
"description": "Important keywords",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Url": {
"type": "string",
"description": "URL if existent",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionType": {
"type": "string",
"description": "Type of Jurisdiction",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ProfessionalStandard": {
"type": "string",
"description": "Name of professional valuation standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AccountingStandard": {
"type": "string",
"description": "Name of Accounting standard used",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"JurisdictionStandard": {
"type": "string",
"description": "Name of Jurisdiction type used",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"Value": {
"type": "integer",
"description": "Value of Valuation",
"minimum": -999999999999,
"maximum": 999999999999
},
"Unit": {
"type": "string",
"description": "Unit of valuation",
"minLength": 1,
"maxLength": 50
},
"Assumptions": {
"type": "string",
"description": "Concluded assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpecialAssumptions": {
"type": "string",
"description": "Concluded special assumptions",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Constrains": {
"type": "string",
"description": "Existing constrains",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Approach": {
"type": "string",
"description": "Valuation approach",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MaintenanceBacklog": {
"type": "boolean",
"description": "Does a maintenance backlog exist (Y/N)"
},
"SingleTenant": {
"type": "boolean",
"description": "Valuation of single tenant building (Y/N)"
},
"DiscountRate": {
"type": "number",
"description": "Discount rate included",
"minimum": 0,
"maximum": 100
},
"DiscountPremiums": {
"type": "number",
"description": "Discount premiums included",
"minimum": 0,
"maximum": 100
},
"Uncertainty": {
"type": "string",
"description": "LoV for uncertainty",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Liquidity": {
"type": "number",
"description": "Amount of cash"
},
"SpaceEfficiency": {
"type": "string",
"description": "Space usage efficiency",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"EnergyEfficiency": {
"type": "string",
"description": "Stating the energy efficiency class",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
" DocumentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"Name",
"Type",
"ValidFrom",
"ValidUntil",
"Value",
"Unit"
]
}2.5.2.7.5 Valuation JSON data
{
"ValuationId": "V021",
"PreviousValuationId": "V020",
"Name": "Comparative Valuation",
"Type": "Comparative method",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"Description": "nR99urh,xQ9XHi,fRlSihsyqj-0k51TqkgYLOq-AX*DsSSnYE1P9*VuD",
"Text": "g1'Nz3FlAQ#7KbjMFK--M`,eK41sIkTW45NdZ R2W,Aheq7_dGKOWq1p2D ATy78SHP-qElGq2n*`bNlh-lNuogbQtB'JR5v-Q S.WJJH@-t0Gz4vGyUeqhx*#DTnxsOFeMGSCMdKWCHWce*xUXDqd0XL4XbgtsDx#402BGCw Xb",
"Keywords": "20Ew0GJSu.tllCOvGtOtzSIYcGrvA6*kd-P-nCAaTL6-V9c6,A'jnFNsZ1Y3-b,yVBRwYytOK3Is_IYv`nZ5t5Sz@N7uy#[email protected]'Yk_xGZG8EHDX4*j vw4#lXOTJjnC#zIGG#SdwPlypEL-IjLdSAv*tS5luV",
"Url": "I\\.oE\\4PB/1c.OXURaz*dFtP0n7Z77nc02o-y5JLZ9yB/jbM/5K/GJ4d_CuD4oJbF8Hn/UbDl9I#\\l.N63KIj",
"JurisdictionType": "RICS valuation",
"ProfessionalStandard": "NZIXC2DOD`",
"AccountingStandard": "IFRS",
"JurisdictionStandard": "Local legislation",
"Value": 342025873563,
"Unit": "€",
"Assumptions": "Q6l279ENKEO_*O aWErUcqe4Ldf7A`ZZVB `WW41cAN*4BVGUsM.35ZxDAwb2P8oyEbB62tLfAiWkoKnKjVo1IYMLfwiebbLRb2_1nQ8kjir0z.W_AIO`XM`2mZGcFo6DdBFVFJ68X#9Hf_D_WpEEoR_ lK7ejdNiEK@o-EWYpfaC8",
"SpecialAssumptions": "#YnjgGqGMVX9URz2OSPNiPJwUIYolLKWcgvog@cwEV4ur01pZkCQhCDtUN--EdYN*6EDwnk*CIM#zCj8DoyYHSu2y-WCyggXp6zqmwA1T4`msqjY9G ##5b1kPQn4SVt0IMDtBPax2kx `ODk@`IOdcfw*Ofr7MO1y1U3vgNbEKbmOOjx9Ew9EuA#wAr2-WZe",
"Constrains": "I",
"Approach": "TCz`QTGzwLX@sSA8rX6u1tnwHcsHCdspe#aA",
"MaintenanceBacklog": true,
"SingleTenant": true,
"DiscountRate": 7.29,
"DiscountPremiums": 2.87,
"Uncertainty": "Z-QPsWjytrjz0GENKRt-8U7#,XlD",
"Liquidity": 4539.27,
"SpaceEfficiency": "2X-mg 26UQ7wO",
"EnergyEfficiency": "A",
" DocumentId": "_7o2NoB.r8jgp"
}2.5.2.8 Document ValuationBuilding
2.5.2.8.1 ValuationBuilding Tree Diagram
2.5.2.8.2 ValuationBuilding Properties
| Property | Value |
| Document name | ValuationBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Valuation and Building |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.8.3 ValuationBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.8.3.1 Field ValuationId
2.5.2.8.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to ValuationBuilding. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.5.2.8.3.2 Field BuildingId
2.5.2.8.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to ValuationBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.5.2.8.4 ValuationBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationBuilding",
"description": "Linking entity between Valuation and Building",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"BuildingId"
]
}2.5.2.8.5 ValuationBuilding JSON data
{
"ValuationId": "V021",
"BuildingId": "SE-CH-2341"
}2.5.2.9 Document ValuationIndividualAccount
2.5.2.9.1 ValuationIndividualAccount Tree Diagram
2.5.2.9.2 ValuationIndividualAccount Properties
| Property | Value |
| Document name | ValuationIndividualAccount |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Valuation and IndividualAccount |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.9.3 ValuationIndividualAccount Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| IndividualAccountId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.9.3.1 Field ValuationId
2.5.2.9.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to ValuationIndividualAccount. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.5.2.9.3.2 Field IndividualAccountId
2.5.2.9.3.2.1 IndividualAccountId properties
| Property | Value |
| Name | IndividualAccountId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | IndividualAccount |
| Foreign field | IndividualAccountId |
| Relationship type | Foreign Key |
| Relationship name | fk IndividualAccount. to ValuationIndividualAccount. |
| Cardinality | 0..n |
| Sample | 1890627182 |
| Comments |
2.5.2.9.4 ValuationIndividualAccount JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationIndividualAccount",
"description": "Linking entity between Valuation and IndividualAccount",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"IndividualAccountId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"IndividualAccountId"
]
}2.5.2.9.5 ValuationIndividualAccount JSON data
{
"ValuationId": "V021",
"IndividualAccountId": "1890627182"
}2.5.2.10 Document ValuationLand
2.5.2.10.1 ValuationLand Tree Diagram
2.5.2.10.2 ValuationLand Properties
| Property | Value |
| Document name | ValuationLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Valuation and Land |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.10.3 ValuationLand Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.5.2.10.3.1 Field ValuationId
2.5.2.10.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to ValuationLand. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.5.2.10.3.2 Field LandId
2.5.2.10.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to ValuationLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.5.2.10.4 ValuationLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationLand",
"description": "Linking entity between Valuation and Land",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"ValuationId",
"LandId"
]
}2.5.2.10.5 ValuationLand JSON data
{
"ValuationId": "V021",
"LandId": "RE-AT-05"
}2.5.2.11 Document ValuationOperationalMeasurement
2.5.2.11.1 ValuationOperationalMeasurement Tree Diagram
2.5.2.11.2 ValuationOperationalMeasurement Properties
| Property | Value |
| Document name | ValuationOperationalMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between Valuation and OperationalMeasurement |
| Group | PortfolioAndAssetManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.5.2.11.3 ValuationOperationalMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| ValuationId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| OperationalMeasurementId | string | true | fk | Globally Unique Identifier number | [{"dataType":"guid"}] |
2.5.2.11.3.1 Field ValuationId
2.5.2.11.3.1.1 ValuationId properties
| Property | Value |
| Name | ValuationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Valuation |
| Foreign field | ValuationId |
| Relationship type | Foreign Key |
| Relationship name | fk Valuation. to ValuationOperationalMeasurement. |
| Cardinality | 0..n |
| Sample | V021 |
| Comments |
2.5.2.11.3.2 Field OperationalMeasurementId
2.5.2.11.3.2.1 OperationalMeasurementId properties
| Property | Value |
| Name | OperationalMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Globally Unique Identifier number |
| Format | |
| Pattern | ^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$ |
| Min length | 36 |
| Max length | 36 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | OperationalMeasurement |
| Foreign field | OperationalMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Cardinality | 0..n |
| Sample | 271ef573-3521-474a-a3de-08c32b8156d6 |
| Comments | [{"dataType":"guid"}] |
2.5.2.11.4 ValuationOperationalMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "ValuationOperationalMeasurement",
"description": "Linking entity between Valuation and OperationalMeasurement",
"properties": {
"ValuationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"OperationalMeasurementId": {
"type": "string",
"description": "Globally Unique Identifier number",
"minLength": 36,
"maxLength": 36,
"pattern": "^[0-9A-Fa-f]{8}(?:-[0-9A-Fa-f]{4}){3}-[0-9A-Fa-f]{12}$"
}
},
"required": [
"ValuationId",
"OperationalMeasurementId"
]
}2.5.2.11.5 ValuationOperationalMeasurement JSON data
{
"ValuationId": "V021",
"OperationalMeasurementId": "271ef573-3521-474a-a3de-08c32b8156d6"
}2.6 Group PropertyManagement
2.6.1 PropertyManagement Properties
| Property | Value |
| Group name | PropertyManagement |
| Technical name | |
| Activated | true |
| Description | Comprises data about the operation, control, and oversight of the real estate (current status: Focus on tenant relationship) |
| Comments |
2.6.2 PropertyManagement Documents
2.6.2.1 Document Dunning
2.6.2.1.1 Dunning Tree Diagram
2.6.2.1.2 Dunning Properties
| Property | Value |
| Document name | Dunning |
| Technical name | |
| Activated | true |
| Id | |
| Description | Information about outstanding rent receivables |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.1.3 Dunning Fields
| Field | Type | Req | Key | Description | Comments |
| DunningId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalPaymentId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| DunningLevel | string | true | Dunning level | ||
| DunningAmount | integer | true | Dunning Amount | [{"dataType":"decimal"}] | |
| Currency | string | true | Currency of payment | ||
| PaymentAmount | integer | true | Value of payment | [{"dataType":"decimal"}] | |
| InitialDueDate | date-time | true | Initial due date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PaymentDate | date-time | true | Payment date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] |
2.6.2.1.3.1 Field DunningId
2.6.2.1.3.1.1 DunningId properties
| Property | Value |
| Name | DunningId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | D-B-RU-10293 |
| Comments |
2.6.2.1.3.2 Field RentalPaymentId
2.6.2.1.3.2.1 RentalPaymentId properties
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | RentalPayment |
| Foreign field | RentalPaymentId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalPayment. to Dunning. |
| Cardinality | 0..n |
| Sample | RP-RC-6271 |
| Comments |
2.6.2.1.3.3 Field DunningLevel
2.6.2.1.3.3.1 DunningLevel properties
| Property | Value |
| Name | DunningLevel |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Dunning level |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 3 |
| Comments |
2.6.2.1.3.4 Field DunningAmount
2.6.2.1.3.4.1 DunningAmount properties
| Property | Value |
| Name | DunningAmount |
| Technical name | |
| Activated | true |
| Id | |
| Description | Dunning Amount |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 223.21 |
| Comments | [{"dataType":"decimal"}] |
2.6.2.1.3.5 Field Currency
2.6.2.1.3.5.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.6.2.1.3.6 Field PaymentAmount
2.6.2.1.3.6.1 PaymentAmount properties
| Property | Value |
| Name | PaymentAmount |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of payment |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 130.22 |
| Comments | [{"dataType":"decimal"}] |
2.6.2.1.3.7 Field InitialDueDate
2.6.2.1.3.7.1 InitialDueDate properties
| Property | Value |
| Name | InitialDueDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Initial due date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.1.3.8 Field PaymentDate
2.6.2.1.3.8.1 PaymentDate properties
| Property | Value |
| Name | PaymentDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Payment date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.1.4 Dunning JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Dunning",
"description": "Information about outstanding rent receivables",
"properties": {
"DunningId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningLevel": {
"type": "string",
"description": "Dunning level",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"DunningAmount": {
"type": "integer",
"description": "Dunning Amount",
"minimum": 1,
"maximum": 999999
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 50
},
"PaymentAmount": {
"type": "integer",
"description": "Value of payment",
"minimum": 1,
"maximum": 999999
},
"InitialDueDate": {
"type": "string",
"description": "Initial due date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"PaymentDate": {
"type": "string",
"description": "Payment date in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
}
},
"required": [
"DunningId",
"RentalPaymentId",
"DunningLevel",
"DunningAmount",
"Currency",
"PaymentAmount",
"InitialDueDate",
"PaymentDate"
]
}2.6.2.1.5 Dunning JSON data
{
"DunningId": "D-B-RU-10293",
"RentalPaymentId": "RP-RC-6271",
"DunningLevel": "3",
"DunningAmount": 223.21,
"Currency": "€",
"PaymentAmount": 130.22,
"InitialDueDate": "2011-06-14T04:12:36.123Z",
"PaymentDate": "2011-06-14T04:12:36.123Z"
}2.6.2.2 Document RentalContract
2.6.2.2.1 RentalContract Tree Diagram
2.6.2.2.2 RentalContract Properties
| Property | Value |
| Document name | RentalContract |
| Technical name | |
| Activated | true |
| Id | |
| Description | Agreement identifying all information regarding the rental relationship |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.6.2.2.3 RentalContract Fields
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| MainContractId | string | false | Main contract code | ||
| ContractCode | string | true | Contract Code (e.g. SAP) | ||
| ContractType | string | false | Contract type | ||
| CompanyCode | string | false | Company Code (e.g. SAP code) | ||
| ContractName | string | false | Contract name | ||
| ContractGroup | string | false | Contract group | ||
| RentBeginDate | date-time | true | Date original contract starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| RentEndDate | date-time | true | Date original contract ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidFrom | date-time | true | Date of first paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date of last paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| PeriodOfNotice | string | false | Period of notice e.g. monthly; 3 month; 6 month etc. | ||
| PaymentInAdvance | boolean | false | Does the payment have to be conducted in advance (Y/N) | ||
| PaymentFrequency | string | true | Frequency of payment e.g. weekly, monthly, quarterly etc. | ||
| ShortTermLease | boolean | false | Is this a short term lease (Y/N) | ||
| TenantSector | string | false | Sector / Business area of the tenant | ||
| TurnoverReportingInterval | string | false | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
2.6.2.2.3.1 Field RentalContractId
2.6.2.2.3.1.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | RC-6271 |
| Comments |
2.6.2.2.3.2 Field MainContractId
2.6.2.2.3.2.1 MainContractId properties
| Property | Value |
| Name | MainContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Main contract code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | R-01 |
| Comments |
2.6.2.2.3.3 Field ContractCode
2.6.2.2.3.3.1 ContractCode properties
| Property | Value |
| Name | ContractCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract Code (e.g. SAP) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1870_1867_00093 |
| Comments |
2.6.2.2.3.4 Field ContractType
2.6.2.2.3.4.1 ContractType properties
| Property | Value |
| Name | ContractType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract type |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Operating Lease |
| Comments |
2.6.2.2.3.5 Field CompanyCode
2.6.2.2.3.5.1 CompanyCode properties
| Property | Value |
| Name | CompanyCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Company Code (e.g. SAP code) |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 1870 |
| Comments |
2.6.2.2.3.6 Field ContractName
2.6.2.2.3.6.1 ContractName properties
| Property | Value |
| Name | ContractName |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract name |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Mainz Bürogebäude 6-0291 |
| Comments |
2.6.2.2.3.7 Field ContractGroup
2.6.2.2.3.7.1 ContractGroup properties
| Property | Value |
| Name | ContractGroup |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Contract group |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Munich Main Office |
| Comments |
2.6.2.2.3.8 Field RentBeginDate
2.6.2.2.3.8.1 RentBeginDate properties
| Property | Value |
| Name | RentBeginDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.9 Field RentEndDate
2.6.2.2.3.9.1 RentEndDate properties
| Property | Value |
| Name | RentEndDate |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date original contract ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.10 Field ValidFrom
2.6.2.2.3.10.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of first paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.11 Field ValidUntil
2.6.2.2.3.11.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date of last paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.2.3.12 Field PeriodOfNotice
2.6.2.2.3.12.1 PeriodOfNotice properties
| Property | Value |
| Name | PeriodOfNotice |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Period of notice e.g. monthly; 3 month; 6 month etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 6 month |
| Comments |
2.6.2.2.3.13 Field PaymentInAdvance
2.6.2.2.3.13.1 PaymentInAdvance properties
| Property | Value |
| Name | PaymentInAdvance |
| Technical name | |
| Activated | true |
| Id | |
| Description | Does the payment have to be conducted in advance (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | false |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.6.2.2.3.14 Field PaymentFrequency
2.6.2.2.3.14.1 PaymentFrequency properties
| Property | Value |
| Name | PaymentFrequency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Frequency of payment e.g. weekly, monthly, quarterly etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | monthly |
| Comments |
2.6.2.2.3.15 Field ShortTermLease
2.6.2.2.3.15.1 ShortTermLease properties
| Property | Value |
| Name | ShortTermLease |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is this a short term lease (Y/N) |
| Type | boolean |
| Default | true |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.6.2.2.3.16 Field TenantSector
2.6.2.2.3.16.1 TenantSector properties
| Property | Value |
| Name | TenantSector |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Sector / Business area of the tenant |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Research & development |
| Comments |
2.6.2.2.3.17 Field TurnoverReportingInterval
2.6.2.2.3.17.1 TurnoverReportingInterval properties
| Property | Value |
| Name | TurnoverReportingInterval |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc. |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | quarterly |
| Comments |
2.6.2.2.4 RentalContract JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContract",
"description": "Agreement identifying all information regarding the rental relationship",
"additionalProperties": false,
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"MainContractId": {
"type": "string",
"description": "Main contract code",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractCode": {
"type": "string",
"description": "Contract Code (e.g. SAP)",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 70
},
"ContractType": {
"type": "string",
"description": "Contract type",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"CompanyCode": {
"type": "string",
"description": "Company Code (e.g. SAP code)",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractName": {
"type": "string",
"description": "Contract name",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ContractGroup": {
"type": "string",
"description": "Contract group",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentBeginDate": {
"type": "string",
"description": "Date original contract starts in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"RentEndDate": {
"type": "string",
"description": "Date original contract ends in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidFrom": {
"type": "string",
"description": "Date of first paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date of last paying month in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"PeriodOfNotice": {
"type": "string",
"description": "Period of notice e.g. monthly; 3 month; 6 month etc.",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
},
"PaymentInAdvance": {
"type": "boolean",
"description": "Does the payment have to be conducted in advance (Y/N)"
},
"PaymentFrequency": {
"type": "string",
"description": "Frequency of payment e.g. weekly, monthly, quarterly etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ShortTermLease": {
"type": "boolean",
"description": "Is this a short term lease (Y/N)",
"default": true
},
"TenantSector": {
"type": "string",
"description": "Sector / Business area of the tenant",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"TurnoverReportingInterval": {
"type": "string",
"description": "If turnover rent, reporting interval for the tenant turnover: monthly, quarterly, etc.",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"ContractCode",
"RentBeginDate",
"RentEndDate",
"ValidFrom",
"ValidUntil",
"PaymentFrequency"
]
}2.6.2.2.5 RentalContract JSON data
{
"RentalContractId": "RC-6271",
"MainContractId": "R-01",
"ContractCode": "1870_1867_00093",
"ContractType": "Operating Lease",
"CompanyCode": "1870",
"ContractName": "Mainz Bürogebäude 6-0291",
"ContractGroup": "Munich Main Office",
"RentBeginDate": "2011-06-14T04:12:36.123Z",
"RentEndDate": "2011-06-14T04:12:36.123Z",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"PeriodOfNotice": "6 month",
"PaymentInAdvance": true,
"PaymentFrequency": "monthly",
"ShortTermLease": true,
"TenantSector": "Research & development",
"TurnoverReportingInterval": "quarterly"
}2.6.2.3 Document RentalContractRentalUnit
2.6.2.3.1 RentalContractRentalUnit Tree Diagram
2.6.2.3.2 RentalContractRentalUnit Properties
| Property | Value |
| Document name | RentalContractRentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalContract and RentalUnit |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.3.3 RentalContractRentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.3.3.1 Field RentalContractId
2.6.2.3.3.1.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalContractRentalUnit. |
| Cardinality | 1..n |
| Sample | RC-6271 |
| Comments |
2.6.2.3.3.2 Field RentalUnitId
2.6.2.3.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalContractRentalUnit. |
| Cardinality | 1..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.3.4 RentalContractRentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRentalUnit",
"description": "Linking entity between RentalContract and RentalUnit",
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"RentalUnitId"
]
}2.6.2.3.5 RentalContractRentalUnit JSON data
{
"RentalContractId": "RC-6271",
"RentalUnitId": "B-RU-10293"
}2.6.2.4 Document RentalContractRole
2.6.2.4.1 RentalContractRole Tree Diagram
2.6.2.4.2 RentalContractRole Properties
| Property | Value |
| Document name | RentalContractRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalContract and Role |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.4.3 RentalContractRole Fields
| Field | Type | Req | Key | Description | Comments |
| RentalContractId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.4.3.1 Field RentalContractId
2.6.2.4.3.1.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalContractRole. |
| Cardinality | 0..n |
| Sample | RC-6271 |
| Comments |
2.6.2.4.3.2 Field RoleId
2.6.2.4.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to RentalContractRole. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.6.2.4.4 RentalContractRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalContractRole",
"description": "Linking entity between RentalContract and Role",
"properties": {
"RentalContractId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalContractId",
"RoleId"
]
}2.6.2.4.5 RentalContractRole JSON data
{
"RentalContractId": "RC-6271",
"RoleId": "R-01"
}2.6.2.5 Document RentalOption
2.6.2.5.1 RentalOption Tree Diagram
2.6.2.5.2 RentalOption Properties
| Property | Value |
| Document name | RentalOption |
| Technical name | |
| Activated | true |
| Id | |
| Description | Information about rental option of rental contract |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.5.3 RentalOption Fields
| Field | Type | Req | Key | Description | Comments |
| RentalOptionId | string | true | Unique identifier either coming from previous system otherwise it needs to be defined | ||
| RentalContractId | string | true | fk | Reference to corresponding rental contract | |
| Type | string | true | Type of option | ||
| SubType | string | true | Subtype of the option | ||
| ValidFrom | date-time | true | Date option is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | Date option is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| DocumentId | string | false | Reference to document | does not exist yet |
2.6.2.5.3.1 Field RentalOptionId
2.6.2.5.3.1.1 RentalOptionId properties
| Property | Value |
| Name | RentalOptionId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | LO-RC-6271-1 |
| Comments |
2.6.2.5.3.2 Field RentalContractId
2.6.2.5.3.2.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to corresponding rental contract |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | RentalContract |
| Foreign field | RentalContractId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalOption. |
| Cardinality | 0..n |
| Sample | RC-6271 |
| Comments |
2.6.2.5.3.3 Field Type
2.6.2.5.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of option |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Contract extension |
| Comments |
2.6.2.5.3.4 Field SubType
2.6.2.5.3.4.1 SubType properties
| Property | Value |
| Name | SubType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Subtype of the option |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Renewal |
| Comments |
2.6.2.5.3.5 Field ValidFrom
2.6.2.5.3.5.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.5.3.6 Field ValidUntil
2.6.2.5.3.6.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date option is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.5.3.7 Field DocumentId
2.6.2.5.3.7.1 DocumentId properties
| Property | Value |
| Name | DocumentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to document |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | does not exist yet |
2.6.2.5.4 RentalOption JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalOption",
"description": "Information about rental option of rental contract",
"properties": {
"RentalOptionId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalContractId": {
"type": "string",
"description": "Reference to corresponding rental contract",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of option ",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SubType": {
"type": "string",
"description": "Subtype of the option",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Date option is valid from in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date option is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
" DocumentId": {
"type": "string",
"description": "Reference to document",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalOptionId",
"RentalContractId",
"Type",
"SubType",
"ValidFrom",
"ValidUntil"
]
}2.6.2.5.5 RentalOption JSON data
{
"RentalOptionId": "LO-RC-6271-1",
"RentalContractId": "RC-6271",
"Type": "Contract extension",
"SubType": "Renewal",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
" DocumentId": "FiBwxuQkf5hagviUs"
}2.6.2.6 Document RentalPayment
2.6.2.6.1 RentalPayment Tree Diagram
2.6.2.6.2 RentalPayment Properties
| Property | Value |
| Document name | RentalPayment |
| Technical name | |
| Activated | true |
| Id | |
| Description | Information about payments related to rental contract |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.6.3 RentalPayment Fields
| Field | Type | Req | Key | Description | Comments |
| RentalPaymentId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalContractId | string | true | fk | Reference to rental contract | |
| ValidFrom | date-time | true | Starting date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | true | End date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Type | string | true | Type of lease payment | ||
| Currency | string | true | Currency of payment | ||
| ValueMonth | integer | true | Value of payment per month | [{"dataType":"decimal"}] | |
| ValueYear | integer | false | Value of payment per year | [{"dataType":"decimal"}] | |
| DiscountInPercentage | number | false | Discount percentage of payment | [{"dataType":"float"}] | |
| VatOpted | boolean | false | Is the vat payable (Y/N) | ||
| IndexId | string | false | Reference to index table | does not exist yet |
2.6.2.6.3.1 Field RentalPaymentId
2.6.2.6.3.1.1 RentalPaymentId properties
| Property | Value |
| Name | RentalPaymentId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | RP-RC-6271 |
| Comments |
2.6.2.6.3.2 Field RentalContractId
2.6.2.6.3.2.1 RentalContractId properties
| Property | Value |
| Name | RentalContractId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to rental contract |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | RentalContract |
| Foreign field | |
| Relationship type | Foreign Key |
| Relationship name | fk RentalContract. to RentalPayment. |
| Cardinality | 1..n |
| Sample | RC-6271 |
| Comments |
2.6.2.6.3.3 Field ValidFrom
2.6.2.6.3.3.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Starting date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.6.3.4 Field ValidUntil
2.6.2.6.3.4.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | End date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.6.3.5 Field Type
2.6.2.6.3.5.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of lease payment |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Ancillary costs |
| Comments |
2.6.2.6.3.6 Field Currency
2.6.2.6.3.6.1 Currency properties
| Property | Value |
| Name | Currency |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Currency of payment |
| Format | |
| Pattern | |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | € |
| Comments |
2.6.2.6.3.7 Field ValueMonth
2.6.2.6.3.7.1 ValueMonth properties
| Property | Value |
| Name | ValueMonth |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of payment per month |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 9999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 216.21 |
| Comments | [{"dataType":"decimal"}] |
2.6.2.6.3.8 Field ValueYear
2.6.2.6.3.8.1 ValueYear properties
| Property | Value |
| Name | ValueYear |
| Technical name | |
| Activated | true |
| Id | |
| Description | Value of payment per year |
| Type | integer |
| Min value | 1 |
| Excl min | |
| Max value | 99999999 |
| Excl max | |
| Multiple of | |
| Unit | |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 251.21 |
| Comments | [{"dataType":"decimal"}] |
2.6.2.6.3.9 Field DiscountInPercentage
2.6.2.6.3.9.1 DiscountInPercentage properties
| Property | Value |
| Name | DiscountInPercentage |
| Technical name | |
| Activated | true |
| Id | |
| Description | Discount percentage of payment |
| Type | number |
| Min value | 0 |
| Excl min | |
| Max value | 100 |
| Excl max | |
| Multiple of | |
| Unit | % |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | 4.53 |
| Comments | [{"dataType":"float"}] |
2.6.2.6.3.10 Field VatOpted
2.6.2.6.3.10.1 VatOpted properties
| Property | Value |
| Name | VatOpted |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is the vat payable (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.6.2.6.3.11 Field IndexId
2.6.2.6.3.11.1 IndexId properties
| Property | Value |
| Name | IndexId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Reference to index table |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | does not exist yet |
2.6.2.6.4 RentalPayment JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalPayment",
"description": "Information about payments related to rental contract",
"properties": {
"RentalPaymentId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalContractId": {
"type": "string",
"description": "Reference to rental contract",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"ValidFrom": {
"type": "string",
"description": "Starting date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "End date of payment in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Type": {
"type": "string",
"description": "Type of lease payment",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Currency": {
"type": "string",
"description": "Currency of payment",
"minLength": 1,
"maxLength": 50
},
"ValueMonth": {
"type": "integer",
"description": "Value of payment per month",
"minimum": 1,
"maximum": 9999999
},
"ValueYear": {
"type": "integer",
"description": "Value of payment per year",
"minimum": 1,
"maximum": 99999999
},
"DiscountInPercentage": {
"type": "number",
"description": "Discount percentage of payment",
"minimum": 0,
"maximum": 100
},
"VatOpted": {
"type": "boolean",
"description": "Is the vat payable (Y/N)"
},
"IndexId": {
"type": "string",
"description": "Reference to index table",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalPaymentId",
"RentalContractId",
"ValidFrom",
"ValidUntil",
"Type",
"Currency",
"ValueMonth"
]
}2.6.2.6.5 RentalPayment JSON data
{
"RentalPaymentId": "RP-RC-6271",
"RentalContractId": "RC-6271",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"Type": "Ancillary costs",
"Currency": "€",
"ValueMonth": 216.21,
"ValueYear": 251.21,
"DiscountInPercentage": 4.53,
"VatOpted": true,
"IndexId": "TGfHJh2T"
}2.6.2.7 Document RentalUnit
2.6.2.7.1 RentalUnit Tree Diagram
2.6.2.7.2 RentalUnit Properties
| Property | Value |
| Document name | RentalUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Structure or part of a structure rented out to a third party as a home, residence, office or for any other use |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | false |
| Comments |
2.6.2.7.3 RentalUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Name | string | true | Name of rental unit | ||
| RentalUnitCode | string | false | User specific RentalUnit Code | ||
| RentedOut | boolean | false | Is the RentalUnit rented out (Y/N) | ||
| UsageType | string | false | Usage type of the rental unit | ||
| Vacancy | boolean | false | Is the rental unit vacant (Y/N) |
2.6.2.7.3.1 Field RentalUnitId
2.6.2.7.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | B-RU-10293 |
| Comments |
2.6.2.7.3.2 Field Name
2.6.2.7.3.2.1 Name properties
| Property | Value |
| Name | Name |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Name of rental unit |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Heinrich-Heinestr. C602 |
| Comments |
2.6.2.7.3.3 Field RentalUnitCode
2.6.2.7.3.3.1 RentalUnitCode properties
| Property | Value |
| Name | RentalUnitCode |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | User specific RentalUnit Code |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 70 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | DE-B-C602 |
| Comments |
2.6.2.7.3.4 Field RentedOut
2.6.2.7.3.4.1 RentedOut properties
| Property | Value |
| Name | RentedOut |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is the RentalUnit rented out (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | false |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.6.2.7.3.5 Field UsageType
2.6.2.7.3.5.1 UsageType properties
| Property | Value |
| Name | UsageType |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Usage type of the rental unit |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | Office |
| Comments |
2.6.2.7.3.6 Field Vacancy
2.6.2.7.3.6.1 Vacancy properties
| Property | Value |
| Name | Vacancy |
| Technical name | |
| Activated | true |
| Id | |
| Description | Is the rental unit vacant (Y/N) |
| Type | boolean |
| Default | |
| Dependencies | |
| Required | |
| Primary key | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | true |
| Comments |
2.6.2.7.4 RentalUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnit",
"description": "Structure or part of a structure rented out to a third party as a home, residence, office or for any other use",
"additionalProperties": false,
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Name": {
"type": "string",
"description": "Name of rental unit",
"minLength": 1,
"maxLength": 200,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitCode": {
"type": "string",
"description": "User specific RentalUnit Code",
"minLength": 1,
"maxLength": 70,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentedOut": {
"type": "boolean",
"description": "Is the RentalUnit rented out (Y/N)"
},
"UsageType": {
"type": "string",
"description": "Usage type of the rental unit",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Vacancy": {
"type": "boolean",
"description": "Is the rental unit vacant (Y/N)"
}
},
"required": [
"RentalUnitId",
"Name"
]
}2.6.2.7.5 RentalUnit JSON data
{
"RentalUnitId": "B-RU-10293",
"Name": "Heinrich-Heinestr. C602",
"RentalUnitCode": "DE-B-C602",
"RentedOut": true,
"UsageType": "Office",
"Vacancy": true
}2.6.2.8 Document RentalUnitAreaMeasurement
2.6.2.8.1 RentalUnitAreaMeasurement Tree Diagram
2.6.2.8.2 RentalUnitAreaMeasurement Properties
| Property | Value |
| Document name | RentalUnitAreaMeasurement |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and AreaMeasurement |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.8.3 RentalUnitAreaMeasurement Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| AreaMeasurementId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.8.3.1 Field RentalUnitId
2.6.2.8.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitAreaMeasurement. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.8.3.2 Field AreaMeasurementId
2.6.2.8.3.2.1 AreaMeasurementId properties
| Property | Value |
| Name | AreaMeasurementId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | AreaMeasurement |
| Foreign field | AreaMeasurementId |
| Relationship type | Foreign Key |
| Relationship name | fk AreaMeasurement. to RentalUnitAreaMeasurement. |
| Cardinality | 0..n |
| Sample | AM-CH-SE-2312 |
| Comments |
2.6.2.8.4 RentalUnitAreaMeasurement JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitAreaMeasurement",
"description": "Linking entity between RentalUnit and AreaMeasurement",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"AreaMeasurementId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"AreaMeasurementId"
]
}2.6.2.8.5 RentalUnitAreaMeasurement JSON data
{
"RentalUnitId": "B-RU-10293",
"AreaMeasurementId": "AM-CH-SE-2312"
}2.6.2.9 Document RentalUnitBuilding
2.6.2.9.1 RentalUnitBuilding Tree Diagram
2.6.2.9.2 RentalUnitBuilding Properties
| Property | Value |
| Document name | RentalUnitBuilding |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and Building |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.9.3 RentalUnitBuilding Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| BuildingId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.9.3.1 Field RentalUnitId
2.6.2.9.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitBuilding. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.9.3.2 Field BuildingId
2.6.2.9.3.2.1 BuildingId properties
| Property | Value |
| Name | BuildingId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Building |
| Foreign field | BuildingId |
| Relationship type | Foreign Key |
| Relationship name | fk Building. to RentalUnitBuilding. |
| Cardinality | 0..n |
| Sample | SE-CH-2341 |
| Comments |
2.6.2.9.4 RentalUnitBuilding JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitBuilding",
"description": "Linking entity between RentalUnit and Building",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"BuildingId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"RentalUnitId",
"BuildingId"
]
}2.6.2.9.5 RentalUnitBuilding JSON data
{
"RentalUnitId": "B-RU-10293",
"BuildingId": "SE-CH-2341"
}2.6.2.10 Document RentalUnitFloor
2.6.2.10.1 RentalUnitFloor Tree Diagram
2.6.2.10.2 RentalUnitFloor Properties
| Property | Value |
| Document name | RentalUnitFloor |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and Floor |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.10.3 RentalUnitFloor Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| FloorId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.10.3.1 Field RentalUnitId
2.6.2.10.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitFloor. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.10.3.2 Field FloorId
2.6.2.10.3.2.1 FloorId properties
| Property | Value |
| Name | FloorId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Floor |
| Foreign field | FloorId |
| Relationship type | Foreign Key |
| Relationship name | fk Floor. to RentalUnitFloor. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01 |
| Comments |
2.6.2.10.4 RentalUnitFloor JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitFloor",
"description": "Linking entity between RentalUnit and Floor",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"FloorId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"FloorId"
]
}2.6.2.10.5 RentalUnitFloor JSON data
{
"RentalUnitId": "B-RU-10293",
"FloorId": "SE-CH-F-01"
}2.6.2.11 Document RentalUnitLand
2.6.2.11.1 RentalUnitLand Tree Diagram
2.6.2.11.2 RentalUnitLand Properties
| Property | Value |
| Document name | RentalUnitLand |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and Land |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.11.3 RentalUnitLand Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| LandId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.11.3.1 Field RentalUnitId
2.6.2.11.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitLand. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.11.3.2 Field LandId
2.6.2.11.3.2.1 LandId properties
| Property | Value |
| Name | LandId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Land |
| Foreign field | LandId |
| Relationship type | Foreign Key |
| Relationship name | fk Land. to RentalUnitLand. |
| Cardinality | 0..n |
| Sample | RE-AT-05 |
| Comments |
2.6.2.11.4 RentalUnitLand JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitLand",
"description": "Linking entity between RentalUnit and Land",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"LandId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"RentalUnitId",
"LandId"
]
}2.6.2.11.5 RentalUnitLand JSON data
{
"RentalUnitId": "B-RU-10293",
"LandId": "RE-AT-05"
}2.6.2.12 Document RentalUnitSpace
2.6.2.12.1 RentalUnitSpace Tree Diagram
2.6.2.12.2 RentalUnitSpace Properties
| Property | Value |
| Document name | RentalUnitSpace |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and Space |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.12.3 RentalUnitSpace Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| SpaceId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.12.3.1 Field RentalUnitId
2.6.2.12.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitSpace. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.12.3.2 Field SpaceId
2.6.2.12.3.2.1 SpaceId properties
| Property | Value |
| Name | SpaceId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Space |
| Foreign field | SpaceId |
| Relationship type | Foreign Key |
| Relationship name | fk Space. to RentalUnitSpace. |
| Cardinality | 0..n |
| Sample | SE-CH-F-01-21 |
| Comments |
2.6.2.12.4 RentalUnitSpace JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitSpace",
"description": "Linking entity between RentalUnit and Space",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"SpaceId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"SpaceId"
]
}2.6.2.12.5 RentalUnitSpace JSON data
{
"RentalUnitId": "B-RU-10293",
"SpaceId": "SE-CH-F-01-21"
}2.6.2.13 Document RentalUnitUnit
2.6.2.13.1 RentalUnitUnit Tree Diagram
2.6.2.13.2 RentalUnitUnit Properties
| Property | Value |
| Document name | RentalUnitUnit |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between RentalUnit and Unit |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.13.3 RentalUnitUnit Fields
| Field | Type | Req | Key | Description | Comments |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| UnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.13.3.1 Field RentalUnitId
2.6.2.13.3.1.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to RentalUnitUnit. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.13.3.2 Field UnitId
2.6.2.13.3.2.1 UnitId properties
| Property | Value |
| Name | UnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Unit |
| Foreign field | UnitId |
| Relationship type | Foreign Key |
| Relationship name | fk Unit. to RentalUnitUnit. |
| Cardinality | 0..n |
| Sample | UN-SE-CH-2341-02 |
| Comments |
2.6.2.13.4 RentalUnitUnit JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "RentalUnitUnit",
"description": "Linking entity between RentalUnit and Unit",
"properties": {
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"UnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"RentalUnitId",
"UnitId"
]
}2.6.2.13.5 RentalUnitUnit JSON data
{
"RentalUnitId": "B-RU-10293",
"UnitId": "UN-SE-CH-2341-02"
}2.6.2.14 Document TenantCommunication
2.6.2.14.1 TenantCommunication Tree Diagram
2.6.2.14.2 TenantCommunication Properties
| Property | Value |
| Document name | TenantCommunication |
| Technical name | |
| Activated | true |
| Id | |
| Description | Communication between different parties involved in operation, control, and oversight of the real estate |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.14.3 TenantCommunication Fields
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | dk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| RentalUnitId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined | |
| Type | string | true | Type of communication | ||
| Medium | string | false | Medium of communication | ||
| Description | string | true | Description of communciation | ||
| ValidFrom | date-time | true | Date communication occurred in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| ValidUntil | date-time | false | Date communication is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) | [{"dataType":"dateTime"}] | |
| Status | string | true | Status of communication |
2.6.2.14.3.1 Field TenantCommunicationId
2.6.2.14.3.1.1 TenantCommunicationId properties
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | TC-20561 |
| Comments |
2.6.2.14.3.2 Field RentalUnitId
2.6.2.14.3.2.1 RentalUnitId properties
| Property | Value |
| Name | RentalUnitId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | RentalUnit |
| Foreign field | RentalUnitId |
| Relationship type | Foreign Key |
| Relationship name | fk RentalUnit. to TenantCommunication. |
| Cardinality | 0..n |
| Sample | B-RU-10293 |
| Comments |
2.6.2.14.3.3 Field Type
2.6.2.14.3.3.1 Type properties
| Property | Value |
| Name | Type |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Type of communication |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.6.2.14.3.4 Field Medium
2.6.2.14.3.4.1 Medium properties
| Property | Value |
| Name | Medium |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Medium of communication |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.6.2.14.3.5 Field Description
2.6.2.14.3.5.1 Description properties
| Property | Value |
| Name | Description |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Description of communciation |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 200 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.6.2.14.3.6 Field ValidFrom
2.6.2.14.3.6.1 ValidFrom properties
| Property | Value |
| Name | ValidFrom |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication occurred in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | true |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.14.3.7 Field ValidUntil
2.6.2.14.3.7.1 ValidUntil properties
| Property | Value |
| Name | ValidUntil |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Date communication is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061) |
| Format | date-time |
| Pattern | |
| Min length | |
| Max length | |
| Default | |
| Enum | |
| Required | false |
| Primary key | false |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments | [{"dataType":"dateTime"}] |
2.6.2.14.3.8 Field Status
2.6.2.14.3.8.1 Status properties
| Property | Value |
| Name | Status |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Status of communication |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | |
| Dependencies | |
| Foreign collection | |
| Foreign field | |
| Relationship type | |
| Relationship name | |
| Cardinality | |
| Sample | |
| Comments |
2.6.2.14.4 TenantCommunication JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunication",
"description": "Communication between different parties involved in operation, control, and oversight of the real estate",
"properties": {
"TenantCommunicationId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RentalUnitId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Type": {
"type": "string",
"description": "Type of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Medium": {
"type": "string",
"description": "Medium of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"Description": {
"type": "string",
"description": "Description of communciation",
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$",
"minLength": 1,
"maxLength": 200
},
"ValidFrom": {
"type": "string",
"description": "Date communication occurred in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"ValidUntil": {
"type": "string",
"description": "Date communication is valid until in yyyy-mm-ddThh:mm:ssZ form (conform to ISO 8061)",
"format": "date-time"
},
"Status": {
"type": "string",
"description": "Status of communication",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"RentalUnitId",
"Type",
"Description",
"ValidFrom",
"Status"
]
}2.6.2.14.5 TenantCommunication JSON data
{
"TenantCommunicationId": "TC-20561",
"RentalUnitId": "B-RU-10293",
"Type": "gqa4sRauHZKRAb*FVpgX8N6TY-h6sdfDY067'HYzpp@PqDD",
"Medium": "[email protected]#.'cYG'6Wuxf#A1BPCht",
"Description": "O7ilGRETQgLmX snx_somVFdwPff86p8Q*l#jnD#RGF,A41dv,FsCEXor4sZ._5 YWijTkT yO#_Bpo-mR4hDHgihED0EgFqyy-oRwNJztuobG3NrLFiYP_.g7yHxRXsfxs51E.wTfn6l.UeS-H9'9CAUS RkkqvECfoV350paaZF9OYKJ7nbe*'iOiEXEk",
"ValidFrom": "2011-06-14T04:12:36.123Z",
"ValidUntil": "2011-06-14T04:12:36.123Z",
"Status": "9IOf_rAsqQ#Sr2n`L"
}2.6.2.15 Document TenantCommunicationRole
2.6.2.15.1 TenantCommunicationRole Tree Diagram
2.6.2.15.2 TenantCommunicationRole Properties
| Property | Value |
| Document name | TenantCommunicationRole |
| Technical name | |
| Activated | true |
| Id | |
| Description | Linking entity between TenantCommunication and Role |
| Group | PropertyManagement |
| Pulsar topic name | |
| Is non-persistent Pulsar topic | |
| Additional properties | |
| Comments |
2.6.2.15.3 TenantCommunicationRole Fields
| Field | Type | Req | Key | Description | Comments |
| TenantCommunicationId | string | true | fk | ||
| RoleId | string | true | fk | Unique identifier either coming from previous system otherwise it needs to be defined |
2.6.2.15.3.1 Field TenantCommunicationId
2.6.2.15.3.1.1 TenantCommunicationId properties
| Property | Value |
| Name | TenantCommunicationId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | TenantCommunication |
| Foreign field | TenantCommunicationId |
| Relationship type | Foreign Key |
| Relationship name | fk TenantCommunication. to TenantCommunicationRole. |
| Cardinality | 0..n |
| Sample | TC-20561 |
| Comments |
2.6.2.15.3.2 Field RoleId
2.6.2.15.3.2.1 RoleId properties
| Property | Value |
| Name | RoleId |
| Technical name | |
| Activated | true |
| Id | |
| Type | string |
| Description | Unique identifier either coming from previous system otherwise it needs to be defined |
| Format | |
| Pattern | [^<>\[\]\{\}\|\\\/\(\)°"&=\+§\^~:;\$%!\?\0-\cZ]+$ |
| Min length | 1 |
| Max length | 50 |
| Default | |
| Enum | |
| Required | true |
| Primary key | true |
| Dependencies | |
| Foreign collection | Role |
| Foreign field | RoleId |
| Relationship type | Foreign Key |
| Relationship name | fk Role. to TenantCommunicationRole. |
| Cardinality | 0..n |
| Sample | R-01 |
| Comments |
2.6.2.15.4 TenantCommunicationRole JSON Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "TenantCommunicationRole",
"description": "Linking entity between TenantCommunication and Role",
"properties": {
"TenantCommunicationId": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
},
"RoleId": {
"type": "string",
"description": "Unique identifier either coming from previous system otherwise it needs to be defined",
"minLength": 1,
"maxLength": 50,
"pattern": "[^<>\\[\\]\\{\\}\\|\\\\\\/\\(\\)°\"&=\\+§\\^~:;\\$%!\\?\\0-\\cZ]+$"
}
},
"required": [
"TenantCommunicationId",
"RoleId"
]
}2.6.2.15.5 TenantCommunicationRole JSON data
{
"TenantCommunicationId": "TC-20561",
"RoleId": "R-01"
}3. Relationships
3.1 Relationship fk Account. to IndividualAccount.
3.1.1 fk Account. to IndividualAccount. Diagram
3.1.2 fk Account. to IndividualAccount. Properties
| Property | Value |
| Name | fk Account. to IndividualAccount. |
| Description | |
| Parent Document | Account |
| Parent field | AccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | AccountId |
| Child Cardinality | 0..n |
| Comments |
3.2 Relationship fk Address. to AddressBuilding.
3.2.1 fk Address. to AddressBuilding. Diagram
3.2.2 fk Address. to AddressBuilding. Properties
| Property | Value |
| Name | fk Address. to AddressBuilding. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.3 Relationship fk Address. to AddressContact.
3.3.1 fk Address. to AddressContact. Diagram
3.3.2 fk Address. to AddressContact. Properties
| Property | Value |
| Name | fk Address. to AddressContact. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.4 Relationship fk Address. to AddressLand.
3.4.1 fk Address. to AddressLand. Diagram
3.4.2 fk Address. to AddressLand. Properties
| Property | Value |
| Name | fk Address. to AddressLand. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.5 Relationship fk Address. to AddressOrganisation.
3.5.1 fk Address. to AddressOrganisation. Diagram
3.5.2 fk Address. to AddressOrganisation. Properties
| Property | Value |
| Name | fk Address. to AddressOrganisation. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.6 Relationship fk Address. to AddressRentalUnit.
3.6.1 fk Address. to AddressRentalUnit. Diagram
3.6.2 fk Address. to AddressRentalUnit. Properties
| Property | Value |
| Name | fk Address. to AddressRentalUnit. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.7 Relationship fk Address. to AddressSite.
3.7.1 fk Address. to AddressSite. Diagram
3.7.2 fk Address. to AddressSite. Properties
| Property | Value |
| Name | fk Address. to AddressSite. |
| Description | |
| Parent Document | Address |
| Parent field | AddressId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | AddressId |
| Child Cardinality | 0..n |
| Comments |
3.8 Relationship fk AreaMeasurement. to AreaMeasurementBuilding.
3.8.1 fk AreaMeasurement. to AreaMeasurementBuilding. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementBuilding | AreaMeasurementId |
3.8.2 fk AreaMeasurement. to AreaMeasurementBuilding. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementBuilding. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementBuilding |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.9 Relationship fk AreaMeasurement. to AreaMeasurementFloor.
3.9.1 fk AreaMeasurement. to AreaMeasurementFloor. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementFloor | AreaMeasurementId |
3.9.2 fk AreaMeasurement. to AreaMeasurementFloor. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementFloor. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementFloor |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.10 Relationship fk AreaMeasurement. to AreaMeasurementLand.
3.10.1 fk AreaMeasurement. to AreaMeasurementLand. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementLand | AreaMeasurementId |
3.10.2 fk AreaMeasurement. to AreaMeasurementLand. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementLand. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementLand |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.11 Relationship fk AreaMeasurement. to AreaMeasurementSite.
3.11.1 fk AreaMeasurement. to AreaMeasurementSite. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementSite | AreaMeasurementId |
3.11.2 fk AreaMeasurement. to AreaMeasurementSite. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementSite. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementSite |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.12 Relationship fk AreaMeasurement. to AreaMeasurementSpace.
3.12.1 fk AreaMeasurement. to AreaMeasurementSpace. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementSpace | AreaMeasurementId |
3.12.2 fk AreaMeasurement. to AreaMeasurementSpace. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementSpace. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementSpace |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.13 Relationship fk AreaMeasurement. to AreaMeasurementUnit.
3.13.1 fk AreaMeasurement. to AreaMeasurementUnit. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| AreaMeasurementUnit | AreaMeasurementId |
3.13.2 fk AreaMeasurement. to AreaMeasurementUnit. Properties
| Property | Value |
| Name | fk AreaMeasurement. to AreaMeasurementUnit. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementUnit |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.14 Relationship fk AreaMeasurement. to RentalUnitAreaMeasurement.
3.14.1 fk AreaMeasurement. to RentalUnitAreaMeasurement. Diagram
| Parent Table | Parent field |
| AreaMeasurement | AreaMeasurementId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | AreaMeasurementId |
3.14.2 fk AreaMeasurement. to RentalUnitAreaMeasurement. Properties
| Property | Value |
| Name | fk AreaMeasurement. to RentalUnitAreaMeasurement. |
| Description | |
| Parent Document | AreaMeasurement |
| Parent field | AreaMeasurementId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | AreaMeasurementId |
| Child Cardinality | 0..n |
| Comments |
3.15 Relationship fk Building. to AddressBuilding.
3.15.1 fk Building. to AddressBuilding. Diagram
3.15.2 fk Building. to AddressBuilding. Properties
| Property | Value |
| Name | fk Building. to AddressBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | AddressBuilding |
| Child field | BuildingId |
| Child Cardinality | 1 |
| Comments |
3.16 Relationship fk Building. to AreaMeasurementBuilding.
3.16.1 fk Building. to AreaMeasurementBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| AreaMeasurementBuilding | BuildingId |
3.16.2 fk Building. to AreaMeasurementBuilding. Properties
| Property | Value |
| Name | fk Building. to AreaMeasurementBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.17 Relationship fk Building. to CertificateBuilding.
3.17.1 fk Building. to CertificateBuilding. Diagram
3.17.2 fk Building. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Building. to CertificateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.18 Relationship fk Building. to ClimateBuilding.
3.18.1 fk Building. to ClimateBuilding. Diagram
3.18.2 fk Building. to ClimateBuilding. Properties
| Property | Value |
| Name | fk Building. to ClimateBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.19 Relationship fk Building. to ComponentBuilding.
3.19.1 fk Building. to ComponentBuilding. Diagram
3.19.2 fk Building. to ComponentBuilding. Properties
| Property | Value |
| Name | fk Building. to ComponentBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.20 Relationship fk Building. to CostCenterBuilding.
3.20.1 fk Building. to CostCenterBuilding. Diagram
3.20.2 fk Building. to CostCenterBuilding. Properties
| Property | Value |
| Name | fk Building. to CostCenterBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.21 Relationship fk Building. to EmissionFactorBuilding.
3.21.1 fk Building. to EmissionFactorBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| EmissionFactorBuilding | BuildingId |
3.21.2 fk Building. to EmissionFactorBuilding. Properties
| Property | Value |
| Name | fk Building. to EmissionFactorBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.22 Relationship fk Building. to Floor.
3.22.1 fk Building. to Floor. Diagram
3.22.2 fk Building. to Floor. Properties
| Property | Value |
| Name | fk Building. to Floor. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | Floor |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.23 Relationship fk Building. to GhgEmissionBuilding.
3.23.1 fk Building. to GhgEmissionBuilding. Diagram
3.23.2 fk Building. to GhgEmissionBuilding. Properties
| Property | Value |
| Name | fk Building. to GhgEmissionBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.24 Relationship fk Building. to IndividualAccountBuilding.
3.24.1 fk Building. to IndividualAccountBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| IndividualAccountBuilding | BuildingId |
3.24.2 fk Building. to IndividualAccountBuilding. Properties
| Property | Value |
| Name | fk Building. to IndividualAccountBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.25 Relationship fk Building. to OperationalMeasurementBuilding.
3.25.1 fk Building. to OperationalMeasurementBuilding. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| OperationalMeasurementBuilding | BuildingId |
3.25.2 fk Building. to OperationalMeasurementBuilding. Properties
| Property | Value |
| Name | fk Building. to OperationalMeasurementBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.26 Relationship fk Building. to PortfolioBuilding.
3.26.1 fk Building. to PortfolioBuilding. Diagram
3.26.2 fk Building. to PortfolioBuilding. Properties
| Property | Value |
| Name | fk Building. to PortfolioBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.27 Relationship fk Building. to RentalUnitBuilding.
3.27.1 fk Building. to RentalUnitBuilding. Diagram
3.27.2 fk Building. to RentalUnitBuilding. Properties
| Property | Value |
| Name | fk Building. to RentalUnitBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.28 Relationship fk Building. to RoleBuilding.
3.28.1 fk Building. to RoleBuilding. Diagram
3.28.2 fk Building. to RoleBuilding. Properties
| Property | Value |
| Name | fk Building. to RoleBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.29 Relationship fk Building. to SustainabilityIndicator.
3.29.1 fk Building. to SustainabilityIndicator. Diagram
| Parent Table | Parent field |
| Building | BuildingId |
| Child Table | Child field |
| SustainabilityIndicator | BuildingId |
3.29.2 fk Building. to SustainabilityIndicator. Properties
| Property | Value |
| Name | fk Building. to SustainabilityIndicator. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | SustainabilityIndicator |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.30 Relationship fk Building. to UnitBuilding.
3.30.1 fk Building. to UnitBuilding. Diagram
3.30.2 fk Building. to UnitBuilding. Properties
| Property | Value |
| Name | fk Building. to UnitBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | UnitBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.31 Relationship fk Building. to ValuationBuilding.
3.31.1 fk Building. to ValuationBuilding. Diagram
3.31.2 fk Building. to ValuationBuilding. Properties
| Property | Value |
| Name | fk Building. to ValuationBuilding. |
| Description | |
| Parent Document | Building |
| Parent field | BuildingId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | BuildingId |
| Child Cardinality | 0..n |
| Comments |
3.32 Relationship fk Certificate. to CertificateBuilding.
3.32.1 fk Certificate. to CertificateBuilding. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateBuilding | CertificateId |
3.32.2 fk Certificate. to CertificateBuilding. Properties
| Property | Value |
| Name | fk Certificate. to CertificateBuilding. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateBuilding |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.33 Relationship fk Certificate. to CertificateComponent.
3.33.1 fk Certificate. to CertificateComponent. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateComponent | CertificateId |
3.33.2 fk Certificate. to CertificateComponent. Properties
| Property | Value |
| Name | fk Certificate. to CertificateComponent. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.34 Relationship fk Certificate. to CertificateSystem.
3.34.1 fk Certificate. to CertificateSystem. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateSystem | CertificateId |
3.34.2 fk Certificate. to CertificateSystem. Properties
| Property | Value |
| Name | fk Certificate. to CertificateSystem. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.35 Relationship fk Certificate. to CertificateValuation.
3.35.1 fk Certificate. to CertificateValuation. Diagram
| Parent Table | Parent field |
| Certificate | CertificateId |
| Child Table | Child field |
| CertificateValuation | CertificateId |
3.35.2 fk Certificate. to CertificateValuation. Properties
| Property | Value |
| Name | fk Certificate. to CertificateValuation. |
| Description | |
| Parent Document | Certificate |
| Parent field | CertificateId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | CertificateId |
| Child Cardinality | 0..n |
| Comments |
3.36 Relationship fk Climate. to ClimateBuilding.
3.36.1 fk Climate. to ClimateBuilding. Diagram
3.36.2 fk Climate. to ClimateBuilding. Properties
| Property | Value |
| Name | fk Climate. to ClimateBuilding. |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateId |
| Parent Cardinality | 1 |
| Child Document | ClimateBuilding |
| Child field | ClimateId |
| Child Cardinality | 0..n |
| Comments |
3.37 Relationship fk Climate. to ClimateSite.
3.37.1 fk Climate. to ClimateSite. Diagram
3.37.2 fk Climate. to ClimateSite. Properties
| Property | Value |
| Name | fk Climate. to ClimateSite. |
| Description | |
| Parent Document | Climate |
| Parent field | ClimateId |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | ClimateId |
| Child Cardinality | 0..n |
| Comments |
3.38 Relationship fk Component. to CertificateComponent.
3.38.1 fk Component. to CertificateComponent. Diagram
| Parent Table | Parent field |
| Component | ComponentId |
| Child Table | Child field |
| CertificateComponent | ComponentId |
3.38.2 fk Component. to CertificateComponent. Properties
| Property | Value |
| Name | fk Component. to CertificateComponent. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | CertificateComponent |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.39 Relationship fk Component. to ComponentBuilding.
3.39.1 fk Component. to ComponentBuilding. Diagram
3.39.2 fk Component. to ComponentBuilding. Properties
| Property | Value |
| Name | fk Component. to ComponentBuilding. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentBuilding |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.40 Relationship fk Component. to ComponentFloor.
3.40.1 fk Component. to ComponentFloor. Diagram
3.40.2 fk Component. to ComponentFloor. Properties
| Property | Value |
| Name | fk Component. to ComponentFloor. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.41 Relationship fk Component. to ComponentSite.
3.41.1 fk Component. to ComponentSite. Diagram
3.41.2 fk Component. to ComponentSite. Properties
| Property | Value |
| Name | fk Component. to ComponentSite. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.42 Relationship fk Component. to ComponentSpace.
3.42.1 fk Component. to ComponentSpace. Diagram
3.42.2 fk Component. to ComponentSpace. Properties
| Property | Value |
| Name | fk Component. to ComponentSpace. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.43 Relationship fk Component. to ComponentSystem.
3.43.1 fk Component. to ComponentSystem. Diagram
3.43.2 fk Component. to ComponentSystem. Properties
| Property | Value |
| Name | fk Component. to ComponentSystem. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | ComponentId |
| Child Cardinality | 1..n |
| Comments |
3.44 Relationship fk Component. to ComponentUnit.
3.44.1 fk Component. to ComponentUnit. Diagram
3.44.2 fk Component. to ComponentUnit. Properties
| Property | Value |
| Name | fk Component. to ComponentUnit. |
| Description | |
| Parent Document | Component |
| Parent field | ComponentId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | ComponentId |
| Child Cardinality | 0..n |
| Comments |
3.45 Relationship fk Contact. to AddressContact.
3.45.1 fk Contact. to AddressContact. Diagram
3.45.2 fk Contact. to AddressContact. Properties
| Property | Value |
| Name | fk Contact. to AddressContact. |
| Description | |
| Parent Document | Contact |
| Parent field | ContactId |
| Parent Cardinality | 1 |
| Child Document | AddressContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
3.46 Relationship fk Contact. to RoleContact.
3.46.1 fk Contact. to RoleContact. Diagram
3.46.2 fk Contact. to RoleContact. Properties
| Property | Value |
| Name | fk Contact. to RoleContact. |
| Description | |
| Parent Document | Contact |
| Parent field | ContactId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | ContactId |
| Child Cardinality | 0..n |
| Comments |
3.47 Relationship fk CostCenter. to CostCenterBuilding.
3.47.1 fk CostCenter. to CostCenterBuilding. Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterBuilding | CostCenterId |
3.47.2 fk CostCenter. to CostCenterBuilding. Properties
| Property | Value |
| Name | fk CostCenter. to CostCenterBuilding. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterBuilding |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.48 Relationship fk CostCenter. to CostCenterPortfolio.
3.48.1 fk CostCenter. to CostCenterPortfolio. Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterPortfolio | CostCenterId |
3.48.2 fk CostCenter. to CostCenterPortfolio. Properties
| Property | Value |
| Name | fk CostCenter. to CostCenterPortfolio. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.49 Relationship fk CostCenter. to CostCenterRentalUnit.
3.49.1 fk CostCenter. to CostCenterRentalUnit. Diagram
| Parent Table | Parent field |
| CostCenter | CostCenterId |
| Child Table | Child field |
| CostCenterRentalUnit | CostCenterId |
3.49.2 fk CostCenter. to CostCenterRentalUnit. Properties
| Property | Value |
| Name | fk CostCenter. to CostCenterRentalUnit. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.50 Relationship fk CostCenter. to CostCenterSite.
3.50.1 fk CostCenter. to CostCenterSite. Diagram
3.50.2 fk CostCenter. to CostCenterSite. Properties
| Property | Value |
| Name | fk CostCenter. to CostCenterSite. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | CostCenterId |
| Child Cardinality | 0..n |
| Comments |
3.51 Relationship fk CostCenter. to Transaction.
3.51.1 fk CostCenter. to Transaction. Diagram
3.51.2 fk CostCenter. to Transaction. Properties
| Property | Value |
| Name | fk CostCenter. to Transaction. |
| Description | |
| Parent Document | CostCenter |
| Parent field | CostCenterId |
| Parent Cardinality | 1 |
| Child Document | Transaction |
| Child field | CostCenterId |
| Child Cardinality | 1..n |
| Comments |
3.52 Relationship fk EmissionFactor. to EmissionFactorBuilding.
3.52.1 fk EmissionFactor. to EmissionFactorBuilding. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| EmissionFactorBuilding | EmissionFactorId |
3.52.2 fk EmissionFactor. to EmissionFactorBuilding. Properties
| Property | Value |
| Name | fk EmissionFactor. to EmissionFactorBuilding. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorBuilding |
| Child field | EmissionFactorId |
| Child Cardinality | 0..1 |
| Comments |
3.53 Relationship fk EmissionFactor. to EmissionFactorOperationalMeasurement.
3.53.1 fk EmissionFactor. to EmissionFactorOperationalMeasurement. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| EmissionFactorOperationalMeasurement | EmissionFactorId |
3.53.2 fk EmissionFactor. to EmissionFactorOperationalMeasurement. Properties
| Property | Value |
| Name | fk EmissionFactor. to EmissionFactorOperationalMeasurement. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorOperationalMeasurement |
| Child field | EmissionFactorId |
| Child Cardinality | 0..n |
| Comments |
3.54 Relationship fk EmissionFactor. to EmissionFactorRole.
3.54.1 fk EmissionFactor. to EmissionFactorRole. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| EmissionFactorRole | EmissionFactorId |
3.54.2 fk EmissionFactor. to EmissionFactorRole. Properties
| Property | Value |
| Name | fk EmissionFactor. to EmissionFactorRole. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorRole |
| Child field | EmissionFactorId |
| Child Cardinality | 0..1 |
| Comments |
3.55 Relationship fk EmissionFactor. to EmissionFactorSite.
3.55.1 fk EmissionFactor. to EmissionFactorSite. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| EmissionFactorSite | EmissionFactorId |
3.55.2 fk EmissionFactor. to EmissionFactorSite. Properties
| Property | Value |
| Name | fk EmissionFactor. to EmissionFactorSite. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | EmissionFactorId |
| Child Cardinality | 0..1 |
| Comments |
3.56 Relationship fk EmissionFactor. to GhgEmissionEmissionFactor.
3.56.1 fk EmissionFactor. to GhgEmissionEmissionFactor. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| GhgEmissionEmissionFactor | EmissionFactorId |
3.56.2 fk EmissionFactor. to GhgEmissionEmissionFactor. Properties
| Property | Value |
| Name | fk EmissionFactor. to GhgEmissionEmissionFactor. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionEmissionFactor |
| Child field | EmissionFactorId |
| Child Cardinality | 0..n |
| Comments |
3.57 Relationship fk EmissionFactor. to SustainabilityIndicatorEmissionFactor.
3.57.1 fk EmissionFactor. to SustainabilityIndicatorEmissionFactor. Diagram
| Parent Table | Parent field |
| EmissionFactor | EmissionFactorId |
| Child Table | Child field |
| SustainabilityIndicatorEmissionFactor | EmissionFactorId |
3.57.2 fk EmissionFactor. to SustainabilityIndicatorEmissionFactor. Properties
| Property | Value |
| Name | fk EmissionFactor. to SustainabilityIndicatorEmissionFactor. |
| Description | |
| Parent Document | EmissionFactor |
| Parent field | EmissionFactorId |
| Parent Cardinality | 1 |
| Child Document | SustainabilityIndicatorEmissionFactor |
| Child field | EmissionFactorId |
| Child Cardinality | 0..n |
| Comments |
3.58 Relationship fk Floor. to AreaMeasurementFloor.
3.58.1 fk Floor. to AreaMeasurementFloor. Diagram
3.58.2 fk Floor. to AreaMeasurementFloor. Properties
| Property | Value |
| Name | fk Floor. to AreaMeasurementFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.59 Relationship fk Floor. to ComponentFloor.
3.59.1 fk Floor. to ComponentFloor. Diagram
3.59.2 fk Floor. to ComponentFloor. Properties
| Property | Value |
| Name | fk Floor. to ComponentFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | ComponentFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.60 Relationship fk Floor. to OperationalMeasurementFloor.
3.60.1 fk Floor. to OperationalMeasurementFloor. Diagram
3.60.2 fk Floor. to OperationalMeasurementFloor. Properties
| Property | Value |
| Name | fk Floor. to OperationalMeasurementFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.61 Relationship fk Floor. to RentalUnitFloor.
3.61.1 fk Floor. to RentalUnitFloor. Diagram
3.61.2 fk Floor. to RentalUnitFloor. Properties
| Property | Value |
| Name | fk Floor. to RentalUnitFloor. |
| Description | |
| Parent Document | Floor |
| Parent field | FloorId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | FloorId |
| Child Cardinality | 0..n |
| Comments |
3.62 Relationship fk Floor. to Space.
3.62.1 fk Floor. to Space. Diagram
3.63 Relationship fk Floor. to UnitFloor.
3.63.1 fk Floor. to UnitFloor. Diagram
3.64 Relationship fk GhgEmission. to GhgEmissionBuilding.
3.64.1 fk GhgEmission. to GhgEmissionBuilding. Diagram
| Parent Table | Parent field |
| GhgEmission | GhgEmissionId |
| Child Table | Child field |
| GhgEmissionBuilding | GhgEmissionId |
3.64.2 fk GhgEmission. to GhgEmissionBuilding. Properties
| Property | Value |
| Name | fk GhgEmission. to GhgEmissionBuilding. |
| Description | |
| Parent Document | GhgEmission |
| Parent field | GhgEmissionId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionBuilding |
| Child field | GhgEmissionId |
| Child Cardinality | 0..1 |
| Comments |
3.65 Relationship fk GhgEmission. to GhgEmissionEmissionFactor.
3.65.1 fk GhgEmission. to GhgEmissionEmissionFactor. Diagram
| Parent Table | Parent field |
| GhgEmission | GhgEmissionId |
| Child Table | Child field |
| GhgEmissionEmissionFactor | GhgEmissionId |
3.65.2 fk GhgEmission. to GhgEmissionEmissionFactor. Properties
| Property | Value |
| Name | fk GhgEmission. to GhgEmissionEmissionFactor. |
| Description | |
| Parent Document | GhgEmission |
| Parent field | GhgEmissionId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionEmissionFactor |
| Child field | GhgEmissionId |
| Child Cardinality | 0..1 |
| Comments |
3.66 Relationship fk GhgEmission. to GhgEmissionSite.
3.66.1 fk GhgEmission. to GhgEmissionSite. Diagram
| Parent Table | Parent field |
| GhgEmission | GhgEmissionId |
| Child Table | Child field |
| GhgEmissionSite | GhgEmissionId |
3.66.2 fk GhgEmission. to GhgEmissionSite. Properties
| Property | Value |
| Name | fk GhgEmission. to GhgEmissionSite. |
| Description | |
| Parent Document | GhgEmission |
| Parent field | GhgEmissionId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionSite |
| Child field | GhgEmissionId |
| Child Cardinality | 0..1 |
| Comments |
3.67 Relationship fk IndividualAccount. to IndividualAccountBuilding.
3.67.1 fk IndividualAccount. to IndividualAccountBuilding. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountBuilding | IndividualAccountId |
3.67.2 fk IndividualAccount. to IndividualAccountBuilding. Properties
| Property | Value |
| Name | fk IndividualAccount. to IndividualAccountBuilding. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountBuilding |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.68 Relationship fk IndividualAccount. to IndividualAccountPortfolio.
3.68.1 fk IndividualAccount. to IndividualAccountPortfolio. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountPortfolio | IndividualAccountId |
3.68.2 fk IndividualAccount. to IndividualAccountPortfolio. Properties
| Property | Value |
| Name | fk IndividualAccount. to IndividualAccountPortfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.69 Relationship fk IndividualAccount. to IndividualAccountSite.
3.69.1 fk IndividualAccount. to IndividualAccountSite. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| IndividualAccountSite | IndividualAccountId |
3.69.2 fk IndividualAccount. to IndividualAccountSite. Properties
| Property | Value |
| Name | fk IndividualAccount. to IndividualAccountSite. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.70 Relationship fk IndividualAccount. to Portfolio.
3.70.1 fk IndividualAccount. to Portfolio. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| Portfolio | IndividualAccountId |
3.70.2 fk IndividualAccount. to Portfolio. Properties
| Property | Value |
| Name | fk IndividualAccount. to Portfolio. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | Portfolio |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.71 Relationship fk IndividualAccount. to Transaction.
3.71.1 fk IndividualAccount. to Transaction. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| Transaction | IndividualAccountId |
3.71.2 fk IndividualAccount. to Transaction. Properties
| Property | Value |
| Name | fk IndividualAccount. to Transaction. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | Transaction |
| Child field | IndividualAccountId |
| Child Cardinality | 1..n |
| Comments |
3.72 Relationship fk IndividualAccount. to ValuationIndividualAccount.
3.72.1 fk IndividualAccount. to ValuationIndividualAccount. Diagram
| Parent Table | Parent field |
| IndividualAccount | IndividualAccountId |
| Child Table | Child field |
| ValuationIndividualAccount | IndividualAccountId |
3.72.2 fk IndividualAccount. to ValuationIndividualAccount. Properties
| Property | Value |
| Name | fk IndividualAccount. to ValuationIndividualAccount. |
| Description | |
| Parent Document | IndividualAccount |
| Parent field | IndividualAccountId |
| Parent Cardinality | 1 |
| Child Document | ValuationIndividualAccount |
| Child field | IndividualAccountId |
| Child Cardinality | 0..n |
| Comments |
3.73 Relationship fk Land. to AddressLand.
3.73.1 fk Land. to AddressLand. Diagram
3.73.2 fk Land. to AddressLand. Properties
| Property | Value |
| Name | fk Land. to AddressLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | AddressLand |
| Child field | LandId |
| Child Cardinality | 1 |
| Comments |
3.74 Relationship fk Land. to AreaMeasurementLand.
3.74.1 fk Land. to AreaMeasurementLand. Diagram
3.74.2 fk Land. to AreaMeasurementLand. Properties
| Property | Value |
| Name | fk Land. to AreaMeasurementLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.75 Relationship fk Land. to OperationalMeasurementLand.
3.75.1 fk Land. to OperationalMeasurementLand. Diagram
3.75.2 fk Land. to OperationalMeasurementLand. Properties
| Property | Value |
| Name | fk Land. to OperationalMeasurementLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.76 Relationship fk Land. to PortfolioLand.
3.76.1 fk Land. to PortfolioLand. Diagram
3.76.2 fk Land. to PortfolioLand. Properties
| Property | Value |
| Name | fk Land. to PortfolioLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.77 Relationship fk Land. to RentalUnitLand.
3.77.1 fk Land. to RentalUnitLand. Diagram
3.77.2 fk Land. to RentalUnitLand. Properties
| Property | Value |
| Name | fk Land. to RentalUnitLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.78 Relationship fk Land. to RoleLand.
3.78.1 fk Land. to RoleLand. Diagram
3.79 Relationship fk Land. to UnitLand.
3.79.1 fk Land. to UnitLand. Diagram
3.80 Relationship fk Land. to ValuationLand.
3.80.1 fk Land. to ValuationLand. Diagram
3.80.2 fk Land. to ValuationLand. Properties
| Property | Value |
| Name | fk Land. to ValuationLand. |
| Description | |
| Parent Document | Land |
| Parent field | LandId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | LandId |
| Child Cardinality | 0..n |
| Comments |
3.81 Relationship fk OperationalMeasurement. to EmissionFactorOperationalMeasurement.
3.81.1 fk OperationalMeasurement. to EmissionFactorOperationalMeasurement. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| EmissionFactorOperationalMeasurement | OperationalMeasurementId |
3.81.2 fk OperationalMeasurement. to EmissionFactorOperationalMeasurement. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to EmissionFactorOperationalMeasurement. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorOperationalMeasurement |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..n |
| Comments |
3.82 Relationship fk OperationalMeasurement. to GhgEmission.
3.82.1 fk OperationalMeasurement. to GhgEmission. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| GhgEmission | OperationalMeasurementId |
3.82.2 fk OperationalMeasurement. to GhgEmission. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to GhgEmission. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | GhgEmission |
| Child field | OperationalMeasurementId |
| Child Cardinality | 1..n |
| Comments |
3.83 Relationship fk OperationalMeasurement. to OperationalMeasurementBuilding.
3.83.1 fk OperationalMeasurement. to OperationalMeasurementBuilding. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementBuilding | OperationalMeasurementId |
3.83.2 fk OperationalMeasurement. to OperationalMeasurementBuilding. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementBuilding. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementBuilding |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.84 Relationship fk OperationalMeasurement. to OperationalMeasurementFloor.
3.84.1 fk OperationalMeasurement. to OperationalMeasurementFloor. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementFloor | OperationalMeasurementId |
3.84.2 fk OperationalMeasurement. to OperationalMeasurementFloor. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementFloor. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementFloor |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.85 Relationship fk OperationalMeasurement. to OperationalMeasurementLand.
3.85.1 fk OperationalMeasurement. to OperationalMeasurementLand. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementLand | OperationalMeasurementId |
3.85.2 fk OperationalMeasurement. to OperationalMeasurementLand. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementLand. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementLand |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.86 Relationship fk OperationalMeasurement. to OperationalMeasurementRole.
3.86.1 fk OperationalMeasurement. to OperationalMeasurementRole. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementRole | OperationalMeasurementId |
3.86.2 fk OperationalMeasurement. to OperationalMeasurementRole. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementRole. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementRole |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.87 Relationship fk OperationalMeasurement. to OperationalMeasurementSite.
3.87.1 fk OperationalMeasurement. to OperationalMeasurementSite. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementSite | OperationalMeasurementId |
3.87.2 fk OperationalMeasurement. to OperationalMeasurementSite. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementSite. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.88 Relationship fk OperationalMeasurement. to OperationalMeasurementSpace.
3.88.1 fk OperationalMeasurement. to OperationalMeasurementSpace. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementSpace | OperationalMeasurementId |
3.88.2 fk OperationalMeasurement. to OperationalMeasurementSpace. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementSpace. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.89 Relationship fk OperationalMeasurement. to OperationalMeasurementUnit.
3.89.1 fk OperationalMeasurement. to OperationalMeasurementUnit. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| OperationalMeasurementUnit | OperationalMeasurementId |
3.89.2 fk OperationalMeasurement. to OperationalMeasurementUnit. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to OperationalMeasurementUnit. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..1 |
| Comments |
3.90 Relationship fk OperationalMeasurement. to ValuationOperationalMeasurement.
3.90.1 fk OperationalMeasurement. to ValuationOperationalMeasurement. Diagram
| Parent Table | Parent field |
| OperationalMeasurement | OperationalMeasurementId |
| Child Table | Child field |
| ValuationOperationalMeasurement | OperationalMeasurementId |
3.90.2 fk OperationalMeasurement. to ValuationOperationalMeasurement. Properties
| Property | Value |
| Name | fk OperationalMeasurement. to ValuationOperationalMeasurement. |
| Description | |
| Parent Document | OperationalMeasurement |
| Parent field | OperationalMeasurementId |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | OperationalMeasurementId |
| Child Cardinality | 0..n |
| Comments |
3.91 Relationship fk Organisation. to AddressOrganisation.
3.91.1 fk Organisation. to AddressOrganisation. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| AddressOrganisation | OrganisationId |
3.91.2 fk Organisation. to AddressOrganisation. Properties
| Property | Value |
| Name | fk Organisation. to AddressOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | AddressOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.92 Relationship fk Organisation. to Contact.
3.92.1 fk Organisation. to Contact. Diagram
3.92.2 fk Organisation. to Contact. Properties
| Property | Value |
| Name | fk Organisation. to Contact. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | Contact |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.93 Relationship fk Organisation. to CostCenter.
3.93.1 fk Organisation. to CostCenter. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| CostCenter | OrganisationId |
3.93.2 fk Organisation. to CostCenter. Properties
| Property | Value |
| Name | fk Organisation. to CostCenter. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | CostCenter |
| Child field | OrganisationId |
| Child Cardinality | 1 |
| Comments |
3.94 Relationship fk Organisation. to IndividualAccount.
3.94.1 fk Organisation. to IndividualAccount. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| IndividualAccount | OrganisationId |
3.94.2 fk Organisation. to IndividualAccount. Properties
| Property | Value |
| Name | fk Organisation. to IndividualAccount. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccount |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.95 Relationship fk Organisation. to RoleOrganisation.
3.95.1 fk Organisation. to RoleOrganisation. Diagram
| Parent Table | Parent field |
| Organisation | OrganisationId |
| Child Table | Child field |
| RoleOrganisation | OrganisationId |
3.95.2 fk Organisation. to RoleOrganisation. Properties
| Property | Value |
| Name | fk Organisation. to RoleOrganisation. |
| Description | |
| Parent Document | Organisation |
| Parent field | OrganisationId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | OrganisationId |
| Child Cardinality | 0..n |
| Comments |
3.96 Relationship fk Portfolio. to CostCenterPortfolio.
3.96.1 fk Portfolio. to CostCenterPortfolio. Diagram
| Parent Table | Parent field |
| Portfolio | PortfolioId |
| Child Table | Child field |
| CostCenterPortfolio | PortfolioId |
3.96.2 fk Portfolio. to CostCenterPortfolio. Properties
| Property | Value |
| Name | fk Portfolio. to CostCenterPortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | CostCenterPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.97 Relationship fk Portfolio. to IndividualAccount.
3.97.1 fk Portfolio. to IndividualAccount. Diagram
| Parent Table | Parent field |
| Portfolio | PortfolioId |
| Child Table | Child field |
| IndividualAccountPortfolio | PortfolioId |
3.97.2 fk Portfolio. to IndividualAccount. Properties
| Property | Value |
| Name | fk Portfolio. to IndividualAccount. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountPortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.98 Relationship fk Portfolio. to PortfolioBuilding.
3.98.1 fk Portfolio. to PortfolioBuilding. Diagram
3.98.2 fk Portfolio. to PortfolioBuilding. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioBuilding. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioBuilding |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.99 Relationship fk Portfolio. to PortfolioLand.
3.99.1 fk Portfolio. to PortfolioLand. Diagram
3.99.2 fk Portfolio. to PortfolioLand. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioLand. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioLand |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.100 Relationship fk Portfolio. to PortfolioSite.
3.100.1 fk Portfolio. to PortfolioSite. Diagram
3.100.2 fk Portfolio. to PortfolioSite. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioSite. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.101 Relationship fk Portfolio. to PortfolioStrategy.
3.101.1 fk Portfolio. to PortfolioStrategy. Diagram
3.101.2 fk Portfolio. to PortfolioStrategy. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioStrategy |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.102 Relationship fk Portfolio. to PortfolioUnit.
3.102.1 fk Portfolio. to PortfolioUnit. Diagram
3.102.2 fk Portfolio. to PortfolioUnit. Properties
| Property | Value |
| Name | fk Portfolio. to PortfolioUnit. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.103 Relationship fk Portfolio. to RolePortfolio.
3.103.1 fk Portfolio. to RolePortfolio. Diagram
3.103.2 fk Portfolio. to RolePortfolio. Properties
| Property | Value |
| Name | fk Portfolio. to RolePortfolio. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | PortfolioId |
| Child Cardinality | 0..n |
| Comments |
3.104 Relationship fk Portfolio. to RolePortfolioStrategy.
3.104.1 fk Portfolio. to RolePortfolioStrategy. Diagram
| Parent Table | Parent field |
| Portfolio | PortfolioId |
| Child Table | Child field |
| RolePortfolioStrategy | PortfolioStrategyId |
3.104.2 fk Portfolio. to RolePortfolioStrategy. Properties
| Property | Value |
| Name | fk Portfolio. to RolePortfolioStrategy. |
| Description | |
| Parent Document | Portfolio |
| Parent field | PortfolioId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | PortfolioStrategyId |
| Child Cardinality | 0..n |
| Comments |
3.105 Relationship fk RentalContract. to RentalContractRentalUnit.
3.105.1 fk RentalContract. to RentalContractRentalUnit. Diagram
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalContractId |
3.105.2 fk RentalContract. to RentalContractRentalUnit. Properties
| Property | Value |
| Name | fk RentalContract. to RentalContractRentalUnit. |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
3.106 Relationship fk RentalContract. to RentalContractRole.
3.106.1 fk RentalContract. to RentalContractRole. Diagram
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalContractRole | RentalContractId |
3.106.2 fk RentalContract. to RentalContractRole. Properties
| Property | Value |
| Name | fk RentalContract. to RentalContractRole. |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
3.107 Relationship fk RentalContract. to RentalOption.
3.107.1 fk RentalContract. to RentalOption. Diagram
| Parent Table | Parent field |
| RentalContract | RentalContractId |
| Child Table | Child field |
| RentalOption | RentalContractId |
3.107.2 fk RentalContract. to RentalOption. Properties
| Property | Value |
| Name | fk RentalContract. to RentalOption. |
| Description | |
| Parent Document | RentalContract |
| Parent field | RentalContractId |
| Parent Cardinality | 1 |
| Child Document | RentalOption |
| Child field | RentalContractId |
| Child Cardinality | 0..n |
| Comments |
3.108 Relationship fk RentalContract. to RentalPayment.
3.108.1 fk RentalContract. to RentalPayment. Diagram
3.108.2 fk RentalContract. to RentalPayment. Properties
| Property | Value |
| Name | fk RentalContract. to RentalPayment. |
| Description | |
| Parent Document | RentalContract |
| Parent field | |
| Parent Cardinality | 1 |
| Child Document | RentalPayment |
| Child field | RentalContractId |
| Child Cardinality | 1..n |
| Comments |
3.109 Relationship fk RentalPayment. to Dunning.
3.109.1 fk RentalPayment. to Dunning. Diagram
| Parent Table | Parent field |
| RentalPayment | RentalPaymentId |
| Child Table | Child field |
| Dunning | RentalPaymentId |
3.109.2 fk RentalPayment. to Dunning. Properties
| Property | Value |
| Name | fk RentalPayment. to Dunning. |
| Description | |
| Parent Document | RentalPayment |
| Parent field | RentalPaymentId |
| Parent Cardinality | 1 |
| Child Document | Dunning |
| Child field | RentalPaymentId |
| Child Cardinality | 0..n |
| Comments |
3.110 Relationship fk RentalUnit. to AddressRentalUnit.
3.110.1 fk RentalUnit. to AddressRentalUnit. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| AddressRentalUnit | RentalUnitId |
3.110.2 fk RentalUnit. to AddressRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to AddressRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | AddressRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 1 |
| Comments |
3.111 Relationship fk RentalUnit. to CostCenterRentalUnit.
3.111.1 fk RentalUnit. to CostCenterRentalUnit. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| CostCenterRentalUnit | RentalUnitId |
3.111.2 fk RentalUnit. to CostCenterRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to CostCenterRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | CostCenterRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.112 Relationship fk RentalUnit. to RentalContractRentalUnit.
3.112.1 fk RentalUnit. to RentalContractRentalUnit. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalContractRentalUnit | RentalUnitId |
3.112.2 fk RentalUnit. to RentalContractRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalContractRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 1..n |
| Comments |
3.113 Relationship fk RentalUnit. to RentalUnitAreaMeasurement.
3.113.1 fk RentalUnit. to RentalUnitAreaMeasurement. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitAreaMeasurement | RentalUnitId |
3.113.2 fk RentalUnit. to RentalUnitAreaMeasurement. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitAreaMeasurement. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitAreaMeasurement |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.114 Relationship fk RentalUnit. to RentalUnitBuilding.
3.114.1 fk RentalUnit. to RentalUnitBuilding. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| RentalUnitBuilding | RentalUnitId |
3.114.2 fk RentalUnit. to RentalUnitBuilding. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitBuilding. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitBuilding |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.115 Relationship fk RentalUnit. to RentalUnitFloor.
3.115.1 fk RentalUnit. to RentalUnitFloor. Diagram
3.115.2 fk RentalUnit. to RentalUnitFloor. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitFloor. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitFloor |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.116 Relationship fk RentalUnit. to RentalUnitLand.
3.116.1 fk RentalUnit. to RentalUnitLand. Diagram
3.116.2 fk RentalUnit. to RentalUnitLand. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitLand. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitLand |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.117 Relationship fk RentalUnit. to RentalUnitSpace.
3.117.1 fk RentalUnit. to RentalUnitSpace. Diagram
3.117.2 fk RentalUnit. to RentalUnitSpace. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitSpace. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.118 Relationship fk RentalUnit. to RentalUnitUnit.
3.118.1 fk RentalUnit. to RentalUnitUnit. Diagram
3.118.2 fk RentalUnit. to RentalUnitUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to RentalUnitUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.119 Relationship fk RentalUnit. to RoleRentalUnit.
3.119.1 fk RentalUnit. to RoleRentalUnit. Diagram
3.119.2 fk RentalUnit. to RoleRentalUnit. Properties
| Property | Value |
| Name | fk RentalUnit. to RoleRentalUnit. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.120 Relationship fk RentalUnit. to TenantCommunication.
3.120.1 fk RentalUnit. to TenantCommunication. Diagram
| Parent Table | Parent field |
| RentalUnit | RentalUnitId |
| Child Table | Child field |
| TenantCommunication | RentalUnitId |
3.120.2 fk RentalUnit. to TenantCommunication. Properties
| Property | Value |
| Name | fk RentalUnit. to TenantCommunication. |
| Description | |
| Parent Document | RentalUnit |
| Parent field | RentalUnitId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunication |
| Child field | RentalUnitId |
| Child Cardinality | 0..n |
| Comments |
3.121 Relationship fk Role. to EmissionFactorRole.
3.121.1 fk Role. to EmissionFactorRole. Diagram
3.121.2 fk Role. to EmissionFactorRole. Properties
| Property | Value |
| Name | fk Role. to EmissionFactorRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorRole |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
3.122 Relationship fk Role. to OperationalMeasurementRole.
3.122.1 fk Role. to OperationalMeasurementRole. Diagram
3.122.2 fk Role. to OperationalMeasurementRole. Properties
| Property | Value |
| Name | fk Role. to OperationalMeasurementRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementRole |
| Child field | RoleId |
| Child Cardinality | 0..1 |
| Comments |
3.123 Relationship fk Role. to RentalContractRole.
3.123.1 fk Role. to RentalContractRole. Diagram
3.123.2 fk Role. to RentalContractRole. Properties
| Property | Value |
| Name | fk Role. to RentalContractRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RentalContractRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.124 Relationship fk Role. to RoleBuilding.
3.124.1 fk Role. to RoleBuilding. Diagram
3.124.2 fk Role. to RoleBuilding. Properties
| Property | Value |
| Name | fk Role. to RoleBuilding. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleBuilding |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.125 Relationship fk Role. to RoleContact.
3.125.1 fk Role. to RoleContact. Diagram
3.125.2 fk Role. to RoleContact. Properties
| Property | Value |
| Name | fk Role. to RoleContact. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleContact |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.126 Relationship fk Role. to RoleLand.
3.126.1 fk Role. to RoleLand. Diagram
3.127 Relationship fk Role. to RoleOrganisation.
3.127.1 fk Role. to RoleOrganisation. Diagram
3.127.2 fk Role. to RoleOrganisation. Properties
| Property | Value |
| Name | fk Role. to RoleOrganisation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleOrganisation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.128 Relationship fk Role. to RolePortfolio.
3.128.1 fk Role. to RolePortfolio. Diagram
3.128.2 fk Role. to RolePortfolio. Properties
| Property | Value |
| Name | fk Role. to RolePortfolio. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolio |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.129 Relationship fk Role. to RolePortfolioStrategy.
3.129.1 fk Role. to RolePortfolioStrategy. Diagram
3.129.2 fk Role. to RolePortfolioStrategy. Properties
| Property | Value |
| Name | fk Role. to RolePortfolioStrategy. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RolePortfolioStrategy |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.130 Relationship fk Role. to RoleRentalUnit.
3.130.1 fk Role. to RoleRentalUnit. Diagram
3.130.2 fk Role. to RoleRentalUnit. Properties
| Property | Value |
| Name | fk Role. to RoleRentalUnit. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleRentalUnit |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.131 Relationship fk Role. to RoleSite.
3.131.1 fk Role. to RoleSite. Diagram
3.132 Relationship fk Role. to RoleValuation.
3.132.1 fk Role. to RoleValuation. Diagram
3.132.2 fk Role. to RoleValuation. Properties
| Property | Value |
| Name | fk Role. to RoleValuation. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.133 Relationship fk Role. to TenantCommunicationRole.
3.133.1 fk Role. to TenantCommunicationRole. Diagram
3.133.2 fk Role. to TenantCommunicationRole. Properties
| Property | Value |
| Name | fk Role. to TenantCommunicationRole. |
| Description | |
| Parent Document | Role |
| Parent field | RoleId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | RoleId |
| Child Cardinality | 0..n |
| Comments |
3.134 Relationship fk Servitudes. to Land.
3.134.1 fk Servitudes. to Land. Diagram
3.134.2 fk Servitudes. to Land. Properties
| Property | Value |
| Name | fk Servitudes. to Land. |
| Description | |
| Parent Document | Servitudes |
| Parent field | ServitudeId |
| Parent Cardinality | 1 |
| Child Document | Land |
| Child field | ServitudeId |
| Child Cardinality | 0..1 |
| Comments |
3.135 Relationship fk Site. to AddressSite.
3.135.1 fk Site. to AddressSite. Diagram
3.135.2 fk Site. to AddressSite. Properties
| Property | Value |
| Name | fk Site. to AddressSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | AddressSite |
| Child field | SiteId |
| Child Cardinality | 1 |
| Comments |
3.136 Relationship fk Site. to AreaMeasurementSite.
3.136.1 fk Site. to AreaMeasurementSite. Diagram
3.136.2 fk Site. to AreaMeasurementSite. Properties
| Property | Value |
| Name | fk Site. to AreaMeasurementSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.137 Relationship fk Site. to Building.
3.137.1 fk Site. to Building. Diagram
3.138 Relationship fk Site. to ClimateSite.
3.138.1 fk Site. to ClimateSite. Diagram
3.138.2 fk Site. to ClimateSite. Properties
| Property | Value |
| Name | fk Site. to ClimateSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ClimateSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.139 Relationship fk Site. to ComponentSite.
3.139.1 fk Site. to ComponentSite. Diagram
3.139.2 fk Site. to ComponentSite. Properties
| Property | Value |
| Name | fk Site. to ComponentSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | ComponentSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.140 Relationship fk Site. to CostCenterSite.
3.140.1 fk Site. to CostCenterSite. Diagram
3.140.2 fk Site. to CostCenterSite. Properties
| Property | Value |
| Name | fk Site. to CostCenterSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | CostCenterSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.141 Relationship fk Site. to EmissionFactorSite.
3.141.1 fk Site. to EmissionFactorSite. Diagram
3.141.2 fk Site. to EmissionFactorSite. Properties
| Property | Value |
| Name | fk Site. to EmissionFactorSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | EmissionFactorSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.142 Relationship fk Site. to GhgEmissionSite.
3.142.1 fk Site. to GhgEmissionSite. Diagram
3.142.2 fk Site. to GhgEmissionSite. Properties
| Property | Value |
| Name | fk Site. to GhgEmissionSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | GhgEmissionSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.143 Relationship fk Site. to IndividualAccountSite.
3.143.1 fk Site. to IndividualAccountSite. Diagram
3.143.2 fk Site. to IndividualAccountSite. Properties
| Property | Value |
| Name | fk Site. to IndividualAccountSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | IndividualAccountSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.144 Relationship fk Site. to Land.
3.144.1 fk Site. to Land. Diagram
3.145 Relationship fk Site. to OperationalMeasurementSite.
3.145.1 fk Site. to OperationalMeasurementSite. Diagram
3.145.2 fk Site. to OperationalMeasurementSite. Properties
| Property | Value |
| Name | fk Site. to OperationalMeasurementSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.146 Relationship fk Site. to PortfolioSite.
3.146.1 fk Site. to PortfolioSite. Diagram
3.146.2 fk Site. to PortfolioSite. Properties
| Property | Value |
| Name | fk Site. to PortfolioSite. |
| Description | |
| Parent Document | Site |
| Parent field | SiteId |
| Parent Cardinality | 1 |
| Child Document | PortfolioSite |
| Child field | SiteId |
| Child Cardinality | 0..n |
| Comments |
3.147 Relationship fk Site. to RoleSite.
3.147.1 fk Site. to RoleSite. Diagram
3.148 Relationship fk Site. to UnitSite.
3.148.1 fk Site. to UnitSite. Diagram
3.149 Relationship fk Space. to AreaMeasurementSpace.
3.149.1 fk Space. to AreaMeasurementSpace. Diagram
3.149.2 fk Space. to AreaMeasurementSpace. Properties
| Property | Value |
| Name | fk Space. to AreaMeasurementSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.150 Relationship fk Space. to ComponentSpace.
3.150.1 fk Space. to ComponentSpace. Diagram
3.150.2 fk Space. to ComponentSpace. Properties
| Property | Value |
| Name | fk Space. to ComponentSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | ComponentSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.151 Relationship fk Space. to OperationalMeasurementSpace.
3.151.1 fk Space. to OperationalMeasurementSpace. Diagram
3.151.2 fk Space. to OperationalMeasurementSpace. Properties
| Property | Value |
| Name | fk Space. to OperationalMeasurementSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.152 Relationship fk Space. to RentalUnitSpace.
3.152.1 fk Space. to RentalUnitSpace. Diagram
3.152.2 fk Space. to RentalUnitSpace. Properties
| Property | Value |
| Name | fk Space. to RentalUnitSpace. |
| Description | |
| Parent Document | Space |
| Parent field | SpaceId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitSpace |
| Child field | SpaceId |
| Child Cardinality | 0..n |
| Comments |
3.153 Relationship fk Space. to UnitSpace.
3.153.1 fk Space. to UnitSpace. Diagram
3.154 Relationship fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor.
3.154.1 fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor. Diagram
| Parent Table | Parent field |
| SustainabilityIndicator | SustainabilityIndicatorId |
| Child Table | Child field |
| SustainabilityIndicatorEmissionFactor | SustainabilityIndicatorId |
3.154.2 fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor. Properties
| Property | Value |
| Name | fk SustainabilityIndicator. to SustainabilityIndicatorEmissionFactor. |
| Description | |
| Parent Document | SustainabilityIndicator |
| Parent field | SustainabilityIndicatorId |
| Parent Cardinality | 1 |
| Child Document | SustainabilityIndicatorEmissionFactor |
| Child field | SustainabilityIndicatorId |
| Child Cardinality | 0..1 |
| Comments |
3.155 Relationship fk System. to CertificateSystem.
3.155.1 fk System. to CertificateSystem. Diagram
3.155.2 fk System. to CertificateSystem. Properties
| Property | Value |
| Name | fk System. to CertificateSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | CertificateSystem |
| Child field | SystemId |
| Child Cardinality | 0..n |
| Comments |
3.156 Relationship fk System. to ComponentSystem.
3.156.1 fk System. to ComponentSystem. Diagram
3.156.2 fk System. to ComponentSystem. Properties
| Property | Value |
| Name | fk System. to ComponentSystem. |
| Description | |
| Parent Document | System |
| Parent field | SystemId |
| Parent Cardinality | 1 |
| Child Document | ComponentSystem |
| Child field | SystemId |
| Child Cardinality | 1..n |
| Comments |
3.157 Relationship fk TenantCommunication. to TenantCommunicationRole.
3.157.1 fk TenantCommunication. to TenantCommunicationRole. Diagram
| Parent Table | Parent field |
| TenantCommunication | TenantCommunicationId |
| Child Table | Child field |
| TenantCommunicationRole | TenantCommunicationId |
3.157.2 fk TenantCommunication. to TenantCommunicationRole. Properties
| Property | Value |
| Name | fk TenantCommunication. to TenantCommunicationRole. |
| Description | |
| Parent Document | TenantCommunication |
| Parent field | TenantCommunicationId |
| Parent Cardinality | 1 |
| Child Document | TenantCommunicationRole |
| Child field | TenantCommunicationId |
| Child Cardinality | 0..n |
| Comments |
3.158 Relationship fk Type. to Component.
3.158.1 fk Type. to Component. Diagram
| Parent Table | Parent field |
| ComponentType | ComponentTypeId |
| Child Table | Child field |
| Component | ComponentTypeId |
3.158.2 fk Type. to Component. Properties
| Property | Value |
| Name | fk Type. to Component. |
| Description | |
| Parent Document | ComponentType |
| Parent field | ComponentTypeId |
| Parent Cardinality | 1 |
| Child Document | Component |
| Child field | ComponentTypeId |
| Child Cardinality | 1..n |
| Comments |
3.159 Relationship fk Unit. to AreaMeasurementUnit.
3.159.1 fk Unit. to AreaMeasurementUnit. Diagram
3.159.2 fk Unit. to AreaMeasurementUnit. Properties
| Property | Value |
| Name | fk Unit. to AreaMeasurementUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | AreaMeasurementUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.160 Relationship fk Unit. to ComponentUnit.
3.160.1 fk Unit. to ComponentUnit. Diagram
3.160.2 fk Unit. to ComponentUnit. Properties
| Property | Value |
| Name | fk Unit. to ComponentUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | ComponentUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.161 Relationship fk Unit. to OperationalMeasurementUnit.
3.161.1 fk Unit. to OperationalMeasurementUnit. Diagram
3.161.2 fk Unit. to OperationalMeasurementUnit. Properties
| Property | Value |
| Name | fk Unit. to OperationalMeasurementUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | OperationalMeasurementUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.162 Relationship fk Unit. to PortfolioUnit.
3.162.1 fk Unit. to PortfolioUnit. Diagram
3.162.2 fk Unit. to PortfolioUnit. Properties
| Property | Value |
| Name | fk Unit. to PortfolioUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | PortfolioUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.163 Relationship fk Unit. to RentalUnitUnit.
3.163.1 fk Unit. to RentalUnitUnit. Diagram
3.163.2 fk Unit. to RentalUnitUnit. Properties
| Property | Value |
| Name | fk Unit. to RentalUnitUnit. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | RentalUnitUnit |
| Child field | UnitId |
| Child Cardinality | 0..n |
| Comments |
3.164 Relationship fk Unit. to UnitBuilding.
3.164.1 fk Unit. to UnitBuilding. Diagram
3.164.2 fk Unit. to UnitBuilding. Properties
| Property | Value |
| Name | fk Unit. to UnitBuilding. |
| Description | |
| Parent Document | Unit |
| Parent field | UnitId |
| Parent Cardinality | 1 |
| Child Document | UnitBuilding |
| Child field | UnitId |
| Child Cardinality | 0..1 |
| Comments |
3.165 Relationship fk Unit. to UnitFloor.
3.165.1 fk Unit. to UnitFloor. Diagram
3.166 Relationship fk Unit. to UnitLand.
3.166.1 fk Unit. to UnitLand. Diagram
3.167 Relationship fk Unit. to UnitSite.
3.167.1 fk Unit. to UnitSite. Diagram
3.168 Relationship fk Unit. to UnitSpace.
3.168.1 fk Unit. to UnitSpace. Diagram
3.169 Relationship fk Valuation. to CertificateValuation.
3.169.1 fk Valuation. to CertificateValuation. Diagram
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| CertificateValuation | ValuationId |
3.169.2 fk Valuation. to CertificateValuation. Properties
| Property | Value |
| Name | fk Valuation. to CertificateValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | CertificateValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.170 Relationship fk Valuation. to RoleValuation.
3.170.1 fk Valuation. to RoleValuation. Diagram
3.170.2 fk Valuation. to RoleValuation. Properties
| Property | Value |
| Name | fk Valuation. to RoleValuation. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | RoleValuation |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.171 Relationship fk Valuation. to ValuationBuilding.
3.171.1 fk Valuation. to ValuationBuilding. Diagram
3.171.2 fk Valuation. to ValuationBuilding. Properties
| Property | Value |
| Name | fk Valuation. to ValuationBuilding. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationBuilding |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.172 Relationship fk Valuation. to ValuationIndividualAccount.
3.172.1 fk Valuation. to ValuationIndividualAccount. Diagram
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| ValuationIndividualAccount | ValuationId |
3.172.2 fk Valuation. to ValuationIndividualAccount. Properties
| Property | Value |
| Name | fk Valuation. to ValuationIndividualAccount. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationIndividualAccount |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.173 Relationship fk Valuation. to ValuationLand.
3.173.1 fk Valuation. to ValuationLand. Diagram
3.173.2 fk Valuation. to ValuationLand. Properties
| Property | Value |
| Name | fk Valuation. to ValuationLand. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationLand |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |
3.174 Relationship fk Valuation. to ValuationOperationalMeasurement.
3.174.1 fk Valuation. to ValuationOperationalMeasurement. Diagram
| Parent Table | Parent field |
| Valuation | ValuationId |
| Child Table | Child field |
| ValuationOperationalMeasurement | ValuationId |
3.174.2 fk Valuation. to ValuationOperationalMeasurement. Properties
| Property | Value |
| Name | fk Valuation. to ValuationOperationalMeasurement. |
| Description | |
| Parent Document | Valuation |
| Parent field | ValuationId |
| Parent Cardinality | 1 |
| Child Document | ValuationOperationalMeasurement |
| Child field | ValuationId |
| Child Cardinality | 0..n |
| Comments |