Search Results for

    Show / Hide Table of Contents

    Application: Jira to Targetprocess

    Introduction

    Certain projects are managed in Targetprocess, which is used for planning, tracking, and other administrative functions. However, because customer requests are typically submitted through Jira, it's difficult for us to keep track of which requests have been submitted and which comments have been added. To close this gap, we created the Jira2Tp Synchronization component, which automatically synchronizes requests, comments, and other data from Jira to Targetprocess.

    Features

    Projects

    To let the tool know which projects need to be synced, we first need to add them to Casewhere.

    project_list

    We need to configure a few more fields, as follows:

    project_config

    • Name: the name of the project to manage in Casewhere.
    • Jira project key: the key of the project in the Jira system.
    • Jira secret: a secret key added in the Jira webhook. This lets Casewhere confirm that the requests coming into the Casewhere system originate from Jira.
    • Jira custom field name: we need a field to display the synced TP-ID for each Jira request, and this setting provides the name for that field.
    • TP closed status ID: each project may have a different set of statuses. To run certain background jobs, we need to provide the closed status ID.
    • Jira webhook assignee: the user ID in the Jira system. This is used to double-check that we only sync requests assigned to this user.

    Entity map

    We have completed the first step. The next one is also the most important part, where we specify the logic for mapping fields between Jira and Targetprocess. This is in JSON format, and each object has the following attributes:

    Example:

    [
      {
        "targetFieldName": "AssignedTeams",
        "targetFieldValue": {
          "Items": [
            {
              "Team": {
                "Id": 63942
              }
            },
            {
              "Team": {
                  "Id": 70528
              }
            }
          ]
        },
        "isRequiredJiraChange": true,
        "targetIsCustomField": true
      },
      ...
    ]
    
    • sourceFieldName: [Optional] the field name from Jira. This can be a JSONPath query; more about JSONPath can be found here.
    • targetFieldName: [Required] the field name in Targetprocess.
    • targetFieldValue: [Optional] the fixed value for the targetFieldName. If it is defined, its value is always set on the targetFieldName.
    • values: [Optional] an object containing key/value pairs, where the key is Jira's value and the value is the Targetprocess value.
      • Example:
        "sourceFieldName": "status.name",
        "targetFieldName": "EntityState",
        "values": {
          "Open": {
            "Id": 64
          },
          "Reopened": {
            "Id": 1477
          }
        }
        
        This means that the status Open on Jira is mapped to "Id: 64" on Targetprocess, which is Open. The same logic applies to Reopened.
    • isRequiredJiraChange: [Optional] if set to true, the field is only synchronized when the targetFieldName on Jira changes its value. Otherwise, it is always synced.
    • targetIsCustomField: [Optional] set it to true to let Casewhere know that it's a custom field on Targetprocess.

    Installation

    Requirements

    • Casewhere 2.6 or later

    Configuration

    1. Import the product.
    2. If you have access to Jira, set up a webhook with the following information: webhook_settings
    3. Replace the URL with your API endpoint, and remember to enter the secret key configured in the project.

    Releases

    2.0.1 - 02/03/2022

    Changelog

    • Update mappings, allow ignoring specific values of a Jira field.
    • Automatically add tags in Targetprocess for some fields.

    Download (login required): Jira2Tp v2.0.1

    2.0.0 - 06/05/2021

    Changelog

    • Configure projects, entity mappings.
    • Sync requests, comments, attachments.

    Download (login required): Jira2Tp v2.0.0

    1.0.0 - 10/04/2018 (Deprecated)

    Changelog

    • Sync requests, comments.

    Download (login required): Jira integration v1.0.0

    Roadmap

    • No plan as of now.
    In This Article
    Back to top Generated by DocFX