Hub Planner
On This Page
Hub Planner is a cloud-based project and resource management platform that allows businesses to manage their projects. It enables you to allocate resources to projects according to their availability, set budgets, calculate spends, and generate insights and reports for these projects.
You can replicate the data from your Hub Planner account to a Destination database or data warehouse using Hevo Pipelines. Hub Planner uses an API key to identify Hevo and authorize the request for accessing account data. Hevo ingests the data in Full Load mode. Refer to section, Data Model for the list of supported objects.
Prerequisites
-
An active Hub Planner account from which data is to be ingested exists.
-
The API key is available to authenticate Hevo on your Hub Planner account.
-
You are logged in as an Account Owner to obtain the API key. Else, you can obtain it from your account administrator.
-
You are assigned the Team Administrator, Team Collaborator, or Pipeline Administrator role in Hevo to create the Pipeline.
Obtaining the API Key
The API keys you generate in Hub Planner do not expire. Therefore, you can use an existing token or create a new one to authenticate Hevo on your Hub Planner account.
Note: You must log in as an Account Owner to perform these steps.
To obtain the API key:
-
Log in to your Hub Planner account.
-
In the top right corner of the page, click Settings.
-
In the left navigation pane, under Integrations, click Hub Planner API.
-
In the Hub Planner API page, click Enable API.
-
Under the API Key Generator section, click Generate Key.
-
Copy the API key and save it securely like any other password. Use this key while configuring your Hevo Pipeline.
Configuring Hub Planner as a Source
Perform the following steps to configure Hub Planner as the Source in your Pipeline:
-
Click PIPELINES in the Navigation Bar.
-
Click + CREATE PIPELINE in the Pipelines List View.
-
In the Select Source Type page, select Hub Planner.
-
In the Configure your Hub Planner Source page, specify the following:
-
Pipeline Name: A unique name for the Pipeline, not exceeding 255 characters.
-
API Key: The API key that you obtained from your Hub Planner account.
-
-
Click TEST & CONTINUE.
-
Proceed to configure the data ingestion and setting up the Destination.
Data Replication
| For Teams Created | Default Ingestion Frequency | Minimum Ingestion Frequency | Maximum Ingestion Frequency | Custom Frequency Range (in Hrs) |
|---|---|---|---|---|
| Before Release 2.21 | 1 Hr | 1 Hr | 24 Hrs | 1-24 |
| After Release 2.21 | 6 Hrs | 30 Mins | 24 Hrs | 1-24 |
Note: The custom frequency must be set in hours as an integer value. For example, 1, 2, or 3 but not 1.5 or 1.75.
Hevo ingests all the objects in Full Load mode in each run of the Pipeline.
Schema and Primary Keys
Hevo uses the following schema to upload the records in the Destination database:
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| Billing Rates | Contains details of the compensation rates that you define for different roles of a resource or project in your organization. |
| Booking Categories | Contains details of the categories used to classify projects and resources in your Hub Planner scheduler. |
| Bookings | Contains details of the time interval for which resources are allocated to a project. |
| Clients | Contains details of the customers in your Hub Planner account. |
| Events | Contains details of the activities for which a time interval has been allocated in your Hub Planner scheduler. For example, sick leave and vacation. |
| Project Groups | Contains the list of all the groups created for the different projects by owners of your Hub Planner account. |
| Project Managers | Contains details of the users responsible for handling the project. |
| Project Tags | Contains details of the tags that can be assigned to projects. |
| Projects | Contains details of the tasks associated with a client along with the managers, resources, budgets assigned to that task. |
| Public Holidays | Contains details of the days for which the reporting hours for countries and resources is zero. |
| Resource Tags | Contains details about the tags assigned to resources. |
| Resources | Contains details of all the users that have access to the Hub Planner account. |
| Timesheets | Contains details of the time spent by teams on projects. |
| Unassigned Work | Contains details of the work that has not been assigned any resources yet. |
| Vacations | Contains details of the leaves that resources can request apart from the public holidays. |
Additional Information
Read the detailed Hevo documentation for the following related topics:
Source Considerations
-
Pagination: Each API response for a Hub Planner object fetches one page with up to 1000 records.
-
Rate Limit: Hub Planner imposes a limit of 50 API calls per five seconds. If the limit is exceeded, Hevo defers the ingestion till the limits reset. Read API Limits to configure a suitable ingestion frequency for your Pipeline.
-
To ingest data from the Timesheets and Unassigned Work objects, you must add the respective extensions to your Hub Planner account.
Limitations
-
Hevo currently does not support deletes. Therefore, any data deleted in the Source may continue to exist in the Destination.
-
You cannot specify a duration for loading the historical data. Hevo loads the entire data present in your Hub Planner account.
Revision History
Refer to the following table for the list of key updates made to this page:
| Date | Release | Description of Change |
|---|---|---|
| Mar-05-2024 | 2.21 | Updated the ingestion frequency table in the Data Replication section. |
| Jan-23-2023 | 2.06 | New document. |