Microsoft Exchange Online - Get calendar items

Use the Microsoft Exchange Online - Get calendar items action to retrieve the details of an existing calendar items in Microsoft 365.

Before you start 
Microsoft Exchange Online is a hosted messaging solution for Office 365 and Microsoft 365, that delivers the capabilities of Microsoft Exchange Server as a cloud-based service. It gives users access to email, calendar, contacts, and tasks from any cloud connected device. For more information on Microsoft Exchange Online, see the company website. In the context of Nintex Workflow, Microsoft Exchange Online is a connector A software component that allows seamless integration with third-party services, business applications, and content stores. Examples include Salesforce, Box, and Microsoft SharePoint. Connectors are used to create connections required for workflow actions and start events..

Variables allow you to store and manipulate data and files in your workflows. They can be created by start events, forms, tasks, workflow actions, or automatically created when a workflow is run. For more information, see Variables.

You can start a workflow whenever a new or updated file is detected (example: Box - New file), upload files on start or at any point in the workflow, generate documents from tagged templates, send and receive files via email, and manipulate files. You can set up file handling in your workflow start event An event that triggers a workflow to run when it occurs. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder. and actions A tool for building the processes, logic, and direction within workflows. Actions are the steps the workflow performs to complete a process..

Note: Your tenancy's default file storage location must be configured to hold files for later reference by the workflow. This location is used for uploaded files and for files stored as output from actions.

  • Generate documents from tagged templates using Generate document
  • Send and receive files via email; for example, see Assign a task to multiple users
  • Manipulate files in services (see Connectors): 

  • For example, store any email attachments received by the task assignee.

    1. On the Designer canvas, click the action you want to configure.

    2. Find the output field for storing the file or set of files.

      For example, to store attachments received in task assignee email replies when they may attach multiple files, use the Assign a task to multiple users Multiple file attachments option for the Store output field.

    3. In the output field, select a variable or specify a file path: 

      • Select a variable. For outputs storing multiple files, select a collection variable. For outputs storing a single file, select a file variable.

      • Specify a file path. You can use any combination of text and variables, beginning with the root folder. If available, use the folder browse icon on the right of the path field to navigate to the folder and any subfolders that you want, and then edit the path as desired to include variables and different text.

      The availability of variable or path options for storing files varies by action. For more information, see Connectors and Workflow actions.

  • For example, reference the new Box file that started the workflow to attach it to a task email notification or reference an image received by the task assignee to generate an invoice document.

    1. On the Designer canvas, click the action you want to configure.
    2. Find the field where you want to reference the stored file select a variable or specify a file path:

      • Select the file variable associated with the stored file. For example, select the variable for the new Box file that started the workflow or select the variable storing Multiple file attachments output from a task action.

      • Specify the file path where the file is stored. You can use any combination of text and variables, beginning with the root folder. If available, use the folder browse icon on the right of the path field to navigate to the folder and any subfolders that you want, and then edit the path as desired to include variables and different text.

        Both a file variable and a file path are used in the example image below for the Dropbox Business - Copy a file action. A file variable is selected for Source and a file path is specified for Destination.

        The variables "CountryVariable" and "Program" insert the values into the file path as determined by earlier workflow logic (in this case, fields in a submitted form). For example, if the person submitting the form selects Australia for country and specifies Inspire2017 for program, then the resulting file path is "/SpecialProgramNDAs/Australia/Inspire2017NDA.docx."

Configure the Microsoft Exchange Online - Get calendar items action

The steps required to configure the action are given below. The Microsoft Exchange Online - Get calendar items action fields and settings table describes all the required and optional configuration fields.

Important: Before inserting variables in the action configuration, you must manually type or select the values and populate other dependent fields in order to retrieve the output data. Once configured, you can insert variables to the required fields.

    1. Find the action in the Microsoft Exchange Online action group in the action toolbox.

      2. or

      Type the action name in the Search field at the top of the action toolbox.

    1. Drag the Get calendar items action to the designer canvas.
    2. Click the action to open the configuration panel.
  1. Select a Connection.

    1. In the drop-down list for Connection, select Add new connection.

      A new window appears, prompting you for a connection name.

    2. Type a user-friendly Connection name.
    3. Click Connect.

      4. The entered name is validated for uniqueness. If credentials are not stored in the browser for the selected connector service, then you are prompted for credentials. For more guidance on connections, see Connectors.

    4. Enter your Microsoft credentials if prompted.

      Upon successful log in, a window appears where you can assign owner and user permissions to the connection. Add Owners and Users, if required. For more guidance on connection permissions, see Permissions.

    5. Click Save permissions.

      6. Your newly added connection now appears in the Connection field.

  1. Add a condition defining the returned collection of calendar items.
  2. Create or select a variable for the Calendar items output.

Microsoft Exchange Online - Get calendar items

Important: Before inserting variables in the action configuration, you must manually type or select the values and populate other dependent fields in order to retrieve the output data. Once configured, you can insert variables to the required fields.

Section Field Description Variable types
(unlabeled) Connection Credentials and other settings that enables workflows to communicate with external systems, services, or applications. It's required to pass data between the workflow and the indicated service, which could be a cloud service, business application, or content store.

Microsoft Exchange Online connection for the calendar items you want to retrieve.

To refresh the available connections, click Refresh.

 (n/a)
  Add condition

Add conditions to select the calendar items to return. Only the calendar items that match the condition set are returned.

  • When: The calendar detail field that begins the conditional statement.

  • Operator: Operator to use for the condition. Comparison between When and Value fields is done based on the selected operator. Selections in the drop-down list correspond to the data type of the column selected for When.

  • Value. The value to match with the detail field specified for When.

  • Summary. Description of the condition.

  • Save condition: Save the condition.

You can edit or delete the added conditions.

  • Click Edit to edit a condition.
  • Click Delete to delete a condition.

When you have two or more conditions, the If All/Any of the following are true drop-down shows:

  • All: Returns the item only if the item matches all of the conditions.
  • Any: Returns the item if the item matches any of the conditions.
(Varies)
Output

Calendar items

Object variable to store the output from the action:

Calendar Items: Collection

  • ID: Text variable to store the calendar item ID.
  • Title: Text variable to store the title for the calendar item.
  • Start time: Object variable to store the time that the calendar item will start.
    • Time: DateTime variable to store the start time of the calendar item.
    • Time zone: Text.
  • End time: Object variable to store the time that the calendar item will end.
    • Time: DateTime variable to store the end time of the calendar item.
    • Time zone: Text.
  • All day event: Boolean variable indicating if the calendar item is an all day event.
  • Let attendees propose a new time: Boolean variable indicating if attendees can propose a new time for the calendar item.
  • Show as: Text variable indicating what status to show the attendees as during the calendar item.
  • Reminder enabled: Boolean variable indicating if a reminder is to be sent.
  • Reminder minutes before start: Integer variable storing the time in minutes for a reminder to be sent.
  • Attendees: Collection variable storing attendee details.
    • Attendee: Object variable storing the names and emails of the attendees.
      • Name: Text variable storing the attendee name.
      • Address: Text variable storing the attendee email address.
  • Response requested: Boolean variable indicating if the calendar item creator expected a response from the attendees.
  • Location: Object variable storing the location of the calendar item.
    • Name: Text variable storing the easy to read display name of the location.
  • Importance: Text variable storing the importance setting of the calendar item. Can be set to low, normal, or high.
  • Categories: Collection variable storing the categories for this calendar item
  • Sensitivity: Text variable storing the sensitivity setting of the calendar item. Can be set to personal, private, or confidential.
  • Recurrence: Text variable storing the recurrence setting of the calendar item.
  • Has attachments: Boolean variable indicating if the calendar item has attachments.
  • Body: Object variable storing the content type and message content of the calendar item.
    • Message body format: Text variable storing whether the content is in HTML or text format.
    • Message body: Text variable storing the message of the calendar item.
  • Canceled: Boolean variable indicating if the calendar item is canceled.
  • Online meeting: Boolean variable indicating if the calendar item is for an inline meeting.
  • Meeting URL: Text variable storing the URL of the calendar item if it is an online meeting.
  • Online meeting provider: Text variable storing the meeting platform.
  • Response status: Object variable storing details of responses to the calendar item.
    • Response: Text variable storing the attendees responses. Example: tentativelyAccepted.
    • Time: Text variable storing the time of the attendee response.
  • Is organizer: Boolean variable indicating if the update was made by the calendar item organizer.
  • Organizer: Object variable storing details of the calendar item organizer.
    • Details: Object variable storing the name and email of the organizer.
      • Name: Text variable storing the attendee name.
      • Address: Text variable storing the attendee email address.
  • Created date: DateTime variable storing the date and time that the calendar item was created.
  • Last modified date: DateTime variable storing the date and time that the calendar item was last updated.

Object