Advanced Newsletter Suite para Magento 2 - instruções de instalação e configuração

Objetivo do documento

Este documento descreve a instalação e configuração do pacote magento-2-package-advanced-newsletter-suite. É um pacote completo de newsletter e email marketing para Magento 2, que abrange destinatários, captação, campanhas, conteúdo, envio, tracking, painel operacional e pontos de subscrição no frontend.

Requisitos prévios

Antes da implementação, prepare:

• Magento Open Source 2.4.x,
• Composer,
• acesso CLI a bin/magento,
• conta de administrador Magento,
• dados de acesso ao SMTP,
• cron Magento configurado,
• disponibilidade para executar consumidores de filas,
• ambiente de teste para verificar a subscrição, as campanhas e os envios.

O que o pacote instala

O pacote inclui:

• Kowal_MarketingCore,
• Kowal_EmailTransport,
• Kowal_EmailSmtp,
• Kowal_EmailEvents,
• Kowal_EmailTemplateStudio,
• Kowal_NewsletterAudience,
• Kowal_NewsletterCapture,
• Kowal_NewsletterCampaigns,
• Kowal_NewsletterConsole,
• Kowal_NewsletterFrontend.

Este é o nível mais elevado de agregação no ecossistema de módulos de email marketing para Magento.

Instalação

1. Instalação do pacote Composer

Receberá por email os dados de acesso ao repositório Composer, ou seja, o endereço de email do cliente e o token de licença, após a compra. Também estão disponíveis na área de cliente, após iniciar sessão em kowal.store. Substitua TWOJ_EMAIL_KLIENTA pelo endereço de email da sua conta e TWOJ_TOKEN pelo token recebido. Execute os comandos no diretório raiz do Magento.

composer config repositories.kowal composer https://repo.kowal.storecomposer config http-basic.repo.kowal.store 'TWOJ_EMAIL_KLIENTA' 'TWOJ_TOKEN'composer require kowal/package-advanced-newsletter-suite

2. Ativação dos módulos no Magento

bin/magento module:enable \ Kowal_MarketingCore \ Kowal_EmailTransport \ Kowal_EmailSmtp \ Kowal_EmailEvents \ Kowal_EmailTemplateStudio \ Kowal_NewsletterAudience \ Kowal_NewsletterCapture \ Kowal_NewsletterCampaigns \ Kowal_NewsletterConsole \ Kowal_NewsletterFrontendbin/magento setup:upgradebin/magento cache:flush

Em modo de produção, execute adicionalmente:

bin/magento setup:di:compilebin/magento setup:static-content:deploy -f

Configuração

1. Secção administrativa

A configuração básica deverá estar disponível em:

Kowal / Email Marketing

De acordo com a especificação, os grupos de definições esperados são:

• general,
• transport,
• smtp,
• campaigns,
• double_opt_in,
• events.

2. Configuração de envio

Primeiro, configure a base de delivery:

• atividade do módulo,
• tipo de transporte predefinido,
• registo dos envios,
• conta ou contas SMTP,
• encaminhamento de mensagens,
• fallback para contas de reserva, se utilizado.

A implementação do pacote completo continua a exigir uma camada SMTP e de transporte funcional.

3. Configuração de destinatários e subscrições

Em seguida, confirme a configuração da camada de destinatários:

• integração com newsletter_subscriber,
• listas de mailing,
• segmentos,
• estados de subscrição,
• metadados adicionais do subscritor,
• fontes de aquisição,
• consentimentos de marketing.

Configure também o processo de subscrição:

• formulários e pontos de subscrição,
• double opt-in,
• modelo da mensagem de confirmação,
• tempo de validade do token de confirmação.

4. Configuração de campanhas

Na secção campaigns, defina:

• batch_size,
• max_retry_count,
• send_rate_limit_per_run,
• watchdog_timeout_minutes.

O pacote suporta:

• definição de campanhas,
• agendamento,
• fila de destinatários,
• envio em batches,
• histórico de execução de campanhas,
• envios de teste.

5. Configuração do Template Studio

Se a implementação incluir trabalho com o conteúdo da newsletter, configure EmailTemplateStudio de acordo com o âmbito do MVP:

• trabalho com modelos nativos de newsletter do Magento,
• seleção de layouts de produto,
• gravação da secção gerada no modelo nativo,
• importação do conteúdo final para a campanha.

6. Configuração de eventos de email

Na secção events, configure:

• processamento de eventos,
• retenção de payloads,
• política de aceitação de eventos duplicados de fornecedores.

A camada EmailEvents é responsável pela observabilidade do processo de entrega e pela associação dos eventos aos logs de transporte e às campanhas.

7. Configuração do painel administrativo e do frontend

O pacote completo inclui:

• Kowal_NewsletterConsole como painel operacional,
• Kowal_NewsletterFrontend como camada de formulários e widgets de subscrição no frontend.

Após a instalação, verifique:

• disponibilidade do dashboard,
• atalhos para a configuração e módulos operacionais,
• vista dos erros e envios mais recentes,
• presença de formulários de subscrição no frontend da loja.

Cron e consumidores de filas

O pacote completo requer o funcionamento do processamento assíncrono.

1. Cron Magento

bin/magento cron:install

O cron deve ser responsável por:

• agendamento de campanhas,
• recuperação de tarefas,
• watchdog operacional.

2. Queue consumers

Os consumidores de filas devem ser responsáveis pelo processamento efetivo dos batches de envio. Os nomes dos consumidores devem ser obtidos a partir dos ficheiros atuais etc/queue_consumer.xml dos módulos implementados.

No ambiente de produção, assegure:

• execução dos consumers em segundo plano,
• arranque automático após reinício do servidor,
• monitorização de falhas,
• registo de erros.

Passos após a instalação

Após a implementação, execute a checklist completa:

1. Configure e teste a conta SMTP.
2. Verifique o encaminhamento de mensagens.
3. Teste a subscrição do subscritor e o double opt-in.
4. Confirme a compatibilidade com a newsletter nativa do Magento.
5. Crie uma lista ou segmento de teste.
6. Prepare uma campanha de teste.
7. Execute um envio de teste.
8. Verifique o agendamento de campanhas através do cron.
9. Verifique o processamento da fila pelos consumers.
10. Confirme a gravação de logs e eventos de email.
11. Verifique o dashboard administrativo.
12. Verifique os formulários e widgets de subscrição no frontend.

Teste de aceitação após a implementação

O pacote está corretamente implementado se:

• os módulos forem instalados corretamente no Magento 2.4.x,
• o envio SMTP funcionar ao nível das contas e do encaminhamento,
• a subscrição do subscritor permanecer compatível com a newsletter nativa do Magento,
• a campanha for agendada por cron e processada por queue consumer,
• os estados de entrega atualizarem os logs e os eventos de email,
• o painel administrativo apresentar dados operacionais básicos,
• os pontos de subscrição no frontend funcionarem corretamente,
• após a desativação dos módulos, o mecanismo base Magento_Newsletter ainda puder funcionar.

Notas de implementação

• Vale a pena implementar o pacote completo juntamente com uma configuração SMTP e de tracking comprovada.
• Os dados de extensão devem ser armazenados em tabelas próprias, sem duplicar a tabela nativa newsletter_subscriber.
• A documentação operacional da implementação deve incluir adicionalmente o procedimento de gestão de filas, webhooks e testes de regressão da configuração administrativa.