Dev Answers & Best Practices - Recent Threads

RE: SugarIdentity OAuth flow for third-party app integration for SSO users

Jeff Bickart — Thu, 16 Apr 2026 19:27:34 GMT

I believe In SugarIDM you can create a user and set their Local Authentication Username; this avoids using whatever you might use for SSO (Google or MSFT, etc)

You'll need to create a password for this user using the Forgot Password functionality.

Once you have both the username and password

You'll obtain a token the same as you normally would at https://<sugar>/rest/v11/oauth2/token; The pass thru to IDM is handled for you.

We do this with our iPaas integrations, etc

SugarIdentity OAuth flow for third-party app integration for SSO users

Dimitry Polivaev — Thu, 26 Mar 2026 16:08:04 GMT

Hello,

I am trying to integrate my third-party application with the Sugar REST API for a SugarCloud instance that uses SugarIdentity.

I found a description of a SugarIdentity 3-legged OAuth consent flow for OPI (Sugar Outlook Plug-In), where the user is redirected to the Sugar login service, authenticates through the IdP, sees a SugarIdentity consent screen, and the client receives access and refresh tokens.

However, I could not find equivalent documentation for integrating a custom third-party application.

Could you please explain how this integration should be implemented today for an external app?

Specifically, I need to understand the supported flow for a third-party app that accesses the Sugar REST API on behalf of an SSO user in a SugarIdentity-enabled tenant.

The main points I need are:

Where should the third-party app/client be registered?
Which OAuth flow should be used for this scenario?
What are the correct authorization and token endpoints?
Can a normal SSO user authorize such an app and grant access to their Sugar data?
If there is documentation for this flow, could you please share it?

I am not asking about configuring Okta/Azure/Google as login providers for Sugar itself.
I am asking about a custom external app integrating with Sugar via SugarIdentity for SSO users.

Thanks.

Best way to add extra info to assign notification email

Jeroen Somhorst — Fri, 06 May 2022 13:49:34 GMT

Hi,

I would like to add extra information to the notification email template. More information regarding the record that is being assigned. When I add $contacts_name using the insert button it doesn't seem to be working? Is there an easy (read: non programming) to add extra information to the assign notification mail?

RE: Best way to add extra info to assign notification email

Phuong Trinh — Tue, 14 Apr 2026 13:33:50 GMT

Hi Enes Saridogan ,

I am experiencing the same issue. I am trying to add the account_description field to the system assignment notification email for the Leads module, but the data is not pulling through—the field remains empty in the received email.

Since account_description is a stock field in the Leads module, I expected it to be readily available, but it seems I am missing something in the implementation.

Could someone please take a look at my code below? I can't figure out why the value isn't being parsed correctly:

<!-- BEGIN: Lead_Subject -->
SugarCRM Lead - {LEAD_NAME}
<!-- END: Lead_Subject -->
<!-- BEGIN: Lead -->
{ASSIGNER} a assigné un Lead à {ASSIGNED_USER}.

Nom: {LEAD_NAME}
Origine principale: {LEAD_SOURCE}
Statut: {LEAD_STATUS}
Description: {LEAD_DESCRIPTION}
Message de Lead : {ACCOUNT_DESCRIPTION} // 'new field'

Vous pouvez consulter la fiche de ce Lead ici:
<{URL}>
<!-- END: Lead -->

Any insights or corrections would be greatly appreciated. Is there a specific way to reference this field in the fr_FR.notify_template.html ?

Thanks in advance for your help!

Custom Field not populating in System Assignment Notifications (Leads module)

Phuong Trinh — Mon, 13 Apr 2026 13:03:48 GMT

Hi everyone,

I am encountering an issue with System Assignment Notifications in the Leads module and would appreciate some advice from the community.

The Problem:
I am trying to include a natif field called "Message du lead" (account_description) in the notification email sent to users when a Lead is assigned to them.

Observations:

The field is correctly populated within the SugarCRM record view

However, the field remains blank in the actual notification email received by the user. It appears that the variable used in the notification template is not correctly pulling the data from the Lead bean during the notification trigger.

Technical Context:

Module: Leads
Field Name: account_description
Deployment: SugarCloud

My Question:
Has anyone successfully added more fields to the system assignment notifications?

Is there a specific syntax to use in the fr_FR.notify_template.html file for custom fields?

Here is the code modified :

[embed:dc8ab71f-3b98-42d9-b0f6-e21e02a0f8e2:003795b9-e924-4a77-aba2-bc8e2f63ffb8:type=text&text=%3C%21--%20BEGIN%3A%20Lead_Subject%20--%3E%0ASugarCRM%20Lead%20-%20%7BLEAD_NAME%7D%0A%3C%21--%20END%3A%20Lead_Subject%20--%3E%0A%3C%21--%20BEGIN%3A%20Lead%20--%3E%0A%7BASSIGNER%7D%20a%20assign%C3%A9%20un%20Lead%20%C3%A0%20%7BASSIGNED_USER%7D.%0A%0ANom%3A%20%7BLEAD_NAME%7D%0AOrigine%20principale%3A%20%7BLEAD_SOURCE%7D%0AStatut%3A%20%7BLEAD_STATUS%7D%0ADescription%3A%20%7BLEAD_DESCRIPTION%7D%0AMessage%20de%20Lead%20%3A%20%7BLEAD_SOURCE_DESCRIPTION%7D%20%2F%2F%20%27new%20field%27%0A%0AVous%20pouvez%20consulter%20la%20fiche%20de%20ce%20Lead%20ici%3A%0A%3C%7BURL%7D%3E%0A%3C%21--%20END%3A%20Lead%20--%3E]

Any guidance, code snippets, or best practices would be greatly appreciated!

Thanks in advance,

H. Phuong

Error: POST /rest/v11_27/Contacts/ — 500 Internal Server Error (confirmed via browser console)

Kelli Morgan — Thu, 09 Apr 2026 18:24:06 GMT

We are experiencing a critical issue in SugarCRM where no users can open any contact records. The contact record will open for a split second, then the system displays an "Unknown Error" message.

Here is a summary of what we found:

ERROR:
POST /rest/v11_27/Contacts/ — 500 Internal Server Error (confirmed via browser console)

This occurred around the same time a mass update of 30 fields and report generation. Schedulers were also likely to be simultaneously running.

ADDITIONAL DETAILS:

Affects all users on all contact records
SugarCRM log shows repeated CSRF errors: "ModuleBuilder -> savetablesort"
Quick Repair and Rebuild has been run with no errors
Restoring previous layout versions from history has not resolved the issue
Version 25.2./Sell Advanced

Has anyone else experienced this issue? If so, any suggestions?

RE: Error: POST /rest/v11_27/Contacts/ — 500 Internal Server Error (confirmed via browser console)

Andre Serrazina — Fri, 10 Apr 2026 10:26:54 GMT

Hello Kelli Morgan ,

Thanks for creating this entry. The 500 error you're seeing is a good starting point.

This type of error will typically also generate an entry in the PHP error logs of the instance, which can help identify the root cause. Could you check whether there are any log entries recorded at the same time the error appears?

From experience, if the contact record loads briefly before failing, this could indicate the issue is related to elements that take slightly longer to load in the record view, such as dashlets.

As a troubleshooting step, you could try removing the dashlets from the record view to see if that prevents the error.

That said, checking the server logs is definitely the best next step.

Let us know what you find.

Cheers,

André

RE: Issue after repair

Andre Serrazina — Wed, 08 Apr 2026 08:45:23 GMT

Hello Adrian Arauz ,

As this issue is happening during a Repair, I would suspect that something is preventing all the required files from being created.

The first thing I would check is to scan the php error logs to see if you spot any entries related to filesystem permissions, or memory exhaustion errors that could have occurred during the QRR process.

Can you also check the SugarCRM log to see if there are any DB queries erroring out?

Let us know what you find.

Cheers,

André

Issue after repair

Adrian Arauz — Mon, 06 Apr 2026 14:48:56 GMT

Hello, good day. We're experiencing a problem repairing SugarCRM Enterprise version 25.1.2. For the past few days, we've noticed that after repairing, we're getting an unknown error. We've resolved this by copying the cache folder and updating a Google folder within the vendor directory using Composer.

Has anyone else experienced this? Any recommendations to prevent it from happening again?

Bizarre logic hook problem

Francesca Shiekh — Wed, 01 Apr 2026 18:11:20 GMT

I was working on cleaning up some very very old code (I think v6 or v7)

As I do that I wanted to be more consistent with naming conventions

The original logic hook was

$hook_array['process_record'][] = Array(1,'conditional_formatting','custom/modules/Cases/conditional_formatting.php','ConditionalFormatting','conditional_formatting');

The cleaned up one was using camel case for the function, and a better name for the file

$hook_array['process_record'][] = array( 1, 'conditionalFormatting', 'custom/modules/Cases/Cases_ConditionalFormatting_Logic.php', 'ConditionalFormatting', 'conditionalFormatting');

Of course the class and the function names were changed consistently in the new file, the old file was removed.

I did a QRR, cleared cache etc... the logic_hook refuses to fire with the new names. I put a fatal log entry at the start of the hook function, nothing in the log.

If all I do is change the name of the refactored file, name of the function and name of the class to the old ones then everything runs smoothly.

Why would that be? How can renaming something (consistently I might add) break it?
It's puzzling...

FrancescaS

RE: Bizarre logic hook problem

Francesca Shiekh — Tue, 07 Apr 2026 21:45:18 GMT

Yes, the original hook works fine.

I don't think it's worth your time trying to figure this out.

Thanks for the note on the change in Logic Hooks, I'll plan to move to Extensions with the next upgrade. It will be a bit of work given that over 40 modules have logic hooks...

Thanks again!
Francesca

RE: Bizarre logic hook problem

Angel Magana — Tue, 07 Apr 2026 15:59:55 GMT

Whether it shows or doesn't will be dependent on how one goes about defining the hook.

Older versions of Sugar would use the approach that leverages the logic_hooks.php file. At some point, we introduced Logic Hooks into the capabilities of the Extensions Framework, which then allowed one to define a logic hook by way of extensions and in turn, use the logichooks.ext.php file. Both approaches are equally valid, but we do favor the Extensions approach for situations where a customization can be implemented through multiple means.

Your hooks are likely configured that way due to their age. There is nothing inherently wrong with them.

As a side note, the order numbering is fine. That's mostly relevant for scenarios where you have multiple hooks of the same type (e.g. before_save) and need them to execute in a specific order.

I'll ask a dumb question, does the hook work if you rename the files back to their prior name?

RE: Bizarre logic hook problem

Francesca Shiekh — Tue, 07 Apr 2026 15:45:57 GMT

I don't, but should they?
I don't see any custom logic hooks in that file, not even for the hooks that work just fine.

This is all I see in

custom/modules/Cases/Ext/LogicHooks/logichooks.ext.php

<?php
// WARNING: The contents of this file are auto-generated.
?>
<?php
// Merged from modules/Cases/Ext/LogicHooks/RelationshipHook.php

/*
 * Your installation or use of this SugarCRM file is subject to the applicable
 * terms available at
 * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.
 * If you do not agree to all of the applicable terms or do not have the
 * authority to bind the entity as an authorized representative, then do not
 * install or use this SugarCRM file.
 *
 * Copyright (C) SugarCRM Inc. All rights reserved.
 */

$hook_array['before_relationship_delete'][] = [
    1,
    'beforeRelationshipDelete',
    'modules/Cases/CasesHooks.php',
    'CasesHooks',
    'beforeRelationshipDelete',
];

$hook_array['after_relationship_add'][] = [
    1,
    'afterRelationshipAdd',
    'modules/Cases/CasesHooks.php',
    'CasesHooks',
    'afterRelationshipAdd',
];

$hook_array['after_relationship_delete'][] = [
    1,
    'afterRelationshipDelete',
    'modules/Cases/CasesHooks.php',
    'CasesHooks',
    'afterRelationshipDelete',
];

?>
<?php
// Merged from custom/Extension/modules/Cases/Ext/LogicHooks/denorm_field_hook.php

/*
 * Your installation or use of this SugarCRM file is subject to the applicable
 * terms available at
 * http://support.sugarcrm.com/Resources/Master_Subscription_Agreements/.
 * If you do not agree to all of the applicable terms or do not have the
 * authority to bind the entity as an authorized representative, then do not
 * install or use this SugarCRM file.
 *
 * Copyright (C) SugarCRM Inc. All rights reserved.
 */

// Relate Field Denormalization hook

$hook_array['before_save'][] = [
    1,
    'denorm_field_watcher',
    null,
    '\\Sugarcrm\\Sugarcrm\\Denormalization\\Relate\\Hook',
    'handleBeforeUpdate',
];

$hook_array['after_save'][] = [
    1,
    'denorm_field_watcher',
    null,
    '\\Sugarcrm\\Sugarcrm\\Denormalization\\Relate\\Hook',
    'handleAfterUpdate',
];

$hook_array['before_relationship_delete'][] = [
    1,
    'denorm_field_watcher',
    null,
    '\\Sugarcrm\\Sugarcrm\\Denormalization\\Relate\\Hook',
    'handleDeleteRelationship',
];

$hook_array['after_relationship_add'][] = [
    1,
    'denorm_field_watcher',
    null,
    '\\Sugarcrm\\Sugarcrm\\Denormalization\\Relate\\Hook',
    'handleAddRelationship',
];

?>

And these are my working (tested) Logic hooks,

custom/modules/Cases/logic_hooks.php

<?php
/**
 * logic_hooks.php — Cases module
 *
 * Hook registration order within each event is determined by the first
 * element of each entry (the position integer). Lower numbers run first.
 *
 * Format: array(position, label, file, class, method)
 */

$hook_version = 1;
$hook_array   = array();

// -----------------------------------------------------------------------------
// before_save
// -----------------------------------------------------------------------------
$hook_array['before_save'][] = array( 3, 'beforeSave',        'custom/modules/Cases/Cases_Logic.php',                      'AutomatedCaseHandling', 'beforeSave',);
$hook_array['before_save'][] = array( 4, 'updateLog',         'custom/modules/Cases/Cases_Logic.php',                      'AutomatedCaseHandling', 'updateLog',);
$hook_array['before_save'][] = array( 5, 'checkEmailAddress', 'custom/modules/Cases/Cases_Logic.php',                      'AutomatedCaseHandling', 'checkEmailAddress',);
$hook_array['before_save'][] = array( 6, 'checkVIP',          'custom/modules/Cases/Cases_Logic.php',                      'AutomatedCaseHandling', 'checkVIP',);
$hook_array['before_save'][] = array( 7, 'checkGDPR',         'custom/modules/Cases/Cases_Logic.php',                      'AutomatedCaseHandling', 'checkGDPR',);

// -----------------------------------------------------------------------------
// after_save
// -----------------------------------------------------------------------------
$hook_array['after_save'][] = array( 3, 'afterSave',               'custom/modules/Cases/Cases_Logic.php',                 'AutomatedCaseHandling', 'afterSave',);
$hook_array['after_save'][] = array( 4, 'saveContactRelationship', 'custom/modules/Cases/Cases_Logic.php',                 'AutomatedCaseHandling', 'saveContactRelationship',);

// -----------------------------------------------------------------------------
// after_relationship_add
// -----------------------------------------------------------------------------
$hook_array['after_relationship_add'][] = array( 1, 'checkVIP',          'custom/modules/Cases/Cases_Logic.php',           'AutomatedCaseHandling', 'checkVIP',);
$hook_array['after_relationship_add'][] = array( 2, 'compProductNotes',  'custom/modules/Cases/Cases_Logic.php',           'AutomatedCaseHandling', 'compProductNotes',);

// -----------------------------------------------------------------------------
// after_relationship_delete
// -----------------------------------------------------------------------------
$hook_array['after_relationship_delete'][] = array( 1, 'checkVIP',       'custom/modules/Cases/Cases_Logic.php',           'AutomatedCaseHandling', 'checkVIP',);

// -----------------------------------------------------------------------------
// process_record
// -----------------------------------------------------------------------------
$hook_array['process_record'][] = Array(1,'conditional_formatting','custom/modules/Cases/conditional_formatting.php','ConditionalFormatting','conditional_formatting');

Not all numbering starts with 1 because I removed some old hooks and didn't think to renumber until now, but that has no created issues for years.

Thanks,

Francesca

RE: Bizarre logic hook problem

Angel Magana — Mon, 06 Apr 2026 14:42:19 GMT

Hi Francesca,

Another thought that crosses my mind is that perhaps the QRR process didn't pick up the definition.

Are you seeing a reference to the definition file in ./custom/modules/<Module>/Ext/LogicHooks/logichooks.ext.php ?

RE: Bizarre logic hook problem

Francesca Shiekh — Fri, 03 Apr 2026 00:18:03 GMT

Thank you Angel, I double checked everything, including copy/paste names in searches in the code to make absolutely sure they are the same...🤷

RE: Bizarre logic hook problem

Angel Magana — Thu, 02 Apr 2026 22:08:14 GMT

Hi Francesca,

Yeah, something doesn't add up. I would be equally puzzled as renaming things wouldn't cause such problems, assuming everything lines up in the definition file, etc.

Is it possible that the permissions on the files were changed when your renamed them? Other than that, the only other thing I can think of is the casing on the names...that is, the names might match, but the casing doesn't.

RE: Calculated Checkbox not setting as expected

Francesca Shiekh — Wed, 01 Apr 2026 19:08:21 GMT

That did it, thanks!

Calculated Checkbox not setting as expected

Francesca Shiekh — Wed, 01 Apr 2026 00:04:17 GMT

Sugar Ent 25.1 on site
I have a calculated checkbox field with formula

greaterThan(
count(

related($aupub_author_publications_contacts,"name")

)
,0)

The formula is acceptable, the related portion is built in Studio via the usual selection of Related, the relationship link is correct.

Yet when I add an Author Publication the checkbox is not set

Any thoughts on how to debug?

Thanks,
FrancescaS

RE: Calculated Checkbox not setting as expected

Chris Raffle — Wed, 01 Apr 2026 11:35:36 GMT

Hi Francesca ,

When using count(), you only need to specify the relationship link for the formula to properly assess whether any related records exist. Try using the following formula instead:

greaterThan(
    count(
        $aupub_author_publications_contacts
    ),
    0
)

Chris

RE: demobuilder.sugarcrmdemo.com's File manager no longer let's me edit files

Miruna Craciun — Tue, 17 Mar 2026 09:23:15 GMT

Issue was addressed last night, thanks for your patience!

demobuilder.sugarcrmdemo.com's File manager no longer let's me edit files

Patrick McQueen — Sun, 15 Mar 2026 22:36:48 GMT

What happened to demobuilder.sugarcrmdemo.com's File manager?
The interface up to a few days ago allowed me to open a file and edit it right there in the File manager interface. Now, files opened display the file content, but do not allow me to edit the content.
The ability to edit file content was a essential for debugging. Was this an intentional removal of functionality? Is it a defect? Is it something on my end I need to change?

[mention:1ec9289a19b7489188e562f4d7c7d4ac:e9ed411860ed4f2ba0265705b8793d05]

RE: demobuilder.sugarcrmdemo.com's File manager no longer let's me edit files

Keith Neuendorff — Mon, 16 Mar 2026 23:36:44 GMT

Yes, mine is working now too.

RE: demobuilder.sugarcrmdemo.com's File manager no longer let's me edit files

Patrick McQueen — Mon, 16 Mar 2026 22:45:21 GMT

Keith Neuendorff Mine is working as expected today. Is yours back to working as well?

RE: demobuilder.sugarcrmdemo.com's File manager no longer let's me edit files

Patrick McQueen — Mon, 16 Mar 2026 22:44:57 GMT

Miruna Craciun Not sure if you did anything, but this looks to be back to working as expected today.

Are you cleaning up your Emails/Email Addresses?

Francesca Shiekh — Mon, 16 Mar 2026 16:53:13 GMT

In 2011, when I was starting off with Sugar, I drew a sketch of the back-end tables that make up an Email.

Fast Forward (and it has been very fast) to 2026 and I asked ClaudeAI to take that overused coffee-stained sketch and draw it out for me.
I thought I would share it here, together with some thoughts on a cleanup effort I've been working through hoping others will share their cleanup journey too.

We are on-site, and space has never been much of an issue, but that's not a good reason to let the data sit unchecked and I found some "orphans" around the Emails module.

What I found:

1) I have quite a few orphan email addresses with no related Emails or beans

I believe these come from Spam emails that reached our Inbound email addresses.
The Case is deleted, the corresponding Email is deleted, but the email address remains, with no related beans or Emails.

2) I have quite a few orphan Emails where the customer's email address/es are not linked to any Beans
These are most likely from a custom inbound_email address that does not create Cases but is parsed to create Leads.
The Lead is deleted as Spam/useless but the email address and corresponding Email remain.
Clearly such orphaned emails are not ever visible on any record unless you go directly to the Emails module (and who does that?)

3) I have a lot of email addresses that were marked invalid over time and should probably be deleted, but if I do that then I should delete the Email too, or I'll end up with Emails with no To/From address.

Have you tried doing some cleanup in this area of your stored data?

What have you found? And how are you going about cleaning things up?

Thanks,

FrancescaS