Skip to content

Commit 031e965

Browse files
devGregAclaudeMaffooch
authored
docs: add ServiceDesk Plus to the Pro Integrations tool reference (#15217)
Covers both editions (on-premises technician key and cloud Zoho OAuth with the self-client walkthrough and regional token endpoints), the group-name mapping identifier, priority/status name mappings, and the SDP-specific behaviors (full content sync on update, close-on-delete, mandatory-on-closure caveat). Co-authored-by: Claude Fable 5 <noreply@anthropic.com> Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com>
1 parent f386e52 commit 031e965

2 files changed

Lines changed: 68 additions & 0 deletions

File tree

docs/content/issue_tracking/pro_integration/integrations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Supported Integrations:
1616
- GitHub
1717
- GitLab Boards
1818
- Jira
19+
- ServiceDesk Plus
1920
- ServiceNow
2021
- Shortcut
2122

@@ -78,6 +79,7 @@ For the complete list of requirements, please open the vendor specific pages bel
7879
- [GitHub](/issue_tracking/pro_integration/integrations_toolreference/#github)
7980
- [GitLab Boards](/issue_tracking/pro_integration/integrations_toolreference/#gitlab)
8081
- [Jira](/issue_tracking/pro_integration/integrations_toolreference/#jira)
82+
- [ServiceDesk Plus](/issue_tracking/pro_integration/integrations_toolreference/#servicedesk-plus)
8183
- [ServiceNow](/issue_tracking/pro_integration/integrations_toolreference/#servicenow)
8284
- [Shortcut](/issue_tracking/pro_integration/integrations_toolreference/#shortcut)
8385

docs/content/issue_tracking/pro_integration/integrations_toolreference.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,3 +430,69 @@ A few Freshservice-specific behaviors to be aware of:
430430
- Updates sync the full ticket content - Freshservice allows the subject and description to be edited after creation.
431431
- Tickets are closed rather than deleted when a Finding is removed; tickets already Resolved or Closed are left untouched. A resolution note is attached automatically on closure, so accounts that require one (a common business rule) accept the close.
432432
- Some accounts compute a ticket's priority from an Impact/Urgency matrix or a business rule and ignore the priority sent at creation. DefectDojo detects this and re-applies the mapped priority with a follow-up update, so the mapping still takes effect.
433+
434+
## ServiceDesk Plus
435+
436+
The ManageEngine ServiceDesk Plus Integration allows you to push DefectDojo Findings and Finding Groups as ServiceDesk Plus requests, assigned to a support Group of your choice. Both the **cloud** (ServiceDesk Plus OnDemand) and **on-premises** editions are supported by the same integration - the credentials you provide determine which mode is used.
437+
438+
### Instance Setup
439+
440+
- **Label** should be the label that you want to use to identify this integration.
441+
- **Location** should be set to your ServiceDesk Plus URL: `https://sdpondemand.manageengine.com` for the cloud edition (or your regional equivalent), or your server's address for on-premises installs.
442+
443+
Then provide **one** of the two credential sets:
444+
445+
#### On-premises: Technician Key
446+
447+
- **Technician Key** should be an API key generated for a technician on your server, under **Admin > General Settings > API**. Leave the Zoho OAuth fields empty.
448+
449+
#### Cloud: Zoho OAuth
450+
451+
The cloud edition authenticates through Zoho Accounts OAuth:
452+
453+
1. Open the [Zoho API Console](https://api-console.zoho.com/) and create a **Self Client**.
454+
2. Note the **Client ID** and **Client Secret**.
455+
3. In the Self Client's "Generate Code" tab, enter the scope `SDPOnDemand.requests.ALL`, choose a duration, and generate the code.
456+
4. Exchange the code for a refresh token:
457+
458+
```
459+
curl --request POST \
460+
--url 'https://accounts.zoho.com/oauth/v2/token' \
461+
--data 'grant_type=authorization_code' \
462+
--data 'client_id={{CLIENT_ID}}' \
463+
--data 'client_secret={{CLIENT_SECRET}}' \
464+
--data 'code={{GENERATED_CODE}}'
465+
```
466+
467+
5. Enter the **Client ID**, **Client Secret**, and the returned **Refresh Token** in the instance form. If your account is hosted outside the US data center, set **Token URL** to your regional Zoho Accounts endpoint (for example `https://accounts.zoho.eu/oauth/v2/token`).
468+
469+
### Issue Tracker Mapping
470+
471+
- **Group Name** should be the name of the ServiceDesk Plus support group requests will be assigned to, exactly as it appears under **Admin > Users > Support Groups**.
472+
473+
### Severity Mapping Details
474+
475+
This maps to the ServiceDesk Plus request **Priority** field by name, using your account's priority names:
476+
477+
- **Severity Field Name**: `Priority`
478+
- **Info Mapping**: `Low`
479+
- **Low Mapping**: `Normal`
480+
- **Medium Mapping**: `Medium`
481+
- **High Mapping**: `High`
482+
- **Critical Mapping**: `High`
483+
484+
### Status Mapping Details
485+
486+
This maps to the request **Status** field by name. The defaults use the built-in statuses:
487+
488+
- **Status Field Name**: `Status`
489+
- **Active Mapping**: `Open`
490+
- **Closed Mapping**: `Closed`
491+
- **False Positive Mapping**: `Closed`
492+
- **Risk Accepted Mapping**: `On Hold`
493+
494+
A few ServiceDesk Plus-specific behaviors to be aware of:
495+
496+
- Updates sync the full request content - unlike most trackers, ServiceDesk Plus allows the subject and description to be edited after creation.
497+
- Requests are closed rather than deleted when a Finding is removed; requests already Closed or Resolved are left untouched.
498+
- If your account makes fields mandatory on closure (for example a resolution), a close pushed from DefectDojo may be rejected by those rules and will appear in the Integration errors table.

0 commit comments

Comments
 (0)