Wiki

Scale Your Enterprise

User Tools

Site Tools

Trace: • Introduction (ExchangeConnector)
bw:exchangeconnector_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:exchangeconnector_tool [2019/03/07 10:42]
runger [General Process] 		bw:exchangeconnector_tool [2022/08/02 16:55] (current)
akoehler
Line 1: Line 1:
 ====== Introduction (ExchangeConnector) ====== ====== Introduction (ExchangeConnector) ======
  
-This document described the use of the Bizweaver ExchangeConnectortool. This tool is used to read email from a designated user and create new appointments for any user defined in Exchange.+This page describes the configuration of the Bizweaver ExchangeConnectortool. This tool is used to read email from a designated user and create new appointments for any user defined in Exchange.
  
-====== Audience ====== 
- 
-This document is intended for developers of Bizweaver workflows. 
  
 ====== Related Documents ====== ====== Related Documents ======
  
-The following documents contain additional information that may be helpful with the development of Bizweaver workflows.+The following pages contain additional information that may be helpful with the development of Bizweaver workflows using the Exchange Connector tool.
  
-  * [[bw:global_connections|Introduction (Global Connections)]]+  * **[[bw:global_connections|Introduction (Global Connections)]]**
  
 ====== Before You Begin ====== ====== Before You Begin ======
  
-You will need to have at least one Exchange global connection defined.  Instructions to do this are found [[https://wiki.twbs.com/doku.php/bw/global_connections#exchange_connections|here (opens in a new tab)]].+You will need to have at least one Exchange global connection defined.  Instructions to do this are found in the Global Connections page noted in the previous section. 
 + 
 +<WRAP center round tip 80%> 
 +An Exchange global connection can only reference one user mailbox for reading email.  If you need to read email from multiple mailboxes, each mailbox will need its own connection to be defined. 
 +</WRAP>
  
  
 ====== General Configuration ====== ====== General Configuration ======
  
-{{:bw:exchange1.png?400|}}+{{  :bw:exchange1.png?400  |}}
  
   - Select the **Exchange Connection** from the drop-down list.   - Select the **Exchange Connection** from the drop-down list.
Line 28: Line 29:
     - The available options will change depending on the action selected.  Specific options for each action are described below.     - The available options will change depending on the action selected.  Specific options for each action are described below.
  
-===== Read Mails Options =====+ 
 +<WRAP center round tip 80%> 
 +Notes for the following sections. 
 + 
 +  - Values used by the two actions, except drop-down selections, can use workflow variables. If necessary (as with the date/time values), clear the field manually, then press <**F4**> for a list of workflow variables. 
 +  - Date values must be entered or passed in YYYY-MM-DD format (including the dashes). 
 +  - Time values must be entered or passed in HH:MM XX (including the colon), where "XX" is AM or PM. 
 +</WRAP> 
 +===== Read Mail Options ===== 
 + 
 +{{  :bw:exchange2.png?400  |}} 
 + 
 +  - Select the mailbox **Folder** to process from the drop-down list. 
 +  - Define the **Filter** criteria to be used. 
 +    - Select the desired data field from the __Search__ drop-down list. 
 +    - Select the desired filtering option from the __Filter__ drop-down list. 
 +    - Enter the filtering value in the  __Value__ field. 
 +      - This will most typically be a variable but can also be directly entered as needed. 
 +      - Multiple filtering statements can be used.  In the example above the two statements are 'greater than' and 'less than'. 
 +  - If you wish to use this tool to move email from one folder to another, select the target folder from the **Move mail to folder** drop-down list. 
 +    - The target folder must exist in the user's mailbox before it can be used here.  The folder must be created in Exchange/Outlook as it cannot be created through the Exchange Connector tool. 
 +  - Select a folder where any **Attachments** should be stored. 
 +    - This is a Windows folder.  Use the standard Windows Explorer tool to locate the folder if needed. 
 +    - This action does not remove the attachments from the Exchange database.  It stores a copy of the attachment so that it can be used in other Bizweaver workflow steps. 
 + 
 + 
 + 
  
  
 ===== Create Appointment Options ===== ===== Create Appointment Options =====
 +"Appointment" and "Meeting" are used interchangeably for the Exchange Connector tool.  An "Appointment" is simply a meeting with only one person attending.
 +
 +{{  :bw:exchange3.png?400  |}}
 +
 +  - Enter the **Subject** of the appointment.
 +  - Enter any **Body** text for the appointment.
 +  - Enter/select a **Start** date and time.  Or select the __All Day__ checkbox.
 +  - Enter/select an **End** date and time.
 +  - Enter a **Location** (optional).
 +  - Enter one or more email addresses of **Required Attendees**.
 +    - Appointments can be sent to users that are not part of your Exchange system.
 +      - If the recipient uses Exchange/Outlook, the appoint will be handled in the normal manner.
 +      - If the recipient does not use Exchange/Outlook they will receive as .ics calendar file.
 +  - Enter one or more email addresses of **Optional Attendees**.
 +  - Enter a **Remind before minutes** (numeric) value.
 +  - Select how the **notification email** should be sent.
 +    - Use **SendOnlyToAll** to notify all attendees via email.
 +    - Use **SentToAllAndSaveCopy** to notify all attendees via email and save a copy in the sender's mailbox.
 +    - Using **SendToNone** is not recommended since no notifications are sent.
 +
 +====Exchange Variables====
 +
 +^Name ^Description^
 +|Action|This indicates the action taken|
 +|AllDay|True or False indicator if the all-day check box is selected|
 +|AttachmentsFolder|This indicates if there is an attachments folder selected|
 +|AttendeesCopy|This indicates who will get a response when an appointment is created|
 +|Body|This indicates if there is a body to a created appointment|
 +|ConnectionName|This indicated the name of the connection that is being used|
 +|Count|This indicates the count of the emails that are to be read|
 +|DataSourceResultsTable|This displays the results of the emails and all their fields|
 +|EndDate|This is the end date of an appointment|
 +|EndTime|This is the end time of an appointment|
 +|FolderMove|This indicates the folder the selected email will be moved to|
 +|FolderSearch|This indicates the folder the searched|
 +|Location|This indicates the location of a meeting|
 +|OptionalAttendees|This indicates the email addresses of all optional attendees to a meeting|
 +|ReminderMinutes|This indicates when a meeting will send out a reminder for the meeting|
 +|RequiredAttendees|This indicates the email addresses of all the required attendees to a meeting|
 +|SearchFilterCollection|This indicates the search criteria when reading emails|
 +|StartDate|This indicates the start date of a meeting|
 +|StartTime|This indicates the start time of a meeting|
 +|Subject|This indicates the subject of a meeting |
 +|StepMessage|During a failure the reason for failure will be populated here|
 +|StepStatus|True or False|
 +
 +
  
bw/exchangeconnector_tool.1551973371.txt.gz · Last modified: 2019/03/07 10:42 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