Differences

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

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
72:scripting_dataset [2018/07/24 17:18] – created bkkr72:scripting_dataset [2019/10/04 07:11] cgl
Line 2: Line 2:
  
 ====== Metric Dataset Script Global Variables ====== ====== 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 | stages | $s**
 +
 +   * 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
 +
 +**Dataset**
 +
 +  * Return: void
 +  * Description: Handle to the dataset result set
 +
 +**CurrentMetric**
 +
 +  * Return: MetricFolder
 +  * Description: Returns the report folder
 +
 +**CurrentUser**
 +
 +  * Return: UserElement
 +  * Description: Returns the current user