Differences

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

--- 712:process_feedback [2025/11/06 07:54] – Stengel, Paulina
+++ 712:process_feedback [2026/03/03 14:31] (current) – [Configuration] Hammrich, Oliver
@@ Line 1: / Line 1: @@
 ====== Process feedback ======
-With this feature, users are able to provide feedback directly while navigating through the process. The feedback is created as a Jira or PTC-ILM item and can be triaged, planned, and tracked within the system. Every generated item contains a link back to the original process element where the feedback was created, so full traceability of process change requests is assured.
+With this feature, users can provide feedback directly as they navigate the process. The feedback is created as a data item and can be triaged, planned, and tracked within a ticket system. Every generated item contains a link back to the original process element where the feedback was created, ensuring full traceability of process change requests.
 ===== Configuration =====
 Changes in the Stages ''config.xml'', metamodel and language properties are required. In general, this configuration looks like the following:
 <code xml>
 <?xml version="1.0" encoding="UTF-8" ?>
@@ Line 35: / Line 37: @@
   </feedback-systems>
 </stages-config>
 </code>
-It is possible to define multiple feedback system types and feedback hosts. You  can define a default feedback system by adding “default=”true”” to the host in config.xml, e.g. the first configured one. You can furthermore change the feedback system for each workspace in the workspace settings. Choosing a specific feedback system to set it permanently for the current workspace. Choose “Default” to set the feedback system to the configured default feedback system in config.xml (if no default=”true” is set, it is “Default (None)”). Choose “None” to not display the feedback widget in the current workspace.
+It is possible to define multiple feedback system types and feedback hosts. You can define a default feedback system by adding “default=”true”” to the host in config.xml, e.g., the first configured one. You can furthermore change the feedback system for each workspace in the workspace settings. Choosing a specific feedback system to set it permanently for the current workspace. Choose “Default” to set the feedback system to the configured default feedback system in config.xml (if no default=”true” is set, it is “Default (None)”). Choose “None” to not display the feedback widget in the current workspace.
 [[https://doc.stagesasaservice.com/lib/exe/detail.php?id=:712:feedback-dropdown&media=:712:feedback-dropdown.png|{{:712:feedback-dropdown.png}}]]
@@ Line 46: / Line 46: @@
 ==== Stages config ====
-The changes in ''config.xml'' are system specific. Please refer the right manual page:
+The changes in ''config.xml'' They are system-specific. Please refer to the right manual page:
-   * [[:712:process_feedback_jira|Jira]]
+  * [[:712:process_feedback_jira|Jira]]
-   * [[:712:process_feedback_servicenow|ServiceNow]]
+  * [[:712:process_feedback_servicenow|ServiceNow]]
   * [[:712:process_feedback_ptcilm|PTC Integrity (ILM)]]
   * [[:712:process_feedback_redmine|Redmine]]
@@ Line 60: / Line 60: @@
 <code xml>
 <property name="propertyKey" value="propertyValue" />
 </code>
-Properties are configuration parameters for the feedback system. Every feedback system defines its own parameter, which are Username and password for authentication or project name etc. Properties are configured as key:value pairs.
+Properties are configuration parameters for the feedback system. Every feedback system defines its own parameters, such as a username and password for authentication or a project name, etc. Properties are configured as key: value pairs.
 === Attributes ===
-Attributes define the values, which are visible to the feedback-creator. Each attribute will be shown in form of a text-box in the feedback widget and will be sent to the feedback system once the user clicks on "save" in the Stages Application.
+Attributes define the values visible to the feedback-creator. Each attribute will appear as a text box in the feedback widget and will be sent to the feedback system when the user clicks "save" in the Stages Application.
 <code xml>
 <attribute ident="description" type="text" target="MyDescriptionField" targetType="MyFieldType" />
 </code>
   * ''ident'': Stages translation property
   * ''type'': Type of text field in Stags:
-      * ''string'': Text Field (single line)
+    * ''string'': Text Field (single line)
-      * ''text'': Text Field (multi line)
+    * ''text'': Text Field (multi line)
-  * ''target''  and ''targetType'': Defines feedback system specific configuration
+  * ''target''  and ''targetType'': Defines the feedback system-specific configuration
 === System Attribute Mappings ===
-System attribute mappings are similar to the attributes but are NOT visible in the Stages Application. The values for these attributes come directly from Stages.
+System attribute mappings are similar to the attributes, but are NOT visible in the Stages Application. The values for these attributes come directly from Stages.
 <code xml>
-<attribute source="elementUrl" target="MyField" targetType="MyField" targetType="MyFieldType" />
+<attribute source="elementUrl" target="MyField" targetType="MyFieldType" />
+</code>
+  * ''source''Which information from Stages should be taken? See also the picture below.
+    * Attributes of the current view where the user provides feedback
+      * ''elementName'': e.g., "Analyze Scope" (Since Stages 7.8)
+      * ''elementShortname'': e.g., "AS" (Since Stages 7.8)
+      * ''elementLabel'': e.g., "AS: Analyze Scope" (Since Stages 7.8)
+      * ''elementType'': e.g., "Workflow" (Since Stages 7.8)
+      * ''elementIdentity'': e.g. _wUV9sBbNHr-aicWx33VsQA (Since Stages 7.5.1.3)
+      * ''elementUrl'': Url to element
+      * ''elementStableUrl'': Url to element with specific version (Since Stages 7.5.1.3)
+      * ''processVersionName'': e.g. V1 (Since Stages 7.5.1.3)
+      * ''workspaceName'': e.g., Software Engineering
+      * ''workspacePath'': e.g., Company > Software
+      * ''workspaceFullPath'': e.g. Company > Software > Software Engineering (Since Stages 7.5.1.3)
+      * ''creatorFullname'': e.g., John Doe
+      * ''creatorUsername'': e.g., jdoe
+      * ''creatorEmail'': e.g. jdoe@example.com (Since Stages 7.5.2.2)
+    * If the process element was imported via a module import, the following attributes belong to the imported source module. Otherwise, or if the process element is overwritten, the attributes belong to the current view (Since Stages 7.9)
+      * ''sourceModuleElementUrl'': Url to element if the current element is imported by a module import
+      * ''sourceModuleElementStableUrl'': Url to element with specific version if the current element is imported by module import
+      * ''sourceModuleWorkspaceName'': e.g., Software Engineering
+      * ''sourceModuleWorkspacePath'': e.g., Company > Software
+      * ''sourceModuleWorkspaceFullPath'': e.g. Company > Software > Software Engineering
+    * If a process element is imported by multiple module imports, the following attributes belong to the module where the process element was originally created and can be edited. Otherwise, or if the process element is overwritten, the attributes belong to the current view
+      * ''originElementUrl'': Url to editable element if current element is imported by module import (Since Stages 7.5.1.3)
+      * ''originElementStableUrl'': URL to editable element with specific version if current element is imported by module import (Since Stages 7.5.1.3)
+      * ''originWorkspaceName'': e.g., Software Engineering (Since Stages 7.5.2.2)
+      * ''originWorkspacePath'': e.g. Company > Software (Since Stages 7.5.2.2)
+      * ''originWorkspaceFullPath'': e.g. Company > Software > Software Engineering (Since Stages 7.5.2.2)
+  * ''target''  and ''targetType'': Defines the feedback system-specific configuration
-</code>
+[[https://doc.stagesasaservice.com/lib/exe/detail.php?id=77:process_feedback&media=77:feedback-source.png|{{ :77:feedback-source.png?400 }}]]
-  * ''source'': Which information from Stages should be taken. See also picture below.
-      * Attributes of current view where the user provides feedback
-        * ''elementName'': e.g. "Analyze Scope" (Since Stages 7.8)
-        * ''elementShortname'': e.g. "AS" (Since Stages 7.8)
-        * ''elementLabel'': e.g. "AS: Analyze Scope" (Since Stages 7.8)
-        * ''elementType'': e.g. "Workflow" (Since Stages 7.8)
-        * ''elementIdentity'': e.g. _wUV9sBbNHr-aicWx33VsQA (Since Stages 7.5.1.3)
-        * ''elementUrl'': Url to element
-        * ''elementStableUrl'': Url to element with specific version (Since Stages 7.5.1.3)
-        * ''processVersionName'': e.g. V1 (Since Stages 7.5.1.3)
-        * ''workspaceName'': e.g. Software Engineering
-        * ''workspacePath'': e.g. Company > Software
-        * ''workspaceFullPath'': e.g. Company > Software > Software Engineering (Since Stages 7.5.1.3)
-        * ''creatorFullname'': e.g. John Doe
-        * ''creatorUsername'': e.g. jdoe
-        * ''creatorEmail'': e.g. jdoe@example.com (Since Stages 7.5.2.2)
-      * If process element was imported by module import, then the following attributes belongs to the imported source module. Otherwise or if process element is overwritten the attributes belongs to current view (Since Stages 7.9)
-        * ''sourceModuleElementUrl'': Url to element if current element is imported by module import
-        * ''sourceModuleElementStableUrl'': Url to element with specific version if current element is imported by module import
-        * ''sourceModuleWorkspaceName'': e.g. Software Engineering
-        * ''sourceModuleWorkspacePath'': e.g. Company > Software
-        * ''sourceModuleWorkspaceFullPath'': e.g. Company > Software > Software Engineering
-      * If process element was imported by multiple module imports, then the following attributes belongs to the module where the process element was created originally and can be edited. Otherwise or if process element is overwritten the attributes belongs to current view
-        * ''originElementUrl'': Url to editable element if current element is imported by module import (Since Stages 7.5.1.3)
-        * ''originElementStableUrl'': Url to editable element with specific version if current element is imported by module import (Since Stages 7.5.1.3)
-        * ''originWorkspaceName'': e.g. Software Engineering (Since Stages 7.5.2.2)
-        * ''originWorkspacePath'': e.g. Company > Software (Since Stages 7.5.2.2)
-        * ''originWorkspaceFullPath'': e.g. Company > Software > Software Engineering (Since Stages 7.5.2.2)
-  * ''target''  and ''targetType'': Defines feedback system specific configuration
-[[https://doc.stagesasaservice.com/lib/exe/detail.php?id=77:process_feedback&media=77:feedback-source.png|{{  :77:feedback-source.png?400  }}]]
 === Custom Attribute Mappings ===
@@ Line 126: / Line 122: @@
 (Since Stages 7.5.1.3)
-Custom attribute mappings are similar to the attributes but are NOT visible in the Stages Application. The values for these attributes come directly from ''config.xml''. You can map static values to fields in the feedback system.
+Custom attribute mappings are similar to the attributes, but are NOT visible in the Stages Application. The values for these attributes come directly from ''config.xml''. You can map static values to fields in the feedback system.
 <code xml>
 <attribute value="Stages" target="MySourceSystemField" targetType="MyFieldType" />
 </code>
   * ''value'': The value that should be mapped
-  * ''target''  and ''targetType'': Defines feedback system specific configuration
+  * ''target''  and ''targetType'': Defines feedback system-specific configuration
 === Script Attribute Mappings ===
-If you want to map more complex values to your feedback system, then it's possible to run a script in Stages to aggregate more mappings. The script is able to access the Facade API. Create a script ''feedback-demo.js''  like this and store it to your Stages conf folder:
+If you want to map more complex values to your feedback system, you can run a script in Stages to aggregate additional mappings. The script can access the Facade API. Create a script ''feedback-demo.js''  like this and store it in your Stages conf folder:
 <code javascript>
@@ Line 146: / Line 141: @@
 }
 result.properties.put("project", "Demo"); // Override property 'project'
 </code>
-Add to your feedback host configuration the attribute ''script''  with the file name as value and add a ''script-attribute-mappings''  section:
+Add to your feedback host configuration the attribute ''script''  with the file name as a value, and add a ''script-attribute-mappings''  section:
 <code xml>
@@ Line 167: / Line 160: @@
   </feedback-systems>
 </stages-config>
 </code>
-The script can access to several information of the process:
+The script can access several pieces of information about the process:
-  * Current process element: ''currentElement''  (in case of process start page it is null)
+  * Current process element: ''currentElement''  (In case of the process start page, it is null.)
   * Current user: ''currentUser''
   * Logger: ''log''
   * Pkit: ''pkit''
-      * Current version of process: ''pkit.getCurrentProcess()''
+    * Current version of process: ''pkit.getCurrentProcess()''
-      * Current workspace: ''pkit.getCurrentProject()''
+    * Current workspace: ''pkit.getCurrentProject()''
-      * …
+    * …
 The script cannot access the information that the user entered into an Attribute.
-All results have to be stored to the predefined ''result''  variable.
+All results have to be stored in the predefined ''result''  variable.
-  * Values in ''result.mappings''  are configurable in the xml via ''script-attribute-mappings''
+  * Values in ''result.mappings''  are configurable in the XML via ''script-attribute-mappings''
-  * Values in ''result.properties''  will add or override the ''properties''  of the xml file
+  * Values in ''result.properties''  will add or override the ''properties''  of the XML file