Exchange - Trigger Configuration (Magic xpi 4.13)
The Exchange connector can be used to trigger a flow as a result of entities changed in the Microsoft Exchange server. When you drag the Exchange connector into the Magic xpi Studio’s trigger area, the Properties pane opens. Then, double-click or right-click on the connector and select Configuration from the context menu to open the Exchange Trigger Configuration dialog box.
This dialog box contains the following fields:
|
|
|
|
Connection
|
|
Resource Name
|
This read-only field displays the name(s) of the Exchange resource(s) that you selected for the trigger in the Settings dialog box's Services section.
|
|
Polling Interval
|
Click  to open the Polling Interval dialog box. Enter the frequency that the connector will check for changes in your organization's data. You can select a combination of minutes, hours, and days.
The value that you set here (for example, three minutes) determines the number of real calls that are made to the Microsoft Exchange API. This mechanism works in the following way:
-
The trigger calls the GetEvents() Exchange method.
-
Each call to these methods returns an ID list of the triggered entities.
-
When Magic xpi gets the list of IDs, you can obtain the Exchange item details by using the GetById() method in an Exchange step.
|
|
Synchronous
|
Select this check box to invoke the Magic xpi flow in synchronous mode each time an event is executed (for example, the deletion of contacts). This means that the next flow will be invoked only after the complete execution of the previously invoked flow.
The default is unchecked.
|
|
Keep Alive Interval
|
The amount of time in minutes that the trigger can be unresponsive before it is automatically restarted. The default value is 0, which means that the trigger can be permanently unresponsive.
|
|
-
You should be very careful when selecting a value for this parameter. If the chosen value is too small, a trigger may terminate before it completes a valid operation.
-
If you select the Synchronous check box (above), the trigger and the flow will operate in the same thread. This means that if the trigger is terminated because it is unresponsive, the flow will be terminated as well. Therefore, when setting the Keep Alive Interval parameter, you should also take into account the amount of time it takes for the flow to run.
For example, if the trigger's unresponsive time is three minutes, and the flow takes a maximum of two minutes to run, then you should set the Keep Alive Interval parameter to a value of more than five minutes.
|
|
|
Row Label
|
Enter a label to define the triggered row. The variable mapped in the Store Row Label In field (below) holds the label value when the flow is invoked.
|
|
Entity
|
The entity that the operation will be performed on. Select one of the following entities from the drop-down list:
-
Mail
-
Contact
-
Calendar
-
Task
If you select Mail, click to open the Trigger's Folder List. Select one or more mail folders to work with. Your selected mail folders will appear at the bottom of the dialog box's Details area.
|
|
Operation
|
Determines which operation will be triggered on an Exchange item. Select one of the following operations from the drop-down list:
-
Add (default)
-
Update
-
Delete
-
Move
-
Copy
-
New Mail
|
|
The Update operation is triggered when a Contact entity is created.
|
|
|
Result Store Options
|
|
Store XML Result In
|
This field is used to store the trigger’s polling results.
Click to open the Variables List. Choose the required BLOB variable by clicking Select. The default is C.UserBLOB.
|
|
Store Row Label In
|
This field is used to store the trigger’s row label.
Click to open the Variables List. Choose the required Alpha variable by clicking Select.
|
|
Store Row Unique Identifier
|
This field holds the name of the row label that invoked the trigger.
Click to open the Variables List. Choose the required Alpha variable by clicking Select. The default is C.UserString.
|
The Exchange Trigger Configuration dialog box contains the following additional buttons:
|
|
|
|
New
|
Creates a new line in the trigger table.
|
|
Delete
|
Deletes a selected line in the trigger table.
|
|
Folders
|
This button retrieves the mail Folder List from the Exchange server. You must click this button if you want to use the Exchange component later on. If the Folder List is successfully retrieved, it means that the connection to the Exchange server is valid.
|
When you have finished configuring the connector, click OK to save your definitions and to close the Exchange Trigger Configuration dialog box.
Alternatively, you can click Cancel to close the Exchange Trigger Configuration dialog box without saving your definitions.
Then click the Component Properties dialog box’s OK button to close the dialog box and to save your configuration settings.
