W Kreatorze BI możesz korzystać z zewnętrznych baz danych MySQL, PostgreSQL i ClickHouse. To przydatne, jeśli przechowujesz część danych poza Bitrix24: w sklepie internetowym, systemie wewnętrznym lub innej firmowej bazie danych.
Na przykład firma przechowuje zamówienia w bazie PostgreSQL. Po podłączeniu bazy do Kreatora BI możesz wybrać tabelę sprzedaży i utworzyć zestaw danych. Następnie możesz zbudować wykres łącznej wartości zamówień. Dzięki temu przełożony zobaczy zmiany sprzedaży i dane z Bitrix24 w jednym raporcie.
Z tego artykułu dowiesz się, jak:
Jak przygotować się do podłączenia bazy danych
Przejdź do sekcji Kreator BI > Centrum analityczne > Połączenia > Utwórz i wybierz MySQL, PostgreSQL lub ClickHouse.
Dalsze kroki zależą od wersji Bitrix24.
Bitrix24 w chmurze. Zewnętrzną bazę danych podłączysz za pomocą aplikacji serwerowej. Najpierw skonfiguruj aplikację zgodnie z instrukcją, a następnie wróć do tworzenia połączenia.
Aplikacja połączy Bitrix24 z bazą danych. Odbierze zapytanie, połączy się z bazą MySQL, PostgreSQL lub ClickHouse, a następnie odczyta listę tabel i strukturę pól. Na koniec przekaże dane do Kreatora BI.
Serwerowa aplikacja lokalna bez interfejsu użytkownika
Aby skonfigurować aplikację, przygotuj:
- Serwer — komputer lub maszynę wirtualną, na której będzie działać aplikacja i będą przechowywane jej pliki. Możesz użyć firmowego serwera wirtualnego lub osobnego serwera we własnej infrastrukturze.
- Docker i Docker Compose — zainstaluj je na serwerze, aby uruchomić aplikację w kontenerze. Docker tworzy izolowane środowisko dla aplikacji, a Docker Compose pozwala uruchomić ją z odpowiednimi ustawieniami. Zapoznaj się z dokumentacją Dockera i zainstaluj wersję dla swojego systemu operacyjnego:
Instalacja Docker Desktop w systemie Windows
Instalacja Docker Desktop w systemie Linux
Instalacja Docker Desktop w systemie macOS - Pliki potrzebne do zbudowania aplikacji serwerowej. Pobierz je z repozytorium i prześlij na serwer.
Bitrix24 BI Connector Extension - Dostęp do zewnętrznej bazy MySQL, PostgreSQL lub ClickHouse — aplikacja potrzebuje go, aby połączyć się z bazą i odczytać dane. Przygotuj adres, port i nazwę bazy oraz nazwę i hasło użytkownika z uprawnieniami do odczytu tabel.
- Publiczny adres HTTPS aplikacji serwerowej — Bitrix24 potrzebuje go, aby połączyć się z aplikacją. Adres
localhostnie będzie odpowiedni, ponieważ wskazuje środowisko, z którego nawiązywane jest połączenie. Użyj publicznego adresu, na przykładhttps://bi-connector.example.com.
Bitrix24 On-Premise. Nie musisz konfigurować aplikacji serwerowej. Po wybraniu MySQL, PostgreSQL lub ClickHouse możesz od razu podać parametry połączenia i korzystać z bazy danych. Przed konfiguracją przygotuj adres, port i nazwę bazy oraz nazwę i hasło użytkownika. Upewnij się, że serwer Bitrix24 ma dostęp do bazy przez sieć.
Sprawdź nazwy tabel i pól w zewnętrznej bazie MySQL lub PostgreSQL. Muszą spełniać następujące wymagania:
- Nazwy tabel muszą zaczynać się od małej litery łacińskiej. Mogą zawierać tylko małe litery łacińskie, cyfry i podkreślenia. Na przykład:
users,order_items,customer_data_2024. - Nazwy pól muszą zaczynać się od wielkiej litery łacińskiej. Mogą zawierać tylko wielkie litery łacińskie, cyfry i podkreślenia. Na przykład:
ID,USER_ID,ORDER_DATE.
Jak zainstalować aplikację na serwerze
Aplikacja serwerowa łączy Bitrix24 z zewnętrzną bazą danych. Wykonuje cztery działania:
- Sprawdza połączenie z bazą.
- Pobiera listę tabel.
- Pobiera strukturę tabeli i typy pól.
- Przekazuje dane do Kreatora BI.
Aplikacja wykonuje te działania automatycznie, gdy sprawdzasz połączenie, wybierasz tabelę lub tworzysz raport. Aby ją zainstalować, wykonaj sześć kroków:
1. Przejdź do folderu aplikacji na serwerze. Wszystkie polecenia wykonuj na serwerze, na którym będzie działać aplikacja. Otwórz terminal i przejdź do folderu z plikami aplikacji. Sprawdź, czy znajduje się w nim plik docker-compose.yml. Jeśli tak, jesteś we właściwym folderze. Wykonuj w nim polecenia Docker Compose.
2. Utwórz plik ustawień. W folderze aplikacji znajduje się plik .env.example z przykładowymi ustawieniami. Na jego podstawie utwórz plik roboczy .env. Przechowuje on publiczny adres aplikacji, parametry logowania, ustawienia pamięci podręcznej i dane aplikacji lokalnej Bitrix24. Wykonaj polecenie:
cp .env.example .env
3. Podaj publiczny adres aplikacji. Otwórz plik .env i wpisz adres, pod którym Bitrix24 będzie łączyć się z aplikacją serwerową. Przykład ustawień:
APP_DOMAIN=https://bi-connector.example.com APP_ENV=production LOG_LEVEL=INFO
APP_DOMAIN — publiczny adres HTTPS aplikacji. Musi być dostępny z internetu, aby Bitrix24 w chmurze mógł wysyłać do niej zapytania. Adres localhost nie będzie odpowiedni. Wskazuje on lokalne środowisko serwera lub kontenera, z którego nawiązywane jest połączenie. Jeśli aplikacja działa w kontenerze Dockera i jest dostępna z internetu pod publiczną domeną, połączenie może wyglądać tak:
https://bi-connector.example.com → serwer z aplikacją → kontener Dockera
Użyj ważnego certyfikatu SSL. Bitrix24 musi mieć dostęp do aplikacji przez HTTPS bez ostrzeżeń o bezpieczeństwie.
4. Sprawdź sieć Dockera. Aplikacja korzysta z zewnętrznej sieci shared_db_network. Umożliwia ona połączenie z bazami danych działającymi w Dockerze lub dostępnymi przez wspólną sieć. Jeśli uruchamiasz aplikację poleceniem make start, sieć zostanie utworzona automatycznie. Jeśli uruchamiasz kontenery bezpośrednio przez Docker Compose, utwórz sieć ręcznie:
docker network create shared_db_network
Jeśli Docker zgłosi, że sieć już istnieje, oznacza to, że została utworzona wcześniej. Nie musisz tworzyć jej ponownie.
5. Uruchom aplikację. Zbuduj i uruchom aplikację na serwerze. Wykonaj polecenia:
make build make start
Polecenie make build buduje obraz aplikacji w Dockerze. Polecenie make start uruchamia kontener.
6. Sprawdź, czy aplikacja działa. Wykonaj polecenie, aby sprawdzić stan kontenerów:
docker compose ps
Jeśli aplikacja działa, w statusie kontenera zobaczysz wartość Up. Następnie sprawdź, czy aplikacja odpowiada pod publicznym adresem:
curl -i https://bi-connector.example.com/
Jeśli aplikacja odpowiada, możesz utworzyć aplikację lokalną w Bitrix24. Odpowiedź może zawierać komunikat o błędzie, na przykład: {"error":"Unknown action: "}. Taki komunikat pojawia się, gdy zapytanie nie zawiera parametru określającego działanie. Bitrix24 będzie wysyłać właściwe zapytania podczas sprawdzania połączenia, wyboru tabeli i tworzenia zestawu danych.
Jak utworzyć aplikację lokalną w Bitrix24
Przejdź do sekcji Aplikacje > Zasoby programistów > Inne > Aplikacja lokalna. Uzupełnij ustawienia:
- Aplikacja lokalna — wybierz typ Serwerowa. Jest przeznaczony dla aplikacji, która działa na serwerze i wymienia dane z Bitrix24 przez REST API.
- Ścieżka obsługi — wpisz publiczny adres HTTPS aplikacji serwerowej. Bitrix24 będzie wysyłać zapytania pod ten adres. Na przykład:
https://bi-connector.example.com/. - Ścieżka do instalacji początkowej — wpisz adres pliku instalacyjnego aplikacji. Bitrix24 wywołuje go podczas instalacji aplikacji lokalnej. Na przykład:
https://bi-connector.example.com/install.php. - Używa tylko API — włącz tę opcję. Jest potrzebna aplikacji, która nie ma własnego interfejsu w Bitrix24. Kreator BI będzie łączyć się z nią automatycznie przez REST API, bez otwierania osobnej strony.
- Konfiguracja uprawnień — dodaj uprawnienie Konektor analityki BI (biconnector). Umożliwia ono aplikacji korzystanie ze źródeł danych Kreatora BI.
Po uzupełnieniu ustawień kliknij Zapisz.
Po zapisaniu Bitrix24 wyświetli pola systemowe:
- Kod aplikacji (client_id) — identyfikator aplikacji lokalnej. Aplikacja serwerowa potrzebuje go do łączenia się z Bitrix24.
- Klucz aplikacji (client_secret) — tajny klucz aplikacji lokalnej. Służy do uwierzytelniania aplikacji.
Skopiuj client_id i client_secret. Wróć na serwer i uzupełnij parametry w pliku .env:
BITRIX24_PHP_SDK_APPLICATION_CLIENT_ID=twoj_client_id BITRIX24_PHP_SDK_APPLICATION_CLIENT_SECRET=twoj_client_secret BITRIX24_PHP_SDK_APPLICATION_SCOPE=biconnector
Zapisz plik .env w kodowaniu UTF-8 bez dodatkowych znaków na początku pliku. W przeciwnym razie aplikacja może nie odczytać ustawień. Następnie uruchom ponownie aplikację na serwerze:
docker compose restart app
Wróć do formularza aplikacji lokalnej w Bitrix24 i kliknij Przeinstaluj aplikację. Dzięki temu w Kreatorze BI będzie można nawiązać połączenie z bazą danych.
Jak podłączyć zewnętrzną bazę danych
Przejdź do sekcji Kreator BI > Centrum analityczne > Połączenia > Utwórz. Wybierz źródło danych: MySQL Database Connector, PostgreSQL Database Connector lub ClickHouse Database Connector.
Uzupełnij parametry połączenia:
- Nazwa — wpisz nazwę, która ułatwi rozpoznanie połączenia. Będzie widoczna na liście połączeń Kreatora BI.
- Adres hosta — wpisz adres serwera, na którym znajduje się baza danych. Nie wpisuj
localhost, jeśli baza znajduje się na innym serwerze. W przeciwnym razie aplikacja będzie szukać bazy we własnym środowisku. Wpisz na przykładdb.company.local,10.10.20.15lub nazwę kontenera, jeśli baza działa w Dockerze i należy do tej samej sieci. - Port — wpisz port połączenia z bazą danych. Domyślny port PostgreSQL to 5432, a MySQL — 3306. ClickHouse domyślnie używa portu 8123 dla połączeń HTTP i 8443 dla połączeń HTTPS. Jeśli w Twojej infrastrukturze skonfigurowano inny port, wpisz go.
- Baza danych — wpisz nazwę bazy, z której będą pobierane dane do raportów.
- Użytkownik — wpisz nazwę użytkownika bazy danych.
- Hasło — wpisz hasło użytkownika bazy danych.
Po uzupełnieniu parametrów kliknij Sprawdź połączenie. Jeśli test zakończy się powodzeniem, kliknij Utwórz. Bitrix24 zaproponuje utworzenie tabeli na podstawie danych z zewnętrznej bazy. Kliknij Utwórz tabelę.
Jak utworzyć tabelę i zestaw danych
W formularzu tworzenia tabeli wybierz w polu Tabela tabelę z zewnętrznej bazy danych. Po prawej stronie pojawi się Podgląd danych. Sprawdź w nim, jakie pola i wiersze Kreator BI pobrał z bazy. Podgląd pokazuje tylko część danych.
W bloku Właściwości tabeli sprawdź nazwę i opis. System uzupełnia nazwę automatycznie na podstawie nazwy tabeli w zewnętrznej bazie danych. W razie potrzeby możesz ją zmienić przed utworzeniem tabeli.
W bloku Konfiguracja kolumn tabeli sprawdź, czy Bitrix24 poprawnie rozpoznał pola i ich typy danych. Jeśli wszystko się zgadza, kliknij Utwórz.
Jak skonfigurować kolumny
Jak skonfigurować formaty i typy danych do importowania pliku CSV
Bitrix24 wyświetli komunikat o utworzeniu arkusza kalkulacyjnego. Kliknij Utwórz zestaw danych. Zestaw danych pozwala korzystać z tych informacji w raportach i na wykresach w Kreatorze BI.
Po utworzeniu zestawu danych możesz zbudować wykres i dodać go do pulpitu nawigacyjnego. Na przykład utwórz zestaw danych o zamówieniach na podstawie arkusza kalkulacyjnego. Następnie zbuduj wykres łącznej wartości sprzedaży i dodaj go do raportu dla przełożonego.
Jak tworzyć raporty w Kreatorze BI
W skrócie
- W Kreatorze BI możesz podłączać zewnętrzne bazy danych MySQL, PostgreSQL i ClickHouse.
- W Bitrix24 w chmurze zainstaluj aplikację serwerową, utwórz aplikację lokalną i uzupełnij jej dane w pliku
.env. - W Bitrix24 On-Premise aplikacja serwerowa nie jest wymagana. Możesz od razu podać parametry połączenia z bazą danych.
- Przed podłączeniem sprawdź adres bazy danych, port, nazwę i hasło użytkownika oraz jego uprawnienia do odczytu tabel.
- Po podłączeniu możesz utworzyć arkusz kalkulacyjny, zestaw danych i wykres oraz wykorzystać dane z zewnętrznej bazy w raportach Kreatora BI.