Skip to main content

 

  • arrow icon
Language Selector

  1. Other Languages

    (machine translation)

Planview Customer Success Center

Logbook

  1. Last updated
  2. Save as PDF

Overview

Planview Logbook is a shared capability in Planview that enables customers to configure, capture, and report on items relevant to their organization. The Planview Hub connector for Logbook allows bidirectional synchronization of Logbook artifacts (such as Risks, Issues, Decisions, Actions, and custom log types) between Planview Portfolios and external tools like Jira, AgilePlace and other external repositories.

Learn more about Planview Logbook here.

Setup Details

This section describes how to enable Logbook shared capability in Planview Portfolios.

  1. Enable Logbook for Work and Enable Logbook for Strategy via Admin > Global Options > Shared Capabilities

  2. Enable the entity view tab via Admin > Menus and View Settings > Entity View Tabs

Note: Only users with the System Administrator role can enable Logbook shared capabilities in Portfolios.

For more information, refer to Getting started with Logbook. 

Connector Setup Details

This section describes the basic steps needed to prepare your Planview Portfolios Logbook instance for use with Hub. Note that additional fields for synchronization or query configuration may be required depending on your integration's requirements.

Prerequisites

Logbook integration requires separate OAuth2 credentials in addition to the standard Portfolios repository connection. These credentials are used to authenticate with the Logbook API.

Generate OAuth2 Credentials for Logbook

  1. In Planview Admin, go to the OAuth2 credentials tab, click Create OAuth2 credentials
  2. Name credentials and select Logbook Integration in the application dropdown
  3. Click Create — a modal shows the ID and Secret
  4. Copy and store the ID and Secret securely
  5. Click Close

See: OAuth2 Client Credentials

Connecting to Logbook in the Portfolios Repository

In addition to the standard Portfolios repository connection fields, the following Logbook-specific fields must be configured on the repository connection page:

Required Fields

  • Logbook OAuth Token URL: OAuth token URL for Logbook API authentication. Replace <region> with one of the following based on the hosting location of your environment (us, eu, or ap).

  • Logbook Client ID: Client ID for Logbook API authentication
  • Logbook Client Secret: Client Secret for Logbook API authentication

02_Logbook_Hub-20260403-183459.png

Note: Only PVAdmin can generate Logbook OAuth credentials.

For more information, please refer to Logbook REST APIs. 

Supported Features

Special Features Supported

You can learn more about special features in Planview Hub here.

Feature

Custom Type Supported?

Applicable Hub Versions

Applicable Repository Versions

1Not_allowed.svg.png Time Worked (Worklogs)

1Not_allowed.svg.png Impersonation

      

1Not_allowed.svg.png Comments

1Not_allowed.svg.png Impersonation

1Not_allowed.svg.png Public/Private

 

 

 

1Not_allowed.svg.png Attachments

1Not_allowed.svg.png Impersonation

 

 

 

1Not_allowed.svg.png State Transitions

 

 

 
1checkicon.png Affinity Modeling on Log Types    Planview Hub: 26.2 and later

Any supported repository version:

Planview Hub

 

Supported Artifacts

Supported Work Items

Logbook supports both out-of-the-box (OOTB) and custom log types. The artifact types available during collection creation depend on the log types configured in the customer's Logbook instance.

Supported Work Item Type Applicable Hub Versions

Applicable Repository Versions

Unique URL?

All Logbook types (e.g., Risk, Issue, Decision, and all custom types)

 Planview Hub: 26.2 and later

Any supported repository version:

Planview Hub

No

 

 

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.

Standard 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

1checkicon.png String

1checkicon.png

String

Name

 
1checkicon.png Single Select 1checkicon.png

 Single Select

Status, Probability (Risk), Impact (Risk)

  

1checkicon.png Date

1checkicon.png

Date

Due Date

 

1Not_allowed.svg.png Date Time

 1Not_allowed.svg.png

 

 

 

1Not_allowed.svg.png Person

1Not_allowed.svg.png

 

 

 

1Not_allowed.svg.png Persons

 1Not_allowed.svg.png      
1Not_allowed.svg.png Location 1Not_allowed.svg.png      
1checkicon.png Weblinks 1checkicon.png Web Link (URL)

 

  
1checkicon.png Multi-select 1checkicon.png Multi Select

 

  
1Not_allowed.svg.pngBoolean 1Not_allowed.svg.png      

1Not_allowed.svg.pngLong

1Not_allowed.svg.png

 

 

 

1checkicon.png Double

1checkicon.png

Double

 

 
1Not_allowed.svg.png Relationship(s) 1Not_allowed.svg.png      
1checkicon.png Rich Text 1checkicon.png Rich Text Description  

1Not_allowed.svg.png Duration

 1Not_allowed.svg.png      
1Not_allowed.svg.png Attachments 1Not_allowed.svg.png      
1Not_allowed.svg.png Comments 1Not_allowed.svg.png      

 

 

Functional Limitations

Category

Limitation

Applicable Hub Versions

Applicable Repository Versions

Third Party API Limitation

 Person(s), Comments, Attachments and Relationships (Associations) are not supported. Planview Hub: 26.2 and later

Any supported repository version:

Third Party Functional Limitation

Parent Link

The parent artifact link for Logbook items is writable only at creation. Once set, the parent cannot be updated.

 Planview Hub: 26.2 and later

Any supported repository version:
Third Party Functional Limitation

Inactive Log Types

When a log type is made inactive, logs of that type become read-only and cannot be updated. If an update is made in an external repository for the paired artifact, it will cause synchronization errors in Logbook.

 Planview Hub: 26.2 and later

Any supported repository version:
Third Party Functional Limitation

Time Custom Field

The Time field is a special field that requires data in a specific format. Users should enter a maximum of 4 digits with a maximum value of 99h and 59 mins. Exceeding this value will throw Hub errors.

 Planview Hub: 26.2 and later

Any supported repository version:
Third Party Functional Limitation

Archive Field

When a mandatory field is archived, Hub still treats it as required and throws an error indicating that a mandatory field is missing. Before archiving an attribute in Logbook, users should turn off the required toggle.

 Planview Hub: 26.2 and later

Any supported repository version:

Feature Unsupported

Transfer Log

Transfer log will create a new artifact in the external tool. Hub cannot update a log which has already been transferred to another type.

 Planview Hub: 26.2 and later

Any supported repository version:
Good to Know

Logbook artifacts that are directly created in Portfolios are supported. When Portfolios and Projectplace are connected, logbooks created in either application become visible in the other. Logbooks that are created in Projectplace and visible in Portfolios will not synchronize in Hub.

 Planview Hub: 26.2 and later

Any supported repository version:
Good to Know When a system attribute is removed and added back to a Logbook type, the ID of the field changes. If this field is mapped in Hub, the fields must be refreshed and remapped in the collection. Planview Hub: 26.2 and later

Any supported repository version: