Work Log Field

This is a module loadable field type for use with Sugar 7+. The key features of this field type is that worklog entries will be adjusted by the current users display preferences for user names, timezones, and date formats. This field was created as a replacement for the original worklog field by Jon Whitcraft ( http://h2ik.co/2012/02/sugarfield-worklog-v1-0-released/ ) as it is not currently being adapted from 6.x.

Usage

This repo is the source for a module loadable package that can be installed to Sugar through the module loader. Once installed, Administrators can navigate to Admin / Studio / {module} / Fields and create a new database field with the type of 'Worklog'.

• If you are a developer and would like to convert an existing field to a worklog type field, you will need to implement a custom vardef extension in ./custom/Extension/modules/{module}/Ext/Vardefs/{filename}.php that contains the code below. It is very important to convert the fields db column to a type that can support large blocks of text such as longtext or you may run into truncation issues.

<?php
    //<singular module name> is the singular name of your module. The example being to use "Account" not "Accounts".
    //<field name> is the name of the text field to place the worklog UI over.
    $dictionary[<singular module name>]['fields'][<field name>]['type']='worklog';
    $dictionary[<singular module name>]['fields'][<field name>]['dbType']='text';

    //for elastic search
    $dictionary[<singular module name>]['fields'][<field name>]['full_text_search']['type'] = 'text';
    $dictionary[<singular module name>]['fields'][<field name>]['full_text_search']['boost'] = '3';
    $dictionary[<singular module name>]['fields'][<field name>]['full_text_search']['enabled'] = true;
?>

• To implement report filtering, you will need to make a core file change in ./modules/Reports/templates/templates_modules_def_js.php at line 486 by adding filter_defs['worklog'] = qualifiers;.
• This field is not supported in workflow.
• This field does not currently support being sent in a stock email template.
• If you need to decode the history json for a customization, you can do:

<?php
    require_once('custom/include/SugarFields/Fields/Worklog/SugarFieldWorklogHelpers.php');
    //you can pass in a user object as a second parameter to decodeJsonValue to convert the timestamps to a specific users timezone
    $displayValue = SugarFieldWorklogHelpers::decodeJsonValue($bean-><field name>));
?>

Migrating

As of Sugar 8.3, you may want to migrate to the comment log field. To do so, you can use the worklog:migrate command in the CLI framework.

php bin/sugarcrm worklog:migrate <module> <work log field>

• This command can not be resumed. It is highly recommend to run the command on a backup of your instance and migrate the commentlog and commentlog_rel tables to your production instance. If you are running this on production, you should backup your database first.
• This command will directly populate the commentlog and commentlog_rel tables. It will not make any changes to the existing work log fields.
• Things to note:
  • Empty entries are ignored
  • Entries that are not json encoded or are missing a created by user will be assigned to a system administrator. The header timestamp will look similar to Admin 1969-12-31 07:00pm in the comment log.

If your instance is on SugarCloud, you can ask for Sugar Support to run the following command:

shadowy bin/sugarcrm worklog:migrate <module> <work log field>

To Do

• Implement mobile layouts

Building Installer Package

To build the installer package, you will need to download the contents on this repository and execute:

php build.php

Once completed, the installer .zip package will be located under ./builds/.

Contributing

Everyone is welcome to be involved by creating or improving functionality. If you would like to contribute, please make sure to review the [CONTRIBUTOR TERMS](CONTRIBUTOR TERMS.pdf). When you update this README, please check out the contribution guidelines for helpful hints and tips that will make it easier to accept your pull request.

Contributors

Jerry Clark

Jon Whitcraft

Licensed under Apache

© 2016 SugarCRM Inc. Licensed by SugarCRM under the Apache 2.0 license.