User Tools

Site Tools


jira_installation

Differences

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

Link to this comparison view

Next revision
Previous revision
jira_installation [2018/05/23 13:39]
willm created
jira_installation [2019/06/25 12:31] (current)
timothy.pike [Perspectium Configuration]
Line 13: Line 13:
   - In the name field enter a name that is meaningful to your oganization.   - In the name field enter a name that is meaningful to your oganization.
   - Make sure that the status of the Webhook is set to enabled.   - Make sure that the status of the Webhook is set to enabled.
-  - In the URL field, enter the URL for the Perspectium MBS provided by Perspectium support. ​+  - In the URL field, enter the URL for the Perspectium MBS provided by Perspectium support. You can also specify whether you want your Jira issues to be mapped to ServiceNow incidents or ServiceNow change requests by adding **?​target=common_incident** or **?​target=common_change** at the end of the Webhook URL.
   - In the events field, enter the key for the project(s) you wish to share from.   - In the events field, enter the key for the project(s) you wish to share from.
        * This should look like project="​projectIdentifier"​ i.e. project=STP        * This should look like project="​projectIdentifier"​ i.e. project=STP
Line 26: Line 26:
 Per [[https://​jira.atlassian.com/​browse/​JRACLOUD-68414|Atlassian]],​ webhooks currently do not support the issue_deleted event that should be triggered when an issue is deleted and thus deletes initiated in Jira are not currently supported. Per [[https://​jira.atlassian.com/​browse/​JRACLOUD-68414|Atlassian]],​ webhooks currently do not support the issue_deleted event that should be triggered when an issue is deleted and thus deletes initiated in Jira are not currently supported.
 </​WRAP>​ </​WRAP>​
-==== 2. ServiceNow Identifier Custom ​Field ==== +==== 2. ServiceNow Identifier ​& Sys ID Custom ​Fields ​==== 
-The ServiceNow Identifier custom ​field in Jira will allow for the bonding of the ServiceNow ​identifier ​with the Jira identifier. This needs to be done to ensure that both ServiceNow and Jira can identify the issues/​incidents being replicated. To set up a custom ​field you will need a Jira account with administrative access to your Jira instance or the project you wish to share from. View the Atlassian documentation for general information on [[https://​confluence.atlassian.com/​adminjiracloud/​adding-editing-and-deleting-a-custom-field-776636410.html|creating]] or [[https://​confluence.atlassian.com/​adminjiracloud/​configuring-a-custom-field-776636423.html|configuring]] a custom field. To create the ServiceNow Identifier ​field:  + 
-  - Create ​the field as a Text Field(single line)  +<wrap round info>​[[https://​docs.perspectium.com/​display/​fluorineplus|Fluorine+]]</​wrap>​ 
-  - Name the field //​ServiceNow Identifier// ​exactly as it is shown here.  + 
-    - The name of the field you create should have the exact capitalization shown here, as well as a space between ServiceNow and Identifier.  +The ServiceNow Identifier ​& Sys ID custom ​fields ​in Jira will allow for the bonding of ServiceNow ​incident ​with Jira issue. This needs to be done to ensure that both ServiceNow and Jira can identify the issues/​incidents being replicated. To add these custom ​fields, ​you will need a Jira account with administrative access to your Jira instance or the project you wish to share from. View the Atlassian documentation for general information on [[https://​confluence.atlassian.com/​adminjiracloud/​adding-editing-and-deleting-a-custom-field-776636410.html|creating]] or [[https://​confluence.atlassian.com/​adminjiracloud/​configuring-a-custom-field-776636423.html|configuring]] a custom field. To create the custom ​ServiceNow Identifier ​& Sys ID fields in Jira, follow these steps:  
-  - Set the screens that the field will be seen on. The fields should be prefaced by the project that you are sharing from.  +  - Create ​each custom ​field as a Text Field(single line)  
-    - If you are doing multiple projects ​or adding projects ​make sure that that each project is listed here.+  - Name the fields ​//​ServiceNow Identifier// ​and //Sys ID// 
 +    - The name of the field you create should have the exact capitalization ​and spacing as shown above
 +  - Set the screens that the fields ​will be seen on. The fields should be prefaced by the project that you are sharing from.  
 +    - If you are syncing data with multiple projectsmake sure that that each project is listed here.
     - More projects can be added by hitting the gear icon, selecting "​Screens",​ and then by hitting the checkbox for the respective projects.     - More projects can be added by hitting the gear icon, selecting "​Screens",​ and then by hitting the checkbox for the respective projects.
  
-Once these steps have been completed save the identifier ​and verify that it has been created. ​You should be seeing something similar to this:  +Once these steps have been completedsave the custom fields ​and verify that they have been created. 
-{{:​servicenowidentifierex.png?​1000|}} \\ \\ + 
-Once the ServiceNow Identifier ​field has been created and configured you will now need to find the customFieldId for it and provide ​that to Perspectium Support. This field is needed for the Perspectium ​MBS setup and can be obtained in two ways:  +Once the ServiceNow Identifier ​& Sys ID fields have been created and configuredyou will now need to find the customFieldId for both of these fields ​and provide ​those ID numbers ​to [[mailto:​support@perspectium.com|Perspectium Support]]. This is needed for the Perspectium ​Mesh setup and can be obtained in two ways:  
-  - Obtaining the ServiceNow Identifier field I.D. from the configure page URL +  - Obtaining the ServiceNow Identifier ​& Sys ID'​s ​field IDs from Jira'​s ​configure page URL: 
-       - Go to your ServiceNow ​Identifer field on the Custom Fields link under the Issues tab as an administrator +       - Go to your ServiceNow ​& Sys ID fields ​on the Custom Fields link under the Issues tab as an administrator 
-       - Click on the settings menu for the ServiceNow Identifier ​field+       - Click on the settings menu for each field
        - Click the configure link        - Click the configure link
        - Once on the configure page notice that the customFieldId is at the end of the URL for that page.         - Once on the configure page notice that the customFieldId is at the end of the URL for that page. 
-       - This is the number that should be given to Perspectium Support. ​+       - This is the number that should be given to [[mailto:​support@perspectium.com|Perspectium Support]]
    - Obtaining it from the rest API    - Obtaining it from the rest API
        - Enter this URL //​%%https://​yourInstanceName/​rest/​api/​2/​field%%//​ substituting yourInstanceName for the name of your Jira instance. ​        - Enter this URL //​%%https://​yourInstanceName/​rest/​api/​2/​field%%//​ substituting yourInstanceName for the name of your Jira instance. ​
-       ​- ​It should return a JSON file which you should then search for //​ServiceNow Identifier//​ +       ​- ​This should return a JSON file which you should then search for //​ServiceNow Identifier// & //Sys ID// 
-       - On the line you find the //​ServiceNow Identifier//​ you should see //​customfield_#####//​ +       - On the lines you find the //​ServiceNow Identifier// & //Sys ID// you should see //​customfield_#####//​ 
-       - The ##### you see is the customFieldId that should be given to Perspectium ​support. ​+       - The ##### you see is the customFieldId that should be given to [[mailto:support@perspectium.com|Perspectium Support]]
 <WRAP round info> <WRAP round info>
-If you are using any other custom fields that you wish to be replicated as well, provide Perspectium Support with the exact name of the field, the type of field, and the field'​s customFieldId.+If you are using any other custom fields that you wish to be replicated as well, provide ​[[mailto:​support@perspectium.com|Perspectium Support]] with the exact name of the field, the type of field, and the field'​s customFieldId.
 </​WRAP>​ </​WRAP>​
 Your Jira instance should now be set up to replicate to and from your ServiceNow instance. ​ Your Jira instance should now be set up to replicate to and from your ServiceNow instance. ​
  
-For more information ​for setting up the ServiceNow Identifier ​field or other mapping features ​please ​see [[jira_additional_mapping_guide|here]].+For more information ​on setting up the ServiceNow Identifier ​& Sys ID custom fields in your Jira instance ​or other mapping features ​for Jira, see [[jira_additional_mapping_guide|here]].
  
 ==== 3. Jira User ==== ==== 3. Jira User ====
Line 67: Line 70:
   - Your Jira instance ServiceNow Identifier customFieldID   - Your Jira instance ServiceNow Identifier customFieldID
   - Information on any custom fields you wish to be replicated from Jira to ServiceNow or ServiceNow to Jira   - Information on any custom fields you wish to be replicated from Jira to ServiceNow or ServiceNow to Jira
-  - An endpoint user and password ​to establish an authenticated connection to Jira+  - Your Jira username ​and [[https://​confluence.atlassian.com/​cloud/​api-tokens-938839638.html|API token]] used to establish an authenticated connection to Jira
  
  
jira_installation.1527107963.txt.gz · Last modified: 2018/05/23 13:39 by willm