Skip to end of banner
Go to start of banner

Exchange Create

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

On this Page

Snap type:

Write


Description:

This Snap provides the functionality to create appointments in Microsoft Exchange via the Microsoft Exchange web services. The Snap requires an input Exchange appointment record specific to the appointment to create and sends the request to Microsoft Exchange.  If the result is successful the ID is returned. However, if there is an error in performing the create, then the error view will contain the error message. 

  • Expected upstream SnapsA document is expected as an input into the Exchange Snap.  The upstream Snap can be either a JSON generator Snap or file Snap that reads in the document information to create the appointment.
  • Expected downstream SnapsA document is the expected output of the Exchange Snap with an ID for the meeting invite that was created.  The downstream Snap can be any Snap that consumes a document for example a file Snap or database Snap.
  • Expected inputThe following JSON is a sample of the input.
 
The date/time fields must be in the format below and the values are in UTC.  Additionally, the meeting start date must occur before the meeting end date or no meeting will be created.  
 

There are many additional fields that can be specified and the fields below are the minimum required fields to create an appointment:

{
    "requiredAttendees": "test@test.com",
    "subject": "test meeting",
    "body": "test meeting body",
    "start": "2014-1-18 11:00:00",
    "end": "2014-1-18 12:00:00",
    "location": "office" }


  • Expected outputThe following JSON is a sample of the output generated when a meeting has been successfully created:


[
   {
      "requiredAttendees":"test@test.com",
      "subject":"test meeting",
      "body":"test meeting body",
      "start":"2014-1-18 11:00:00",
      "end":"2014-1-18 12:00:00",
      "location":"office",
      "Id":{ "changeKey":"DwAAABYAAADsJ95dokZBSI4/bT7TSzJiAAAJPIVs", "uniqueId":"AAMkAGM4Y2Q2YmJlLWEyODktNDAxOS1hYzFiLTY0YjExYTg2ZmYxYQBGAAAAAADI1CKlDYCwTbXn+BLjIBxNBwDsJ95dokZBSI4/bT7TSzJiAAAAAAEOAADsJ95dokZBSI4/bT7TSzJiAAAJPB00AAA=" } }
]


  • Expected usagesThe main purpose of the Exchange Create Snap is to create appointments or meeting invites from Exchange.  The meeting invites can be sent to other exchange email accounts or to email accounts on different software platforms (such as GMAIL).


Prerequisites:

[None]


Support and limitations:


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:
InputThis Snap has exactly one document input view. Each document contains an Exchange appointment to create. Multiple attendees can be included in the appointment invite and if no attendees are specified, then the appointment will be created on the calendar for the user specified in the Account. The way to determine the input fields is to create a pipeline with the Create component and save the pipeline. Based on the suggest functionality, the Create Snap will populate with the correct input view field name.
OutputThis Snap has exactly one document output view. Each document contains Map data, which includes the ID of the object created.
ErrorThis 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 created in Exchange.

Example: Appointment

Default valueAppointment
 

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

  • No labels