How To: Add Stock UDAs into Email Templates
Table Of Contents
Stock User Defined Attributes (UDAs) can be added to Invoice email templates, allowing information stored against stock records to be included automatically in invoice emails.
This is useful when you want to provide customers with additional product information, specifications, custom attributes or other stock-related details directly within the email.
Important: Setting up Email Message Templates is an advanced user feature.
Prerequisites
Before adding Stock UDAs to an email template:
- The required Stock UDA must already be configured.
- The Stock UDA must contain data against the relevant stock records.
- The email template must be of type INVOICE.
For information on creating Stock UDAs, see How To: Setup Stock UDAs.
Add a Stock UDA to an Invoice Email Template
- Open an Email Manager screen using (show me how).
- Open an existing email template with a Type of INVOICE, or create a new invoice email template by following How To: Setup Email Templates.
- Press Alt + E or click Edit to enter edit mode.
- Place the cursor in either the Item Template or To Follow Item Template field where you want the Stock UDA value to appear.
- Double-click the Stock UDA Item tag from the available tag list, or use the adjacent insert button.
- Select the required Stock UDA from the drop-down list.
- Click OK.
- Update the rest of the email template as required, ensuring that the Item Template and To Follow Item Template tags are included in the main body of the email where appropriate.
- Press Ctrl + S or click Save to save the template.
How It Works
When an invoice email is generated:
- Khaos Control reads the selected Stock UDA from each stock item on the invoice.
- The UDA value is inserted into the Item Template or To Follow Item Template section of the email.
- Product-specific information is displayed automatically for each invoice line where applicable.
This allows invoice emails to include additional product information without manual editing.
Limitations
The following Stock UDA types cannot be used with the Stock UDA Item tag:
- Yes / No
- List
Only supported UDA types can be inserted into invoice templates.
Additional Information
- Stock UDAs must be configured before they can be used in email templates.
- The UDA must contain data against the stock record for a value to be displayed.
- Stock UDA Item tags can be added to both the Item Template and To Follow Item Template sections.
- Multiple Stock UDAs can be added to the same email template if required.
Note: Company UDAs can also be included in the main body of the email template. For more information, see How To: Add Company UDAs into Email Templates.