Administration système
Administration système
Vous pouvez désactiver une application installée sur un site sans la désinstaller. Ses tables et ses données restent dans la base. L'application cesse d'agir sur le site jusqu'à sa réactivation.
Cette possibilité sert à suspendre une application, à isoler un problème ou à tester le site sans elle.
Prérequis
- Avoir le rôle Responsable système.
- L'application ne doit pas être
frappe. Dodock ne peut pas être désactivé.
Désactiver une application depuis le bureau
- Ouvrez la recherche (Ctrl+K) et saisissez « Applications installées ».
- Dans le tableau, ouvrez la ligne de l'application.
- Cliquez sur Désactiver l'application.
- Confirmez. Dokos affiche : « Désactiver {application} sur ce site ? Ses données seront conservées, mais elle n'aura plus d'effet. »
La case Désactivé de la ligne est alors cochée. Pour réactiver l'application, ouvrez la même ligne et cliquez sur Activer l'application.
Désactiver une application en ligne de commande
bench --site <site> disable-app <application>
bench --site <site> enable-app <application>
La réactivation ne resynchronise pas le schéma de l'application. Lancez bench --site <site> migrate si l'application a été mise à jour entre-temps.
Dépendances
| Action | Contrôle |
|---|---|
| Désactiver | Refusée si une autre application active dépend de celle-ci : « L'application {0} est une dépendance de {1}. Désactivez d'abord {1}. » |
| Activer | Refusée si une dépendance de l'application est désactivée : « L'application {0} dépend de {1}. Activez d'abord {1}. » |
Désactivez d'abord les applications qui dépendent d'une autre. Réactivez dans l'ordre inverse.
Ce qui s'arrête
| Élément de l'application | Comportement quand l'application est désactivée |
|---|---|
| Types de documents | Plus aucune permission. Ils n'apparaissent plus dans les recherches ni les listes. |
| Modules, espaces de travail, icônes du bureau, barres latérales | Masqués dans le bureau. |
| Formats d'impression, notifications, formulaires web, scripts client et serveur de ses modules | Masqués dans les listes. |
| Méthodes appelables (API) | Refusées avec le message « L'application {0} est désactivée sur ce site ». |
Hooks (hooks.py) | Plus exécutés. |
| Tâches planifiées | Plus exécutées. Leur fiche ne peut plus être modifiée. |
| Recherche globale | Les types de documents de l'application sont exclus. |
| Invitations d'utilisateurs | L'application n'est plus proposée. |
Les modules créés sur le site (modules personnalisés) restent visibles, même s'ils sont rattachés à l'application.
Pendant une installation, une migration, un import ou l'assistant de configuration, Dokos ne masque rien. Après une migration, Dokos exécute à nouveau les hooks before_disable des applications désactivées.
Personnalisations posées par l'application
Une application peut ajouter des champs personnalisés, des propriétés personnalisées ou des permissions personnalisées sur les types de documents d'une autre application. Dokos ne les masque pas tout seul. L'application doit le faire dans son hook before_disable.
Pour les développeurs : hooks de désactivation
Déclarez les hooks dans le hooks.py de l'application, sous forme de chemins vers des fonctions. Dokos les appelle sans argument.
| Hook | Moment |
|---|---|
before_disable | Avant la désactivation. Aussi après chaque migration, tant que l'application est désactivée. |
after_disable | Après la désactivation. |
before_enable | Avant la réactivation. |
after_enable | Après la réactivation. |
Une exception dans un hook annule toute l'opération.
# mon_app/hooks.py
before_disable = "mon_app.app_state.hide"
before_enable = "mon_app.app_state.show"
# mon_app/app_state.py
from frappe.custom import hide_customizations, unhide_customizations
CUSTOMIZATIONS = {
"Custom Field": [{"dt": "Address", "fieldname": "custom_code_tournee"}],
}
def hide():
hide_customizations(CUSTOMIZATIONS)
def show():
unhide_customizations(CUSTOMIZATIONS)
before_disable peut s'exécuter plusieurs fois. Écrivez-le pour qu'il donne le même résultat à chaque appel.
Exemple
Exemple fictif : un site utilise l'application webshop, mais la boutique en ligne ferme pour trois mois.
- Vous ouvrez Applications installées, puis la ligne
webshop. - Vous cliquez sur Désactiver l'application et confirmez.
- Les espaces de travail et les types de documents de la boutique disparaissent du bureau. Ses tâches planifiées s'arrêtent.
- Trois mois plus tard, vous cliquez sur Activer l'application. Les données de la boutique sont intactes.
Pour suivre et arrêter une tâche planifiée précise, voir Tâches planifiées.