{"id":20326,"date":"2024-02-16T15:48:38","date_gmt":"2024-02-16T14:48:38","guid":{"rendered":"https:\/\/help.openbee.com\/open-bee-portal\/installers-guide\/installing-and-updating-an-add-on\/"},"modified":"2024-06-07T10:32:32","modified_gmt":"2024-06-07T08:32:32","slug":"installing-and-updating-an-add-on","status":"publish","type":"page","link":"https:\/\/help.openbee.com\/en\/open-bee-portal\/installers-guide\/installing-and-updating-an-add-on\/","title":{"rendered":"Installing and updating an add-on"},"content":{"rendered":"<div id=\"main-content\" class=\"wiki-content group\">\n<p>Open Bee\u2122 Portal has a system of add-ons to enrich the basic functionality of the application. This section describes the processes for installing and managing an add-on.<\/p>\n<p>Two management modes are possible:<\/p>\n<ul>\n<li>From the Open Bee\u2122 Portal administration web interface<\/li>\n<li>Command line from the server hosting Open Bee\u2122 Portal<\/li>\n<\/ul>\n<style type=\"text\/css\"><![CDATA[\/*<![CDATA[*\/ div.rbtoc1648215951470 {padding: 0px;} div.rbtoc1648215951470 ul {list-style: disc;margin-left: 0px;} div.rbtoc1648215951470 li {margin-left: 0px;padding-left: 0px;} \/*]]]]><![CDATA[>*\/]]><\/style>\n<div class=\"toc-macro rbtoc1648215951470\">\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Depuisl'interfaceWeb\">From the web interface  <\/a>\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Installationd'unadd-on\">Installing an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Activation\/D%C3%A9sactivationd'unadd-on\">Enabling\/Disabling an Add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Mise%C3%A0jourd'unadd-on\">Updating an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-D%C3%A9sinstallationd'unadd-on\">Uninstalling an add-on<\/a><\/li>\n<\/ul>\n<\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Enlignedecommande\">Command Line  <\/a>\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Installationd'unadd-on.1\">Installing an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Activation\/D%C3%A9sactivationd'unadd-on.1\">Enabling\/Disabling an Add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Mise%C3%A0jourd'unadd-on.1\">Updating an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-D%C3%A9sinstallationd'unadd-on.1\">Uninstalling an add-on<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n<h1 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Depuisl'interfaceWeb\">From the web interface<\/h1>\n<p>Log in as an administrator, &#8220;Administration &gt; Add-ons&#8221; section.<\/p>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Installationd'unadd-on\">Installing an add-on<\/h2>\n<p>Click on the &#8220;Add add-on&#8221; button.<\/p>\n<p>There are two options:<\/p>\n<p>1\/The add-on is available online and appears in the list of installable add-ons.<\/p>\n<p>Then simply click on the &#8220;Install&#8221; button<br \/>\n<img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845633-translated.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845633-translated.png\"><\/p>\n<p>2\/ The add-on is not available online and does not appear in the list of installable add-ons, but you do have the ZIP archive of the add-on.<\/p>\n<p>Then click on the &#8220;Install an add-on&#8221; link, then choose the Zip archive of the add-on present on your computer.<\/p>\n<p><img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845635-translated.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845635-translated.png\"><\/p>\n<p>Once the add-on is installed, it will appear in the list of add-ons. It is necessary to enable it in order for it to be usable by a user.<\/p>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Activation\/D\u00e9sactivationd'unadd-on\">Enabling\/Disabling an Add-on<\/h2>\n<p>From the list of add-ons you can enable\/disable add-ons from the menu associated with each add-on, or in bulk from the batch action menu.<\/p>\n<p><img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845636-translated.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845636-translated.png\"><\/p>\n<p><img decoding=\"async\" class=\"emoticon emoticon-information\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/03\/information.png\" alt=\"(info)\" data-emoticon-name=\"information\">  Disabling an add-on usually hides it from users while retaining the associated configurations.<\/p>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Mise\u00e0jourd'unadd-on\">Updating an add-on<\/h2>\n<p>When a new version of an installed add-on is available online, a notification that an update is available is displayed in the &#8220;Version&#8221; column.<\/p>\n<p><img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845637-translated.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845637-translated.png\"><\/p>\n<p>It is then possible to update the add-on by clicking on the icon <img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/03\/267845639.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/03\/267845639.png\">.<\/p>\n<p>Updating can also be done through the unit or batch action menu in the add-on list.<\/p>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-D\u00e9sinstallationd'unadd-on\">Uninstalling an add-on<\/h2>\n<p>From the list of add-ons you can uninstall add-ons from the menu associated with each add-on, or in bulk from the batch action menu.<\/p>\n<p><img decoding=\"async\" class=\"confluence-embedded-image\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845636-translated.png\" data-image-src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2026\/03\/267845636-translated.png\"><\/p>\n<p><img decoding=\"async\" class=\"emoticon emoticon-warning\" src=\"https:\/\/help.openbee.com\/wp-content\/uploads\/2022\/03\/warning.png\" alt=\"(warning)\" data-emoticon-name=\"warning\">  Deleting an add-on will in most cases result in the deletion of the configuration and data associated with the add-on. This can vary from one add-on to another, as it depends on the choices made by the developers of the add-on.<\/p>\n<h1 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Enlignedecommande\">Command Line<\/h1>\n<p>Add-on come in the form of a ZIP file.<\/p>\n<p>All commands for managing the lifecycle of an add-on must be run from a console (<strong>as the machine administrator<\/strong>) in the &#8220;<em>openbeeportal\/sf3&#8243;<\/em> folder in the Open Bee\u2122 Portal installation directory.<\/p>\n<style type=\"text\/css\"><![CDATA[\/*<![CDATA[*\/ div.rbtoc1648215951517 {padding: 0px;} div.rbtoc1648215951517 ul {list-style: disc;margin-left: 0px;} div.rbtoc1648215951517 li {margin-left: 0px;padding-left: 0px;} \/*]]]]><![CDATA[>*\/]]><\/style>\n<div class=\"toc-macro rbtoc1648215951517\">\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Depuisl'interfaceWeb\">From the web interface  <\/a>\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Installationd'unadd-on\">Installing an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Activation\/D%C3%A9sactivationd'unadd-on\">Enabling\/Disabling an Add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Mise%C3%A0jourd'unadd-on\">Updating an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-D%C3%A9sinstallationd'unadd-on\">Uninstalling an add-on<\/a><\/li>\n<\/ul>\n<\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Enlignedecommande\">Command Line  <\/a>\n<ul class=\"toc-indentation\">\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Installationd'unadd-on.1\">Installing an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Activation\/D%C3%A9sactivationd'unadd-on.1\">Enabling\/Disabling an Add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-Mise%C3%A0jourd'unadd-on.1\">Updating an add-on<\/a><\/li>\n<li><a href=\"#Installationetmise%C3%A0jourd'unmodulecompl%C3%A9mentaire-D%C3%A9sinstallationd'unadd-on.1\">Uninstalling an add-on<\/a><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Installationd'unadd-on.1\">Installing an add-on<\/h2>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\"> php app\\console addon:install &lt;addonZipPath&gt;<\/pre>\n<\/div>\n<\/div>\n<p>Replace &lt;addonZipPath&gt; with the absolute path of the add-on.<\/p>\n<p>Add-on-specific parameters can be specified during installation. (If they exist, these parameters are specified in the documentation of each add-on)<\/p>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\"> php app\\console addon:install &lt;addonZipPath&gt; --param1=value1 --param2=value2<\/pre>\n<\/div>\n<\/div>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Activation\/D\u00e9sactivationd'unadd-on.1\">Enabling\/Disabling an Add-on<\/h2>\n<p>Once the add-on is installed, it is not yet available to users. In order to make it accessible, it is necessary to activate it:<\/p>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\">php app\\console addon:enable Openbee\/&lt;addonName&gt;<\/pre>\n<\/div>\n<\/div>\n<p>&lt;addonName&gt; is the name of the add-on. This is usually the same name as the one used in the zip archive. For an archive with the name &#8220;Chorus-6.6.0-ebea6ba.zip&#8221;, &lt;addonName&gt; will be &#8220;Chorus&#8221;.<\/p>\n<p>The reverse operation allows you to disable the add-on of an installation, without deleting the data:<\/p>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\">php app\\console addon:disable Openbee\/&lt;addonName&gt;<\/pre>\n<\/div>\n<\/div>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-Mise\u00e0jourd'unadd-on.1\">Updating an add-on<\/h2>\n<p>To update an add-on, use the following command:<\/p>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\">php app\\console addon:update &lt;addonZipPath&gt;<\/pre>\n<\/div>\n<\/div>\n<pre>&lt;addonZipPath&gt; est le chemin de l'archive ZIP contenant la nouvelle version \u00e0 installer.<\/pre>\n<h2 id=\"Installationetmise\u00e0jourd'unmodulecompl\u00e9mentaire-D\u00e9sinstallationd'unadd-on.1\">Uninstalling an add-on<\/h2>\n<p>Before uninstalling an add-on, it is necessary to disable it.<\/p>\n<div class=\"aui-message problem shadowed information-macro\">\n<div class=\"message-content\">\n<p>Uninstalling an add-on deletes all user data associated with the add-on.<\/p>\n<\/div>\n<\/div>\n<div class=\"code panel pdl\" style=\"border-width: 1px;\">\n<div class=\"codeContent panelContent pdl\">\n<pre class=\"theme: Confluence; brush: bash; gutter: false\" style=\"font-size: 12px;\">php app\\console addon:remove Openbee\/&lt;addonName&gt;<\/pre>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>Open Bee\u2122 Portal has a system of add-ons to enrich the basic functionality of the application. This section describes the processes for installing and managing an add-on. Two management modes are possible: From the Open Bee\u2122 Portal administration web interface Command line from the server hosting Open Bee\u2122 Portal From the web interface Installing an [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":20153,"menu_order":7,"comment_status":"closed","ping_status":"closed","template":"templates\/ob-help-products.php","meta":{"footnotes":""},"class_list":["post-20326","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20326","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/comments?post=20326"}],"version-history":[{"count":3,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20326\/revisions"}],"predecessor-version":[{"id":22471,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20326\/revisions\/22471"}],"up":[{"embeddable":true,"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/pages\/20153"}],"wp:attachment":[{"href":"https:\/\/help.openbee.com\/en\/wp-json\/wp\/v2\/media?parent=20326"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}