Difference between revisions of "Using iCalendar to Generate Meeting Requests, Tasks and Contact Cards"

From SmartWiki
Jump to: navigation, search
Line 1: Line 1:
__TOC__
+
#REDIRECT [[Workflows_Overview#Using_iCalendar_to_generate_Meeting_Requests.2C_Tasks_and_Contact_cards]]
 
 
 
 
[https://en.wikipedia.org/wiki/ICalendar iCalendar] is a file format that allows Internet users to send meeting requests, contacts and tasks through email and other digital methods.
 
 
 
 
 
* iCalendar file formats store event, list and contact information.
 
* The file extensions used include .ics for iCalendar / iTodo and .vcf for vcards (contacts).
 
* Popular uses of iCalendar and vcards include sharing events, to-do lists, and contact information as file attachments in electronic communications like email and text messaging.
 
 
 
 
 
==System Supported Email Attachments==
 
* 3 email attachments types are supported: "ievent", "itodo" and "icard".
 
* The SmartSimple email engine will look for email contents that have ievent, itodo, and icard objects. The contents of these objects are assembled and added as email attachments.
 
* The email engine will process iCalendar objects using the following syntax:
 
** "@@ievent"
 
** "@@itodo"
 
** "@@icard"
 
 
 
 
 
 
 
==Adding iCalendar Objects to a workflow email==
 
 
 
 
 
#Create an acknowledgement workflow [[Creating a Single Step Workflow|- details here]]
 
#Add an acknowledgement workflow task [[Adding a Workflow Task in an Acknowledgment Workflow|- details here]]<br />
 
#Within the body of the Message Template include: an ievent, itodo, or icard object<br />[[Image:Workflow-message-template-icalendar-object.png]]
 
#To add multiple iCalendar objects, add each object to a separate task within the workflow<br />
 
 
 
 
 
 
 
==Sample iCalendar Objects==
 
===ievent Object===
 
<!--@ssattach(icalendar,vevent)--><br />
 
@@ievent<br />UID:@owner.email@<br />ORGANIZER;CN=@company@<br />DTSTART:TO_UTC(@startdate@ @starttime@)<br />DTEND:TO_UTC(@enddate@ @endtime@)<br />LOCATION:Lee parry<br />SUMMARY: @QA TEST MAX@<br />DESCRIPTION: @description@<br />@@ <br />
 
 
 
 
 
===itodo Object===
 
<!--@ssattach(icalendar,vtodo)--><br />@@itodo<br />UID:@owner.email@<br />ORGANIZER;CN=@company@<br />DUE:TO_UTC(@startdate@)<br />STATUS:NEEDS-ACTIONLOCATION:Lee parry<br />SUMMARY: @QA TEST MAX@<br />DESCRIPTION: @description@<br />@@<br />
 
 
 
 
 
===icard Object===
 
<!--@ssattach(icalendar,vcard)--><br />@@icard<br />FN:@owner.fullname@<br />ORG:@company@<br />TITLE:@name@<br />TEL;TYPE=WORK,VOICE:@owner.phone@<br />TEL;TYPE=HOME,VOICE:(404) 555-1212<br />ADR;TYPE=WORK:;;100 Waters Edge;Baytown;LA;30314;United States of America<br />LABEL;TYPE=WORK:100 Waters Edge\nBaytown\, LA 30314\nUnited States of America<br />ADR;TYPE=HOME:;;42 Plantation St.;Baytown;LA;30314;United States of America<br />LABEL;TYPE=HOME:42 Plantation St.\nBaytown\, LA 30314\nUnited States of America<br />EMAIL;TYPE=PREF,INTERNET:forrestgump@example.com<br />@@<!--@end-->
 
 
 
 
 
 
 
==Process==
 
 
 
1. Message is generated through the workflow process<br />
 
[[image:Workflow-message-template-icalendar-object.png]]<br />
 
<br />
 
2. System generated email with iCalendar attachments arrives at recipients email inbox<br />
 
[[image:Event01.png]]<br />
 
<br />
 
3. When iCalendar attachment is clicked the user is given the option to add the event details to their calendar<br />
 
[[image:E02.jpg]]<br />
 
 
 
==Details==
 
* Dates and times are represented in [[https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC]] time format - YYYY-MM-DD hh:mm:ss:ss - ex.2015-10-23 10:00:00:00
 
 
 
 
 
 
 
{| class="wikitable"
 
|-
 
|[[Image:Why.jpeg|50px|link=ICalendar
 
Support - Why?]]
 
|Click [[ICalendar Support - Why?|here]] to learn why this feature is a benefit to your organization.
 
|}
 
<!--iCal ICal ical-->
 
[[Category:How]] [[Category:Workflows]]
 

Revision as of 13:11, 20 July 2017