Configuração de perfil

Como configurar perfis para definir o processamento de dados, geração de PDF e regras de e-mail.

Perfis são o coração do PDF Mail Engine. Um Perfil cria um conjunto reutilizável de regras para ler seus dados, gerar PDFs e enviar e-mails. Você pode criar múltiplos perfis para diferentes finalidades, como "Faturas Mensais", "Ingressos de Evento" ou "Lembretes de Pagamento".


Configuração principal

Ao criar ou editar um perfil, a seção Core Configuration gerencia as configurações essenciais para começar a gerar arquivos.

ConfiguraçãoDescrição
Profile NameDê ao perfil um nome único (ex.: "Invoices_2024"). Este nome é usado para organizar arquivos e logs.
DescriptionAdicione uma nota privada sobre a finalidade deste perfil. É opcional e apenas para sua referência.
Template FileSelecione o arquivo de regras (.yaml) que define como o PDF e o e-mail são gerados.
Padrão: templates/template.yaml
Master Data FileSelecione sua lista de clientes ou catálogo de endereços (CSV ou Excel).
Padrão: data/master_data.csv
PDF Output FolderEscolha onde os PDFs gerados devem ser salvos.
Padrão: outputs

Configuração opcional

Use estas configurações se estiver trabalhando com arquivos Excel específicos ou precisar garantir compatibilidade com ambientes Excel japoneses.

Seleção de planilha Excel

Se seus dados estão em um arquivo Excel (.xlsx), você pode especificar exatamente qual planilha ler.

  • Import Sheet Name: O nome da planilha Excel contendo seus dados de transação (a lista de itens a processar).
  • Master Sheet Name: O nome da planilha Excel contendo seus dados mestre de clientes.

Configurações de compatibilidade

  • Add BOM Output: Marque esta opção se planeja abrir arquivos CSV exportados no Microsoft Excel no Windows. Isso adiciona um marcador especial (BOM) ao arquivo para evitar que caracteres japoneses apareçam como texto ilegível (Mojibake).

Detalhes técnicos

Esta seção é para administradores de sistema ou usuários que configuram perfis por edição direta de arquivos.

Lógica de arquivos e caminhos

Todos os caminhos de arquivo na configuração são relativos à pasta do Workspace do Perfil. Isso permite copiar ou mover a pasta inteira do perfil para outro computador sem quebrar os links.

CampoChave internaValor padrãoNotas
Profile Nameprofile_name(Obrigatório)Máximo 50 caracteres.
DescriptiondescriptionnullNotas internas opcionais.
Template Filepdf_template_pathtemplates/template.yamlRequer formato YAML.
Master Datamaster_csv_pathdata/master_data.csvSuporta CSV, XLSX, XLS.
PDF Outputpdf_output_base_diroutputsCria subpastas automaticamente.
Import Sheetimport_sheet_namenull (Primeira planilha)Para dados de transação.
Master Sheetmaster_sheet_namenull (Primeira planilha)Para dados mestre.
Root Pathprofile_root_path(Gerado automaticamente)Opcional. Substitui o diretório de dados padrão deste perfil.
BOM Outputcsv_export_with_bomfalseDefina true para compatibilidade com Excel/Shift-JIS.