SuiteCRM Developer Insights - Global Record Actions

This week Clemente Raposo, Lead Developer of SuiteCRM, takes you through how to implement global record actions in SuiteCRM 8.

Global record actions are really useful, they are actions that can be used across as many modules as you need. Understanding how to configure them, link them to the right button and keep them secure on both the front and back end are also very important.

Watch this weeks video to learn all about them and be sure to check below for the code example from the video to help you get started.

For those of you who are keen to get started right away, below you will find the code sample from the video.

Copy to Clipboard

<?php

namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use Symfony\Component\DependencyInjection\ContainerBuilder;

return static function (ContainerBuilder $container): void {

$actions = $container->getParameter('module.recordview.actions') ?? [];
    $default = $actions['default'] ?? [];
    $defaultActions = $default['actions'] ?? [];

$defaultActions['add-new'] = [
        'key' => 'add-new',

'labelKey' => 'LBL_NEW', // label to show in the action button

'asyncProcess' => true, // if to call a backend process instead of a frontend action

'modes' => ['detail'], // view modes where the action displays

'acl' => ['view', 'edit'], // acls to check, options include usual acls: edit, delete, list, etc.

'params' => [

'expanded' => true, // show as separate button instead of dropdown

//MORE: Other available params

// 'selectModal' => [ // Allow selecting a record from a modal before running action
            //    'module' => 'AOS_PDF_Templates' // module to show on the select modal
            // ],

// 'displayConfirmation' => true, // Enable to show a confirmation modal before running action
            // 'confirmationLabel' => 'NTC_DELETE_CONFIRMATION' // set the message to show on the confirmation modal
        ],

// MORE: Other available options

// 'aclModule' => 'AOS_PDF_Templates', // Enable if the module to check acls for is different from current

// 'availability' => [ //  Add extra availability checks, by default only 'acls'
        //     'duplicate-merge',
        //     'acls'
        // ],
    ];

$default['actions'] = $defaultActions;
    $actions['default'] = $default;

$container->setParameter('module.recordview.actions', $actions);
};

extensions/defaultExt/config/services/module/recordview/actions.php

Copy to Clipboard

<?php

namespace App\Extension\defaultExt\backend\Process\RecordActions;

use ApiPlatform\Core\Exception\InvalidArgumentException;
use App\Module\Service\ModuleNameMapperInterface;
use App\Process\Entity\Process;
use App\Process\Service\ProcessHandlerInterface;

class AddNewAction implements ProcessHandlerInterface
{
    protected const MSG_OPTIONS_NOT_FOUND = 'Process options is not defined';
    protected const PROCESS_TYPE = 'record-add-new';

/**
     * @var ModuleNameMapperInterface
     */
    private $moduleNameMapper;

/**
     * AddNewAction constructor.
     * @param ModuleNameMapperInterface $moduleNameMapper
     */
    public function __construct(ModuleNameMapperInterface $moduleNameMapper)
    {
        $this->moduleNameMapper = $moduleNameMapper;
    }

/**
     * @inheritDoc
     */
    public function getProcessType(): string
    {
        return self::PROCESS_TYPE;
    }

/**
     * @inheritDoc
     */
    public function requiredAuthRole(): string
    {
        return 'ROLE_USER';
    }

/**
     * @inheritDoc
     */
    public function getRequiredACLs(Process $process): array
    {
        $options = $process->getOptions();
        $module = $options['module'] ?? '';

return [
            $module => [
                [ 'action' => 'edit' ]
            ]
        ];
    }

/**
     * @inheritDoc
     */
    public function configure(Process $process): void
    {
        //This process is synchronous
        //We aren't going to store a record on db
        //thus we will use process type as the id
        $process->setId(self::PROCESS_TYPE);
        $process->setAsync(false);
    }

/**
     * @inheritDoc
     *
     */
    public function validate(Process $process): void
    {
        if (empty($process->getOptions())) {
            throw new InvalidArgumentException(self::MSG_OPTIONS_NOT_FOUND);
        }

$options = $process->getOptions();

if (empty($options['module'])) {
            throw new InvalidArgumentException(self::MSG_OPTIONS_NOT_FOUND);
        }

$legacyModuleName = $this->moduleNameMapper->toLegacy($options['module']);

if (empty($legacyModuleName) || !$this->moduleNameMapper->isValidModule($legacyModuleName)) {
            throw new InvalidArgumentException(self::MSG_OPTIONS_NOT_FOUND);
        }
    }

/**
     * @inheritDoc
     */
    public function run(Process $process)
    {
        $options = $process->getOptions();

$module = $options['module'];

$responseData = [
            'handler' => 'redirect',
            'params' => [
                'route' => $module . '/create',
                'queryParams' => [
                    'name' => 'Preset name for Add New'
                ]
            ]
        ];

$process->setStatus('success');
        $process->setMessages([]);
        $process->setData($responseData);
    }
}

extensions/defaultExt/backend/Process/RecordActions/AddNewAction.php

This sample can be used as a base example to add your custom actions and custom buttons to the record view in SuiteCRM 8.

If you are looking for more development insights, the Development Team here at SalesAgility has created instructor-led master classes for developers covering both SuiteCRM 8.x and SuiteCRM 7.x. Head over to the MasterClasses to find out more.

About SuiteCRM

SuiteCRM is one of the world’s most popular CRM applications. Our feature-rich enterprise-ready alternative to Salesforce enables your sales teams to sell, market & service smarter by providing all the benefits of CRM at substantially lower costs, with the freedoms and flexibility of Open Source.

You can download and host SuiteCRM on your own servers, you can put it in a public cloud, a private cloud or you can access it as software-as-a-service. It is the ultimate freedom, allowing you to stay in full control over your business data. You can try SuiteCRM for free here.

Help support the SuiteCRM project by becoming a sponsor today!

SuiteCRM Developer Insights – Global Record Actions

About SuiteCRM

Share This Story, Choose Your Platform!