Adding a Custom Module to the Customer Portal

RE: Adding a Custom Module to the Customer Portal

Bhavesh Patel — Mon, 27 Feb 2023 07:22:16 GMT

Hi,

I Would like understand What level of customization is possible in sugar Portal? I want to suggest this to my customer.

I Would like to create custom module and add that module into Sugar Portal. Is that possible to achieve in SugarCRM latest version?

I am going create custom relationship with Notes, Documents and Opportunity module is that possible to display into Portal?

I also create some relate fields, Notes, Comments and attachment fields to custom module is that possible to display into Portal?

I Would like to create some custom dashlet through code is that possible to display into Portal?

Regards,
Bhavesh Patel

RE: Adding a Custom Module to the Customer Portal

Anthony Watson — Tue, 13 Jul 2021 19:56:53 GMT

It's worth noting, in regards to this step:

If your module will have record or list views, you will need a portal directory under the clients directory. Within that portal folder, be sure to add the appropriate directories and files like so:

<basepath>/sugar_NameOfYourModule/clients/portal/views/list/list.php

That the relevant content of those files should use the "portal" key, not the "base" key. For instance, the above list.php would have:

[embed:dc8ab71f-3b98-42d9-b0f6-e21e02a0f8e2:83f1be05-5210-4b2a-bce3-d56d2ebb95ab:type=php&text=%3C%3Fphp%0D%0A%0D%0A%24module_name%20%3D%20%27sugar_NameOfYourModule%27%3B%0D%0A%24viewdefs%5B%24module_name%5D%5B%27portal%27%5D%5B%27view%27%5D%5B%27list%27%5D%20%3D%20array%20%28]

If you have created your custom module via Module Loader, the equivalent layout file it builds would be

<basepath>/sugar_NameOfYourModule/clients/base/views/list/list.php

and would start with:

[embed:dc8ab71f-3b98-42d9-b0f6-e21e02a0f8e2:17dcf081-959a-40ff-82a2-c832b4c14c6a:type=php&text=%3C%3Fphp%0D%0A%0D%0A%24module_name%20%3D%20%27sugar_NameOfYourModule%27%3B%0D%0A%24viewdefs%5B%24module_name%5D%5B%27base%27%5D%5B%27view%27%5D%5B%27list%27%5D%20%3D%20array%20%28]

Copying this file directly to the "portal" directory without updating that reference from "base" to "portal" will cause issues. Similarly, there are stock fields in "base" context that are not available in "portal", such as team-based fields. So these should be removed.

TLDR; simply copying those Module Builder built view files over to portal will cause problems.

RE: Adding a Custom Module to the Customer Portal

Harald Kuske — Tue, 13 Jul 2021 08:49:22 GMT

Tried this yesterday with 11.1 and was able to show a custom dashlet on the portal start page and to add and list "orders" from that custom module. Nice job to modify the dashlet JSON which describes the start page.

RE: Adding a Custom Module to the Customer Portal

Omar Delgado Martinez — Tue, 25 Aug 2020 15:18:26 GMT

Great information! I used this method but I am having a issue in the record list view... I can see all records even the ones that my portal user didn't create. Am I missing something?

RE: Adding a Custom Module to the Customer Portal

Alexandre Moulin — Mon, 20 Apr 2020 12:28:24 GMT

If I may add something, this vardefs config is not complete. To have full best behavior you shall better put in vardefs the following :

$dictionary['<bean name>']['portal_visibility'] = array(
    'class' => 'Visible',
    'links' => array(
        'Accounts' => '<name of field link for account's relationship>',
        'Contacts' => '<name of field link for contact's relationship>',
    )
);

Therefore once a portal user creates a record in the custom module it will be automatically linked to the contact's account and/or to the contact itself.

(sources : client/portal/api/ModulePortalApi.php, data/visibility/portal/Context.php, src/Portal/Session.php)

best regards,

Alexandre

RE: Adding a Custom Module to the Customer Portal

Tony Romano — Fri, 14 Feb 2020 18:23:09 GMT

hi Michael Shaheen
Does this work for other Enterprise versions like v9.0.2?

RE: Adding a Custom Module to the Customer Portal

Vincent Amari — Wed, 12 Feb 2020 18:45:33 GMT

Another great and useful post, thank you Michael Shaheen

Mind you, what are the chances of making this a studio config feature rather that having to create code?