Differences

This shows you the differences between two versions of the page.

--- 72:scripting_dataset [2018/07/24 17:18] – created bkkr
+++ 72:scripting_dataset [2018/07/24 18:37] – [Metric Dataset Script Global Variables] bkkr
@@ Line 2: / Line 2: @@
 ====== Metric Dataset Script Global Variables ======
+**Description**: Set of predefined global variables to be used in Stages data set script or in a collector script.
+=== Methods ===
+**Pkit**
+   * Return: pkit
+  * Description: Starting handle to get process information.
+      * getProjectsByName(str)
+        * str is the name of a project
+        * returns an array of Project elements
+      * getProjectByPath (str)
+        * str is the path of a project, parent are separated by | e.g. Methodpark | Development | Projects | Project A
+        * returns the project element
+      * getRootProject()
+        * returns the root project element
+      * getCurrentProject()
+        * returns the project element where the report is located
+**Dataset**
+  * Return: void
+  * Description: Handle to the dataset result set
+**CurrentMetric**
+  * Return: ProcessElementElement (Metric)
+  * Description: Returns the actual metric
+**CurrentCollector**
+  * Return: MetricCollectorElement
+  * Description:
+      * Collector
+        * Returns the actual Collector
+      * Stages Data set
+        * Not defined
+CurrentUser
+  * Return: UserElement
+  * Description: Returns the report datasource user