https://github.com/activeviam/pivot-spring-boot
Template for running ActivePivot as a Spring Boot application
https://github.com/activeviam/pivot-spring-boot
Last synced: about 1 year ago
JSON representation
Template for running ActivePivot as a Spring Boot application
- Host: GitHub
- URL: https://github.com/activeviam/pivot-spring-boot
- Owner: activeviam
- License: apache-2.0
- Archived: true
- Created: 2019-02-17T11:57:42.000Z (over 7 years ago)
- Default Branch: 6.1.0
- Last Pushed: 2024-10-14T15:09:57.000Z (over 1 year ago)
- Last Synced: 2025-03-04T03:29:31.317Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 21.2 MB
- Stars: 13
- Watchers: 25
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Pivot Spring Boot
A minimalist ActivePivot project built with Spring Boot for you to edit, customize and use as a base for your ActivePivot projects.
---
## ❗❗❗ IMPORTANT ❗❗❗
From now on use [https://github.com/activeviam/atoti-spring-boot-template](https://github.com/activeviam/atoti-spring-boot-template) instead of this repository.
## 📋 Details
This project aims to be an example of how to run ActivePivot as a [Spring Boot](https://spring.io/guides/gs/spring-boot)
application. ActivePivot was already a *Spring* application, but with the power of *Spring Boot* we can simplify our
dependency management, deployment model, and many other goodies that come with Spring Boot.
This project is a starting point for your own projects and implementations. You should be able to take this, customize
it and get a cube up and running in a few minutes.
## 📦 Installation
#### Requirements
- Java 21
- Maven 3
- ActivePivot jar files (commercial software)
- Running the application requires a license for the ActivePivot software.
Clone or download this repository and run `mvn clean install`. This will generate a jar file, which can be run using
standard java commands.
**Note:** If your build is unsuccessful, try skipping tests: `mvn clean install -DskipTests`
## 💻 Usage
### Running the fat jar
The project contains, out of the box, an extremely simple datastore schema and small `trades.csv` file. You can find
this file in `src/main/resources/data`.
### Running on macOS
Add the following
argument `-Dactiveviam.chunkAllocatorClass=com.qfs.chunk.direct.allocator.impl.MmapDirectChunkAllocator` to your JVM, so
it then becomes:
```bash
java -Dactiveviam.chunkAllocatorClass=com.qfs.chunk.direct.allocator.impl.MmapDirectChunkAllocator -Dfile.trades= -jar
```
**Note:** If unable to start the ActivePivot Spring Boot application, you may need to add some additional arguments as
well, try the following:
```bash
java --add-opens java.base/java.util.concurrent=ALL-UNNAMED --add-opens java.base/java.net=ALL-UNNAMED -Dactiveviam.chunkAllocatorClass=com.qfs.chunk.direct.allocator.impl.MmapDirectChunkAllocator -Dfile.trades= -jar
```
### Connecting to the ActivePivot
- Excel: you can connect to the cube from Excel, by connecting to an 'Analysis Services' source. The default URL to use
when running locally is `http://localhost:9090/xmla`
- ActiveUI, ActiveViam's user interface for exploring the cube, will be available from `http://localhost:9090/ui`
- List of REST endpoints provided can be found at `http://localhost:9090/activeviam/swagger-ui/index.html`
The default security credentials are `admin:admin`, but can be modified in the `SecurityConfig` class (we use Spring
Security). You should change this before going into production.
It is also recommended that you change the JWT key pair in `application.yaml` by running the class `JwtUtil` and
generating a new key pair.