Profile Configuration
How to configure Profiles to define data processing, PDF generation, and email rules.
Profiles are the heart of PDF Mail Engine. A Profile creates a repeatable set of rules for reading your data, generating PDFs, and sending emails. You can create multiple profiles for different purposes, such as "Monthly Invoices," "Event Tickets," or "Payment Reminders."
Core Configuration
When you create or edit a profile, the Core Configuration section handles the essential settings required to start generating files.
| Setting | Description |
|---|---|
| Profile Name | Give your profile a unique name (e.g., "Invoices_2024"). This name is used to organize your files and logs. |
| Description | Add a private note about this profile's purpose. This is optional and only for your reference. |
| Template File | Select the rule file (.yaml) that defines how your PDF and Email content is generated. Default: templates/template.yaml |
| Master Data File | Select your customer list or address book (CSV or Excel). Default: data/master_data.csv |
| PDF Output Folder | Choose where the generated PDFs should be saved. Default: outputs |
Automatic Organization
When you run a job, PDF Mail Engine automatically creates a sub-folder inside your PDF Output Folder using the format ProfileName_Date_Time. You don't need to manually create new folders for every run.
Optional Configuration
Use these settings if you are working with specific Excel files or need to ensure compatibility with Japanese Excel environments.
Excel Sheet Selection
If your data is in an Excel file (.xlsx), you can specify exactly which sheet to read.
- Import Sheet Name: The name of the Excel sheet containing your transaction data (the list of items to process).
- Master Sheet Name: The name of the Excel sheet containing your master customer data.
Default Behavior
If you leave these fields empty, PDF Mail Engine will automatically read the first sheet in your Excel file.
Compatibility Settings
- Add BOM Output: Check this box if you plan to open exported CSV files in Microsoft Excel on Windows. This adds a special marker (BOM) to the file to prevent Japanese characters from appearing as garbled text (Mojibake).
Technical Details
This section is for system administrators or users configuring profiles via direct file editing.
File & Path Logic
All file paths in the configuration are relative to your Profile Workspace folder. This allows you to copy or move the entire profile folder to another computer without breaking the links.
| Field Key | Internal Key | Default Value | Notes |
|---|---|---|---|
| Profile Name | profile_name | (Required) | Max 50 chars. |
| Description | description | null | Optional internal notes. |
| Template File | pdf_template_path | templates/template.yaml | Expects YAML format. |
| Master Data | master_csv_path | data/master_data.csv | Supports CSV, XLSX, XLS. |
| PDF Output | pdf_output_base_dir | outputs | Auto-creates subfolders. |
| Import Sheet | import_sheet_name | null (First Sheet) | For Transaction Data. |
| Master Sheet | master_sheet_name | null (First Sheet) | For Master Data. |
| BOM Output | csv_export_with_bom | false | Set true for Excel/Shift-JIS compatibility. |