Skip to content

Commit

Permalink
updated $schema last version
Browse files Browse the repository at this point in the history
  • Loading branch information
@albertoabellagarcia
albertoabellagarcia committed Sep 16, 2024
1 parent a379e53 commit a5c5c95
Showing 1 changed file with 141 additions and 189 deletions.
330 changes: 141 additions & 189 deletions KeyPerformanceIndicator/schema.json
View file
Original file line number Diff line number Diff line change
@@ -1,193 +1,145 @@
{
"$schema": "http://json-schema.org/schema#",
"$schemaVersion": "0.2.1",
"modelTags": "",
"$id": "https://smart-data-models.github.io/dataModel.KeyPerformanceIndicator/keyPerformanceIndicator/schema.json",
"title": "Key Performance Indicator",
"description": "A Key Performance Indicator (KPI) is a type of performance measurement. KPIs evaluate the success of an organization or of a particular activity in which it engages.",
"type": "object",
"allOf": [
{
"$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
},
{
"$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"KeyPerformanceIndicator"
],
"description": "Property. It must be KeyPerformanceIndicator. Enum:'KeyPerformanceIndicator'"
},
"category": {
"type": "array",
"description": "Property. Indicator category. Allowed values: (quantitative, qualitative, leading, lagging, input, process, output, practical, directional, actionable, financial). Check Wikipedia for a description of each category listed above. - Any other value meaningful to the application and not covered by the above list",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"actionable",
"directional",
"financial",
"input",
"lagging",
"leading",
"output",
"practical",
"process",
"qualitative",
"quantitative"
]
}
},
"organization": {
"type": "string",
"description": "Property. Subject organization evaluated by the KPI. Model:' https://schema.org/organization'"
},
"process": {
"type": "string",
"description": "Property. Either process or product must be defined"
},
"product": {
"type": "string",
"description": "Property. Either process or product must be defined"
},
"provider": {
"type": "string",
"description": "Property. Model:'https://schema.org/provider'. Provider of the product or service, if any, that this KPI evaluates"
},
"businessTarget": {
"type": "string",
"description": "Property. For informative purposes, the business target to which this KPI is related to"
},
"calculationFrequency": {
"type": "string",
"description": "Property. How often the KPI is calculated. Allowed values: one Of (hourly, daily, weekly, monthly, yearly, quarterly, bimonthly, biweekly). Or any other value meaningful for the application and not covered by the above list",
"enum": [
"hourly",
"daily",
"weekly",
"monthly",
"yearly",
"quarterly",
"bimonthly",
"biweekly"
]
},
"calculatedBy": {
"type": "string",
"description": "Property. The organization in charge of calculating the KPI"
},
"calculationMethod": {
"type": "string",
"description": "Property. The calculation method used",
"enum": [
"manual",
"automatic",
"semiautomatic"
]
},
"calculationFormula": {
"type": "string",
"description": "Property. For informative purposes, the formula used for calculating the indicator"
},
"aggregatedData": {
"type": "array",
"description": "Property. Entity(ies) and attribute(s) aggregated by the KPI",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"entityType": {
"type": "string"
},
"attrs": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1
}
}
}
},
"calculationPeriod": {
"type": "object",
"description": "Property. KPI's period of time",
"properties": {
"from": {
"type": "string",
"format": "date"
},
"to": {
"type": "string",
"format": "date"
}
}
},
"currentStanding": {
"type": "string",
"description": "Property. The KPI's current standing as per its kpiValue. Allowed values: one Of (very good, good, fair, bad, very bad)",
"enum": [
"veryGood",
"good",
"fair",
"bad",
"veryBad"
]
},
"kpiValue": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"description": "Property. Value of the KPI. It can be of any type"
},
"effectiveSince": {
"type": "string",
"format": "date-time",
"description": "Property. The date on which the organization created this KPI. This date might be different than the entity creation date"
},
"dateNextCalculation": {
"type": "string",
"format": "date",
"description": "Property. Date on which a new calculation of the KPI should be available"
},
"dateExpires": {
"type": "string",
"format": "date-time",
"description": "Property. The date on which the KPI will be no longer necessary or meaningful"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Property. Last update date of the KPI data. This can be different than the last update date of the KPI's value"
},
"area": {
"type": "string",
"description": "Property. For organizational purposes, it allows to add extra textual geographical information such as district, borough, or any other hint which can help to identify the KPI coverage"
}
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$schemaVersion": "0.3.4",
"modelTags": "IUDX",
"$id": "https://smart-data-models.github.io/dataModel.Weather/WeatherObserved/schema.json",
"title": "Weather Observed schema - Smart Data Models",
"description": "An observation of weather conditions at a certain place and time. This data model has been developed in cooperation with mobile operators and the GSMA.",
"type": "object",
"allOf": [
{
"$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/GSMA-Commons"
},
{
"$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/Location-Commons"
},
{
"$ref": "https://smart-data-models.github.io/dataModel.Weather/weather-schema.json#/definitions/Weather-Commons"
},
{
"properties": {
"type": {
"type": "string",
"enum": [
"WeatherObserved"
],
"description": "Property. NGSI Entity type. It has to be WeatherObserved"
},
"dateObserved": {
"$ref": "https://smart-data-models.github.io/data-models/common-schema.json#/definitions/dateObserved"
},
"precipitation": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. Amount of water rain registered. Units:'Liters per square meter'. "
},
"solarRadiation": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. The solar radiation observed measured in Watts per square. Units:'w/m2'"
},
"directIrradiation": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. Direct irradiance is the part of the solar irradiance that directly reaches a surface. Units:'w/m2'"
},
"diffuseIrradiation": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. Diffuse irradiance is the part of the solar irradiance that is scattered by the atmosphere. Units:'w/m2'"
},
"pressureTendency": {
"oneOf": [
{
"type": "string",
"enum": [
"falling",
"raising",
"steady"
]
},
{
"type": "number"
}
],
"description": "Property. Enum:'falling, raising, steady'. Is the pressure rising or falling? It can be expressed in quantitative terms or qualitative terms"
},
"dewPoint": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Units:'Celsius degrees'. The dew point encoded as a number. Observed temperature to which air must be cooled to become saturated with water vapor"
},
"refDevice": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^[\\w\\-\\.\\{\\}\\$\\+\\*\\[\\]`|~^@!,:\\\\]+$",
"description": "Property. Identifier format of any NGSI entity"
},
{
"type": "string",
"format": "uri",
"description": "Property. Identifier format of any NGSI entity"
}
],
"description": "Relationship. Model:'https://schema.org/URL'. A reference to the device(s) which captured this observation"
},
"streamGauge": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. The water level surface elevation observed by Hydrometric measurement sensors, namely a [Stream Gauge](https://en.wikipedia.org/wiki/Stream_gauge) expressed in centimeters. Units:'centimeters'"
},
"snowHeight": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. The snow height observed by generic snow depth measurement sensors, expressed in centimeters. Units:'centimeters'"
},
"uVIndexMax": {
"type": "number",
"minimum": 0,
"description": "Property. Model:'https://schema.org/Number'. The maximum UV index for the period, based on the World Health Organization's UV Index measure. [http://www.who.int/uv/intersunprogramme/activities/uv_index/en/](http://www.who.int/uv/intersunprogramme/activities/uv_index/en/) the values between 1 and 11 are the valid range for the index. The value 0 is for describing that no signal is detected so no value is stored"
},
"aqiMajorPollutant": {
"type": "string",
"description": "Property. Model:'https://schema.org/Text'. Major pollutant in the Air Quality Index (AQI)"
},
"aqiMajorPollutantForecast": {
"type": "string",
"description": "Property. Model:'https://schema.org/Text'. Forecasted major air pollutant in the Air Quality Index (AQI) over a certain duration in future"
},
"airTemperatureForecast": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Forecasted value of air temperature over a certain duration in future"
},
"precipitationForecast": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Forecasted rainfall over a certain duration in future"
},
"airQualityIndex": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Air quality index is a number used to report the quality of the air on any given day"
},
"relativeHumidityForecast": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Forecasted relative humidity (water vapour in air) over a certain duration in future"
},
"airQualityIndexForecast": {
"type": "number",
"description": "Property. Model:'https://schema.org/Number'. Forecasted overall Air Quality Index (AQI) over a certain duration in future"
},
"airTemperatureTSA": {
"type": "object",
"description": "Property. Air temperature time series aggregation",
"$ref": "https://smart-data-models.github.io/dataModel.Environment/Environment-schema.json#/definitions/TimeSeriesAggregation"
}
],
"required": [
"id",
"type"
]
}
}
],
"required": [
"id",
"type",
"dateObserved",
"location"
]
}

0 comments on commit a5c5c95

Please sign in to comment.