Skip to content

Commit

Permalink
YD-18 record collector (#167)
Browse files Browse the repository at this point in the history
Co-authored-by: Ruben Lech <[email protected]>
  • Loading branch information
RubenLech and Ruben Lech authored Sep 16, 2024
1 parent d8dc796 commit 62090e4
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ keywords:
- YetiForce
tags:
- Kolektory rekordów
preview: record-collector-2.jpg
---

## Prezentacja wideo
Expand All @@ -30,20 +31,35 @@ import ReactPlayer from 'react-player';
</Tabs>

Kolektor rekordów jest używany do ładowania danych z różnych źródeł i umożliwia wyświetlanie i wczytywanie danych do systemu YetiForce CRM.

![record-collector-1](record-collector-1.jpg)

Mechanizm jest dostępny we wszystkich modułach, jednak musi być włączony i skonfigurowany dla każdego modułu do poprawnego działania.

## Konfiguracja

Kolekcjonerzy mogą być skonfigurowane w następującym panelu: [`Konfiguracja oprogramowania → Integracja → Kolekcjonerzy`](/administrator-guides/integration/record-collectors/)
Konfigurując **kolektor rekordów** w pierwszej kolejności należy nadać odpowiednie uprawienia dla odpowiednich ról w systemie. Szczegółowe informacje na ten temat znajdują się w artykule: [Uprawnienia do kolektora rekordów](/administrator-guides/integration/record-collectors/).

Następnie przejdź do sekcji administracyjnej i wybierz ```Integracja → Kolektor rekordów```. Po otwarciu zakładki wyświetli się lista dostępnych kolektorów.

![record-collector-2](record-collector-2.jpg)

**Najważniejsze kolumny**
* **Moduły** - pokazuje miejsca w systemie, dla których dany kolektor jest dostępny
* **Typ** - określa typ kolektora:
- **wyświetl** - wyświetla informację pobraną z kolektora
- **pokaż i wypełnij** - pozwala nie tylko wyświetlić dane pobrane z kolektora, ale również wypełnić nimi formularz w systemie
* **Adres URL dokumentacji** - link do dokumentacji dostawcy usługi, zawierający szczegółowe informacje na temat kolektora. Znajdziesz tam m.in. instrukcje konfiguracji czy też sposób uzyskania danych autoryzacyjnych, jeżeli są one potrzebne
* **Wyróżniony** - oznacz ten checkbox, aby ikona danego kolektora została wyświetlona obok listy rozwijanej wszystkich uruchomionych kolektorów. Ułatwi to szybki dostęp do najczęściej używanych integratorów
* **Aktywny** - oznacz ten checkbox, aby dany kolektor był dostępny do wybrania w systemie
* **Akcje** - kliknij ikonę akcji (<kbd><i className="fas fa-cog"></i></kbd>), aby rozwinąć okno dialogowe z dodatkowymi opcjami konfiguracyjnymi kolektora

## Dostępne kolektory

Poniżej znajduje się lista wszystkich aktualnie dostępnych kolektorów rekordów. Darmowe kolekcjonerskie dostępne w systemie są domyślnie oznaczone tagiem, pozostałe mogą być zakupione w Marketplace.
Poniżej znajduje się lista wszystkich aktualnie dostępnych kolektorów rekordów. Darmowe kolekcjonerskie dostępne w systemie są domyślnie oznaczone tagiem, pozostałe mogą być zakupione w Marketplace. Regularnie dodajemy do systemu YetiForce nowe kolektory rekordów.

:::warning
Należy pamiętać, że dostęp do danych z niektórych kolektorów może wymagać odpowiednich danych uwierzytelniających.

Regularnie dodajemy do systemu YetiForce nowe kolektory rekordów.
**Prosimy o zapoznanie się z dokumentacją danego kolektora, aby uzyskać więcej informacji na temat wymagań dotyczących dostępu.**
:::

- GUS [PL] - Pobiera dane o polskich firmach z bazy danych REGON 1(BIR1) dostarczonej przez GUS
- ★ VIES [EU] - Sprawdza, czy podmiot gospodarczy posiada ważny numer VAT-UE dla transakcji wewnątrzwspólnotowych w Unii Europejskiej
Expand All @@ -62,3 +78,12 @@ Regularnie dodajemy do systemu YetiForce nowe kolektory rekordów.
- VAT [GB] - Sprawdza czy firma jest zarejestrowana jako podatnik VAT w Wielkiej Brytanii
- EDGAR [USA] - Pobieranie danych o firmach w USA z U.S. Securities andExchange Commission (SEC) z bazy EDGAR
- VATify.eu - Pobieranie danych firm z bazy VATify.eu, która również zawiera aktualny status płatnika VAT


## Wykorzystanie kolektora

W celu skorzystania z kolektora rekordów, przejdź do formularza w module, dla którego jest on dostępny. Na dole pojawi się wówczas lista dostępnych kolektorów. Te, które zostały oznaczone w sekcji administracyjnej jako **Wyróżnione** zostaną wyświetlone na liście niezależnie. Pozostałe aktywne kolektory dostępne są pod przyciskiem <kbd>Kolektory rekordów</kbd>. Po kliknięciu to pole, rozwinie się lista aktywnych kolektorów.

Dostęp do kolektorów również jest możliwy w formularzach typu "Szybkie tworzenie". W oknie modalnym pojawiają się one u góry po prawej stronie, jak to zostało przedstawione na poniższym zrzucie ekranu.

![record-collector-1](record-collector-1.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,61 @@ keywords:
- YetiForce
tags:
- Record collectors
preview: record-collector-2.jpg
---

## Video presentation
## Video guide

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import ReactPlayer from 'react-player';

<Tabs groupId="XlIXiQpC9ug">
<TabItem value="youtube-XlIXiQpC9ug" label="🎬 YouTube">
<ReactPlayer
url="https://www.youtube.com/watch?v=XlIXiQpC9ug"
width="100%"
height="500px"
controls={true}
/></TabItem>
<TabItem value="yetiforce-XlIXiQpC9ug" label="🎥 YetiForce TV">
<ReactPlayer url="/video/record-collector.mp4" width="100%" height="500px" controls={true} /></TabItem>
<TabItem value="youtube-XlIXiQpC9ug" label="🎬 YouTube">
<ReactPlayer
url="https://www.youtube.com/watch?v=XlIXiQpC9ug"
width="100%"
height="500px"
controls={true}
/>
</TabItem>
<TabItem value="yetiforce-XlIXiQpC9ug" label="🎥 YetiForce TV">
<ReactPlayer url="/video/record-collector.mp4" width="100%" height="500px" controls={true} />
</TabItem>
</Tabs>

Record collector is used to load data from various sources and enables displaying and loading data into the YetiForce CRM system.
Record collector is used to load data from various sources and enables displaying and loading data into the YetiForce CRM system. The mechanism is available in all modules, however it has to be enabled and configured for each module to work correctly.

![record-collector-1](record-collector-1.jpg)
## Configuration

The mechanism is available in all modules, however it has to be enabled and configured for each module to work correctly.
Konfigurując **kolektor rekordów** w pierwszej kolejności należy nadać odpowiednie uprawienia dla odpowiednich ról w systemie. Szczegółowe informacje na ten temat znajdują się w artykule: [Uprawnienia do kolektora rekordów](/administrator-guides/integration/record-collectors/).

## Configuration
Następnie przejdź do sekcji administracyjnej i wybierz ```Integracja → Kolektor rekordów```. Po otwarciu zakładki wyświetli się lista dostępnych kolektorów.

![record-collector-1](record-collector-2.jpg)

**Najważniejsze kolumny**
* **Moduły** - pokazuje miejsca w systemie, dla których dany kolektor jest dostępny
* **Typ** - określa typ kolektora:
- **wyświetl** - wyświetla informację pobraną z kolektora
- **pokaż i wypełnij** - pozwala nie tylko wyświetlić dane pobrane z kolektora, ale również wypełnić nimi formularz w systemie
* **Adres URL dokumentacji** - link do dokumentacji dostawcy usługi, zawierający szczegółowe informacje na temat kolektora. Znajdziesz tam m.in. instrukcje konfiguracji czy też sposób uzyskania danych autoryzacyjnych, jeżeli są one potrzebne
* **Wyróżniony** - oznacz ten checkbox, aby ikona danego kolektora została wyświetlona obok listy rozwijanej wszystkich uruchomionych kolektorów. Ułatwi to szybki dostęp do najczęściej używanych integratorów
* **Aktywny** - oznacz ten checkbox, aby dany kolektor był dostępny do wybrania w systemie
* **Akcje** - kliknij ikonę akcji (<kbd><i className="fas fa-cog"></i></kbd>), aby rozwinąć okno dialogowe z dodatkowymi opcjami konfiguracyjnymi kolektora

Collectors can be configured in the following panel: [`Software configuration → Integration → Record collectors`](/administrator-guides/integration/record-collectors/)

## Available collectors

Below is a list of all currently available record collectors. Free collectors available in the system by default are marked with ★, the remaining ones can be purchased from the Marketplace.

We regularly add new record collectors to the YetiForce system.

:::warning
Należy pamiętać, że dostęp do danych z niektórych kolektorów może wymagać odpowiednich danych uwierzytelniających.

**Prosimy o zapoznanie się z dokumentacją danego kolektora, aby uzyskać więcej informacji na temat wymagań dotyczących dostępu.**
:::

- GUS [PL] - Fetches data on Polish companies from the online REGON 1(BIR1) database provided by GUS
- ★ VIES [EU] - Checks if the business entity has a valid VAT-EU number for intra-community transactions within the European Union
- KRS [PL] - Fetches data on Polish companies from The National Court Register in Poland (KRS)
Expand All @@ -58,5 +77,14 @@ We regularly add new record collectors to the YetiForce system.
- ★ YouControl [UA] - Fetches data on Ukrainian companies from the YouControl database provided by YouScore API
- Companies House [GB] - Fetches data on UK companies from the Comapnies House agency
- VAT [GB] - Verifies whether a company is registered as a VAT taxpayer in the United Kingdom
- EDGAR [USA] - Fetches data on US companies from the United States Securities and Exchange Commission via EDGAR Securities andExchange Commission (SEC) z bazy EDGAR
- EDGAR [USA] - Fetches data on US companies from the United States Securities and Exchange Commission via EDGAR
- VATify.eu - Fetches data from VATify.eu database, which also contains the taxpayer's current status


## Wykorzystanie kolektora

W celu skorzystania z kolektora rekordów, przejdź do formularza w module, dla którego jest on dostępny. Na dole pojawi się wówczas lista dostępnych kolektorów. Te, które zostały oznaczone w sekcji administracyjnej jako **Wyróżnione** zostaną wyświetlone na liście niezależnie. Pozostałe aktywne kolektory dostępne są pod przyciskiem <kbd>Kolektory rekordów</kbd>. Po kliknięciu to pole, rozwinie się lista aktywnych kolektorów.

Dostęp do kolektorów również jest możliwy w formularzach typu "Szybkie tworzenie". W oknie modalnym pojawiają się one u góry po prawej stronie, jak to zostało przedstawione na poniższym zrzucie ekranu.

![record-collector-1](record-collector-1.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 62090e4

Please sign in to comment.