On this Page

Snap type:

Read

Description:

This Snap provides the functionality to check calendar availability for appointment attendees in Microsoft Exchange through the Microsoft Exchange web services. The Snap requires an input Exchange availability record specific to the attendees and the date and time of the appointment, and it sends the request to Microsoft Exchange. If the result is successful, the list of dates and times that are available will be returned with any conflicts. However, if there is an error in performing the read, the error view will contain the error message.

Expected upstream Snaps: A document is expected as an input into the Exchange Read Snap. The upstream Snap can be either a JSON-generated Snap or a file Snap that reads in the document information to check meeting attendee availability.

Expected downstream Snaps: A document is the expected output of the Exchange Snap with a JSON payload containing meeting attendee availability information. The downstream Snap can be any Snap that consumes a document such as a file Snap or a database Snap.

Expected input: The following JSON is a sample of the input.

The date and time fields must be in the format below, and the values are in UTC.

In Microsoft's API, there are many additional fields that can be specified, but the fields below are the minimum required fields to read an appointment and therefore are what this Snap supports:

{
    "Id": "1",
    "attendees": "test@test.com",
    "startDate": "2014-1-18 13:00:00",
    "endDate": "2014-1-19 16:00:00",
    "availabilityType": "FreeBusyAndSuggestions"
}

Expected output: Each document contains Map data, which includes the ID of the object and the dates and times where there is a meeting conflict. If there are no meeting conflicts, an empty result is returned. The following JSON is a sample of the output generated when a meeting has been successfully created:

[
   {
      "test@test.com":[
         {
            "date":"2014-01-18T00:00:00.000+0000",
            "quality":"Excellent",
            "timeSuggestions":[
               {
                  "meetingTime":"2014-01-18T00:00:00.000+0000",
                  "quality":"Excellent",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               },
               {
                  "meetingTime":"2014-01-18T00:30:00.000+0000",
                  "quality":"Good",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               },
               {
                  "meetingTime":"2014-01-18T16:00:00.000+0000",
                  "quality":"Good",
                  "conflicts":[
                     {
                        "conflictType":"IndividualAttendeeConflict",
                        "numberOfMembers":0,
                        "numberOfMembersAvailable":0,
                        "numberOfMembersWithConflict":0,
                        "numberOfMembersWithNoData":0,
                        "freeBusyStatus":"Free"
                     }
                  ],
                  "workTime":true
               }
            ]
         }
      ]
   }
]

Expected usage: The main purpose of the Exchange Read Snap is to check availability for a meeting attendee in Exchange. The availability information returned can contain the list of conflicts for meeting attendees and suggest available meeting times.

Prerequisites:

[None]

Support and limitations:

Ultra pipelines: Works in Ultra Pipelines.
Spark mode: Not supported in /wiki/spaces/SD/pages/1437917 mode.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Microsoft Exchange Account for information on setting up this type of account.

Views:

Input

This Snap has exactly one input view and receives documents in the view. Each document contains an Exchange availability request to send to Microsoft Exchange. Multiple attendees can be included in the availability request. The way to determine the input fields is to create a pipeline with the Read Snap and save the pipeline. Based on the suggest functionality, the Read Snap will populate with the correct input view field name.

The Availability Type can be one of the following settings:

FreeBusy will return a list of any conflicts with an attendees calendar but will not return any suggestions on when to meet.
FreeBusyAndSuggestions will return a list of any conflicts with an attendees calendar, and will not return any suggestions on when to meet.
Suggestions will only return a list of suggestions on when to meet.

Output

This Snap has exactly one document output view.

Error

This Snap has at most one document error view and might produce documents in the view if the input data causes an error in Microsoft Exchange.

Settings

Label

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Object type

Required. An object type that will be read from Exchange.

Example: AvailabilityEntity

Default value: AvailabilityEntity

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
Disabled: Disables the Snap and all Snaps that are downstream from it.

Error rendering macro 'excerpt-include' : No link could be created for 'Microsoft Exchange Snap Pack'.

Exchange Read

Settings