Planview AdaptiveWork
Overview
Planview AdaptiveWork (formerly Clarizen) is a PPM tool that enables project managers and delivery teams to collaborate, share ideas, and execute on what is important. Connect disconnected teams to maximize project outcomes, and engage your workforce across the organization. By connecting AdaptiveWork to other tools in the Planview Hub portfolio, PMO’s can gain visibility and streamline communication between all teams within the software development lifecycle. Reduce overhead and manage workflows by integrating AdaptiveWork with Hub.
Key Features and Benefits
-
Synchronizes artifacts across the lifecycle, allowing information to flow freely between AdaptiveWork and other tools
-
Improves collaboration between the PMO, development, test, the service desk and more
-
Provides visibility to PMO office of the status of ongoing projects
-
Supports cross-tool traceability and reporting, removing the need for manual processes and spreadsheets
Connector Setup Details
This section describes the basic steps needed to prepare your AdaptiveWork instance for use with Hub. Note that additional fields for synchronization or configuration of queries may be required depending on the requirements of your integration.
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.
Your user should have a secure password or token. Please be aware that Hub will not allow you to save a repository connection utilizing a weak password/token, such as 'tasktop.'
See instructions on how to add a custom user in AdaptiveWork.
List of minimal permissions:
-
The Hub User needs to have the Integration User permission checked. This can be configured on the People screen by the admin user.
-
The Hub User needs to have the Financial permission checked. This can be configured on the People screen by the admin user.
-
The Hub User needs to have the Super User permission checked. This can be configured on the People screen by the admin user.
-
The Hub User should have Admin permissions checked. This can be configured on the People screen by the admin user.
Connecting to the AdaptiveWork Repository
Standard Authentication
Required Fields:
-
Location/Connection URL: The API base URL for your instance
-
Example Format: https://api.clarizen.com/
-
-
Username
-
Password
Optional Fields:
- Throttling Settings: This field indicates the number of API calls that can be made per minute. See details here.
- Note: This field should only be set under the guidance of customer care as the ideal value is highly dependent on each customer's unique environment.
- Connection Security: If checked, insecure connections to this repository will be allowed. See details here.
- Timesheet Hours per Day: This field indicates the number of hours per day in the AdaptiveWork organization calendar and is required when synchronizing Timesheets. See details here.
- Note: If this field is empty, Timesheets will not be retrieved when flowing data out of the repository, but can still be created when flowing data into the repository.
API Key Authentication (Recommended)
Required Fields:
-
URL: The API base URL for your instance
-
Example Format: https://api.clarizen.com/
-
-
API Key
-
See more details here
-
Optional Fields:
- Throttling Settings: This field indicates the number of API calls that can be made per minute. See details here.
- Note: This field should only be set under the guidance of customer care as the ideal value is highly dependent on each customer's unique environment.
- Connection Security: If checked, insecure connections to this repository will be allowed. See details here.
- Timesheet Hours per Day: This field indicates the number of hours per day in the AdaptiveWork organization calendar and is required when synchronizing Timesheets. See details here.
OAuth 2.0 Client Credentials Proxy Authentication
Planview Hub: 24.4 and later
This authentication method enables secure, token-based access via a proxy, using client credentials. Refer here for full details.
Note: AdaptiveWork does not currently support OAuth 2.0 Client Credentials authentication. As a result, the AdaptiveWork connector does not allow connecting directly with the AdaptiveWork repository using the OAuth 2.0 Client Credentials authentication method.
Learn more about how to set up your repository in Planview Hub here.
Other Configuration Settings
Person Reconciliation
For person reconciliation, the following fields are available:
|
Fields Used for Hub’s Default Person Reconciliation Algorithm |
Field Names for Person Reconciliation Extensions (Note that these are case sensitive) |
Label in AdaptiveWork |
|---|---|---|
|
ID |
ExternalID |
External ID |
|
|
|
|
|
N/A |
DisplayName |
Name |
|
N/A |
FirstName |
First Name |
|
N/A |
LastName |
Last Name |
|
N/A |
UserName |
User Name |
Learn more about how to configure person reconciliation in Planview Hub here.
Query Language
To further refine artifacts in a collection, Planview Hub offers query language support for a limited set of AdaptiveWork fields.
The following field types are supported:
Equal/Not Equal operator
-
String
-
URI
-
Rich Text
-
Multi-Select
-
Boolean
-
Single Select
-
Person
-
Date
-
Long
-
Double
Contains operator
-
String
-
URI
-
Rich Text
-
Multi-Select
Greater Than/Less Than operator
-
Date
-
Long
-
Double
Note: The following standard fields are not supported: Image URL, RTCPI, TCPI, Holding Notes, Closing Notes, Attachments, Comments, Timesheets.
Supported Features
Special Features Supported
|
Feature |
Applicable Hub Version |
Applicable Repository Versions |
|---|---|---|
|
|
Planview Hub: 22.4 and later |
Any supported repository version: |
|
|
Planview Hub: 22.3 and later |
Any supported repository version: |
|
|
Planview Hub: 22.4 and later |
Any supported repository version: |
|
|
Planview Hub: 22.2 and later |
Any supported repository version: |
|
|
Planview Hub: 22.1 and later |
Any supported repository version: |
Time Worked (Worklogs)
Supported Artifact Types
Learn about the difference between containers and work items in Planview Hub here.
Supported Work Items
|
Supported Work Item Type |
Applicable Hub Versions |
Applicable Repository Versions |
Unique URL? |
|---|---|---|---|
|
Task |
Planview Hub: 22.1 and later |
Any supported repository version: |
Yes |
|
Milestone |
Planview Hub: 22.1 and later |
Any supported repository version: |
Yes |
|
Project |
Planview Hub: 22.1 and later |
Any supported repository version: |
Yes |
|
Program |
Planview Hub: 22.1 and later |
Any supported repository version: |
Yes |
Supported Containers
Learn more about containment in Planview Hub here.
|
Containers that can synchronize between repositories |
Applicable Hub Versions |
Applicable Repository Versions |
Unique URL? |
|---|---|---|---|
|
Program Note: Beginning in Hub version 22.4, containers can be treated as work items. Learn more here. |
Planview Hub: 22.1.4 and later |
Any supported repository version: |
Yes |
|
Project Note: Beginning in Hub version 22.4, containers can be treated as work items. Learn more here. |
Planview Hub: 22.1.4 and later |
Any supported repository version: |
Yes |
|
Containers used to define the boundary of a collection (when clicking 'Manage Projects' on a collection) |
|
|
|
|
N/A |
Planview Hub: 22.1 and later |
Any supported repository version: |
|
|
Containers used for artifact routing |
|
|
|
|
Program |
Planview Hub: 22.1.4 and later |
Any supported repository version: |
Yes |
|
Project |
Planview Hub: 22.1.4 and later |
Any supported repository version: |
Yes |
Supported Field Types
Note: If one field of a given type is supported, others that are also that type in theory should also work. However, sometimes there are instances in which this is not the case due to the repository. So, while we can claim support for fields at the type level, there is a chance that some specific fields of a given type will not synchronize properly.
|
Field Type |
Does Hub support custom fields of this type? |
How is field type referenced in the repository? |
Sample Repository Fields Supported |
Particular Repository Fields NOT Supported |
|---|---|---|---|---|
|
|
|
Text |
Name ID |
|
|
|
|
Pick List |
State Phase |
|
|
|
|
Multi-Select Pick List |
Custom Multi-Select |
|
|
|
|
Toggle |
Reportable Deliverable |
|
|
|
N/A |
Date |
Actual Start Date Actual End Date |
|
|
|
|
N/A |
Created On Custom Date |
|
|
|
|
|
|
|
|
|
|
Numeric |
% Complete % Invested |
Currency |
|
|
|
Numeric |
Financial End Financial Start |
|
|
|
N/A |
User |
Created By Last Updated By |
|
|
|
|
|
|
|
|
Learn how to configure relationships in Planview Hub here. |
|
Reference to Object |
Parent Custom Milestone Link |
|
|
|
|
Text Area Rich Text Area |
Overview Custom Rich Text |
|
|
|
|
URL |
Link to Clarizen Go Custom URL |
|
|
|
|
|
|
|
|
|
Functional Limitations
|
Category |
Limitation |
Applicable Hub Version |
Applicable Repository Version |
|---|---|---|---|
| Good to Know |
Calculated Fields Date type fields that contain errors cannot flow out of AdaptiveWork. Instead, an empty field value will be synchronized and an error will appear in the logs. |
Planview Hub: 24.3 and later |
Any supported repository version: |
|
Good to Know |
No Parent Option The 'No Parent' option is no longer available. |
Planview Hub: 23.2 and later |
Any supported repository version: |
|
Good to Know |
Ancestor Program The Ancestor Program is optional for Projects, Tasks, and Milestones. |
Planview Hub: 23.2 and later |
Any supported repository version: |
|
Good to Know |
Projects and Tasks Projects and Tasks can be created without a parent. |
Planview Hub: 23.2 and later |
Any supported repository version: |
|
Good to Know |
Calculated Fields Fields that are meant to perform numeric calculations which contain errors are unable to flow out of AdaptiveWork. Instead, an empty field value will be synchronized and an error will appear in the logs. |
Planview Hub: 22.4.14 and later |
Any supported repository version: |
|
Third Party API Limitation |
Timesheets To avoid errors that prevent Timesheets from being updated, Super User permissions may be required. |
Planview Hub: 22.3 and later |
Any supported repository version: |
|
Configuration Requirement |
Tasks and Milestones If using an AdaptiveWork collection in a Work Item Synchronization and the other repository does not support containers, the Parent Artifact relationship field should be mapped. This will ensure that the artifact hierarchy is preserved. |
Planview Hub: 22.1.5 and later |
Any supported repository version: |
|
Good to Know |
Milestones For Milestones that do not have a Program ancestor, the "No Parent" Program container represents the empty Program when configuring Artifact Routing or Container Mirroring. |
Planview Hub: 22.1.5 and later |
Any supported repository version: |
|
Good to Know |
Tasks For Tasks that don't have a parent, the "No Parent" Program container represents the empty Program and the "No Parent" Project under the empty Program represents the empty Project when configuring Artifact Routing or Container Mirroring. This configuration may be required when creating Tasks at the root of the repository. |
Planview Hub: 22.1.5 and later |
Any supported repository version: |
|
Configuration Requirement |
Projects When configuring a Container integration for Projects, container matching must be set to “Do not match the containers." |
Planview Hub: 22.1.5 and later |
Any supported repository version: |
|
Configuration Requirement |
Projects Projects synchronized into AdaptiveWork must have a program at the top of the ancestor chain. |
Planview Hub: 22.1.4 and later |
Any supported repository version: |
|
Third Party API Limitation |
Person Fields Person Fields are only supported for fields that have the object type “User” as a reference entity. Parent types (like “Groups And Users” (ResourceEntity) and “Users and Resources” (GenericResourceEntity) are not supported, and will not appear in the artifact schema. |
Planview Hub: 22.1 and later |
Any supported repository version: |
|
Good to Know |
Value With Label Fields (Single Select Fields) For fields with dependencies, the options listed will always be all possible options for all dependent field values. There is no limiting of options to the values possible given a dependent field value, so the connector will not validate if options set are correct/possible. |
Planview Hub: 22.1 and later |
Any supported repository version: |
|
Good to Know |
Artifact Link Fields Link fields which link exclusively to a supported artifact type are supported. Additionally, the parent field is supported on all types. |
Planview Hub: 22.1 and later |
Any supported repository version: |