Stages Documentation

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
75:process_feedback_ptcilm [2020/01/27 08:46] – fnpk75:process_feedback_ptcilm [2020/01/27 08:56] – fnpk
Line 14: Line 14:
   <feedback-system name="ptcilm">   <feedback-system name="ptcilm">
  
 +    <!-- Url to the WSDL / SOAP endpoint -->
     <host url="http://integrity.example.com:7001/webservices/10/2/Integrity/?wsdl">     <host url="http://integrity.example.com:7001/webservices/10/2/Integrity/?wsdl">
  
Line 23: Line 24:
       <property name="type" value="feedback" />       <property name="type" value="feedback" />
  
-      <!-- As alternative to the project key you can specify the project by its id -->+      <!-- Url to the Web ILM. It is used to create a link to the generated item -->
       <property name="imweb" value="http://integrity.example.com:7001/im" /> -->       <property name="imweb" value="http://integrity.example.com:7001/im" /> -->
  
  
-      <!-- The summary field will always be available and is automatically mapped to the Jira "Summary" field  -->+      <!-- The summary field will always be available and is automatically mapped to the "Summary" field  -->
  
       <!--       <!--
Line 45: Line 46:
  
       <!--       <!--
-      You can map element specify information to your Jira issue. These sources are available:+      You can map element specify information to your ILM item. These sources are available:
       - elementUrl e.g. https://stages.example.com/stages/index.html#/workspace/200/_vv/(process/activity/_wUV9sBbNHr-aicWx33VsQA)       - elementUrl e.g. https://stages.example.com/stages/index.html#/workspace/200/_vv/(process/activity/_wUV9sBbNHr-aicWx33VsQA)
       - workspaceName e.g. "Software Engineering"       - workspaceName e.g. "Software Engineering"
Line 51: Line 52:
       - creatorFullname "John Doe"       - creatorFullname "John Doe"
       - creatorUsername "jdoe"       - creatorUsername "jdoe"
-      The "target" defines the id for the custom field in Jira (e.g. "customfield_10101"). +      The "target" defines the name for the field in ILM (e.g. "customfield_10101"). 
-      Optional: The targetType defines the type of the Jira field. Supported Jira fields see below.+      Optional: The targetType defines the type of the ILM field. Supported fields see below.
       -->       -->
       <system-attribute-mappings>       <system-attribute-mappings>
-        <attribute source="elementUrl" target="customfield_10104" /> +        <attribute source="elementUrl" target="Element Url" /> 
-        <attribute source="workspaceName" target="customfield_10105" /> +        <attribute source="workspaceName" target="Workspace Name" /> 
-        <attribute source="workspacePath" target="customfield_10106" /> +        <attribute source="workspacePath" target="Workspace Path" /> 
-        <attribute source="creatorFullname" target="customfield_10107" /> +        <attribute source="creatorFullname" target="Creator Fullname" /> 
-        <attribute source="creatorUsername" target="customfield_10108" />+        <attribute source="creatorUsername" target="Assigned User" targetType="user"/>
       </system-attribute-mappings>       </system-attribute-mappings>
     </host>     </host>
Line 66: Line 67:
 </code> </code>
  
-==== Supported Jira fields ===== +==== Supported fields ===== 
-  * Description: ''targetType=""'' (Empty) +  * shorttext: ''targetType=""'' (Empty) 
-  * Text Field (single line): ''targetType=""'' (Empty) +  * longtext: ''targetType="longtext"'' (Also with rich text setting) 
-  * Text Field (multi line): ''targetType=""'' (Empty) +  * user: ''targetType="user"''
-  * Select List (single choice): ''targetType="selectList-singleChoice"'' +
-  * Components: ''targetType="components"''+
  
-Be aware: If you choose Select or Component then the user entered values must be configured in Jira. Otherwise the ticket creation will fail.+Be aware: If you choose user then the user entered values or the Stages username must match / exist in ILM. Otherwise the item creation will fail.
  
-Other Jira fields are not supported at the moment. +Other ILM fields are not supported at the moment.
- +
-==== Custom Endpoint ==== +
- +
-If your Jira REST-Endpiont differs from the standard location, you can specify it. If your link to the Jira-API is for example like ''<nowiki>https://api.example.com/example/api/2/issue</nowiki>'' then you have to specify ''<nowiki>https://api.example.com/example/</nowiki>'' as value for this property. +
-<code xml> +
-<property name="jira.rest.endpoint" value="https://api.example.com/example/" /> +
-</code> +
- +
-==== Proxy ==== +
- +
-You can specify a proxy server. +
- +
-<code xml> +
-<property name="proxy.enabled" value="true" /> +
-<property name="proxy.type" value="https" /> +
-<property name="proxy.port" value="3128" /> +
-<property name="proxy.hostname" value="proxy.example.com" /> +
-</code> +
- +
-==== OAuth 2.0 Password Grant ==== +
- +
-We support also OAuth 2.0 with Password Grant. To configure it there are different properties: +
- +
-<code xml> +
-<property name="authentication.type" value="oauth20" /> +
-<property name="authentication.oauth20.granttype" value="password" /> +
- +
-<!-- URL to your OAuth 2.0 Token Endpiont --> +
-<property name="authentication.oauth20.tokenendpoint" value="https://example.com/oauth/token" /> +
- +
-<!-- OAuth 2.0 Client Id --> +
-<property name="authentication.oauth20.clientid" value="" /> +
- +
-<!-- OAuth 2.0 Client Secret --> +
-<property name="authentication.oauth20.clientsecret" value="" /> +
- +
-<!--  OAuth 2.0 Scope --> +
-<property name="authentication.oauth20.scope" value="" /> +
- +
-<!-- OAuth 2.0 (technical) user --> +
-<property name="authentication.oauth20.user" value="" /> +
- +
-<!-- OAuth 2.0 password --> +
-<property name="authentication.oauth20.password" value="" /> +
-</code> +
- +
-==== Custom Header ==== +
- +
-You can set custom header to the Jira-REST-Requests. +
- +
-<code xml> +
-<property name="jira.rest.customheader.key" value="" /> +
-<property name="jira.rest.customheader.value" value="" /> +
-</code>+