List Events

Owned by Amritesh Singh
Last updated: May 07, 2024 by Gouri Bhagchandani
5 min read

In this article

Overview

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

Snap Type

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

Prerequisites

  • Valid Exchange Online tenant.

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

Support for Ultra Pipelines

Works 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 & Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

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: 1

  • 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

  • Asterisk (*): Indicates a mandatory field.

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

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

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

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

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default Value: List 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.

User/Shared MailBox

 

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

String/Expression

Specify the mailbox from which you want to configure auto reply for emails received. If not provided, then the mailbox specified in the account settings is used.

Calendar Name

 

Default Value: N/A
Example: Office

String/Expression

Specify the name of the calendar.

Start Time

 

Default Value: N/A
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.

You can also specify time zone using 2020-09-29T04:18:00.000+0530 and if UTC time zone the using 2020-09-29T04:18:00.000+0000.

 

End Time

 

Default Value: N/A
Example: 2020-09-30T03:19:00.000

String/Expression

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

You can also specify time zone using 2020-09-29T04:18:00.000+0530 and if UTC time zone the using 2020-09-29T04:18:00.000+0000.

 

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.

Examples

Event Management

We are using an example of event-based management, where we have chain 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 an event with required input using the Create Event Snap.

  2. Mapping the event’s information using Mapper Snap.

  3. Updating an event using Update Event Snap.

  4. Listing the events in the calendar using List Events Snap.

  5. Mapping the event’s information using Mapper Snap.

  6. Deleting an existing event from the calendar using Delete Event Snap.

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

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

Create Event Snap

Output

Create Event Snap

Output

 

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 

Mapper Snap 

Next, we configure the Update Event Snap to use the inputs from the Mapper Snap as shown below:

Update Event

Output

Update Event

Output

 

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

List Events

Output

 

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

Mapper Snap

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

Delete Snap

Output

Delete Snap

Output

 

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

Download this Pipeline. 

Downloads

  File Modified

File Exchange Online_All Event snaps(Create,Update,List Events and Delete).slp

Nov 15, 2020 by Siddharth Menon

Snap Pack History

See Also

Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.