Module Administrator Functionality in Sugar 5.2

bsoremsugar —  December 15, 2008 — 6 Comments

A key feature in the up-coming 5.2 release for Sugar Professional and Sugar Enterprise will enable Sugar administrators to delegate more granular module control to end users. In previous versions, users needed to be marked as an “Administrator” to gain access to the Administration area of the application.  This exposed ALL administration functionality to that user.

In 5.2, users can be marked as being administrators for particular modules giving them access to only relevant administration functionality.  This can be done by giving users a role with its “Access Type” set to “Developer” or “Admin & Developer“.  Both settings will ensure that users with that role will have access to Administration areas for that module.  The “Admin & Developer” setting additionally grants the user visibility into all the records for that module (by-passing any team security that may be in place).

What exactly does a MA see?

  • Upon login, a module administrator will see an “Admin” link at the top of the application (previously only available to System Administrators).  This will give them access to the Administration area of the application.
  • MAs of all studio-enabled modules will have access to Studio in the Administration area.  In Studio, MAs will be able to modify only those modules for which they are either “Developer” or “Admin & Developer”.
  • Workflow tools will be exposed and MAs can define workflows for the pertinent modules.
  • Any other module specific tools in the Administration area will be exposed (e.g. A “Developer” for the Products module will see the Products related tools, etc.).

Enabling MA functionality for your custom modules
Custom modules can take advantage of this feature quite easily.  Any new Administration tools should be added to the following file:

custom/modules/Administration/Ext/Administration/administration.ext.php

in the following format:


In this example, the link will ONLY be available to System Administrators. To enable access for MAs, you’d specify the module name as follows:

$myModuleName = $customPkgName.'_'.$moduleName;
$admin_option_defs[$myModuleName]['MyModulesLink']=...

OOB examples of this construct are located at

/modules/Administration/index.php

API Change Affecting all Editions

While this new feature is available only in Sugar Professional and Sugar Enterprise, the code for defining sections in the Admin screen has changed in 5.2 for all editions of Sugar including the Community Edition.  The $admin_option_defs[] array is now a two-dimensional array as described above where in previous releases it was a one-dimensional array.  The two-dimensional array now defines both the module section and the entry key for a given Admin screen entry instead of just the entry key.

Developers who built customizations around the Admin screen will need to modify their code appropriately.

6 responses to Module Administrator Functionality in Sugar 5.2

  1. 

    In community Edition this “Access Type” column doesn’t appear un Role Form but the functionnality is describe un Help :-)

    If it’s normal, I think it’s important to say that is functionnality is available only in Professional and Enterprise version.

  2. 

    In community Edition this “Access Type” column doesn’t appear un Role Form but the functionnality is describe un Help :-)

    If it’s normal, I think it’s important to say that is functionnality is available only in Professional and Enterprise version.

  3. 

    Good point, this functionality is only in the Professional and Enterprise editions. We will update the article accordingly.

  4. 

    Good point, this functionality is only in the Professional and Enterprise editions. We will update the article accordingly.

  5. 

    And we also updated the article to clearly identify the API change around defining Admin entries.

  6. 

    And we also updated the article to clearly identify the API change around defining Admin entries.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s