# GP Joule

### GP Joule User Manual

#### Introduction

> The GP Joule App provides integration and synchronization between BuildingPro Suites and GP Joule services.

#### Overview

This manual provides instructions for configuring, installing, and using the GP Joule App to manage resources and synchronize data between BuildingPro Suites and GP Joule services.

#### Installation

Install the GP Joule App via the BuildingPro Suites App Store.

#### Configuration

The GP Joule App requires configuration via the BuildingPro Suites settings. The following are the general steps and details required to effectively configure the app.

#### Registering the App with the GP Joule Service

Create credentials in the GP Joule service to connect the GP Joule services from BuildingPro Suites. All required credentials are listed below in the configuration section.

Please contact GP Joule to obtain the URL for API access and your access key.

#### Configuring the GP Joule App

Configurations can be created in BuildingPro Suites under `Apps > GP Joule > Settings`, which opens the app's [Generic User Interface](https://doc.eliona.io/collection/v/eliona-english/manuals/settings/apps). Here you can use the appropriate endpoint with the POST method. Each configuration requires the following data:

| Attribute         | Description                                                |
| ----------------- | ---------------------------------------------------------- |
| `rootUrl`         | URL of the GP Joule API services.                          |
| `apiKey`          | Client secrets received from the GP Joule service.         |
| `assetFilter`     | Filtering of assets during Continuous Asset Creation.      |
| `enable`          | Flag to activate or deactivate this configuration.         |
| `refreshInterval` | Interval in seconds for data synchronization.              |
| `requestTimeout`  | Timeout for API requests in seconds.                       |
| `tenantIDs`       | List of BuildingPro Suites Tenant IDs for data collection. |

Example configuration JSON:

```json
{
  "rootUrl": "[http://gpjoule.api.url/](http://gpjoule.api.url/)",
  "apiKey": "s3cr3t",
  "enable": true,
  "refreshInterval": 60,
  "requestTimeout": 120,
  "tenantIDs": [
    "10"
  ]
}
```

### Continuous Asset Creation

Once configured, the app starts Continuous Asset Creation (CAC). Discovered resources are automatically created as assets in BuildingPro Suites, and users are informed via the BuildingPro Suites notification system.

The GP Joule infrastructure is managed via the charging point asset, which groups all charging points by their cluster name. Each charging point can have one or more connections, each with its own charging properties.

In addition, a session log asset is created for each connection, which provides historical records of all charging sessions.

### Additional Features

#### Dashboard Templates

The app offers a predefined dashboard that clearly displays the most important information. You can create such a dashboard under `Dashboards > Copy Dashboard > From App > GP Joule`.
