Create iCal event and send to participants

Use this step to make an iCal calendar file.

Last published at: July 12th, 2023

createCalendarEvent Step


Create an iCal calendar file.


  • beginDate – Event begin date and time
  • endDate – Event end date and time
  • timezone - Select time zone
  • description – Description of the event
  • summary – Summarize the event details
  • location –Event Location
  • emailTo –Select participant users
  • emailAddresses - Email addresses of participant users



  • True – step executed successfully
  • False – step failed to execute 




Let’s build and execute the createCalendarEventDef example.          

  • Create a new definition called “createCalendarEventDef”
  • Select the definition and click the “design” button
  • Drag a "createCalendarEvent" step to the canvas
  • Connect the dots between the start and "createCalendarEvent" step
  • Click on the "createCalendarEvent" step to configure its "Settings" properties. Provide a name to the step. Provide the event start and finish date and time. Select the time zone from the dropdown list. Provide description text for the event. Provide event location information. 
  • Click on button to provide the event details summary info. Summarize the event details, Template popup will open. Fill the template design as per your requirement or use the existing templates from dropdown.
  • Click on button to select participant users. 
  • Click on the "createCalendarEvent" step to configure its "Advanced" properties. Provide email address of external participant users (separate by semi colon). 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition. Create a new process instance and execute. The process step should create an iCal calendar file and route the same to the participants using the email queue.