Funktionalitäten

Allgemein

Um eine Funktionalät aktivierbar bzw. deaktivierbar zu machen, muss unter dem Pfad data/admin/functions/functions.json ein neuer Datensatz angelegt werden.

{
    "id": 2,
    "parent": 1,
    "name": "func_datamap_datashowmodal",
    "version": "3.0 alpha 1",
    "state": [
        {
            "type": "rest",
            "method": "get",
            "url": "records/tbl_systemconfiguration?storage=smartmonitoring&filter=id,eq,18",
            "check": "active=true"
        }
    ],
    "activate": [
        {
            "type": "rest",
            "method": "put",
            "body": "{\"id\": 18, \"active\": true}",
            "url": "records/tbl_systemconfiguration?storage=smartmonitoring"
        }
    ],
    "deactivate": [
        {
            "type": "rest",
            "method": "put",
            "body": "{\"id\": 18, \"active\": false}",
            "url": "records/tbl_systemconfiguration?storage=smartmonitoring"
        }
    ]
}

• id ist eine fortlaufende ID aller Funktionalitäten
• parent erlaubt es Funktionalitäten mit einer übergeordnenten Funktionalität zu verbinden (Die Kinder werden entsprechend visuell dargestellt)
• name der Funktionalität
  • unter data/languages/ kann der Anzeigename und eine Beschreibung angegeben werden. Dies wird dann entsprechend mit angezeigt.
• state definiert wie der Status (aktiviert oder deaktiviert) überprüft wird
• activate definiert wie eine Funktionalität aktiviert wird
• deactivate definiert wie eine Funktionalität deaktiviert wird
• Im obigen Beispiel wurden die Daten aus der Tabelle tbl_systemconfiguration ausgelesen bzw. manipuliert. Der Datensatz muss dafür zuvor in der Datenbank angelegt werden. Dann kann dieser mit seiner id (hier 18) entsprechende in der Konfiguration von state, activate und deactivate verwendet werden.

Komponenten/Plugins aktivieren bzw. deaktivieren

Um eine Komponente bzw. ein Plugin vom Admin aktivierbar bzw. deaktivierbar zu machen, muss zusätzlich zu dem Anlegen einen neunen Datensatzes unter data/admin/functions/functions.json das Attribute activeOn bei der Konfigurationsdatei der Komponente angegeben werden.

window['datashowmodal_datamap_options'] = {
    activeOn: {
        fromName: 'tbl_systemconfiguration', // Name of the datatable
        fromWheres: {
            filter: 'ckey,eq,func_datamap_datashowmodal&filter=active,eq,true'
        }
    }
}

• activeOn enthält einen datarequestor.
• Wichtig:
  • Wenn mit dem datarequestor Daten zurückgeliefert werden, wird die Komponente aktiviert.
  • sonst wird die Komponente deaktiviert