/
20.Technical Specification
20.Technical Specification
- APP-140Getting issue details... STATUS
1.Objective
Develop plugin to integrate Jira SD to ServiceNow
2.Features
Sl No | Features |
---|---|
1 | admin user should be able to configure the connection parameters in screen |
2 | admins user should be able to map the JIRA SD and Service Now Fields |
3 | Any change (create/update/edit) in JIRA SD should update the respective incident in ServiceNow |
4 | Any change (create/update/edit) in ServiceNow should update the respective Task/issues in Jira SD |
3.Solution Description
3.1 Task List
# | Task | Description | Dependent Task | Owner | Start Date | End Date | Status | Remark |
---|---|---|---|---|---|---|---|---|
1 | Local Environment Setup | Installation of JIRA SDK, Eclipse Setup | 0 | Ariya Krishnan | - AP-844Getting issue details... STATUS | |||
2 | Create ServiceNow Instance | Register in ServiceNow with empyra email Id | 0 | Sharmendra Vishwakarma | - APP-147Getting issue details... STATUS | |||
3 | Connection Screen: Create UI | Screen to enter the connection details | 1 | Ariya Krishnan | - APP-148Getting issue details... STATUS | |||
4 | Connection Screen: Edit UI | Screen to edit the connection details | 1 | Ariya Krishnan | - APP-149Getting issue details... STATUS | |||
5 | Connection Screen : Details UI | Screen to display the connection details | 1 | Ariya Krishnan | - APP-150Getting issue details... STATUS | |||
6 | Create the data model to store the connection details | Create database schema for storing the connection details | 3 | Ariya Krishnan | - APP-155Getting issue details... STATUS | |||
7 | Business Logic to save/edit the connection details | Implementation logic to save the connection details | 6 | Ariya Krishnan | - APP-152Getting issue details... STATUS | |||
8 | Business logic to test the ServiceNow connection | Implementation logic to test the connection | 7 | Ariya Krishnan | - APP-153Getting issue details... STATUS | |||
9 | Business Logic to reset the connection | Implementation logic to RESET the connection | 7 | Ariya Krishnan | - APP-156Getting issue details... STATUS | |||
10 | Configuration Screen : Fields mapping JIRA SD and ServiceNow | Screen to Mapp the Jira SD and ServiceNow fields | 5 | Dipesh Chouksey (Unlicensed) | - APP-157Getting issue details... STATUS | |||
11 | Create data model to store the field mapping in db | Create database table to store the mapping details | 10 | Dipesh Chouksey (Unlicensed) | - APP-158Getting issue details... STATUS | |||
12 | Business Logic to save/edit/delete the configuration details | Implementation logic to save/edit/delete the field mappings. | 11 | Dipesh Chouksey (Unlicensed) | - APP-161Getting issue details... STATUS | |||
13 | Host the Jira Service Desk for ServiceNow Connectivity | Availability of this will help ServiceNow to connect to Jira SD | 12 | |||||
14 | Implement Logger | Implementation the logger | 1,2,3,4,5,6 | |||||
15 | Create a listener for JIRA Issue events(Create/Update/Edit) in Jira SD (Create/Update) | Need to check the deletion( Feature Not Required) | 12 | Sharmendra Vishwakarma | - AP-898Getting issue details... STATUS | |||
16 | Create incident-based on Jira issue creation based on saved mapping | Supported field: Summary, description, Text Field (single line) custom field | Dipesh Chouksey (Unlicensed) | - AP-915Getting issue details... STATUS | ||||
17 | Update incident-based on Jira issue creation based on saved mapping | 16 | Dipesh Chouksey (Unlicensed) | - AP-916Getting issue details... STATUS | ||||
18 | Listener for JIRA comments events(Create/Update/Edit) in Jira SD (Create/Update) | Need to check the deletion( Feature Not Required) | 15 | Sharmendra Vishwakarma | - AP-899Getting issue details... STATUS | |||
19 | Setup instance and prepare for demo. | - AP-928Getting issue details... STATUS | ||||||
20 | Listener for JIRA attachment events(Create/Update/Edit) in Jira SD (Create/Update) | Dipesh Chouksey (Unlicensed) | - AP-919Getting issue details... STATUS | |||||
21 | Check the API to push the create/update of incident to Jira SD | Need to check to configure outbound message configuration in ServiceNow | 0 | Sharmendra Vishwakarma | - APP-151Getting issue details... STATUS | |||
22 | Setup client instance and support a single select field like priority | Dipesh Chouksey (Unlicensed) | - AP-934Getting issue details... STATUS | |||||
23 |
Pull the incident update from ServiceNow and update Jira SD | 0 | ||||||
24 | Create User Documentation in Confluence | 16 | ||||||
25 | Test Cases | 16 | ||||||
26 | Create OBR for the marketplace | 17 |
3.2 Data Model
Sl No# | Table Name | Fields | Field Type | Display Name | Description |
---|---|---|---|---|---|
1 | ao_snow_conn | id | char(36) | Id | |
name | string(255) | Connection URL | Service Now base URL | ||
date_created | datetime | Date Created | |||
date_modified | datetime | Date Modified | |||
created_by | id | Created By | |||
modified_by | id | Modified By | |||
user_name | string(255) | User Name | |||
password | string(255) | Password | |||
hash_password | string(255) | Hashed Password | |||
create | boolean | Create | By Default True | ||
update | boolean | Update | By Default True | ||
2 | ao_snow_config_master | id | char(36) | ||
name | string(255) | ||||
date_created | datetime | ||||
date_modified | datetime | ||||
created_by | id | ||||
modified_by | id | ||||
jira_project | |||||
jira_issue_type | |||||
3 | ao_snow_config_detail | id | char(36) | ||
name | string(255) | ||||
date_created | datetime | ||||
date_modified | datetime | ||||
created_by | id | ||||
modified_by | id | ||||
ao_snow_config_id | id | ||||
jira_field | |||||
snow_field |
3.3 Field Mapping
Jira SD | ServiceNow | |||||||||||
Display Field | Field Name | Type | Default | Value | Description | Display Field | Field Name | Type | Default | Value | Sample data | |
---|---|---|---|---|---|---|---|---|---|---|---|---|
Need to create custom field | Incident | Text | To Capture Incident number of ServiceNow to JIRA SD | Number | number | Text | INC0010006 | |||||
Contact type | Dropdown | None | Email,Phone,Self-Service,Walk-in | |||||||||
Reporter | Caller | caller_id | Lookup | Users | ||||||||
Customer status | State | incident_state | Dropdown | New | New, In Progress, On Hold,Resolved, Closed , Cancelled | |||||||
Request type | Category | category | Dropdown | Inquiry / Help | Inquiry / Help, Help, Software,Hardware,Network,Database | inquiry | ||||||
Impact | impact | Dropdown | 3-Low | 1-High.2-Medium,3-Low | ||||||||
Subcategory | subcategory | Dropdown | None | Antivirus,Email, Internal Application | ||||||||
Urgency | Critical,High,Medium,Low | Urgency | urgency | Dropdown | 3-Low | 1-High.2-Medium,3-Low | ||||||
Service | Lookup | |||||||||||
Priority | High,Medium,Low,Blocker,Minor | Priority | priority | 5-Planning | 5 | |||||||
Configuration item | Lookup | Looup to Configuration | ||||||||||
Assignment group | Lookup | Lookup to Group | ||||||||||
Assignee | Assigned to | Lookup | Lookup to users | |||||||||
Summary | Short description | short_description | Text | Laptop is not working | ||||||||
Description | Description | description | Text Area | |||||||||
Notes | ||||||||||||
Watch list | watch_list | |||||||||||
Respond to Customer | If it is for Customer Comment, visibile to portal | Additional comments(Customer visible) | Text Area | |||||||||
Comment | Related Field, Internal Comment, not visible to customer | Work notes | work_notes | Text Area | ||||||||
Related Records | ||||||||||||
Problem | Lookup | Lookup to Problem | ||||||||||
Change Request | Lookup | Lookup to Change Request | ||||||||||
Caused by Change | Lookup | Lookup to Caused by Change | ||||||||||
Resolution Information | ||||||||||||
Knowledge | Checkbox | |||||||||||
Resolved by | resolved_by | Lookup | ||||||||||
Resolution code | Dropdown | Solved(Work Around) | ||||||||||
Resolved | ||||||||||||
Resolution | Resolution notes | Text Area | ||||||||||
Status | waiting for support | Depends on the workflow assigned | ||||||||||
Component/s | ||||||||||||
Labels | ||||||||||||
Attachment | Related Field | |||||||||||
Create Custom Field( | SysId | Text | sys_id | sys_id | Id | 4830a73a4f69041088adff6f9310c76d | ||||||
sys_updated_on | sys_updated_on | 10-12-2019 12:40 | ||||||||||
sys_updated_by | sys_updated_by | admin | ||||||||||
sys_created_on | sys_created_on | 10-12-2019 05:56 | ||||||||||
sys_created_by | sys_created_by | admin |
3.4 API Details
4.References
Sl No# | URL | Description |
---|---|---|
1 | https://developer.servicenow.com/blog.do?p=/post/dot-walking-in-the-rest-table-api-2/ | REST API to fetch data from table |
2 | https://docs.servicenow.com/bundle/istanbul-application-development/page/integrate/inbound-rest/concept/c_AttachmentAPI.html | For Attachment |
, multiple selections available,