Add case number to case assignment email

bmwtourer · 18 December 2017 19:24

which version are you using, what is your environment?

mikebeck · 19 December 2017 12:18

he’s referring to the notification mail on user assignment, that’s handled by the notify template, you’re in the correct path but you need to modify the /modules/Cases/Case.php specifically the function set_notification_body($xtpl, $case) you need to add the case_number xtpl there variable, remember to copy this file and modify it in the custom folder

best regards

pgr · 19 December 2017 12:32

Mike do you want to create a simple PR adding this into the code? It feels like an obvious thing that would benefit more people.

Thanks

yaakovg · 21 December 2017 19:32

Version 7.9.7
Sugar Version 6.5.25 (Build 344)

yaakovg · 21 December 2017 19:49

Per @mikebeck I added one line to: public function set_notification_body($xtpl, $case)

    $xtpl->assign('CASE_NUMBER', $case->case_number);

and can get the value as {CASE_NIUMBER} in the modified subject line

Real easy if you know where to look!

Thank you for your help

pgr · 8 February 2018 09:16

Months later, I stumbled upon this again and decided to make a simple PR:

https://github.com/salesagility/SuiteCRM/issues/5131

afatac · 22 May 2024 00:30

Our SuiteCRM version is 8.6.0. I check the file modules/Cases/Case.php and notice that this line is already in the file:
$xtpl->assign('CASE_NUMBER', $case->case_number);

But why is the case number not shown in our notification email?

chris001 · 22 May 2024 01:10

Can you look at the Case Assignment email notification template, and see if the variable CASE_NUMBER is used anywhere in there, like in the Subject (the expected place to show the case number), or in the Description?

afatac · 22 May 2024 02:42

I believe you are referring to this file include/language/en_us.notify_template.html

Indeed, the variable CASE_NUMBER is missing.

<!-- BEGIN: Case_Subject -->
<p>SuiteCRM Case - {CASE_SUBJECT}</p>
<!-- END: Case_Subject -->
<!-- BEGIN: Case -->
<p><b>{ASSIGNER}</b> has assigned a Case to <b>{ASSIGNED_USER}</b>.</p>
<p>
Subject: {CASE_SUBJECT}<br/>
Priority: {CASE_PRIORITY}<br/>
Status: {CASE_STATUS}<br/>
Description: {CASE_DESCRIPTION}
</p>
<p>You may <a href={URL}>review this Case</a>.</p>
<!-- END: Case -->

I added this line Case Number: {CASE_NUMBER}<br/>

<!-- BEGIN: Case_Subject -->
<p>SuiteCRM Case - {CASE_SUBJECT}</p>
<!-- END: Case_Subject -->
<!-- BEGIN: Case -->
<p><b>{ASSIGNER}</b> has assigned a Case to <b>{ASSIGNED_USER}</b>.</p>
<p>
Case Number: {CASE_NUMBER}<br/>
Subject: {CASE_SUBJECT}<br/>
Priority: {CASE_PRIORITY}<br/>
Status: {CASE_STATUS}<br/>
Description: {CASE_DESCRIPTION}
</p>
<p>You may <a href={URL}>review this Case</a>.</p>
<!-- END: Case -->

But in the received notification email, I got this.

rsp · 22 May 2024 16:16

Example

afatac · 23 May 2024 08:49

I do not think the variables used in the email templates are the same as the variables used in en_us.notify_template.html. However, I do not know much about coding, so I may be wrong.

What is your intended suggestion?

rsp · 23 May 2024 14:36

Admin → Repair → Quick repair & rebuild
Check if you have to run some commands on 8.6 to update changes
Go to Admin->Developer Tools->Studio->Cases->Fields->check case number Name

development_and_production_builds

afatac · 27 May 2024 11:16

I have inserted a debug point within the function set_notification_body to check if there is a value returned for case_number. The result captured in the log shows that case_number value is empty.

I have no idea how to proceed from here.

    public function set_notification_body($xtpl, $case)
    {
        global $app_list_strings;

        $xtpl->assign('CASE_NUMBER', $case->case_number);
        $xtpl->assign('CASE_SUBJECT', $case->name);
        $xtpl->assign(
            'CASE_PRIORITY',
            (isset($case->priority) ? $app_list_strings['case_priority_dom'][$case->priority] : '')
        );
        $xtpl->assign('CASE_STATUS', (isset($case->status) ? $app_list_strings['case_status_dom'][$case->status] : ''));
        $xtpl->assign('CASE_DESCRIPTION', nl2br($case->description));

        // Debug point: Notification body set
        debug_log("Notification body set for the case. Case number: " . $case->case_number);

        return $xtpl;
    }

pgr · 27 May 2024 11:22

Is that a newly created case? Maybe the case number has not been assigned (created) yet, so it is not available at that point in the execution.

If you can get a stack trace at that point, you can check the calling functions to see if it’s something that can be fixed.

afatac · 28 May 2024 03:55

Hi @pgr , yes, it is a newly created case.

Now, in Case.php, I have inserted debug points into two of the functions with stack trace enabled:

set_notification_body
fill_in_additional_detail_fields

Below is the output log captured after sending a new email to the group email account (Create Case from Email is enalbed).

I notice that for the function call of set_notification_body. the returned value of case_number is null. But for the function call of fill_in_additional_detail_fields, the returned value of case_number is 762, which is correct.

pgr · 28 May 2024 09:51

The problem is exactly that, the notification email is getting populated just before the number is saved in the DB, so someone is suggesting changing that order:

github.com/salesagility/SuiteCRM

Sending new assignee email while creating a case is not working.

opened 08:00AM - 03 Apr 24 UTC

ebsi-RBakade

Status:Requires Updates

#### Issue Email notification is not sending while creating a case at the first timet to assignee. But when we update case and reassign case to other User then it works. #### Expected Behavior It should send an email to assignee for newly created Case. #### Actual Behavior Email is not sending to assignee when new case is created. #### Possible Fix Move the following line below if else block https://github.com/salesagility/SuiteCRM/blob/hotfix/data/SugarBean.php#L2411 `$this->_sendNotifications($check_notify);` it should be below if else block because at that time case is not created. It gets only created in the else block having insert() function. When I moved _sendNotification() line below if else block then it’s working as intended. #### Steps to Reproduce 1. create a new case by filling all the required fields. 2. make sure that assignee field should not be blank and that assignee should have valid email address. 3. save the case. 4. email is received without contact and and case number. #### Context #### Your Environment * SuiteCRM Version used: 7.4.3 * Browser name and version (e.g. Chrome Version 51.0.2704.63 (64-bit)): Google Chrome 123.0.6312.86 (Official Build) (32-bit) * Environment name and version (e.g. MySQL, PHP 7): MariaDB : 5.5.5-10.1.21, PHP 5.3 * Operating System and version (e.g Ubuntu 16.04):Windows 32 Bit

afatac · 28 May 2024 13:23

I have tested the fix mentioned in your linked issue: move the line
$this->_sendNotifications($check_notify);
to after the if-else block.

However, it does not work for my case. The returned value for case_number is still null.

pgr · 28 May 2024 18:00

This code is complex, and not very well done. I had to fix it for my add-on PowerReplacer.

I just dug up my notes at the time, and you can see for yourself how messy it gets

This is what the Create Case process does currently:

1. Receives an Email in an inbox marked as "auto create case"

2. Creates a Case and copies some details from the Email into it.

3. Looks for Account(s) that match the email sender, sets the Case creator to be the first of those Accounts

4. Side-effect of the above: a case assignment notification email is sent to the user to whom the Account is assigned

5. Links the Email to the new Case

6. Links the new Case to the contact (some extra complexity here, depending on whether the sender email belongs to an account, a contact, both, or even several records of each).

7. Side effect of the above: some change notifications emails are sent

8. Copies all incoming Email attachments as files linked to SuiteCRM Notes records, and links them all to the Case.

9. Saves the Email record filling in some more details

10. Side-effect of above: sends change notifications to user assigned to the email

11. Finally starts working on the Reply Email, gathering details such as the Template to use and "From name" and "From address", and creates a subject line with the Case number

12. Does NOT replace any variables in the template! That code simply is not there.

13. Tries to send, but most email servers will reject it due to a wrong "From address".

So as you see - three emails, each with parts missing… the one you’re seeing seems closer to what is intended, but struggles with the new case number. The one that had a better chance of being complete (the last one) is quite a mess to repair

chris001 · 28 May 2024 22:56

Creating the new case number in step 2 shouldn’t cause any issue, and would fix the bugs where case number does not exist yet - causing notification emails with no case numbers!

Receives an Email in an inbox marked as “auto create case”

Creates a Case and copies some details from the Email into it.

Looks for Account(s) that match the email sender, sets the Case creator to be the first of those Accounts

Side-effect of the above: a case assignment notification email is sent to the user to whom the Account is assigned

…

pgr · 29 May 2024 12:32

I don’t recall exactly (and can’t test right now) but I think the number is created, the problem is that the way one code calls the other, hooks, etc, at some point we’re not using the same bean we were using originally, but the one in the database gets referenced, and it is incomplete at that point (in the middle of the save).