Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Configure SQL to call Bizweaver WebService • Introduction (Decisions) • Changing A Database Connection Record • WF_Exec Tool • BigCommerce WebService Access • Introduction (Test Run Tool) • Introduction (WebService Tool) • Introduction (Looping Tool) • Workflow Tools • Setup
bw:email_tool

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
bw:email_tool [2019/03/07 09:19]
runger [Tables] 		bw:email_tool [2022/08/02 17:06] (current)
akoehler
Line 1: Line 1:
-====== Introduction (Bizweaver Email Tool) ======+====== Introduction (Email) ======
  
-This document describes the use of the Bizweaver Email tool+This document describes the use of the Bizweaver Email tool.
  
 ====== Audience ====== ====== Audience ======
Line 11: Line 11:
 The following documents contain additional information that may be helpful with the development of Bizweaver workflows. The following documents contain additional information that may be helpful with the development of Bizweaver workflows.
  
-  * [[bw:application_introduction|Bizweaver – Application Introduction]] +  * **[[bw:bizweaver_application_overview|Application Introduction]]** 
-  * [[bw:global_connections|Bizweaver – Global Connections]] +  * **[[bw:global_connections|Global Connections]]** 
-  * [[bw:using_variables|Bizweaver – Using Variables]]+  * **[[bw:using_variables|Using Variables]]**
  
 ====== Before You Begin ====== ====== Before You Begin ======
  
-At least one SMTP Global configuration must be defined to use the email function. See the [[bw:global_connections|Global Connections Guide]] for information on configuring this type of connection. +At least one SMTP Global configuration must be defined to use the email function. See the **//[[bw:global_connections#SMTP Connections|Global Connections Guide]]//** for information on configuring this type of connection.
- +
-====== General Workflow Step Information ====== +
- +
-  - Each workflow step must have a unique name. +
-    - The application will assign a default name, but we recommend that you change the name to something that helps you understand the purpose of the step as it is used in other steps. +
-    - The name cannot have spaces or special characters other than and underscore (_) +
-  - Press <**F4**> to find and use values from previous workflow steps.+
  
 ====== Email Formats ====== ====== Email Formats ======
Line 34: Line 27:
 ====== Email & HTML Designer ====== ====== Email & HTML Designer ======
  
-The Bizweaver Email tool is used to define technical settings to allow Email messages to be sent from Bizweaver and to format the message content. \\ {{:bw:emailimage1.png?384x403}}+The Bizweaver Email tool is used to define technical settings to allow Email messages to be sent from Bizweaver and to format the message content. \\ {{  :bw:emailimage1.png?384x403  }}
  
   - An Email object may be associated (linked) to a SQL Command: Reader workflow step that will be the source of the message content. The appropriate step is selected from the **Linked Object** drop-down list.   - An Email object may be associated (linked) to a SQL Command: Reader workflow step that will be the source of the message content. The appropriate step is selected from the **Linked Object** drop-down list.
Line 61: Line 54:
 Basic data elements can be inserted into the message using [Date], [Time], and [Field Name] buttons in the Insert row as shown below Basic data elements can be inserted into the message using [Date], [Time], and [Field Name] buttons in the Insert row as shown below
  
-{{:bw:emailimage2.png?576x30}}+{{  :bw:emailimage2.png?576x30  }}
  
-  - Ordered List ItemTo add the current date or time in the message.+  - To add the current date or time in the message.
       - Position the cursor at the point in the message where the information is to be placed.       - Position the cursor at the point in the message where the information is to be placed.
       - Click [**Date**] or [**Time**] to insert the item.       - Click [**Date**] or [**Time**] to insert the item.
Line 79: Line 72:
 Data can be presented in a table (row & column) structure within the body of a Bizweaver Email. This approach is helpful when there are multiple rows of data to present, but the amount of data does not necessarily warrant the use of an attachment. Data can be presented in a table (row & column) structure within the body of a Bizweaver Email. This approach is helpful when there are multiple rows of data to present, but the amount of data does not necessarily warrant the use of an attachment.
  
-The table must be defined before it can be used in the message. See [[bw:email_tool#using_tables|Using Tables]] for information on creating a table.+The table must be defined before it can be used in the message. See **//[[bw:email_tool#using_tables|Using Tables]]//** for information on creating a table.
  
-{{:bw:emailimage3.png?576x30}}+{{  :bw:emailimage3.png?576x30  }}
  
 To add a table into the message body. To add a table into the message body.
Line 89: Line 82:
     - Click [**Insert Table**] to add the table to the message.     - Click [**Insert Table**] to add the table to the message.
  
-Your message must use HTML format to include tables. See the [[bw:email_tool#appendix_c_tables|Appendix C]] section for more information. If you insert a table into a plain-text message the application will prompt you to change the format.+Your message must use HTML format to include tables. See the **//[[bw:email_tool#the_html_editor|The HTML Editor]]//** section for more information. If you insert a table into a plain-text message the application will prompt you to change the format.
 ===== Attachments ===== ===== Attachments =====
  
-Attachments can be included with an Email as needed. The attachment can be a static file such as a marketing document, or it can be generated as part of the workflow process. See [[bw:email_tool#appendix_b_tables|Appendix B]] for more information.+Attachments can be included with an Email as needed. The attachment can be a static file such as a marketing document, or it can be generated as part of the workflow process. See **//[[bw:email_tool#handling_attachments|Handling Attachments]]//** for more information.
 ===== HTML Editor ===== ===== HTML Editor =====
  
-The HTML Editor tool can be used to format the Email using standard HTML tags. See [[bw:email_tool#appendix_c_tables|Appendix C]] for more information.+The HTML Editor tool can be used to format the Email using standard HTML tags. See **//[[bw:email_tool#the_html_editor|The HTML Editor]]//** for more information.
 ====== Using Tables ====== ====== Using Tables ======
  
Line 101: Line 94:
  
   - Tables are created and maintained using the [**Open Table Definition**] button.   - Tables are created and maintained using the [**Open Table Definition**] button.
-    - To create a new table, be sure the “Tables” drop-down field is empty, then click [**Open** **Table Definition**]. \\ {{:bw:emailimage4.png?576x26}} +    - To create a new table, be sure the “Tables” drop-down field is empty, then click [**Open** **Table Definition**]. \\ {{  :bw:emailimage4.png?576x26  }} 
-    - To maintain an existing table, select the table from the “Tables” drop-down, then click [**Open Table Definition**]. \\ {{:bw:emailimage5.png?576x36}}+    - To maintain an existing table, select the table from the “Tables” drop-down, then click [**Open Table Definition**]. \\ {{  :bw:emailimage5.png?576x36  }}
  
 ===== Table Definition ===== ===== Table Definition =====
Line 108: Line 101:
 The Table Definition function opens in the “Layout Designer” mode. This is the easiest way to create and maintain tables. However, the actual HTML code can be viewed and edited by clicking on the “Source” tab. Use of the “Source” option is not discussed in this document. The Table Definition function opens in the “Layout Designer” mode. This is the easiest way to create and maintain tables. However, the actual HTML code can be viewed and edited by clicking on the “Source” tab. Use of the “Source” option is not discussed in this document.
  
-{{:bw:emailimage6.png?576x354}}+{{  :bw:emailimage6.png?576x354  }}
  
 Click the [**Refresh**] button to see a representation of the table. Not all settings will be displayed but items like borders and colors can be checked. Click the [**Refresh**] button to see a representation of the table. Not all settings will be displayed but items like borders and colors can be checked.
Line 123: Line 116:
 All columns in the data source associated with the Email are listed at the top of the layout designer. Width, color, and alignment settings in this section allow these values to be set for each column if needed. For most cases, the settings in the Column Layout section will provide more flexibility. All columns in the data source associated with the Email are listed at the top of the layout designer. Width, color, and alignment settings in this section allow these values to be set for each column if needed. For most cases, the settings in the Column Layout section will provide more flexibility.
  
-{{:bw:emailimage7.png?576x144}}+{{  :bw:emailimage7.png?576x144  }}
  
-  - Ordered List ItemSelect the **Include** checkbox to include a column in the table.+  -Select the **Include** checkbox to include a column in the table.
       - The column order cannot be changed using the layout tool. The columns will be presented in the order shown.       - The column order cannot be changed using the layout tool. The columns will be presented in the order shown.
   - Enter the desired **Width** for this column (in pixels).   - Enter the desired **Width** for this column (in pixels).
Line 143: Line 136:
 This section provides settings for the overall layout of the table. This section provides settings for the overall layout of the table.
  
-{{:bw:emailimage8.png?576x111}}+{{  :bw:emailimage8.png?576x111  }}
  
-  - Ordered List ItemEnter a **Name** for this table.+  - Enter a **Name** for this table.
   - Enter a **Description** for this table.   - Enter a **Description** for this table.
   - Select the **Alignment** (left, center, right) of the table on the page.   - Select the **Alignment** (left, center, right) of the table on the page.
Line 164: Line 157:
 This section provides settings for rows of the table. This section provides settings for rows of the table.
  
-{{:bw:emailimage9.png?576x77}}+{{  :bw:emailimage9.png?576x77  }}
  
   - Select the **Alignment** (left, center, right) of the text in the cells.   - Select the **Alignment** (left, center, right) of the text in the cells.
Line 182: Line 175:
 This section provides settings for columns of the table. This section provides settings for columns of the table.
  
-{{:bw:emailimage10.png?576x123}}+{{  :bw:emailimage10.png?576x123  }}
  
-  - Ordered List ItemSelect the **Alignment** (left, center, right) of the text in the cells.+  - Select the **Alignment** (left, center, right) of the text in the cells.
   - Select the **Vertical Alignment** (top, center, or bottom) of the text in the cells.   - Select the **Vertical Alignment** (top, center, or bottom) of the text in the cells.
   - Select the **Height** of the rows.   - Select the **Height** of the rows.
Line 207: Line 200:
 This section provides settings for any grouping rows of the table. This section provides settings for any grouping rows of the table.
  
-{{:bw:emailimage11.png?576x84}}+{{  :bw:emailimage11.png?576x84  }}
  
   - Select the **Alignment** (left, center, right) of the text in the cells.   - Select the **Alignment** (left, center, right) of the text in the cells.
Line 226: Line 219:
 The following example illustrates the use of an attachment based on a workflow step. The following example illustrates the use of an attachment based on a workflow step.
  
-{{:bw:emailimage12.png?576x79}}+{{  :bw:emailimage12.png?576x79  }}
  
 In this example, we create a file based on a SQL Command step, and save it. We then reference the file via a variable name to use it as an attachment. Finally, we delete the file. The deletion step is optional. In this example, we create a file based on a SQL Command step, and save it. We then reference the file via a variable name to use it as an attachment. Finally, we delete the file. The deletion step is optional.
Line 232: Line 225:
 To add attachments to an Email, click the [**Attachments**] button on the Email tool. The Attachments dialog window is displayed. To add attachments to an Email, click the [**Attachments**] button on the Email tool. The Attachments dialog window is displayed.
  
-{{:bw:emailimage13.png?466x308}}+{{  :bw:emailimage13.png?466x308  }}
  
-  - Ordered List ItemThe upper area of the window lists the attachments associated with this Email.+  - The upper area of the window lists the attachments associated with this Email.
   - Use the **Add custom variable** field to reference variables in this workflow.   - Use the **Add custom variable** field to reference variables in this workflow.
       - Position the cursor in the field and press F4 for available workflow steps and variables.       - Position the cursor in the field and press F4 for available workflow steps and variables.
Line 254: Line 247:
 There are two modes for the editor. The most common is the “View Editor.” This mode displays how the Email will appear. The second mode is “View HTML Source.” This mode displays the HTML code, which can be edited as needed. There are two modes for the editor. The most common is the “View Editor.” This mode displays how the Email will appear. The second mode is “View HTML Source.” This mode displays the HTML code, which can be edited as needed.
  
-{{:bw:emailimage14.png?576x224}}+{{  :bw:emailimage14.png?576x224  }}
  
 Standard Windows text editing functions are available in the icon bar at the top of the window. When these functions are used in the “View Editor” they are converted to the corresponding HTML tags. Standard Windows text editing functions are available in the icon bar at the top of the window. When these functions are used in the “View Editor” they are converted to the corresponding HTML tags.
Line 261: Line 254:
  
 Click the [**Save and Close**] icon to save the HTML in the Email. The standard [**Save**] icon will try to create a file on disk. Click the [**Save and Close**] icon to save the HTML in the Email. The standard [**Save**] icon will try to create a file on disk.
 +
 +
 +====Email Variables====
 +
 +^Name ^Description^
 +|Attachments|This indicates if there are any attachments as text to the email|
 +|AttachObject|True or False if any attachments are found|
 +|BCC|This indicates any email addresses on the BCC line|
 +|CC|This indicates any email addresses on the CC line|
 +|Connection|This indicates the SMTP connection used for the email|
 +|EnableSSL|This indicates if SSL was selected on the SMTP connection|
 +|From|This indicates the email address that is being used to send the email|
 +|LinkedObject|This indicates if there is a linked object used on the email tool|
 +|Message|The body of the email|
 +|Password|The password of the SMTP connection being used|
 +|Port|This indicates the port being used in the SMTP connection|
 +|PortNumber|This indicates the port being used in the SMTP connection|
 +|SkipEmailWhenEmptyContent| |
 +|SkipEmailWhenEmptyRecord|True or False if the skip email tool for empty records and variables is selected|
 +|SMTPCredentials|True or False if you are using SMTP credentials in the SMTP connection|
 +|SMTPHost|This indicates the SMTP host that is being used in the SMTP connection|
 +|SMTPServer|This indicates the SMTP server that is being used in the SMTP connection if any|
 +|Subject|This indicates the subject of the email|
 +|To This|Indicates any email addresses on the To line|
 +|UserName|This indicates the username used in the SMTP connection|
 +|UseZipFileAttachment|True or False if the zip file attachments are used in the attachments section|
 +|ZipAllAttachments|This indicates whether we selected “Zip All Attachments”. In case there are multiple attachments, we do have an option to zip all and send a single attachment.|
 +|StepMessage|During a failure the reason for failure will be populated here|
 +|StepStatus|True or False|
bw/email_tool.1551968378.txt.gz · Last modified: 2019/03/07 09:19 by runger

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
CC Attribution-Noncommercial 4.0 International Valid HTML5 Valid CSS Driven by DokuWiki