Versions Compared

Old Version 6

changes.mady.by.user Akash Kumar Jaiswal

Saved on

compared with

New Version Current

changes.mady.by.user Akash Kumar Jaiswal

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

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. 

This page contains the following information:

Table of Contents
maxLevel4

Creating email notification format

Follow the steps below to create a custom email notification format:

  1. Click Configure > OTHERS > Email Notification Format.

  2. Click Create Email Notification Format.



  3. Enter the name and description of email notification in the Name and Description fields respectively.
  4. Enter the subject of the email in the Email Subject field. 
  5. Enter the body of the email in the Email Body field. Or, click Click Upload File button to upload the HTML file to create the email body. 
  6. Select the project from the Select Project field.
  7. 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

    There are certain guidelines that you need to follow to have a customized email subject and body. 

    Email Subject

    You can append the name of the services in the email subject by using the variables as given in the table below:

    Warning
    Use the variables as is. There should be no change in the text or case of the listed variables. 


    To display

    Use variables

    Description

    Transaction Name $$transactionName$$To display the transaction name in the email subject.
    Partner Name (In transaction)$$spokeCompanyName$$To display the Partner Name in the email subject of transaction.
    Partner Name (In template)$$hubCompanyName$$To display the Partner Name in the email subject of template.

    Email Body

    By default, the body of the email notification is in tabular format. However, you can create and upload your own HTML file to send the email notification to the user in a format other than the tabular one.

    You can append the name of the services in the email body by using the variables as given in the table below:

    Template (success/failure) notification variables list

    To display

    Use variables

    Description

    Environment$$environmentName$$To display the environment name in the email notification. For example: Development, Testing, etc.
    Partner Name$$spokeCompanyName$$
    This variable is used to
    To display the Partner Name used in the transaction/template.
    Transaction Name$$transactionName$$
    This variable is used to
    To display the Transaction Name for which execution took place.
    Source File Location$$sourceFileLocation$$
    This variable is used to
    To display the Source File Location used in the transaction/template.
    Source File Name$$sourceFileName$$
    This variable is used to
    To display the Source File Name used in the transaction/template.
    Source File Size$$fileSize$$
    This variable is used to
    To display the Source File Size (in bytes) used in the transaction/template.
    Template Name$$templateName$$
    This variable is used to
    To display the Template Name for which execution took place.
    Target File Location$$targetFileLocation$$
    This variable is used to
    To display the Target File Location used in the transaction/template.
    Target File Name$$targetFileName$$
    This variable is used to
    To display the Target File Name used in the transaction/template.
    Time$$readableStartTime$$
    This variable is used to
    To display the readable start time.
    Error Message $$exceptionMessage$$
    This variable is used to
    To display the error occurred in the 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

    Transaction (success/failure) notification variables list

    To display

    Use variables

    Description

    Environment$$environmentName$$
    This variable is used to
    To display the environment name in the email notification. For example: Development, Testing, etc.
    Partner Name$$hubCompanyName$$
    This variable is used to
    To display the Partner Name used in the transaction/template.
    Transaction Name$$transactionName$$
    This variable is used to
    To display the Transaction Name for which execution took place.
    Source File Location$$sourceFileLocation$$
    This variable is used to
    To display the Source File Location used in the transaction/template.
    Source File Name$$sourceFileName$$
    This variable is used to
    To display the Source File Name used in the transaction/template.
    Source File Size$$fileSize$$
    This variable is used to
    To display the Source File Size (in bytes) used in the transaction/template.
    Time$$readableStartTime$$
    This variable is used to
    To display the readable start time.
    Error Message$$exceptionMessage$$
    This variable is used to
    To display the error occurred in the execution of transaction
    /template
    .


    Logo in

    Email Notification:

    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

    HTML file, for example, <img src="$$companyLogoPath$$">.


    To display

    Use variables

    Description

    Logo$$companyLogoPath$$
    This variable is used to
    To display the company logo in the email notification.




    Panel
    borderStylesolid
    titleYou may be interested in...
    What's new
    Best practices
    Training guides
    Frequently asked questions
    Adeptia Connect APIs
    Adeptia security report