- Created by Akash Kumar Jaiswal, last modified on Nov 26, 2020
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 6 Next »
Adeptia Connect notifies the user through an email about the execution status of a template or transaction. The format of the email notification can be either system defined or you can select or create a custom format while creating a template or a transaction.
Follow the steps below to create a custom email notification format:
Click Configure > OTHERS > Email Notification Format.
Click Create Email Notification Format.
- Enter the name and description of email notification in the Name and Description fields respectively.
- Enter the subject of the email in the Email Subject field.
- Enter the body of the email in the Email Body field. Or, click Upload File button to upload the HTML file to create the email body.
- Select the project from the Select Project field.
- Click Save.
Email notification format guidelines
Email Subject:
- To add an email subject we will provide a text field under the Customize Email Format section.
- In the text field, a user can add any subject which he/she wants to be used as the subject of email notification.
- Email Subject can also be dynamically used in email notification by using the below variables:
- For Transaction Name: $$transactionName$$
- For Partner Name in Transaction: $$spokeCompanyName$$
- For Partner Name in Template: $$hubCompanyName$$
Email Body:
- We will provide an option to upload the customized email template file for the email content in which user can make the changes as per his/her requirement or as per the content they want to share in email notification.
- Uploaded template must be in html format.
- We will provide some variables that the user can use to dynamically generate the email body. List of these variables are explained in below section.
- The information about these variables will also be available in help link that user can refer. See the below screenshot:
Template Success Notification Template Variables List
Variables
Values
Description
Variables
Values
Description
Environment $$environmentName$$ This variable is used to display the environment name in the email notification. For example: Development, Testing, etc. Partner Name $$spokeCompanyName$$ This variable is used to display the Partner Name used in the transaction/template. Transaction Name $$transactionName$$ This variable is used to display the Transaction Name for which execution took place. Source File Location $$sourceFileLocation$$ This variable is used to display the Source File Location used in the transaction/template. Source File Name $$sourceFileName$$ This variable is used to display the Source File Name used in the transaction/template. Source File Size $$fileSize$$ This variable is used to display the Source File Size (in bytes) used in the transaction/template. Template Name $$templateName$$ This variable is used to display the Template Name for which execution took place. Target File Location $$targetFileLocation$$ This variable is used to display the Target File Location used in the transaction/template. Target File Name $$targetFileName$$ This variable is used to display the Target File Name used in the transaction/template. Time $$readableStartTime$$ This variable is used to display the readable start time. Template Failure Notification Template Variables List
Variables
Values
Description
Environment $$environmentName$$ This variable is used to display the environment name in the email notification. For example: Development, Testing, etc. Partner Name $$spokeCompanyName$$ This variable is used to display the Partner Name used in the transaction/template. Transaction Name $$transactionName$$ This variable is used to display the Transaction Name for which execution took place. Source File Location $$sourceFileLocation$$ This variable is used to display the Source File Location used in the transaction/template. Source File Name $$sourceFileName$$ This variable is used to display the Source File Name used in the transaction/template. Source File Size $$fileSize$$ This variable is used to display the Source File Size (in bytes) used in the transaction/template. Template Name $$templateName$$ This variable is used to display the Template Name for which execution took place. Target File Location $$targetFileLocation$$ This variable is used to display the Target File Location used in the transaction/template. Target File Name $$targetFileName$$ This variable is used to display the Target File Name used in the transaction/template. Time $$readableStartTime$$ This variable is used to display the readable start time. Error Message $$exceptionMessage$$ This variable is used to display the error occurred in execution of transaction/template. Transaction Success Notification Template Variables List
Variables
Values
Description
Environment $$environmentName$$ This variable is used to display the environment name in the email notification. For example: Development, Testing, etc. Partner Name $$hubCompanyName$$ This variable is used to display the Partner Name used in the transaction/template. Transaction Name $$transactionName$$ This variable is used to display the Transaction Name for which execution took place. Source File Location $$sourceFileLocation$$ This variable is used to display the Source File Location used in the transaction/template. Source File Name $$sourceFileName$$ This variable is used to display the Source File Name used in the transaction/template. Source File Size $$fileSize$$ This variable is used to display the Source File Size (in bytes) used in the transaction/template. Time $$readableStartTime$$ This variable is used to display the readable start time. Transaction Failure Notification Template Variables List
Variables
Values
Description
Environment $$environmentName$$ This variable is used to display the environment name in the email notification. For example: Development, Testing, etc. Partner Name $$hubCompanyName$$ This variable is used to display the Partner Name used in the transaction/template. Transaction Name $$transactionName$$ This variable is used to display the Transaction Name for which execution took place. Source File Location $$sourceFileLocation$$ This variable is used to display the Source File Location used in the transaction/template. Source File Name $$sourceFileName$$ This variable is used to display the Source File Name used in the transaction/template. Source File Size $$fileSize$$ This variable is used to display the Source File Size (in bytes) used in the transaction/template. Time $$readableStartTime$$ This variable is used to display the readable start time. Error Message $$exceptionMessage$$ This variable is used to display the error occurred in execution of transaction/template.
Logo in Email Notification:
- If user wants to add company logo in notification then $$companyLogoPath$$ should be used in the uploaded template file.
Guidelines for this will also be provided in the document link.
Variables
Values
Description
Logo $$companyLogoPath$$ This variable is used to display the company logo in the email notification
- No labels