Package Installation
From FacileWiki
Summary : How to install or uninstall Facile Forms packages Author : Larry Stavinoha Created : 2005-11-07 Revisions : Based on : Facile Forms 1.4.3, Joomla 1.0.8 Applies to: Facile Forms 1.0.0 ... 1.4.4, Joomla 1.0.0 ... 1.0.8, Mambo 4.5.1 ... 4.5.3
With Facile Forms, you can easily create forms and applications consisting of Scripts (Javascript), Pieces (PHP), Forms and Backend Menus for use in your Joomla/Mambo environment. These forms and applications can then be easily moved from one website to another by using a Facile Forms Package.
This chapter will outline installing and uninstalling two different Hello World packages into your Facile Forms instance. This chapter references the Hello World packages created in the Package Creation chapter.
Contents |
How to tell if a package is Named or Unnamed
When you receive a package from another Facile Forms user or developer, you may not know if they created a Named package with all items sharing a common package name, or if they created an Unnamed package with no package name for the items.
In order to determine if the package is named or not, you will need to open the package xml file with a text editor or browser. The second line in the xml file will be the FacileFormsPackage element. If the element has an id attribute, then the package was created as a Named Package. This is the preferable manner, as these packages are easily installable, upgradable, and uninstallable.
Here is the example for the named package hello_world.xml created for the Hello World sample:
<FacileFormsPackage id="Hello World" type="autoincrement" version="1.4.3">
As you can see, the id attribute is "Hello World", which tells us that this is a Named Package.
Here is the example for the unnamed package hello_world.xml file created for the Hello World sample:
<FacileFormsPackage type="autoincrement" version="1.4.3">
As you can see, there is no id attribute here, which tells us that this is an Unnamed Package.
The Package Installer
It is very easy to uninstall a named package in Facile Forms.
From the Joomla/Mambo Administrator backend, click on the menu Components->Facile Forms->Configuration. This will open up the Facile Forms Configuration screen. Near the bottom left corner, click on the Package Installer button. This will open up the Facile Forms - Install Package screen.
The Facile Forms Install Package screen lists any currently installed packages and provides a facility to install a named or unnamed package, or uninstall a named package.
Remember, there is no automated upgrade or uninstall of unnamed packages, only for named packages.
Installing or upgrading the Named Package
On the Package Installer screen, click the Upload package file from client & install radio button.
Below this is a text box that will hold the path and name of the xml file to be uploaded. You can either type in the path and filename to the package, or click the Browse... button and select the hello_world.xml file generated in the Package Creation chapter.
You are ready to install the package now. Click the Install Package button to install the package.
Since this is a Named Package, any existing package with the same ID will be upgraded to this version. If there is no existing package with the same ID, then the package will be installed.
You are now at the Facile Forms Package Installation Report screen. This screen shows you summary information including the package ID, version, author and copyright information, and the number of each type of item imported in this package:
Click the Continue button, and you will return to the Facile Forms Package Installer screen.
Your hello_world package is now ready for use.
Uninstalling the Named Package
It is very easy to uninstall a named package in Facile Forms.
On the Package Installer screen, check the checkbox next to the package that you would like to uninstall, in this case the Hello World package:
Click on the Uninstall Package button.
You will be given a warning about uninstalling packages that other packages my depend upon. Remember, if you want to upgrade a package to a newer version, just install it over the old version.
Click OK on the warning screen.
All of the forms, scripts, pieces and backend menus that were part of the Hello World package are now gone, and the uninstall is complete.
Installing the Unnamed Package
The process of installing an unnamed package is identical to installing a named package. However, when installing an unnamed package, no existing forms, scripts, pieces or backend menus are updated or removed. This makes installing an unnamed package a poor choice for an upgradable application.
On the Package Installer screen, click the Upload package file from client & install radio button.
Below this is a text box that will hold the path and name of the xml file to be uploaded. You can either type in the path and filename to the package, or click the Browse... button and select the hello_world.xml file generated in the Package Creation chapter.
You are ready to install the package now. Click the Install Package button to install the package.
The unnamed package will be installed.
You are now at the Facile Forms Package Installation Report screen. This screen shows you summary information including the version, author and copyright information, and the number of each type of item imported in this package:
Click the Continue button, and you will return to the Facile Forms Package Installer screen.
Your hello_world unnamed package is now ready for use.
Uninstalling the Unnamed Package
It is difficult to uninstall an Unnamed Package in Facile Forms. There is no uninstaller that will do it for you. In order to uninstall an unnamed package, you must know which forms, scripts, pieces and backend menus are used by the package.
The unnamed package for the Hello World sample installed two items, a Hello World form and a Say Hello script.
- From the Joomla/Mambo Administrator backend, click on the menu Components->Facile Forms->Manage Forms.
- Find the Hello World form.
- Check the checkbox next to it.
- Click on the Delete button.
- From the Joomla/Mambo Administrator backend, click on the menu Components->Facile Forms->Manage Scripts.
- Find the Say Hello script.
- Check the checkbox next to it.
- Click on the Delete button.
The hello_world unnamed package has now been uninstalled.