manifest.json

Tout module a besoin du fichier manifest.json. Le fichier doit être situé dans le répertoire principal du module (Par exemple, zabbix/ui/modules/module_name/manifest.json).

Au strict minimum, manifest.json doit spécifier ces champs :

{
    "manifest_version": 2.0,
    "id": "mon_adresse_ip",
    "name": "Mon adresse IP",
    "namespace": "MonAdresseIP",
    "version": "1.0"
}

Paramètres pris en charge dans manifest.json (appuyez sur le nom du paramètre pour une description détaillée) :

manifest_version

Version manifeste du module. Actuellement, la version prise en charge est 2.0.

Type : Double

Exemple:

"manifest_version": 2.0

identifiant

ID du module. Doit être unique. Pour éviter de futurs conflits de noms, il est recommandé d'utiliser un préfixe pour les modules (nom de l'auteur ou de l'entreprise, ou tout autre). Par exemple, si un module est un exemple de leçons et que le nom du module est « Mon module », alors l'ID sera « exemple_mon_module ».

Type : Chaîne

Exemple:

"id": "exemple_mon_module"

nom

Nom du module qui sera affiché dans la section Administration.

Type : Chaîne

Exemple:

"name": "Mon module"

namespace

Namespace PHP pour les classes de modules.

Type : Chaîne

Exemple:

"namespace": "ClockWidget"

version

Version du module. La version sera affichée dans la section Administration.

Type : Chaîne

Exemple:

"version": "1.0"

type

Type du module. Obligatoire pour les widgets et doit être égal à « widget ».

Type : Chaîne

Default : "module"

Exemple:

"type": "widget"

Actions

Actions pour s'inscrire avec le module. La définition de la clé d'objet class pour chaque action est requise, les autres clés d'action sont facultatives.

Type : Objet

Clés d'objet prises en charge si type est un module :

• write.your.action.name (object) - le nom de l'action, doit être écrit en minuscules [a-z], en séparant les mots par des points. Prend en charge les clés :
  • class (string ; obligatoire) - nom de la classe d'action.
  • layout (string) - disposition des actions. Valeurs prises en charge : layout.json, layout.htmlpage (par défaut), null.
  • view (string) - vue des actions.

Exemple:

"Actions": {
    "module.exqmple.list": {
        "class": "ExampleList",
        "view": "example.list",
        "layout": "layout.htmlpage"
        }
    }

Clés d'objet prises en charge si type est un widget :

• widget.{id}.view (object) - nom de fichier et de classe pour la vue widget. Remplacez {id} par la valeur id du widget (par exemple, widget.example_clock.view). Prend en charge les clés :
  • class (string ; obligatoire) - nom de la classe d'action pour le mode d'affichage du widget afin d'étendre la classe CControllerDashboardWidgetView par défaut. Le fichier source de la classe doit être situé dans le répertoire actions.
  • view (string) - vue widget. Doit être situé dans le répertoire views. Si le fichier de vue est widget.view.php, ce qui est attendu par défaut, ce paramètre peut être omis. Si vous utilisez un nom différent, spécifiez-le ici.
• widget.{id}.edit (object) - nom de fichier pour la vue de configuration du widget. Remplacez {id} par la valeur id du widget (par exemple, widget.example_clock.edit). Prend en charge les clés :
  • class (string ; obligatoire) - nom de la classe d'action pour le mode d'affichage de la configuration du widget. Le fichier source de la classe doit être situé dans le répertoire actions.
  • view (string) - vue de configuration du widget. Doit être situé dans le répertoire views. Si le fichier de vue est widget.edit.php, ce qui est attendu par défaut, ce paramètre peut être omis. Si vous utilisez un nom différent, spécifiez-le ici.

Exemple:

"Actions": {
    "widget.tophosts.view": {
        "class": "WidgetView"
    },
    "widget.tophosts.column.edit": {
        "class": "ColumnEdit",
        "view": "column.edit",,
        "layout": "layout.json"
    }
}

actifs

Styles CSS et fichiers JavaScript à inclure.

Type : Objet

Clés d'objet prises en charge :

• css (array) - Fichiers CSS à inclure. Les fichiers doivent être situés dans le répertoire assets/css.
• js (array) - Fichiers JavaScript à inclure. Les fichiers doivent être situés dans le répertoire assets/js.

Exemple :

"assets": {
    "css": ["widget.css"],
    "js": ["class.widget.js"]
}

author

Auteur du module. L'auteur sera affiché dans la section Administration.

Type : Chaîne

Exemple:

"author": "John Smith"

configuration

Valeurs par défaut pour les options du module. L'objet peut contenir des clés personnalisées. Si spécifiées, ces valeurs seront écrites dans la base de données lors de l’inscription du module. Les nouvelles variables ajoutées ultérieurement seront écrites lors du premier appel. Ensuite, les valeurs des variables ne peuvent être modifiées que directement dans la base de données.

Type : Objet

Exemple :

"config": {
    "username": "Administrateur",
    "password": "",
    "auth_url": "https://exemple.com/auth"
}

description

Descriptif des modules.

Type : Chaîne

Exemple:

"description": "Ceci est un widget horloge."

widget

Configuration des widgets. Utilisé si type est défini sur widget.

Type : Objet

Clés d'objet prises en charge :

• name (string) - utilisé dans la liste des widgets et comme en-tête par défaut. S'il est vide, le paramètre "name" du module sera utilisé.

• template_support (booléen) - détermine si le widget doit être disponible dans les modèles de tableaux de bord. Valeurs prises en charge : true, false (par défaut).

• size (objet) - dimensions du widget par défaut. Clés prises en charge :

  • width (entier) - largeur du widget par défaut.
  • • height* (entier) - hauteur du widget par défaut.

• form_class (string) - classe avec formulaire de champs de widget. Doit être situé dans le répertoire includes. Si la classe est WidgetForm.php, ce qui est attendu par défaut, ce paramètre peut être omis. Si vous utilisez un nom différent, spécifiez-le ici.

• js_class (string) - nom d'une classe JavaScript pour le mode d'affichage des widgets afin d'étendre la classe CWidget par défaut. La classe sera chargée avec le tableau de bord. Le fichier source de la classe doit se trouver dans le répertoire assets/js. Voir aussi : assets.

• use_time_selector (booléen) - détermine si le widget nécessite un sélecteur d'heure du tableau de bord. Valeurs prises en charge : true, false (par défaut).

• refresh_rate (entier) - taux de rafraîchissement du widget en secondes (par défaut : 60).

Exemple:

"widget": {
    "name": "",
    "template_support": true,
    "size": {
        "width": 12,
        "height": 5
    },
    "form_class": "WidgetForm",
    "js_class": "CWidget",
    "use_time_selector": false,
    "refresh_rate": 60
}

URL

Un lien vers la description du module.

Type : Chaîne

Exemple:

"url": "http://exemple.com"