Versions Compared

Old Version 2

changes.mady.by.user Sebastian Gerdes

Saved on

compared with

New Version Current

changes.mady.by.user Sebastian Gerdes

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Install and configure the Add-In in Outlook.
  2. Go the the folder where the configuration is stored:  C:\Users\<username>\AppData\Local\catworkx GmbH\Teamworkx Outlook Integration for Jira
  3. Open the settings file settings.json with an editor of your choice.

  4. Locate the "Credentials" section of each configured server and replace it by:

    Code Block
    titleCredentials section of settings.json
     "Credentials": {
        "Username": "",
        "Password": "",
        "ApiToken": ""
      },

     

  5. Please also make sure to delete any credentials for the proxy. Due to the encryption it is not possible to deploy them:

    Code Block
    titleCredentials section of settings.json
        "ProxyUsername": "",
    "ProxyPassword": ""
  6. Deploy the settings file to the configuration folder (see above) of each user. 

...

Info

Make sure to keep the JSON valid, otherwise the Add-In will not be able to process it. Please pay special attention to the commas at the end. You can also use an online JSON validator to make sure, the syntax is valid. Furthermore, you should test the settings file before you deploy it.

Last but not least: Not all key-value pairs in the configuration file are logically correct. Do not care about any true or false for values, just trust the configuration made in Outlook.

Share settings

If you want to share settings in your team, for example project mappings, which map e-mail addresses to Jira projects, you can just copy the related sections from one settings file to another. In case you configured multiple servers you can also copy settings from one server to another. 

Please consider, that you cannot share any credentials for Jira or the proxy, due to the encryption. Here are the steps to share all other settings:

  1. Go the the folder where the configuration is stored:  C:\Users\<username>\AppData\Local\catworkx GmbH\Teamworkx Outlook Integration for Jira.
  2. Backup your current settings file settings.json.
  3. Open the settings file settings.json with an editor of your choice.

  4. Locate the server and settings you want to share or copy, for example project mappings:

    Code Block
    titleProject mapping section of settings.json
    "RegExProjectMapping": [
        {
          "ProjectKey": "COMPANY",
          "RegexPattern": "*@company.com"
        },
        {
          "ProjectKey": "SUPPORT",
          "RegexPattern": "support@???.server.com"
        },
        {
          "ProjectKey": "USERS",
          "RegexPattern": "???.*@company.net"
        }
      ]
  5.  Copy the related parts to another server section in the file or to a server section in another file.

...

Info

Make sure to keep the JSON valid. Please pay special attention to the commas at the end. You can also use an online JSON validator to make sure, the syntax is valid. 

Last but not least: Not all key-value pairs in the configuration file are logically correct. Do not care about any true or false for values, just trust the configuration made in Outlook.