schema/kpi_definition-v1.0.schema.json at main · E-RIHS/schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "https://e-rihs.io/schema/kpi_definition-v1.0.schema.json",
    "$code": "2299",
    "title": "KPI Definition",
    "type": "object",
    "required": ["id", "title", "scope", "target_metrics"],
    "properties": {
        "$schema": {
            "type": "string",
            "options": {
                "hidden": true
            }
        },
        "id": {
            "type": "string",
            "cordra": {
                "type": {
                    "autoGeneratedField": "handle"
                }
            }
        },
        "title": {
            "title": "Title",
            "type": "string",
            "minLength": 2,
            "cordra": {
                "preview": {
                    "showInPreview": true,
                    "isPrimary": true
                }
            }
        },
        "scope": {
            "title": "Scope of the KPI",
            "type": "array",
            "minItems": 1,
            "description": "The subject that is being assessed by the KPI.",
            "items": {
                "type": "string",
                "minLenght": 2,
                "enum": [
                    "actor",
                    "dataset",
                    "method",
                    "platform",
                    "project",
                    "repository",
                    "service",
                    "tool",
                    "website"
                ]
            }
        },
        "description": {
            "title": "Description",
            "type": "string",
            "format": "textarea",
            "minLength": 2,
            "description": "A brief description of the purpose of the KPI and the sources of information it is based on. Details of specific calculations will be recorded within the 'formula' field.",
            "cordra": {
                "preview": {
                    "showInPreview": true
                }
            }
        },
        "target_metrics": {
            "title": "Target metrics",
            "type": "array",
            "minItems": 1,
            "description": "Target metrics for the KPI (that will be used for evaluation).",
            "items": {
                "type": "object",
                "required": ["key", "value", "metric_check"],
                "properties": {
                    "key": {
                        "title": "Key",
                        "type": "string",
                        "minLength": 2,
                        "description": "The key of the target metric"
                    },
                    "value": {
                        "title": "Value",
                        "type": ["number", "string", "boolean"],
                        "description": "The value of the target metric"
                    },
                    "unit": {
                        "title": "Unit",
                        "type": "string",
                        "description": "The unit of the target metric"
                    },
                    "metric_check": {
                        "title": "Metric check",
                        "type": "string",
                        "description": "The metric check to be used for evaluation",
                        "enum": [
                            "Exists",
                            "Is equal",
                            "Is not equal",
                            "Is greater than",
                            "Is greater than or equal",
                            "Is less than",
                            "Is less than or equal",
                            "Is true",
                            "Is false"
                        ]
                    }
                }
            }
        },
        "access_level": {
            "title": "Access level",
            "type": "string",
            "description": "The level of access on which the KPI score or value is relevant - Global, EU - E-RIHS, National - French, National - Greek, Institutional - National Gallery, Personal etc."
        },
        "period_class": {
            "title": "Time period or event",
            "type": "string",
            "description": "The time period or the event the KPI is relevant to.",
            "$ref": "https://e-rihs.io/schema/controlled_lists.schema.json#/definitions/period_class"
        },
        "function": {
            "title": "Function",
            "type": "string",
            "format": "textarea",
            "description": "The KPI function is a machine readable description of how the values for a given KPI are gathered or calculated, either from the local database or from external services. It is expected to take the form of a script, programming function, database query or a URL."
        }
    }
}