You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/Advanced.md
+25-8Lines changed: 25 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1035,19 +1035,36 @@ The following tasks will be merged correctly:
1035
1035
```
1036
1036
The same approach can be applied to other actors in the QC framework, like Checks (`checkName`), Aggregators(`aggregatorName`), External Tasks (`taskName`) and Postprocessing Tasks (`taskName`).
1037
1037
1038
-
## Definition and access of user-specific configuration
1038
+
## Definition and access of simple user-defined task configuration ("taskParameters")
1039
1039
1040
-
A task can access custom parameters declared in the configuration file at `qc.tasks.<task_id>.extendedTaskParameters` or `qc.tasks.<task_id>.taskParameters`. They are stored inside an object of type `CustomParameters` named `mCustomParameters`, which is a protected member of `TaskInterface`.
1040
+
The new, extended, way of defining such parameters, not only in Tasks but also in Checks, Aggregators and PP tasks,
1041
+
is described in the next section.
1041
1042
1042
-
The simple, deprecated, syntax is
1043
+
A task can access custom parameters declared in the configuration file at `qc.tasks.<task_id>.taskParameters`. They are stored inside an object of type `CustomParameters` named `mCustomParameters`, which is a protected member of `TaskInterface`.
1044
+
1045
+
The syntax is
1043
1046
```json
1044
1047
"tasks": {
1045
1048
"QcTask": {
1046
1049
"taskParameters": {
1047
1050
"myOwnKey1": "myOwnValue1"
1048
1051
},
1049
1052
```
1050
-
It is accessed with : `mCustomParameters["myOwnKey"]`.
1053
+
It is accessed with : `mCustomParameters["myOwnKey"]`.
1054
+
1055
+
## Definition and access of user-defined configuration ("extendedTaskParameters")
1056
+
1057
+
User code, whether it is a Task, a Check, an Aggregator or a PostProcessing task, can access custom parameters declared in the configuration file.
1058
+
They are stored inside an object of type `CustomParameters` named `mCustomParameters`, which is a protected member of `TaskInterface`.
1059
+
1060
+
The following table gives the path in the config file and the name of the configuration parameter for the various types of user code:
0 commit comments