Digital.ai Release

Common Integration Patterns

• Providing Release Visibility and Traceability to Product and Dev

Demo Videos

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 the Digital.ai user guide to learn how to create a custom user in Digital.ai Release.

List of minimal user permissions:

• Admin

• Create Release

Connecting to the Digital.ai Release Repository

Standard Authentication

Required Fields: 

• Location/Connection URL 
  • Example Format: https://abc-xl123:4567
• 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.

SSO Authentication

Additionally, Digital.ai supports the following SSO implementations:

• Script (HTTP cookies)
• X.509 Certificate

Learn more about how to set up your repository in Planview Hub here. 

Rich Text

Supported rich text elements are: 

• Headings
• Code
• Paragraph
• List
• Quote
• Anchor
• Emphasis (i.e. italic)
• Strong (i.e. bold)

Full Scan

In general, a full scan is not required to synchronize updates from this repository. However, it is possible that some read-only fields may require a full scan. Please consult with customer care for additional details.

Best Practices for Template Variables

It is important to understand that each Hub collection retrieves its artifact schema (i.e., its list of possible fields and field values) based on the template used in Digital.ai. This has some consequences to be aware of:

• If you do not use a template for your release, you will not be able to synchronize variables (i.e., custom fields) 
  • Also note that releases without a template cannot be created in Digital.ai via API (and thus via Hub). However, existing releases not based on a template can be synchronized out of Digital.ai or be updated within Digital.ai.
• Digital.ai allows you to add or remove custom fields (variables) to a release artifact independently of the template used to create it. This means that if a field (variable) is added to a release that does not exist in its template, Hub will not be able to retrieve that field.
• If a field (variable) is removed from the template but still exists on the release artifact itself, Hub will not be able to retrieve or update that field.
• If a field (variable) is added to a release artifact with the same name as an existing field (variable) on its underlying template, but is of a different field type (for example, your template contains a text variable called “var4”, while your release already has a boolean variable called “var4"), this could cause errors or unintended consequences. We do not recommend that users have duplicate field (variable) names of different field types between release artifacts and their templates.
•  If a field (variable) exists on the underlying template, but not on the release artifact itself and your Hub integration has that field mapped, the field will be added to the artifact in Digital.ai if a value is synchronized to it from a source repository.
• As a general rule, we recommend that users not add variables to individual releases. Rather, new variables should be added to the underlying template. 
• Furthermore, we recommend that if a different set of fields are needed, that users create a new template in Digital.ai and a new collection in Hub for those Digital.ai releases.

Special Features Supported

Supported Work Items

Learn about the difference between containers and work items in Planview Hub here. 

Supported Containers

Learn more about containment in Planview Hub here.