Commands

Commands werden in Packages oder auf Pages definiert und können unter anderem zur Navigation sowie zur Ausführung von JavaScript im Frontend oder Codeblock per beas verwendet werden.

Wenn ein command in einem Package definiert wird, kann dieser im gesamten be Portal verwendet werden. Ein in einer Page definierter command kann nur auf der entsprechenden Page verwendet werden.

YAML

// cb Package
....
objects:
  commands:
    - name: custom_command
      action:
        $page: custom_page
      ....

Eigenschaften von commands Objekten:

name	Name des `command` Muss innerhalb des Packages einzigartig sein.
action	Definition der Aktion, die beim Ausführen des `command` durchgeführt werden soll.
label?	(optional) - Das `label` kann im be Portal auf Buttons oder in Menüs angezeigt werden.
permissions?	(optional) - Liste von Berechtigungen
icon?	(optional) - anzuzeigendes Icon

Eigenschaften von action Objekten:

Es kann jeweils nur eine von den Eigenschaften verwendet werden.

$page	Angabe eines Page-Navigationsziels, zu dem navigiert werden soll. Entweder FQN einer Page oder eine ausführliche Definition des Navigationsziels mit Page-FQN und Übergabeparametern.
$navigation	URL einer be Portal Seite, zu der navigiert werden soll.
$script	JavaScript Code, der ausgeführt werden soll.
$backend	Name des Codeblock Events, das ausgeführt werden soll.
$command	Name eines Commands, der ausgeführt werden soll.

Eigenschaften von Objekten in der permissions Liste:

role

Angabe einer Rolle, die der Benutzer haben muss, damit der command für den Benutzer im be Portal verfügbar ist und ausgeführt werden kann.

Standard Commands:

Aktion	FQN
Navigation zu Home	`BE.Package.goto_home`
Datenreplikation - Navigation zum Dashboard	`BE.Package.datareplication_home`
Datenreplikation - Navigation zu Tabellen	`BE.Package.datareplication_tables`
Datenreplikation - Navigation zu Jobs für Komplett-Replikation	`BE.Package.datareplication_jobs`
Datenreplikation - Navigation zu Fehler-Logs	`BE.Package.datareplication_error_logs`
Datenreplikation - Navigation zu Status-Logs	`BE.Package.datareplication_status_logs`
Datenreplikation - Navigation zu Einstellungen	`BE.Package.datareplication_settings`
Datenreplikation - Navigation zu Statisktik	`BE.Package.datareplication_statistics`
PZE - Navigation zu Home	`BE.Package.pze_home`
PZE - Navigation zu Personalübersicht	`BE.Package.pze_personnel_overview`
PZE - Navigation zu Meine Abwesenheitsanträge	`BE.Package.pze_absence_requests`
PZE - Navigation zu Eingegangene Anträge	`BE.Package.pze_absence_request_validation`
PZE - Navigation zu Abwesenheitsübersicht	`BE.Package.pze_absence_overview`
PZE - Navigation zu Anwesenheitsübersicht	`BE.Package.pze_shift_schedule`
PZE - Navigation zu Zeitbuchungen	`BE.Package.pze_time_recordings`
PZE - Navigation zu Monatskonto	`BE.Package.pze_monthly_schedule`
DMS - Navigation zu Home	`BE.Package.dms_home`
DMS - Navigation zu Speicher	`BE.Package.dms_storage`
DMS - Navigation zu Dokumente	`BE.Package.dms_metadata`
DMS - Navigation zu Gelöschte Dokumente	`BE.Package.dms_deleted`
Administration - Navigation zu Einstellungen	`BE.Package.admin_settings`
Administration - Navigation zu API Berechtigungen	`BE.Package.admin_apiPermissions`
Administration - Navigation zu Berechtigungen	`BE.Package.admin_permissions`
Administration - Navigation zu E-Mail Profile	`BE.Package.admin_email_profiles`
Administration - Navigation zu E-Mail Ordner	`BE.Package.admin_email_folders`
Administration - Navigation zu Packages	`BE.Package.admin_codeblockPackages`
Administration - Navigation zu Ausstehende Prozesse	`BE.Package.admin_processQueue`
Workflow - Navigation zu Aufgaben	`BE.Package.tasks_task_list`

Beispiel:

YAML

objects:
  commands:
    # Navigation zu einer Custom Page
    - name: goto_my_custom_page
      label: Custom Page
      action:
        $page: PACKAGE_KEY.my_custom_page
    # Navigation zu einer Custom Page mit Übergabeparametern
    - name: goto_my_custom_page_with_record_id
      label: Custom Page with Record-ID
      action:
        $page:
          id: PACKAGE_KEY.my_custom_page
          data:
            inputs:
              recordId: 42
    # Einbuchen per beas (nur für be User)
    - name: clock_in
      label: Einbuchen
      permisssions:
        - role: be_user
      action:
        $backend: clock_in