SuiteCRM

https://docs.suitecrm.com/
Admin
SuiteCRM is an open-source customer relationship management platform. This documentation site...
Tokens:43,268
Snippets:567
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example SuiteCRM CLI Installation

Source: https://docs.suitecrm.com/8.x/admin/installation-guide/running-the-cli-installer

An example of the SuiteCRM CLI installation command with placeholder values replaced by typical example inputs. This demonstrates how to fill in the required parameters.

```bash
#Example
./bin/console suitecrm:app:install -u "admin" -p "pass" -U "root" -P "dbpass" -H "mariadb" -N "suitecrm" -S "https://yourcrm.com/" -d "yes"
```

--------------------------------

### Example: Run SuiteCRM Post-Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/upgrading/running-the-upgrade

An example of the post-upgrade command using a specific version package name.

```bash
./bin/console suitecrm:app:upgrade-finalize -t SuiteCRM-8.6.0
```

--------------------------------

### Get Help for CLI Installer Arguments

Source: https://docs.suitecrm.com/8.x/admin/installation-guide/running-the-cli-installer

Display the help message for the SuiteCRM CLI installer to view all supported arguments and their descriptions. This is useful for understanding available installation options.

```bash
./bin/console suitecrm:app:install --help
```

--------------------------------

### Example: Run SuiteCRM Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/upgrading/running-the-upgrade

An example of the upgrade command using a specific version package name.

```bash
./bin/console suitecrm:app:upgrade -t SuiteCRM-8.6.0
```

--------------------------------

### Example Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/legacy-migration/8.2.0-legacy-migration

An example of the upgrade command, specifying the target version as SuiteCRM-8.2.0.

```bash
./bin/console suitecrm:app:upgrade -t SuiteCRM-8.2.0
```

--------------------------------

### Input Example: Print Record as PDF

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-api

An example input payload for the `createProcess` mutation to trigger a 'record-print-as-pdf' action for contacts.

```json
{
    "input": {
        "type": "record-print-as-pdf",
        "options": {
            "action": "record-print-as-pdf",
            "module": "contacts",
            "id": "e4941b73-1c01-9016-3cdf-64181e7c4db4",
            "params": {
                "selectModal": {
                    "module": "AOS_PDF_Templates"
                },
                "modalRecord": {
                    "id": "7d1fd5f6-82a6-9f20-6e4f-643d64ed7be2",
                    "module": "pdf-templates",
                    "type": "AOS_PDF_Templates",
                    "attributes": {
                        "module_name": "AOS_PDF_Templates",
                        "object_name": "AOS_PDF_Templates",
                        "id": "7d1fd5f6-82a6-9f20-6e4f-643d64ed7be2",
                        "name": "test",
                        "date_entered": "2023-04-17 15:23:12",
                        "date_modified": "2023-04-17 15:23:12",
                        "modified_user_id": "1",
                        "modified_by_name": {
                            "user_name": "admin",
                            "id": "1"
                        },
                        "created_by": "1",
                        "created_by_name": {
                            "user_name": "admin",
                            "id": "1"
                        },
                        "description": "...",
                        "deleted": "",
                        "assigned_user_id": "1",
                        "assigned_user_name": {
                            "user_name": "admin",
                            "id": "1"
                        },
                        "active": "true",
                        "type": "Accounts",
                        "sample": "",
                        "insert_fields": "",
                        "pdfheader": "",
                        "pdffooter": "",
                        "margin_left": "15",
                        "margin_right": "15",
                        "margin_top": "16",
                        "margin_bottom": "16",
                        "margin_header": "9",
                        "margin_footer": "9",
                        "page_size": "A4",
                        "orientation": "Portrait"
                    },
                    "acls": [
                        "list",
                        "edit",
                        "view",
                        "delete",
                        "export",
                        "import"
                    ]
                }
            }
        }
    }
}
```

--------------------------------

### SAML Configuration Example in .env.local

Source: https://docs.suitecrm.com/8.x/admin/configuration/saml/8.7.0-saml-configuration

This example demonstrates a comprehensive SAML configuration in the .env.local file, including connection options, request settings, and compression. It is based on an instance using Keycloak as an IdP.

```dotenv
###> SAML CONFIG ###
SAML_USERNAME_ATTRIBUTE=username
SAML_USE_ATTRIBUTE_FRIENDLY_NAME=true

# Connection options
SAML_IDP_ENTITY_ID='http://saml:8090/realms/master'
SAML_IDP_SSO_URL='http://saml:8090/realms/master/protocol/saml'
SAML_IDP_SLO_URL='http://saml:8090/realms/master/protocol/saml'
SAML_IDP_X509CERT='MIIC...'

SAML_SP_PRIVATE_KEY='MIIE..'
SAML_SP_CERT='../extensions/defaultExt/config/packages/sp_cert.crt' # example of pointing to a file

# Resquest options
SAML_AUTHN_REQUESTS_SIGNED=true
SAML_LOGOUT_REQUEST_SIGNED=true
SAML_WANT_ASSERTIONS_SIGNED=true

# Compression
SAML_COMPRESS_REQUESTS=true
SAML_COMPRESS_RESPONSES=true

###< SAML CONFIG ###
```

--------------------------------

### Process Type Construction Example

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/manual-migration-tasks

Illustrates how the frontend constructs the process type by combining an asyncProcessKeyPrefix with the service key value.

```text
{asyncProcessKeyPrefix}-{service_key_value}
→ migration-task-migrate-notes-files
```

--------------------------------

### Input Example: Delete Record

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-api

An example input payload for the `createProcess` mutation to trigger a 'record-delete' action.

```json
{
    "input": {
        "type": "record-delete",
        "options": {
            "action": "record-delete",
            "module": "contacts",
            "id": "e4941b73-1c01-9016-3cdf-64181e7c4db4",
            "params": {
                "displayConfirmation": true,
                "confirmationLabel": "NTC_DELETE_CONFIRMATION"
            }
        }
    }
}
```

--------------------------------

### Install SuiteCRM with CLI Options

Source: https://docs.suitecrm.com/8.x/admin/installation-guide/running-the-cli-installer

Run the SuiteCRM CLI installer by providing all required options in a single command line. This is useful for scripting or automated deployments.

```bash
./bin/console suitecrm:app:install -u "admin_username" -p "admin_password" -U "db_user" -P "db_password" -H "db_host" -N "db_name" -S "site_url" -d "demo_data"
```

--------------------------------

### SuiteCRM SAML Configuration Example

Source: https://docs.suitecrm.com/8.x/admin/configuration/saml/8.2.0-saml-configuration

This configuration example demonstrates how to set up SAML integration with an Identity Provider (IdP) like Keycloak. It includes basic and optional settings for both the IdP and the Service Provider (SuiteCRM).

```yaml
hslavich_onelogin_saml:
  # Basic settings

  idp:
    # entity id of your idp
    entityId: '<idp-entity-id>'  # e.g.: 'http://saml-idp-host/realms/master'


    singleSignOnService:
      # single sign on url your IdP
      url: '<idp-sso-url>' # e.g.: 'http://saml-idp-host/realms/master/protocol/saml'
      binding: 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'

    singleLogoutService:
      # single logout service url of your IdP
      url: '<idp-slo-url>' # e.g.: 'http://saml-idp-host/realms/master/protocol/saml'
      binding: 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'

    # IdP certificate
    x509cert: '<idp-certificate-string> # e.g. 'MIICmzCCAYMCBgGC1LTnr ... ='


  # The SP in this case is your SuiteCRM instance
  sp:

    # SP entity id. Use your SuiteCRM instance url
    entityId: '<sp-entity-id-use-suitecrm-url> # e.g. 'https://<your-suitecrm-instance>'

    assertionConsumerService:
      # The path to SuiteCRM's acs service
      url: 'https://<your-suitecrm-instance>/saml/acs'
      binding: 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST'

    singleLogoutService:
      # The path to SuiteCRM's SAML logout service
      url: 'https://<your-suitecrm-instance>/saml/logout'
      binding: 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'

    # SuiteCRM's private key for SAML (sp)
    privateKey: '<sp-private-key>' # e.g. 'MIIEoAIBAAKCAQEAx ...'

    # SuiteCRM's certificate for SAML (sp)
    x509cert: '<sp-cert>' # e.g. 'MIIC1zCCAb8CBgGC1awPM ... ='


  # Optional settings

  # SuiteCRM's base url for SAML
  baseurl: 'https://<your-suitecrm-instance>/saml'

  ######
  # NOTE : The values for the following settings will depend on how the IdP is setup
  ######
  strict: true
  debug: true
  security:
    nameIdEncrypted: false
    authnRequestsSigned: true
    logoutRequestSigned: true
    logoutResponseSigned: false
    wantMessagesSigned: false
    wantAssertionsSigned: false
    wantNameIdEncrypted: false
    requestedAuthnContext: false
    signMetadata: false
    wantXMLValidation: true
    signatureAlgorithm: 'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'
    digestAlgorithm: 'http://www.w3.org/2001/04/xmlenc#sha256'
  contactPerson:
    technical:
      givenName: 'Tech User'
      emailAddress: 'techuser@example.com'
    support:
      givenName: 'Support User'
      emailAddress: 'supportuser@example.com'
  organization:
    en:
      name: 'Example'
      displayname: 'Example'
      url: 'http://example.com'
```

--------------------------------

### Run Legacy Migration Setup Command

Source: https://docs.suitecrm.com/8.x/admin/legacy-migration/8.7.0-legacy-migration

Execute this command from your SuiteCRM 8 instance root to initiate the legacy migration preparation process. It prompts for manual configuration updates.

```bash
./bin/console suitecrm:app:setup-legacy-migration
```

--------------------------------

### Install Composer Dependencies (Production Mode)

Source: https://docs.suitecrm.com/8.x/admin/upgrading/older-versions/upgrading-rc-versions

Run this command in your SuiteCRM 8 root directory to install Composer dependencies with optimizations for production mode.

```bash
composer install --no-dev --prefer-dist --optimize-autoloader
```

--------------------------------

### Example: Configure SAML Username Attribute and Friendly Name

Source: https://docs.suitecrm.com/8.x/admin/configuration/saml/8.2.0-saml-configuration

This example shows how to configure the SAML_USERNAME_ATTRIBUTE to 'username' and set SAML_USE_ATTRIBUTE_FRIENDLY_NAME to 'false'. This affects how SuiteCRM identifies users based on SAML attributes.

```dotenv
###> SAML CONFIG ###
SAML_USERNAME_ATTRIBUTE=username
SAML_USE_ATTRIBUTE_FRIENDLY_NAME=false
###< SAML CONFIG ###
```

--------------------------------

### System-wide Crontab Entry Example

Source: https://docs.suitecrm.com/8.x/admin/administration-panel/schedulers

This is an example of a system-wide crontab entry for running SuiteCRM scheduler jobs. It specifies the user, the PHP path, the SuiteCRM console command, and output redirection.

```bash
* * * * * www-data [path/to/php] [path/to/suite/instance]/bin/console {-e [env]} schedulers:run > /dev/null 2>&1
```

--------------------------------

### Switch to RabbitMQ Transport

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/configuration

Example of how to configure the main async task queue to use RabbitMQ instead of the default Doctrine transport.

```env
MESSENGER_INTERNAL_ASYNC_TRANSPORT_DSN=amqp://guest:guest@localhost:5672/%2f/suitecrm_async
```

--------------------------------

### Systemd Control Commands

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/messenger-setup

Commands to reload the systemd daemon, enable the Messenger worker service to start on boot, and start the service immediately.

```bash
sudo systemctl daemon-reload
sudo systemctl enable suitecrm-messenger
sudo systemctl start suitecrm-messenger

```

--------------------------------

### Concrete Async Task Runner Example

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/async-task-architecture

A minimal implementation of a concrete runner extending the base AsyncTaskRunner class. Specify the TYPE constant and override methods for configuration keys.

```php
class AsyncManualMigrationRunner extends AsyncTaskRunner
{
    const TYPE = 'manual-migration-tasks';

    public function getType(): string
    {
        return self::TYPE;
    }

    protected function getMaxItemsToQueuePerRunConfigKey(): string
    {
        return 'max_migration_items_to_queue_per_run';
    }

    protected function getMaxItemsToProcessPerRunConfigKey(): string
    {
        return 'max_migration_items_to_process_per_run';
    }
}
```

--------------------------------

### Setup Messenger Database Table

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/messenger-setup

Run this command if the 'messenger_messages' table was not automatically created during 'Admin > Repair > Quick Repair & Rebuild'. This command sets up the necessary table for message transport.

```bash
php bin/console messenger:setup-transports
```

--------------------------------

### Process Handler Implementation Example

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-handler

This is the core implementation of a backend Process Handler. Ensure the namespace matches your extension's directory structure. After adding this code, clear the application cache.

```php
<?php

namespace App\Extension\defaultExt\modules\Cases\Service\Fields;

use Process\Api\ProcessHandlerInterface;
use Process\Api\ProcessHandlerResult;

class CaseCalculatePriority implements ProcessHandlerInterface
{
    public function process(
        array $args
    ): ProcessHandlerResult
    {
        // Example logic to calculate priority based on input arguments
        $priority = 'Medium'; // Default priority

        if (isset($args['severity']) && $args['severity'] === 'High') {
            $priority = 'High';
        }

        if (isset($args['status']) && $args['status'] === 'Open') {
            $priority = 'Low';
        }

        // Return the result, potentially with updated values or messages
        return new ProcessHandlerResult([
            'priority' => $priority,
            'message' => 'Priority calculated successfully.'
        ]);
    }
}

```

--------------------------------

### Feedback Model Usage Example

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/async-task-architecture

Demonstrates chaining setter methods on the Feedback model to return processing results. Use setSuccess, setMessages, and setData to convey status, messages, and result data.

```php
return (new Feedback())
    ->setSuccess(true)
    ->setMessages(['Migrated successfully'])
    ->setData(['media_object_id' => $id]);
```

--------------------------------

### SAML User Creation Log Entry

Source: https://docs.suitecrm.com/8.x/admin/configuration/saml/8.2.0-saml-configuration

Example log entry showing the attributes received from the SAML IdP during user creation. Use this to verify attribute mapping.

```log
[2022-09-15 09:23:53] auth.INFO: App\Security\Saml\AppSamlUserFactory | createUser username: jeremy.doe [] []
[2022-09-15 09:23:53] auth.INFO: App\Security\Saml\AppSamlUserFactory | createUser attributes | {"urn:oid:2.5.4.4":["Doe"],"urn:oid:2.5.4.42":["Jeremy"],"username":["jeremy.doe"],"email":["jeremy.doe@example.com"],"Role":["view-profile","offline_access","manage-account","manage-account-links","uma_authorization","default-roles-master"]} [] []
```

--------------------------------

### Set Response Data for Record, Line, or Bulk Actions

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-handler

This example shows how to set response data for handlers like 'redirect', including route and query parameters. It's used for Record, Line, and Bulk Action process handlers.

```php
$responseData = [
            'handler' => 'redirect',
            'params' => [
                'route' => $options['module'] . '/duplicate/' . $options['id'],
                'queryParams' => [
                    'isDuplicate' => true,
                ]
            ]
        ];

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

--------------------------------

### Set Response Data for UpdateFavorite Handler

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-handler

This example demonstrates setting specific data for the 'UpdateFavorite' process handler, such as the saved favorite status.

```php
$process->setData([
                'favorite' => $savedFavorite
            ]);
```

--------------------------------

### Reference a Secret in Configuration

Source: https://docs.suitecrm.com/8.x/admin/configuration/using-symfony-secrets

Integrate a stored secret into your application's configuration by using the '%env(...)' syntax. This example shows how to reference the SAML SP private key.

```yaml
hslavich_onelogin_saml:

  # ...

  sp:

     ...

    # SuiteCRM's private key for SAML (sp)
    privateKey: '%env(SAML_SP_PRIVATE_KEY)%'

    # ...

```

--------------------------------

### Configure AWS S3 Instance using Symfony Secrets

Source: https://docs.suitecrm.com/8.x/admin/configuration/file-storage/aws-how-to-guide

Example of configuring the AWS S3 instance in .env.local, referencing secrets for access key and secret. Ensure secrets are set using the Symfony CLI.

```env
AWS_S3_INSTANCES='{
  "main": {
    "region": "eu-west-1",
    "access_key": "%env(AWS_S3_ACCESS_KEY)%",
    "access_secret": "%env(AWS_S3_ACCESS_SECRET)%"
  }
}'
```

--------------------------------

### Create Notes File Migration Task Handler

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/manual-migration-tasks

Extends AbstractAsyncTaskHandler to define the logic for migrating notes files. Implements methods to get handler key, type, fetch the next batch of records, and process each item for migration.

```php
<?php

namespace App\ManualMigrations\Migrations\MigrateNotesFiles;

use App\AsyncTask\Service\LegacyBridge\AsyncTaskLegacyHandler;
use App\AsyncTask\Service\TaskHandler\AbstractAsyncTaskHandler;
use App\AsyncTask\Service\TaskHandler\AsyncTaskBatchItem;
use App\Data\Entity\Record;
use App\Data\LegacyHandler\PreparedStatementHandler;
use App\Engine\Model\Feedback;
use App\MediaObjects\Repository\MediaObjectManagerInterface;
use App\MediaObjects\Services\LocalFileMediaObjectMigratorInterface;
use Psr\Log\LoggerInterface;

class MigrateNotesFilesTaskHandler extends AbstractAsyncTaskHandler
{
    public function __construct(
        protected AsyncTaskLegacyHandler $legacyHandler,
        protected PreparedStatementHandler $preparedStatementHandler,
        protected MediaObjectManagerInterface $mediaObjectManager,
        protected LocalFileMediaObjectMigratorInterface $migrator,
        protected LoggerInterface $logger
    ) {
    }

    public function getHandlerKey(): string
    {
        return 'migrate-notes-files';
    }

    public function getType(): string
    {
        return 'manual-migration-tasks';
    }

    public function getNextBatchToQueue(
        Record $task,
        array $progress,
        int $batchSize
    ): array {
        $offset = $progress['enqueue_offset'] ?? 0;

        try {
            $qb = $this->preparedStatementHandler->createQueryBuilder();
            $qb->select('id', 'filename', 'file_mime_type')
                ->from('notes')
                ->where('filename IS NOT NULL')
                ->andWhere("filename != ''")
                ->andWhere('deleted = 0')
                ->setFirstResult($offset)
                ->setMaxResults($batchSize);

            $results = $qb->executeQuery()->fetchAllAssociative();
        } catch (\Throwable $e) {
            $this->logger->error(
                'MigrateNotesFilesTaskHandler::getNextBatchToQueue failed: '
                . $e->getMessage(),
                ['component' => 'migrate-notes-files']
            );

            return [];
        }

        $items = [];
        foreach ($results as $row) {
            $items[] = new AsyncTaskBatchItem(
                $row['id'],
                [
                    'record_id' => $row['id'],
                    'filename' => $row['filename'],
                    'file_mime_type' => $row['file_mime_type']
                        ?? 'application/octet-stream',
                ]
            );
        }

        return $items;
    }

    public function processItem(Record $task, array $item): Feedback
    {
        $feedback = new Feedback();
        $data = $item['data'] ?? [];
        $recordId = $data['record_id'] ?? '';
        $filename = $data['filename'] ?? '';
        $mimeType = $data['file_mime_type'] ?? 'application/octet-stream';

        if (empty($recordId) || empty($filename)) {
            return $feedback->setSuccess(false)
                ->setMessages(['Missing record_id or filename']);
        }

        $this->legacyHandler->startLegacy();

        try {
            $legacyDir = $this->legacyHandler->getLegacyDir();
            $legacyPath = $legacyDir . '/upload/' . $recordId;

            // Check if already migrated
            $existing = $this->mediaObjectManager->getLinkedMediaObjects(
                'private-documents',
                'Notes',
                $recordId,
                'file'
            );

            if (!empty($existing)) {
                // Clean up legacy file if it still exists
                if (file_exists($legacyPath)) {
                    unlink($legacyPath);
                }

                return $feedback->setSuccess(true)
                    ->setMessages(['Already migrated']);
            }

            if (!file_exists($legacyPath)) {
                return $feedback->setSuccess(false)
                    ->setMessages(['Legacy file not found: upload/' . $recordId]);
            }

            // Perform the migration
            $record = $this->migrator->migrate(
                $legacyPath,
                'private-documents',
                $mimeType,
                $filename,
                $filename,
                'Notes',
                $recordId,
                'file'
            );

            $feedback->setSuccess(true);
            $feedback->setData(['media_object_id' => $record?->getId()]);
        } catch (\Throwable $e) {
            $this->logger->error(
                'MigrateNotesFilesTaskHandler::processItem failed: '
                . $e->getMessage(),
                [
                    'component' => 'migrate-notes-files',
                    'record_id' => $recordId,
                ]
            );
            return $feedback->setSuccess(false)->setMessages([$e->getMessage()]);
        }

        return $feedback;
    }
}

```

--------------------------------

### Cron Job for Messenger Worker

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/messenger-setup

A cron job entry to periodically start the Messenger worker. This is a simpler alternative for setups where Supervisor or systemd are not available. The `--time-limit` ensures old workers exit before new ones start.

```cron
* * * * * php /path/to/suitecrm/bin/console messenger:consume internal-async --time-limit=55 --memory-limit=256M > /dev/null 2>&1

```

--------------------------------

### Sample Process Handler Implementation

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/process-api/process-handler

This snippet demonstrates a complete implementation of the ProcessHandlerInterface for a 'case-calculate-priority' process. It includes methods for defining the process type, authentication roles, ACLs, configuration, validation, and the main execution logic.

```php
<?php

namespace App\Extension\defaultExt\modules\Cases\Service\Fields;

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

class CaseCalculatePriority implements ProcessHandlerInterface
{
    protected const MSG_OPTIONS_NOT_FOUND = 'Process options are not defined';
    public const PROCESS_TYPE = 'case-calculate-priority';

    /**
     * CaseCalculatePriority constructor.
     */
    public function __construct()
    {
    }

    /**
     * @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'] ?? '';
        $id = $options['id'] ?? '';

        $editACLCheck =  [
            'action' => 'edit',
        ];

        if ($id !== '') {
            $editACLCheck['record'] = $id;
        }

        return [
            $module => [
                $editACLCheck
            ],
        ];
    }

    /**
     * @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
    {

        $options = $process->getOptions();
        $type = $options['record']['attributes']['type'] ?? '';
        if (empty($type)) {
            throw new InvalidArgumentException(self::MSG_OPTIONS_NOT_FOUND);
        }
    }

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

        $type = $options['record']['attributes']['type'] ?? '';

        if ($type !== 'User') {
            $priority = $options['record']['attributes']['priority'] ?? '';

            $responseData = [
                'value' => $priority
            ];

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

            return;
        }

        $name = $options['record']['attributes']['name'] ?? '';

        $value = 'P3';
        if (strpos(strtolower($name), 'warning') !== false) {
            $value = 'P2';
        }

        if (strpos(strtolower($name), 'error') !== false) {
            $value = 'P1';
        }

        $responseData = [
            'value' => $value
        ];

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

```

--------------------------------

### Override Uploader Mappings

Source: https://docs.suitecrm.com/8.x/admin/configuration/file-storage/file-storage-configuration

Overrides specific VichUploader mappings, for example, to change the namer or remove directory naming.

```json
MEDIA_UPLOADER_MAPPINGS='{
  "private_documents_media_object": {
    "uri_prefix": "/media/documents",
    "upload_destination": "private.documents.storage",
    "namer": "App\\MediaObjects\\Services\\UuidMediaObjectFileNamer"
  }
}'
```

--------------------------------

### Run SuiteCRM Post-Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/upgrading/running-the-upgrade

Execute this command from your SuiteCRM 8 instance root to finalize the upgrade after the initial process. Replace '<version>' with the downloaded package name.

```bash
./bin/console suitecrm:app:upgrade-finalize -t "<version>"
```

--------------------------------

### Supervisor Control Commands

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/messenger-setup

Commands to reload Supervisor configuration, update running processes, and start the Messenger worker service.

```bash
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start suitecrm-messenger:*

```

--------------------------------

### Enable SAML Authentication

Source: https://docs.suitecrm.com/8.x/admin/configuration/saml/8.2.0-saml-configuration

To enable SAML authentication, set the AUTH_TYPE to 'saml' in your .env.local file. Remember to clear the cache or run Repair and Rebuild after making changes.

```bash
AUTH_TYPE=saml
```

--------------------------------

### Symfony Messenger Transport Routing Configuration

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/async-task-architecture

Example configuration snippet for defining tagged interfaces in `config/core_services.yaml` to enable service discovery for async task components.

```yaml
services:
  _instanceof:
    App\AsyncTask\Service\TaskHandler\AsyncTaskHandlerInterface:
      tags: [ 'app.async-task.handler' ]
    App\AsyncTask\Service\Runner\AsyncTaskRunnerInterface:
      tags: [ 'app.async-task.runner' ]
    App\AsyncTask\Service\TaskCompletedHandler\AsyncTaskCompletedHandlerInterface:
      tags: [ 'app.async-task.completed.handler' ]
    App\AsyncTask\Service\TaskProgressedHandler\AsyncTaskProgressedHandlerInterface:
      tags: [ 'app.async-task.progressed.handler' ]
    App\AsyncTask\Service\TaskFailureHandler\AsyncTaskFailureHandlerInterface:
      tags: [ 'app.async-task.failure.handler' ]
```

--------------------------------

### Configure Apache Virtual Host for SuiteCRM

Source: https://docs.suitecrm.com/8.x/admin/installation-guide/webserver-setup-guide

Update your Apache virtual host configuration to point the DocumentRoot to the 'public' directory of your SuiteCRM installation and allow all overrides.

```apache
<VirtualHost *:80>

    DocumentRoot /<path-to-suite>/public
    <Directory /<path-to-suite>/public>
        AllowOverride All
        Order Allow,Deny
        Allow from All
    </Directory>

</VirtualHost>
```

--------------------------------

### Configure Flysystem to Use Azure Storage

Source: https://docs.suitecrm.com/8.x/admin/configuration/file-storage/azure-how-to-guide

Set the MEDIA_FLY_SYSTEM_STORAGES variable to direct 'private.documents.storage' to use Azure Blob Storage. Ensure the 'client' option matches the key in AZURE_BLOB_INSTANCES.

```dotenv
MEDIA_FLY_SYSTEM_STORAGES='{
  "private.documents.storage": {
    "adapter": "azure",
    "options": {
      "client": "azure.blob.client.main",
      "container": "YOUR_CONTAINER_NAME"
    }
  }
}'
```

--------------------------------

### Execute SuiteCRM 8 Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/upgrading/older-versions/upgrading-rc-versions

Run this command from your SuiteCRM 8 instance root to initiate the upgrade process, specifying the target version.

```bash
./bin/console suitecrm:app:upgrade -t SuiteCRM-8.0.0-rc
```

--------------------------------

### Azure Blob Client Instance Configuration

Source: https://docs.suitecrm.com/8.x/admin/configuration/file-storage/file-storage-configuration

Configures an Azure Blob Storage client instance named 'main' using a connection string. Replace placeholder with your actual connection string.

```json
AZURE_BLOB_INSTANCES='{
  "main": {
    "connection_string": "DefaultEndpointsProtocol=https;AccountName=...;AccountKey=...;EndpointSuffix=core.windows.net"
  }
}'
```

--------------------------------

### Development/Testing Messenger Worker Command

Source: https://docs.suitecrm.com/8.x/admin/async-tasks/messenger-setup

This command starts the Messenger worker for development or testing purposes. It listens to the default async queue and includes time and memory limits to prevent resource issues.

```bash
php bin/console messenger:consume internal-async --time-limit=3600 --memory-limit=256M

```

--------------------------------

### Run SuiteCRM Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/upgrading/older-versions/upgrading-80-to-81-versions

Execute this command in your SuiteCRM 8 instance root to initiate the upgrade process. Replace 'SuiteCRM-8.1.2' with the actual package name of the target version.

```bash
./bin/console suitecrm:app:upgrade -t SuiteCRM-8.1.2
```

--------------------------------

### AsyncTaskHandlerInterface Definition

Source: https://docs.suitecrm.com/8.x/developer/extensions/backend/async-tasks/async-task-architecture

The primary interface for creating custom asynchronous task handlers. Implement methods for getting the handler key, type, next batch, processing items, finalization, and retry/rerun logic.

```php
interface AsyncTaskHandlerInterface
{
    public function getHandlerKey(): string;
    public function getType(): string;

    /** @return AsyncTaskBatchItemInterface[] */
    public function getNextBatchToQueue(
        Record $task, array $progress, int $batchSize
    ): array;

    public function processItem(Record $task, array $item): Feedback;

    public function finalize(Record $task): Feedback;
    public function hasFinalization(): bool;

    public function getMaxItemRetries(): int;
    public function allowsFailureRetry(): bool;
    public function allowsFailureRerun(): bool;
}
```

--------------------------------

### Run Upgrade Command with Version

Source: https://docs.suitecrm.com/8.x/admin/legacy-migration/8.7.0-legacy-migration

Use this command to perform the SuiteCRM 8 upgrade. Replace '<version>' with the specific SuiteCRM 8 package name you have downloaded.

```bash
./bin/console suitecrm:app:upgrade -t "<version>"
```

```bash
./bin/console suitecrm:app:upgrade -t SuiteCRM-8.2.0
```

--------------------------------

### Crontab Entry to Run Every Two Minutes

Source: https://docs.suitecrm.com/8.x/admin/administration-panel/schedulers

This example demonstrates how to modify the crontab entry to run a scheduler job every two minutes instead of every minute by adjusting the first column.

```bash
*/2 * * * * [path/to/php] [path/to/suite/instance]/bin/console {-e [env]} schedulers:run > /dev/null 2>&1
```

--------------------------------

### Run Post Upgrade Command

Source: https://docs.suitecrm.com/8.x/admin/legacy-migration/8.7.0-legacy-migration

Execute this command after the main upgrade process to finalize the SuiteCRM 8 upgrade. Ensure your customizations are compliant with the minimum PHP version.

```bash
./bin/console suitecrm:app:upgrade-finalize
```

--------------------------------

### Enable LDAP Authentication

Source: https://docs.suitecrm.com/8.x/admin/configuration/ldap-configuration

Set AUTH_TYPE to 'ldap' in your .env.local file to enable LDAP authentication. Remember to clear the cache or run Repair and Rebuild after changes.

```env
AUTH_TYPE=ldap
```

--------------------------------

### Define Azure Blob Instance Configuration

Source: https://docs.suitecrm.com/8.x/admin/configuration/file-storage/azure-how-to-guide

Add this configuration to your .env.local file to define your Azure Blob Storage instance. Replace placeholder values with your actual Azure account details.

```dotenv
AZURE_BLOB_INSTANCES='{
  "main": {
    "connection_string": "DefaultEndpointsProtocol=https;AccountName=YOUR_ACCOUNT;AccountKey=YOUR_KEY;EndpointSuffix=core.windows.net"
  }
}'
```
Tokens:
Raw