Wstęp

Wtyczki mogą integrować się z systemem PlusWorkflow na różnych poziomach. Ta strona opisuje wszystkie sposoby integracji.

Integracja z interfejsem użytkownika

Integracja z interfejsem użytkownika może odbywać się poprzez jego modyfikację lub rozszerzanie już istniejących funkcjonalności. Ten rozdział opisuje wszystkie formy integracji z interfejsem użytkownika.

Wpisy w menu

Moduł menu-entry umożliwia dodanie do istniejących menu własnych wpisów o określonych atrybutach. Sekcja zdefiniowana w tym module jednoznacznie identyfikuje menu, do którego chcemy dodać nasz wpis.

System PlusWorkflow definiuje następujące sekcje:

  • system.menu.top: główne menu systemowe

    Nową pozycją w menu jest Dashboard

  • system.useraccount.menu.top: menu w zakładce MojeKonto

    Nową pozycją w menu są Pulpity

     

  • system.administration.systemconfig.menu: menu w Administracja->Konfiguracja systemu

    Nową pozycją w menu są Pulpity

Wszystkie pozycje w menu mają swój order. Pierwszy systemowy wpis w menu ma order=0, każdy kolejny o 10 większy.

Warto korzystać z atrybutu order, nawet jeżeli nam samym nie zależy na kolejności. Inne wtyczki mogą chcieć dodać pozycje obok naszej, co będzie utrudnione, jeżeli nie nadamy naszemu wpisowi odpowiedniej kolejności.

Kliknięcie na daną pozycję w menu spowoduje wyświetlenie w kontenerze odpowiednim dla każdego z menu zawartości, pobranej ze skonfigurowanego linku.

Dodatkowo Kreatory (Wizardy) korzystają z następujących sekcji:

  • system.search.result.menu - na stronie z wynikami wyszukiwania


    Nowa pozycja w menu 

  • system.process.history.menu - w historii procesu

Nie jest wymagane, aby Kreator posiadał moduł menu-entry. Po zainstalowaniu w systemie sam trafi do odpowiedniej sekcji.

Widok domyślny

Widok domyślny użytkownika wyświetla się zaraz po zalogowaniu do systemu lub kliknięciu na pozycję Start w menu głównym. Możemy umożliwić użytkownikowi wybranie widoku naszej wtyczki jako jego widoku domyślnego.

Odpowiedzialny jest za to moduł default-view.

Dla każdego zdefiniowanego modułu pojawi się możliwość wyboru tej opcji w wyborze widoku domyślnego:





Introduction

Plugins can integrate with PlusWorkflow at different levels. This page describes all the ways of integration.

Integration with the user interface

Integration with the user interface can be done by modifying it or extending already existing functionality. This section describes all forms of integration with the user interface.

Menu entries

The menu-entry module allows you to add your own entries with specific attributes to existing menus. The section defined in this module uniquely identifies the menu to which we want to add our entry.

The PlusWorkflow system defines the following sections:

  • system.menu.top: the main system menu

    A new menu item is the Dashboard

  • system.useraccount.menu.top: menu in the MyAccount tab

    A new menu item is Dashboards

     

  • system.administration.systemconfig.menu: menu in Administration->System Configuration

    A new menu item is Dashboards

All menu items have an order. The first system menu entry has order=0, each subsequent one 10 more.

It's a good idea to use the order attribute, even if we ourselves don't care about the order. Other plugins may want to add items next to ours, which will be difficult if we don't give our entry the right order.

Clicking on a menu item will display the content retrieved from the configured link in the container appropriate for each menu.

In addition, Wizards uses the following sections:

  • system.search.result.menu - on the search results page


    New menu item

  • system.process.history.menu - in process history

It is not required that Wizard has a menu-entry module. Once installed on the system, it will go to the appropriate section by itself.

Default view

The user's default view is displayed as soon as the user logs into the system or clicks on the Start item in the main menu. We can allow the user to select the view of our plug-in as his default view.

The default-view -view module is responsible for this.

For each defined module, you will see the option to select this option in the default view selection: