Versions Compared

Key

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

...

Expand
title3.5. Custom URL configuration

Step 1: Choose the ServiceNow table either Incident or Change Request.

Step 2: After selected the table, Click on the save button.

Step 3: Enter the test connection endpoint URL and click on save. After saving an test connection endpoint, It will take an custom test connection endpoint URL otherwise it will take default one.

Step 4: Enter the get field endpoint URL and click on save. After saving an endpoint, It will take an custom get filed endpoint URL otherwise it will take the default one.

Step 5: Enter the create endpoint URL and click on save. After saving an endpoint, It will take an custom create endpoint URL otherwise it will take the default one.

Step 6: Enter the update endpoint URL and click on save. After saving an endpoint, It will take an custom update endpoint URL otherwise it will take the default one.

Step 7: Enter the attachment endpoint URL and click on save. After saving an endpoint, It will take an custom attachment endpoint URL otherwise it will take the default one.

Step 8: Enter all the endpoint URL’s and click on save. It will take only custom endpoint URL.

Failure Logs:

...

titleFailure Logs Process

In any failure occurs in the process, user will be able to see the logs in failure logs. Some sample scenario's are mentioned below

...

Expand
titleFailure Logs Process

Step 1: Click on the “Failure Logs“ link in the top right, it will show the failure logs list.

Step 2: While creating an issue, if some fields are missed in mandatory field mappings, then failure log will occur. In “Failure Logs” the reason for failure will shown (“Mapping validation failed while creating incident“).

Note: In a Jira issue, SN Number and Sys Id will not appear if failure occurs.

Step 3: After failure occurs in failure logs, add the missing field in field mapping and click on the Retry button on Failure log then it will create an incident on ServiceNow. The SN Number and Sys Id will shown in the Jira issue also. After clicking, a retry log will be successful, and it will delete the particular failure log.

Step 4: While updating an issue (description or summary), if some fields are missed in mandatory field mappings, a failure log will be generated. In “Failure Logs,” the reason for failure will be shown (“Mapping validation failed while updating incident“).

Step 5: After failure occurs in failure logs, add the missing field in field mapping and click on the Retry button on the failure log; then it will update an incident in ServiceNow. After clicking, a retry log will be successful, and it will delete the particular failure log.

Step 6: While updating a comment in an issue, if some fields are missed in mandatory field mappings, then failure logs will be generated. In “Failure Logs,” the reason for failure will be shown ("comment Invalid mapping found for update“).

Step 7: After failure occurs in failure logs, add the missing field in field mapping and click on the Retry button on the failure log; then it will update an incident with a comment in ServiceNow. After clicking, a retry log will be successful, and it will delete the particular failure log.

Step 8: While updating an attachment in an issue, if some fields are missed in mandatory field mappings, then a failure log will be generated. In “Failure Logs,” the reason for failure will be shown (“Mapping failed while updating attachment“).

Step 9: After failure occurs in failure logs, add the missing field in field mapping and click on the Retry button on the failure log; then it will update an incident with an attachment in ServiceNow. After clicking, a retry log will be successful, and it will delete the particular failure log.

...

Expand
titleFields Mapping Process

Step 1: Click on the “Fields Mapping” link in the top right and select the project, issue type, Jira field, and Service Now field, then click on the “+” button to save the mapping.

Note: Please refer to the below mappings between the Jira field and the Service Now field. These are the “Mandatory” field mappings that are required to get the sync up and running.

Note: If a Jira field that we are trying to map is a field that can have predefined multiple values, like a drop-down or a multi-select, then the plugin will open a dialog where you can map individual options. Please refer to image below

Note: All the mappings for Jira fields like drop downs and which require individual value mappings like about will have an eye icon in front of the “Delete“ link in the mapping table (please refer to the image below). You can use this icon to view or change the mappings. It will open up the same dialog box as above.

4. Configure Jira for Synchronization:

Please create two custom text fields in Jira to store sysid and incident number which the Jira would be receiving after a successful update from service now and map these two fields to “sysid” and “number” fields in service now respectively. Without these two fields the sync process will not work.

Expand
title4.1 Configuration
  • Configure outbound rest message

  • Create business rules to push data from ServiceNow to JIRA

4.1.1 Configure outbound rest message

  • Name : Enter valid of outbound rest message

  • Description: Description of outbound rest message

  • Endpoint : URL of your Jira application

Note: If Jira is behind the firewall, you can add mid-server details .

Image Added

4.1.2 Create business rules to push data from ServiceNow to JIRA

  • Give name of Business Rule

  • When to run : Enter when to run it

  • Actions : Set your field values

  • Advanced : Write script

Image Added

5. Configure in ServiceNow for Synchronization:

Below configurations are needed to support real time sync from Service Now to Jira. Please contact us at atlassian@empyra.com . Scripts are developed in Service Now to push the changes from Service Now to JIRA

Expand
title5.1 Field Support for Incident

Field Label

Field Name

Type

Number

incident.number

string

Short description

incident.short_description

string

Description

incident.description

string

State

incident.state

choice

Additional comments

incident.addedComments

journal input

Assigned to

incident.assigned_to

reference

Assignment group

incident.assignment_group

reference

Caller

incident.caller_id

reference

Category

incident.category

Choice

Impact

incident.impact

choice

Priority

incident.priority

choice

Urgency

incident.urgency

choice

Problem

incident.problem

reference

Work notes

incident.work_notes

journal input

Work notes list

incident.work_notes_list

list

…..

….

Note: All fields of Incident table. Provision to map the field values in Jira

6. Other features

Expand
title6.1 Filtering

You can use filter dialog to filter the mapping records based on project, issue type and Jira field. in order filter the records please follow the following steps

Step 1: Click on the filter button besides '+'(add field mapping) button to open the filter dialog.

Image Added

Step 2: Select project(if you want to filter the records in the mapping table by project alone), issue type(if you want to filter the records by selected project and selected issue type) and Jira field (if you want to filter the records by selected project, issue type and Jira field).

Image Added

Step 3: Click on “Set Filters“ button to filter the record in the table based on the selected values

Image Added

Step 4: Now you can click on 'X' at the top right corner of the dialog to close it and see the filtered records. You can close the dialog by clicking on anywhere else on the screen too.

Note: You can clear the filter by clicking the ‘Clear Filters' button. Please remember that filter will remain applicable unless you manually clear them by clicking the 'Clear Filter’ button in the filter dialog or refresh the plugin page.

Image Added
Expand
title6.2 Change Number of records per page

You can change the number of records per page by selecting a different value for “Mappings per page“ in the filter dialog.

Note: Clearing the filter will not reset the value for “Mappings per page”.

Expand
title6.3 Typeahead project field

The project selection field is a special Typeahead field both in the field mapping form above the mapping table and the filter dialog. In order to work with it you need to enter the first three characters of the project name and the field will populate the names of the project matching the search.

Expand
title6.4 Pagination

You use the pagination links below the mapping table to navigate through the records in the mapping table.

Expand
title6.5 View System Logs

You can view the logs generated by the system in last 30 days for your Jira instance using this option. in order to view them please follow the below steps

Expand
title6.6 Special case of description field

We consider the mapping for the description field between Jira and service now to be special. You can map multiple Jira fields to the description field in service now. Whenever this is done, the content of the description field in Jira will be put below a separator ('--------------'), and all the other mapped values will be put above the separator. We recommend that you configure this behavior if you have a field in Jira for which you do not have any service-now equivalent field but you still want to have that value somewhere in service-now.

Step 1: Please click on the COG icon in the top right corner of the screen and then click on 'View System Logs'

Image Added

Step 2: This should open up a popup box with system logs in it. You can scroll through the entries to see the operations listed over here. While reporting for any issue you can copy and paste these lines of logs so that we can identify if the issue is with how the process is followed or if there is really a bug in the system.

Image Added

Expand
title6.7 Delete My Data

You can use this option to clear your mapping data and the connection configurations.

Note: This operation will not delete or touch your data in Jira. It only clears the mappings that you have created in the plugin along with configuration for service now

Step 1: Please click on the COG icon in the top right corner of the screen and then click on 'Reset Settings'

Image Added

Step 2: This should open up a pop for your confirmation to delete the settings. You can click on the “Confirm” button to delete the settings, or you can cancel the operation by clicking on the “Cancel” button.

Image Added