feedback-issue-router
Reactive icon

Feedback Issue Router

Stable version 1.0.0 (Compatible with OutSystems 11)
Uploaded
 on 19 April 2024
 by 
5.0
 (3 ratings)
feedback-issue-router

Feedback Issue Router

Documentation
1.0.0

Before configuring any project to create issues on a project management(PM) tool, it is necessary to configure the driver that will communicate with PM tool to create the issues. However, the process of authenticating with the PM Tool will be different for each PM tool.

Requires Feedback Manager role(ECT Provider)

Instructions

  1. Access the Driver Configurations page

  2. Create a New Driver Config.

  3. Fill the Form

    1. Name - name it as you want, Identifying which PM Tool and user credentials it refers to

    2. Driver Server Base URL - current server url, Eg: your.outsystems.environment.com

    3. Driver Module Name - Name of the Driver’s eSpace

      1. Driver_JiraCloud - Jira Cloud - Must install Feedback Jira Cloud Driver app.

      2. Driver_JiraServer - Jira Server - Must install Feedback Jira Server Driver app.

      3. Driver_DevOps - Azure DevOps - Must install Feedback Azure DevOps Driver app.

    4. Project Management Tool Server Base URL - Base URL of you PM Tool server. Eg: noname.atlassian.net

    5. Auth Email and Token - Credentials to authenticate on the Tool

      1. Jira Cloud - Username and Jira API Key - Manage API tokens for your Atlassian account

      2. Jira Server - Your Jira username and password. Does not support SSO.

      3. Azure DevOps - Your DevOps username and password

  4. Save Changes

Now we need to set up a Project Configuration.

The router is responsible for receiving requests from multiple Feedback Sync apps and syncing them to their respective PM Tool. Even though the router’s APIs are publicly, only requests performed by known entities will be accepted. This recognition is performed by manually exchanging Public and Private keys

Instructions

  1. Access Router Project Configurations

  2. Create a new Project Configuration

  3. Fill the form

    1. Name it as you want, identifying which project is this configuration related to

    2. Input the project code of the project on Jira Cloud/Server or Azure DevOps

    3. Select if you want the parent task of all synced feedback to be created automatically or if you want to select one manually

      1. If you selected the automatic option, the systems will try to create a task on your project once the record is saved. You’ll only be able to save it if the configuration is correct.

    4. Input a valid date for the configuration. After that date, no other synchronization request for this configuration will be accepted

    5. Select from one of the previously configured drivers

  4. Save Record

  5. Then, on the right side of the detail screen, there will e a table for you to add Issuer Public Keys. This will be the public keys from Project Configurations on Feedback Sync(Check Feedback Sync Documentation). There should be one Configuration GUID by environment where this project wants to use feedback on. Eg: A project, such as Delta, want to use Feedback Sync on their Dev and Qual environments. The person who is configuring their project on the Router should provide them their 2 configurations GUIDs, and is expecting them to provide their two Issuer Public Keys (RSA PK in plain text)

  6. Save the Changes

Now , the user on the Feedback Sync application should be able to start syncing issue to their PM Tool