Differences

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

--- 72:scripting_dataset [2018/07/24 18:24] – [Metric Dataset Script Global Variables] bkkr
+++ 72:scripting_dataset [2024/02/15 00:00] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 [[:72:scripting|Use Scripting]]
-====== Metric Dataset Script Global Variables ======
+====== Global Script Variables ======
 **Description**: Set of predefined global variables to be used in Stages data set script or in a collector script.
 === Methods ===
-**Pkit**
+**pkit | stages | $s**
-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)
+   * 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
+      * getCurrentProcess()
+        * returns the currently viewed process version of the active workspace
-str is the path of a project, parent are separated by | e.g. Methodpark | Development | Projects | Project A
+**Dataset**
-returns the project element
+  * Return: void
+  * Description: Handle to the dataset result set
-getRootProject()
+**CurrentMetric**
-returns the root project element
+  * Return: MetricFolder
+  * Description: Returns the report folder
-getCurrentProject()
+**CurrentUser**
-returns the project element where the report is located
+  * Return: UserElement
+  * Description: Returns the current user