ServiceDesk Plus (Pro)
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.
Instance Setup
- Label should be the label that you want to use to identify this integration.
- Location should be set to your ServiceDesk Plus URL:
https://sdpondemand.manageengine.comfor the cloud edition (or your regional equivalent), or your server’s address for on-premises installs.
Then provide one of the two credential sets:
On-premises: Technician Key
- 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.
Cloud: Zoho OAuth
The cloud edition authenticates through Zoho Accounts OAuth:
- Open the Zoho API Console and create a Self Client.
- Note the Client ID and Client Secret.
- In the Self Client’s “Generate Code” tab, enter the scope
SDPOnDemand.requests.ALL, choose a duration, and generate the code. - Exchange the code for a refresh token:
curl --request POST \
--url 'https://accounts.zoho.com/oauth/v2/token' \
--data 'grant_type=authorization_code' \
--data 'client_id={{CLIENT_ID}}' \
--data 'client_secret={{CLIENT_SECRET}}' \
--data 'code={{GENERATED_CODE}}'- 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).
Issue Tracker Mapping
- 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.
Severity Mapping Details
This maps to the ServiceDesk Plus request Priority field by name, using your account’s priority names:
- Severity Field Name:
Priority - Info Mapping:
Low - Low Mapping:
Normal - Medium Mapping:
Medium - High Mapping:
High - Critical Mapping:
High
Status Mapping Details
This maps to the request Status field by name. The defaults use the built-in statuses:
- Status Field Name:
Status - Active Mapping:
Open - Closed Mapping:
Closed - False Positive Mapping:
Closed - Risk Accepted Mapping:
On Hold
Custom Fields (optional)
Use the mapping’s Custom Fields step to send fields beyond the subject, description, priority, status and group. This is how you set a Requester when your ServiceDesk Plus account makes it mandatory. Each custom-field mapping has a Source (an attribute of the Finding, Test, Engagement or Asset being pushed, or a Static value), a Value, and a Vendor Field, which is the ServiceDesk Plus field name.
DefectDojo sends each value in the shape the ServiceDesk Plus API expects for that field:
| Vendor Field | Sent as | Example |
|---|---|---|
requester, technician, category, subcategory, item, site, impact, urgency, level, mode, request_type, service_category, template | a reference by name | requester with the static value Security Bot |
<field>.<attribute> | a reference by that attribute | requester.email_id with the static value security-bot@example.com |
a name starting with udf_ | a user-defined field | udf_sline_301 |
| anything else | plain text | email_ids_to_notify |
A user-defined field’s name (such as udf_sline_301) is the key ServiceDesk Plus shows for it under udf_fields when you read a request through its API.
Apply On decides when a mapping is sent: Creation (the default) or Update. ServiceDesk Plus does not use the transition options; status changes travel with the update. The fields DefectDojo already sends always take precedence: a custom mapping cannot replace the subject, the description or the request ID, or a priority, status or group set by the other mapping steps.
Ticket Template (optional)
Attach a Ticket Template in the mapping’s Ticket Template step to replace the built-in request subject and description, for Findings, Finding Groups or both. The template’s summary becomes the request subject, shortened to 250 characters, and its description becomes the request description. A part the template leaves blank uses the built-in content: the Finding title or Finding Group name for the subject. If a template fails to render, the request is sent with the built-in subject or description instead, and the failure is listed under Errors.
To give every mapping on a connector the same template, set Default Ticket Template on the connector itself (Edit Connector in the connector’s menu). A mapping with no template of its own uses the connector’s default, and a mapping that has its own template uses only that one: a part left blank in the mapping’s template is the built-in content, not the connector default’s part. If the default template is deleted, the connector goes back to the built-in content.
A few ServiceDesk Plus-specific behaviors to be aware of:
- Updates sync the full request content - unlike most trackers, ServiceDesk Plus allows the subject and description to be edited after creation.
- Requests are closed rather than deleted when a Finding is removed; requests already Closed or Resolved are left untouched.
- 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.
- If ServiceDesk Plus rejects a request because a mandatory field is missing, the Integration errors table names the field, for example
Please fill the mandatory fields (fields requester). Add that field under Custom Fields.