Skip to main content
Planview Customer Success Center

Cherwell Service Management

Overview

Cherwell Service Management is an ITSM tool that enables organizations to implement, automate, and modernize service and support their IT service delivery processes. Cherwell Service Management is a flexible and scalable solution for organizations to provide faster and more efficient services, improving customer satisfaction.

By synchronizing Cherwell Service Management with Planview Hub, practitioners can collaborate on artifacts each from within their tool of choice, with data and handoffs flowing seamlessly between them.

For example:

  • Support uses an ITSM tool such as Cherwell Service Management to report any issues/defects.
  • Planview Hub mirrors the Task or Incident to a PPM tool such as Planview PPM Pro where it will be prioritized and developed.  
  • If the development team requires more information about the problem, the teams can easily transfer additional information back and forth.
  • Fixed defects are updated, and the resolution is communicated back to the support team.

Key Features and Benefits

  • Synchronizes artifacts across the lifecycle, allowing information to flow freely between Cherwell Service Management and other tools.
  • Improves quality of IT services by closely integrating support with other teams.
  • Transforms customer support and issue/defect management into a seamless and integrated process.
  • Ensures changes in Cherwell Service Management are instantly recorded in the development teams’ tool of choice. 

Connector Setup Details

Minimal User Permissions & Hub User 

We recommend that you create a new user within your external tool, to be used only for your Hub integration. This is the user information you will enter when setting up your repository connection within Planview Hub. By creating a new user, you will ensure that the correct permissions are granted, and allow for traceability of the modifications that are made by the synchronization. 

In general, your user account should have sufficient permissions to create, read, and update artifacts in your repository. However, depending on the use case, your user may need different permissions. For example, if you are only interested in flowing data out of your repository, your user may not need to have full CRUD access, as the 'create' and 'update' permissions may not be needed.

The user must be a member of member of a security group with the same privileges to use the REST API:
To create, view, update, and delete objects in the repository, you must have the relevant privileges for those actions in addition to the API-specific roles. User must be assign to particular security group which have the access that needs to be performed. The access can be given by Administrator to other security group as well. You can restrict operations like incident reporting etc as well. Refer to CSM Documentation Archive and visit Administration for supported version for more details.

Connecting to Cherwell Service Management

Standard Authentication

Required Fields:

Person Reconciliation

Fields Used for Hub’s Default Person Reconciliation Algorithm

Field Names for Person Reconciliation Extensions

(Note that these are case sensitive)

Label in Cherwell Service Management

ID

person-id

User Record ID

Username

person-username

User Display Name

Email

person-email

User Email

N/A

person-display-name

User Public ID

N/A

person-first-name

User First Name

N/A

person-last-name

User Last Name

N/A

person-full-name

User Full Name

Special Features Supported

Feature

Applicable Hub Versions 

Applicable Repository Versions

Not_allowed.svg.png Time Worked (Worklogs)

   

Not_allowed.svg.png Comments

 

 

Not_allowed.svg.png Attachments

 

 

Not_allowed.svg.png State Transitions

 

 

Not_allowed.svg.png Requirements Ordering

 

 

Supported Work Item Types

Supported Work Item Type

Applicable Hub Versions

Applicable Repository Versions

Unique URL

Task

Planview Hub: 24.1.0 and later

Any supported repository version:

No

Incident (Service Request)

Planview Hub: 24.1.0 and later

Any supported repository version

No

Supported Field Types

Field Type

Does Hub support custom fields of this type?

How is the field type referenced in the repository?

Sample Repository Fields Supported

Particular Repository Fields Not Supported

checkicon.png  String

checkicon.png 

Text

Title

 

checkicon.png  Single-select

checkicon.png 

Text (Validated)

Close Code, Type

 

Not_allowed.svg.png  Multi-select

Not_allowed.svg.png

 

 

checkicon.png  Boolean

checkicon.png 

Text (Validated)

Close Code, Type

 

checkicon.png  Single-select

checkicon.png 

Logical

Approval Needed

 

checkicon.png  Date

checkicon.png 

Date

Due Date

 

checkicon.png  Date Time

checkicon.png 

Date/Time

Due Date

 

Not_allowed.svg.png  Duration

Not_allowed.svg.png

 

 

 

checkicon.png  Double

checkicon.png 

Number (Decimal)

Cost

 

checkicon.png  Long

checkicon.png 

Number

Max Completion Time in Minutes

 

checkicon.png Person

:warning: See Functional Limitations

Text (Validated)

Assigned to ID, Owned by ID

 

Not_allowed.svg.png  Persons

Not_allowed.svg.png

 

 

 

:warning:  Relationship(s) Limited writable support

Not_allowed.svg.png

Relationship

Text Owned by Incident, Task Links the Dependent Task, Incident Owns Tasks, Major Incident links Similar

Read-only Support for remaining fields

:warning:  Rich Text Supported only as plain-text strings

Not_allowed.svg.png

 

Text (Rich Text)

Description

 

Not_allowed.svg.png  Location

Not_allowed.svg.png

 

 

 

Not_allowed.svg.png  Web Links

Not_allowed.svg.png

 

 

 

Supported Containers

Containers that can synchronize between repositories

Applicable Hub Versions

Applicable Repository Versions

Unique URL?

N/A

     

Containers used to define the boundary of a collection

 

 

 

N/A

     

Containers used for artifact routing

 

 

 

N/A

     

Functional Limitations

Category

Limitation

Applicable Hub Versions

Applicable Repository Versions

Third Party API Limitation

Text Fields

Cherwell's REST API does not preserve the escaping of special characters such as "&" These will be automatically converted to their unescaped format such as "&".

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Text Fields

Cherwell's REST API does not preserve the escaping of special characters such as "&" These will be automatically converted to their unescaped format such as "&".

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Single Select Fields

Dependencies between fields are not properly expressed through the Cherwell REST API. Therefore, some single-select fields will not be presented with options by the connector.

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Custom Person Fields

Cherwell's API does not distinguish between single-select fields and person fields. Custom person fields will displayed by the connector as single-select fields.

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Empty Values

For some field types, the Cherwell REST API does not support setting an empty or null value after the field has been set. In some cases, the field may always have a non-empty value to begin with. This appears to be a limitation on most numeric and boolean fields.

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Negative Double Values

Double fields will sometimes return invalid values for negative values. If the number of integral digits is the maximum allowed for the field in Cherwell, the server will cut off one digit of the field's value when the value is negative. A support request has been created with Cherwell: Support Incident 594967

Planview Hub: 24.1.0 and later

Any supported repository version:

Third Party API Limitation

Artifact Linking

Due to limitations in the API for relationships Cherwell, the connector can support writing to only a limited set of Relationship fields. Currently these include "Task Owned by Incident" and "Task Links the Dependent Task" on Tasks, and "Incident Owns Tasks" and "Major Incident links Similar" on Incidents.

Planview Hub: 24.1.0 and later

Any supported repository version:

Configuration Requirement

Task Owned by Incident

When linking a parent Incident to a Task, Cherwell may require that the "Depends on Title" field on the Task is set to the title of the linked Incident, or it will not allow linking to the Incident. We recommend turning off validation of the "Depends on Title" field on Tasks, otherwise users need to map both the "Depends on Title" field and the "Task Owned by Incident" fields.

Planview Hub: 24.1.0 and later

Any supported repository version: