Preconfigure and share settings

Preconfigure settings for deployment

If you want to preconfigure settings for users can create a settings file and deploy it:

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:
   

   Credentials 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:

   Credentials section of settings.json

       "ProxyUsername": "",
       "ProxyPassword": ""

6. Deploy the settings file to the configuration folder (see above) of each user. 

When the user creates a ticket for the first time, the configuration settings will open. After that he needs to edit the connection settings and enter the username, password and API token (Jira Cloud only).

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:
   

   Project 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.