bw:exchangeconnector_tool

Introduction (ExchangeConnector)

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.

Related Documents

The following pages contain additional information that may be helpful with the development of Bizweaver workflows using the Exchange Connector tool.

Before You Begin

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.

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.

General Configuration

  1. Select the Exchange Connection from the drop-down list.
  2. Select the desired Action from the drop-down list.
    1. “Read Mails” is used to retrieve and read email from a designated mailbox folder.
    2. “Create Appointment is used to create a new appointment for one or more users in the designated Exchange system.
  3. The available options will change depending on the action selected. Specific options for each action are described below.

Notes for the following sections.

  1. 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.
  2. Date values must be entered or passed in YYYY-MM-DD format (including the dashes).
  3. Time values must be entered or passed in HH:MM XX (including the colon), where “XX” is AM or PM.

Read Mail Options

  1. Select the mailbox Folder to process from the drop-down list.
  2. Define the Filter criteria to be used.
    1. Select the desired data field from the Search drop-down list.
    2. Select the desired filtering option from the Filter drop-down list.
    3. Enter the filtering value in the Value field.
      1. This will most typically be a variable but can also be directly entered as needed.
      2. Multiple filtering statements can be used. In the example above the two statements are 'greater than' and 'less than'.
  3. 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.
    1. 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.
  4. Select a folder where any Attachments should be stored.
    1. This is a Windows folder. Use the standard Windows Explorer tool to locate the folder if needed.
    2. 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

“Appointment” and “Meeting” are used interchangeably for the Exchange Connector tool. An “Appointment” is simply a meeting with only one person attending.

  1. Enter the Subject of the appointment.
  2. Enter any Body text for the appointment.
  3. Enter/select a Start date and time. Or select the All Day checkbox.
  4. Enter/select an End date and time.
  5. Enter a Location (optional).
  6. Enter one or more email addresses of Required Attendees.
    1. Appointments can be sent to users that are not part of your Exchange system.
      1. If the recipient uses Exchange/Outlook, the appoint will be handled in the normal manner.
      2. If the recipient does not use Exchange/Outlook they will receive as .ics calendar file.
  7. Enter one or more email addresses of Optional Attendees.
  8. Enter a Remind before minutes (numeric) value.
  9. Select how the notification email should be sent.
    1. Use SendOnlyToAll to notify all attendees via email.
    2. Use SentToAllAndSaveCopy to notify all attendees via email and save a copy in the sender's mailbox.
    3. Using SendToNone is not recommended since no notifications are sent.

Exchange Variables

Name Description
ActionThis indicates the action taken
AllDayTrue or False indicator if the all-day check box is selected
AttachmentsFolderThis indicates if there is an attachments folder selected
AttendeesCopyThis indicates who will get a response when an appointment is created
BodyThis indicates if there is a body to a created appointment
ConnectionNameThis indicated the name of the connection that is being used
CountThis indicates the count of the emails that are to be read
DataSourceResultsTableThis displays the results of the emails and all their fields
EndDateThis is the end date of an appointment
EndTimeThis is the end time of an appointment
FolderMoveThis indicates the folder the selected email will be moved to
FolderSearchThis indicates the folder the searched
LocationThis indicates the location of a meeting
OptionalAttendeesThis indicates the email addresses of all optional attendees to a meeting
ReminderMinutesThis indicates when a meeting will send out a reminder for the meeting
RequiredAttendeesThis indicates the email addresses of all the required attendees to a meeting
SearchFilterCollectionThis indicates the search criteria when reading emails
StartDateThis indicates the start date of a meeting
StartTimeThis indicates the start time of a meeting
SubjectThis indicates the subject of a meeting
StepMessageDuring a failure the reason for failure will be populated here
StepStatusTrue or False
bw/exchangeconnector_tool.txt · Last modified: 2022/08/02 16:55 by akoehler