Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

Table of Contents
maxLevel2
absoluteUrltrue

Overview

Use You can use this Snap to generate a list of the calendar events in a given time range.Image Removed

...

Snap Type

List Events is a Read-type Snap that monitors the calender for new event invitations.

Prerequisites

  • Valid Exchange

    Valid Exchange Online tenant.

  • Valid 

    Valid OAUth2 application in Azure Active Directory with all the required API permissions.

Support for Ultra Pipelines

Works  in in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines. 

Limitations

...

None.

& Known Issues

None.

Snap

...

Input/Output

...

Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Update Event

Need Calendar name and Time Interval.

Output

Document


  • Min: 0

  • Max: 1

  • Mapper Snap

  • Delete Event

List out the events in your calendar within a specific time frame.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current Pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

...

Parameter Name

...

Data Type

...

Description

...

Default Value

...

Example 

...

Info
  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star)): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ((blue star)): Indicates that you can add fields in the field set.

  • Remove icon ((blue star)): Indicates that you can remove fields from the field set.

Field Name

Field Type

Description

Label*

Default ValueList Events
Example: List Events

String

Specify 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.

List Event OfficeList Event Office

User/Shared MailBox

Default Value: N/A
Example: john.doe@snaplogic.com

String/Expression

Enter

Specify the

 

mailbox

/account for which to create the event 

from

 

which you want to

create the event. 

configure auto reply for emails received. If not provided, then the mailbox

 associated to Calendar Name

specified in the account settings is used.

Calendar Name

Default Value: N/A

mark.twain@microsoft.com

Example: Office

String/Expression

Enter Enter

Specify the name of the calendar.

Start Time

Default Value: N/A

MeetingStart TimeString

Example: 2020-09-30T03:19:00.000

String/Expression

Specify the start time to retrieve events from your calendar. If not provided, then the current time will be considered.

note

You can also specify time zone

using 

using 2020-09-29T04:18:00.000+0530 and if UTC time zone the

using 

using 2020-09-29T04:18:00.000+0000.

End Time

Default Value: N/A
Example: 2020-09-

29T04

30T03:

18

19:00.000

End Time

String/Expression

Enter

Specify the end time until when you want to retrieve events from your calendar. If not provided, then 24 hours from

 Start

 Start Time

 will

 will be considered. 

note

You can also specify time zone

using 

using 2020-09-29T04:18:00.000+0530 and if UTC time zone the

using Snap ExecutionDrop-down

using 2020-09-29T04:18:00.000+0000.

N/A2020-09-30T03:19:00.000

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Select one of the three following modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then 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 downstream from it.

Execute onlyDisabled

Examples

Event Management

We are using an example of event-based management, where we have chain of event Snaps of event Snaps in this Pipeline, designated to perform specific tasks pertaining to their functionalities.

In this example, our Pipeline activities are as follows:

  1. Creating

...

  1. an event with required

...

  1. input using the Create Event

...

  1.  Snap.

  2. Mapping

...

  1. the event’s information

...

  1.  using Mapper

...

  1.  Snap.

  2. Updating an event

...

  1. using Update Event

...

  1.  Snap.

  2. Listing the events in the calendar

...

  1. using List Events

...

  1.  Snap.

  2. Mapping

...

  1. the event’s information

...

  1.  using Mapper

...

  1.  Snap.

  2. Deleting an existing event from the calendar

...

  1. using Delete Event

...

  1.  Snap.

...

Here, let us look into the role of the Create Event the role of the Create Event Snap in this Pipeline.

We create an event We create an event in the calendar with all the required inputs. Let us provide  Let us provide input in the Snap Settings and look at the output.

Create Event Snap

Output

Image Removed
Image Added
Image Removed
Image Added

Upon execution, we see an output confirming creation of an event with the given input.

We use the Mapper Snap to map the newly created event’s details with the details of another event to update.

Mapper Snap 

Image Removed
Image Added

Next, we configure

...

the Update Event

...

 Snap to use the inputs from the Mapper Snap as shown below:

Update Event

Output

Image Removed
Image Added
Image Removed
Image Added

Upon execution, we see an output with the update reflecting.

We

...

retrieve the list of events from the calendar associated

...

with an individual's mailbox. Let us provide input in the Snap Settings and look at the output.

List Events

Output

Image Removed
Image Added

Image Removed
Image Added

Upon execution, we see list of events and details related to the events shown in the output.

We use the Mapper Snap to map the event’s ID received from the List Events Snap with

...

the Existing Event ID

...

 field’s value in the Delete Event Snap.

Mapper Snap

Image Removed
Image Added

We then add the Delete Event Snap and configure it to delete the specified event as shown below:

Delete Snap

Output

Image Removed
Image Added
Image Removed
Image Added

Upon execution, we see an output with the update reflecting saying the event with a specific ID is deleted.

Download this Pipeline. 

Downloads

...

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

Attachments
patterns*.slp, *.zip


Insert excerpt
Exchange Online Snap Pack
Exchange Online Snap Pack
nopaneltrue

...

See Also