AnsweredAssumed Answered

Audit log does not show a log entry for changes on an audited relate field's on Sugar 8.0.1

Question asked by Victoria Askham on Nov 26, 2018
Latest reply on Jan 30, 2019 by Matt Marum

Like • Show 0 Likes0
Comment • 5

Hi,

We have upgraded to Sugar 8.0.1 on our test platform.

As part of our testing we check whether certain fields are "Audited". We have identified that our existing audited relate fields are no longer showing any audit log entries in the UI. (These audited relate fields was working in the Sugar 7.9.4 instance.)

Initially this was thought to be because of the way we applied our custom relate fields without Studio. ( Please see example below, we marked the relate field as the audited.)


'stage1_approver_id'                       => array(
    'name'            => 'stage1_approver_id',
    'rname'           => 'user_name',
    'id_name'         => 'stage1_approver_id',
    'vname'           => 'LBL_STAGE1_APPROVER_ID',
    'type'            => 'id',
    'table'           => 'users',
    'module'          => 'Users',
    'reportable'      => false,
    'isnull'          => 'true',
    'dbType'          => 'id',
    'duplicate_merge' => 'disabled',
    'massupdate'      => false,
),
'stage1_approver_name'                     => array(
    'audited'         => true,
    'name'            => 'stage1_approver_name',
    'required'        => true,
    'link'            => 'stage1_approver_link',
    'vname'           => 'LBL_STAGE1_APPROVER',
    'rname'           => 'name',
    'type'            => 'relate',
    'reportable'      => false,
    'source'          => 'non-db',
    'table'           => 'users',
    'id_name'         => 'stage1_approver_id',
    'module'          => 'Users',
    'duplicate_merge' => 'disabled',
    'studio'          => 'visible',
),
'stage1_approver_link'                     => array(
    'name'         => 'stage1_approver_link',
    'type'         => 'link',
    'relationship' => 'emis_internalorders_stage1_approver',
    'vname'        => 'LBL_STAGE1_APPROVER_LINK',
    'link_type'    => 'one',
    'module'       => 'Users',
    'bean_name'    => 'User',
    'source'       => 'non-db',
    'rname'        => 'user_name',
    'id_name'      => 'stage1_approver_id',
    'table'        => 'users',
),

We then set the ID field Audited, but this only showed an audited log entry for the IDs (the GUIDS).

However we have identified this applies to other relate fields including studio built ones in the majority of modules if not all.

We created a custom relate field using the studio in one of the modules.

Ticked the "Audit" checkbox.

When we we edited the field multiple times, no audit log entries appeared, though the field was highlighted as being audited in the bottom pane of the "Audit Log".

I then checked SugarCRM 8.0.1 Vanilla (This is a sugar instance with no customisations) this also did not appear to audit relate fields. e.g;

Opportunities -> change the Account relate field on an existing record. This was not logged.
Cases -> change the Account relate field on an existing record. This was not logged.

Though on both it states the Account ID is "audited".

Is this a know issue?

Wondered someone could advise?

No one else has this question

Outcomes

Junaid Usman Nov 27, 2018 6:46 AM

Hi Viktoria,

There is nothing wrong in your code. We have encountered the same problem with one of our customer and found out that it is due to a bug in SugarCRM. This is currently logged as bug #81798 on Sugar support portal.

I guess we have to wait for a fix. If you are on-premise then you may have to request for a hotfix once it is resolved.

Regards,

Junaid Usman

3 people found this helpful

Actions

Victoria Askham @ Junaid Usman on Nov 27, 2018 7:26 AM

There is also bug 81328 on the sugar portal as well. Thanks Junaid.

2 people found this helpful

Actions

Francesca Shiekh Dec 19, 2018 7:09 AM

Victoria Askham, thank you for the bug reference, the Problem persists in v8.0.2 Pro

Actions

Francesca Shiekh Jan 30, 2019 11:06 AM

I have a theory:

getAuditDataChanges was modified and moved from include/database/DBManager.php to SugarBean::getAuditDataChanges()

AND

the vardefs for relate fields have changed but studio/modulebuilder has not been updated.

While relate fields that are from the stock instance have been updated to the most recent version, there was no provision in the upgrades to change the the vardefs for custom relate fields.

Let me explain in more detail:

In a custom relate field that is audited the audited =>true is set in the vardefs for the field, not the vadef for the corresponding id.

For example I have a salesperson relate field in a custom module.

The relate field was added when I built the module via module builder.

The vardef for the field looks like this:

    'user_id_c' =>
    array (
      'required' => false,
      'name' => 'user_id_c',
      'vname' => 'LBL_SALESPERSON_USER_ID',
      'type' => 'id',
      'massupdate' => false,
      'no_default' => false,
      'comments' => '',
      'help' => '',
      'importable' => 'true',
      'duplicate_merge' => 'enabled',
      'duplicate_merge_dom_value' => 1,
      'reportable' => false,
      'unified_search' => false,
      'merge_filter' => 'disabled',
      'pii' => false,
      'calculated' => false,
      'len' => 36,
      'size' => '20',
    ),
    'salesperson' =>
    array (
      'required' => true,
      'source' => 'non-db',
      'name' => 'salesperson',
      'vname' => 'LBL_SALESPERSON',
      'type' => 'relate',
      'massupdate' => false,
      'no_default' => false,
      'comments' => '',
      'help' => '',
      'importable' => 'true',
      'duplicate_merge' => 'enabled',
      'duplicate_merge_dom_value' => '1',
      'audited' => true,
      'reportable' => true,
      'unified_search' => false,
      'merge_filter' => 'disabled',
      'pii' => false,
      'calculated' => false,
      'dependency' => 'isInList($sales_entity_type,createList("Account Executive","Inside Sales"))',
      'len' => 255,
      'size' => '20',
      'id_name' => 'user_id_c',
      'ext2' => 'Users',
      'module' => 'Users',
      'rname' => 'name',
      'quicksearch' => 'enabled',
      'studio' => 'visible',
    ),

Notice that audited => true is set on the 'salesperson' definition, not on the 'user_id_c' definition.

By ADDING audited=>true to the 'user_id_c' via a vardef extension

$dictionary['sgoal_SalesGoals']['fields']['user_id_c']['audited']=true;

I can now see the audit entries in the _audit table as field_name = 'user_id_c' and before and after values are the user ids.

But still cannot see the update in the View Audit Logs

However, if I also set the audit to false on the field vardef

$dictionary['sgoal_SalesGoals']['fields']['salesperson']['audited']=false;

I can now see the changes in the View Audit Log:

But... the plot thickens...

While the module from the example above was created in v8.x, if I do the same thing on a custom module built in v6.x , where the relate field was added some time after its creation, and later upgraded to sidecar, the View Audit Log displays without the field specifics.

In this module I happen to have multiple relate fields, and I can't tell which one was updated based on the View Audit Log.

The only difference I see in the vardefs is the custom module information:

'id' => 'smgmt_Sales_Managementsales_executive_c',

'custom_module' => 'smgmt_Sales_Management',

in both the field vardef and the id vardef

    'sales_assistant_c' =>
    array (
      'labelValue' => 'Inside Sales',
      'dependency' => '',
      'massupdate' => true,
      'audited' => false,
      'required' => false,
      'source' => 'non-db',
      'name' => 'sales_assistant_c',
      'vname' => 'LBL_SALES_ASSISTANT_C',
      'type' => 'relate',
      'no_default' => false,
      'comments' => '',
      'help' => '',
      'importable' => 'true',
      'duplicate_merge' => 'enabled',
      'duplicate_merge_dom_value' => 1,
      'reportable' => true,
      'unified_search' => false,
      'merge_filter' => 'disabled',
      'pii' => false,
      'calculated' => false,
      'len' => 255,
      'size' => '20',
      'id_name' => 'user_id_c',
      'ext2' => 'Users',
      'module' => 'Users',
      'rname' => 'name',
      'quicksearch' => 'enabled',
      'studio' => 'visible',
      'id' => 'smgmt_Sales_Managementsales_assistant_c',
      'custom_module' => 'smgmt_Sales_Management',
    ),
    'user_id_c' =>
    array (
      'audited' => true,
      'required' => false,
      'source' => 'custom_fields',
      'name' => 'user_id_c',
      'vname' => 'LBL_LIST_RELATED_TO',
      'type' => 'id',
      'massupdate' => false,
      'no_default' => false,
      'comments' => '',
      'help' => '',
      'importable' => 'true',
      'duplicate_merge' => 'disabled',
      'duplicate_merge_dom_value' => 0,
      'reportable' => true,
      'unified_search' => false,
      'merge_filter' => 'disabled',
      'pii' => false,
      'calculated' => false,
      'len' => 36,
      'size' => '20',
      'id' => 'smgmt_Sales_Managementuser_id_c',
      'custom_module' => 'smgmt_Sales_Management',
    ),

Matt Marum, I'd love some input from your end if possible.

thanks,
FrancescaS

Actions

Matt Marum

@ Francesca Shiekh on Jan 30, 2019 11:44 AM

So I don't have intimate knowledge of this code. I know that audit log implementation was changed as part of Data Privacy work for 8.0. The platform team has been investigating what the effort would be to add this capability.

Actions

Audit log does not show a log entry for changes on an audited relate field's on Sugar 8.0.1

Outcomes

Related Content

Recommended Content