Przenoszenie modułów między systemami - eDokumenty Market

1. Eksport - Przygotowanie paczki z modułem
2. Import paczki do lokalnego repozytorium marketu
3. Instalacja paczki z marketu

W systemie eDokumenty od wersji 4.10 został udostępniony eDokumenty Market dzięki, któremu możemy przenosić gotowe moduły między systemami.

eDokumenty Market jest dostępny w Narzędziach > Panel sterowania w sekcja Narzędzia administracyjne.

eDokumenty Market został podzielony na trzy sekcje:

• Zainstalowane - modułu dostępne w naszym systemie
• Dostępne - moduły w bazie lokalnej marketu do zainstalowania
• Market - moduły stworzone oraz udostępnione przez innych twórców modułów

Eksport - Przygotowanie paczki z modułem

Wybieramy moduł, który chcemy przenieść do innego systemu. Po kliknięciu w przycisk Eksportuj zostanie uruchomiony skrypt Migration Custom Modules dzięki któremu krok po krok przejdziemy przez proces przygotowania paczki instalacyjnej.

Krok 1. Exporter Custom Modules

Krok 2. Własności Custom Module

Przedstawienie zawartości modułu, z którego przygotowujemy paczkę instalacyjną - zakładki utworzone w module, podłączone raporty oraz przyciski zadeklarowane w pliku CustomModules.xml.

Krok 3. Rejestry

Wybieramy rejestry na których został oparty nasz moduł. Jeśli moduł nie wymaga rejestru pozostawiamy to pole niezmienione.

Krok 4. CustomWidget

Przedstawia listę przycisków dodanych przez mechanizm CustomWidget wraz z definicją. Przyciski, które zostały wykorzystane w module.

Krok 5. Skrypty

Lista skryptów wykorzystanych w module, jeśli moduł wykorzystuje skrypty napisane przez nas należy je dodać do paczki. Nie należy dodawać skryptów domyślnie dostępnych w systemie.

Krok 6. Komendy

Lista Komend wykorzystanych w module, jeśli moduł wykorzystuje komendy napisane przez nas należy je dodać do paczki. Nie należy dodawać komend domyślnie dostępnych w systemie.

Krok 7. Informacje o module

W przedostatnim kroku eksportu modułu uzupełniamy opis samego modułu. Możemy umieścić takie informację dla osób na co zwrócić uwagę podczas instalacji modułu z przygotowanej przez nas paczki.

Krok 8. Zakończenie

Ostatnie krok to eksport przygotowanej paczki do pliku *.zip. Eksport zostanie wykonany w chwili kliknięcia w ikonę paczki.

Import paczki do lokalnego repozytorium marketu

Przygotowaną wcześniej paczkę przed instalacją musimy zaimportować do lokalnego repozytorium marketu z którego potem moduł zostanie zainstalowany.

1. Uruchamiamy eDokumenty Market z poziomu systemu - Narzędziach > Panel sterowania w sekcja Narzędzia administracyjne.
2. Następnie klikamy na dodaj aplikację, po pojawieniu się nowego okna wybieramy lokalizację z wcześniej wyeksportowaną paczką modułu
3. Klikamy na Aktualizuj. Zaimportowana paczka pojawi się w naszym lokalnym markecie.

Instalacja paczki z marketu

Uwaga

W systemie linux, aby był możliwy import ikonek używanych przez CustomModule należy przydzielić uprawnienia dla www-data, po niżej znajduje się przykładowy skrypt.

  #!/bin/bash

  cd ../../..
  chmod o+w commands
  chmod o+w var/tpl
  chmod o+w scripts
  chmod o+w ../../framework/img/toolbarIcons/24x24/
  chmod o+w ../../framework/img/toolbarIcons/small/
  chmod o+w ../../framework/img/PageToolBar
 

Paczki z modułami już znajdujące się w markecie oraz te które dodajemy do lokalnego marketu musimy zainstalować w systemie eDokumenty.

1. Uruchamiamy eDokumenty Market z poziomu systemu - Narzędziach > Panel sterowania w sekcja Narzędzia administracyjne.
2. Wybieramy paczkę z modułem którą chcemy zainstalować
3. Klikamy Zainstaluj.

Ostatnim etapem do zaimportowaniu modułu jest dostosowanie go na instalacji klienta