Sugar Developer Guide Version 5.1

Manifest Overview

The following section outlines the parameters specified in the $manifest array contained in the manifest file (manifest.php). An example manifest file is included later for your reference.

$manifest array elements provide the Module Loader with descriptive information about the extension.

o	acceptable_sugar_flavors - Contains which Sugar Editions the package can be installed on. Accepted values are any combination of: OS (valid prior to Sugar 5.0.0), CE (valid after Sugar 5.0.0), PRO, and ENT.

o	acceptable_sugar_versions - This directive contains two arrays:

o	exact_matches: each element in this array should be one exact version string, i.e. “5.0.0e” or “5.1.0”

o	regex_matches: each element in this array should be one regular expression designed to match a group of versions, i.e. “5\\.0\\.0[a-z]”

o	author - Contains the author of the package, i.e. “SugarCRM Inc.”

o	copy_files - An array detailing the source and destination of files that should be copied during installation of the package. See the example manifest file below for details.

o	dependencies - A set of dependencies that must be satisfied to install the module. This contains two arrays:

o	id_name : the unique name found in $installdefs.

o	version: the version number.

o	description - A description of the package. Displayed during installation. Note: Apostrophes (') are not supported in your description and will cause a Module Loader error.

o	icon - A path (within the package ZIP file) to an icon image that will be displayed during installation. Examples include: “./patch_directory/icon.gif” and “./patch_directory/images/theme.gif”

o	is_uninstallable - Setting this directive to TRUE allows the Sugar administrator to uninstall the package. Setting this directive to FALSE disables the uninstall feature.

o	name - The name of the package. Displayed during installation. Note: Apostrophes (') are not supported in your description and will cause a Module Loader error.

o	published_date - The date the package was published. Displayed during installation.

o	type - The package type. Accepted values are:

o	langpack - Packages of type langpack will be automatically added to the “Language” dropdown on the Sugar Login screen. They are installed using the Upgrade Wizard.

o	module - Packages of type module are installed using the Module Loader.

o	patch - Packages of type patch are installed using the Upgrade Wizard.

o	theme - Packages of type theme will be automatically added to the “Theme” dropdown on the Sugar Login screen. They are installed using the Upgrade Wizard.

o	version - The version of the patch, i.e. “1.0” or “0.96-pre1” .