User Tools

Site Tools


employee_outlookintegration

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

employee_outlookintegration [2021/08/31 00:00 (8 weeks ago)]
jbalasabas created
employee_outlookintegration [2021/08/31 00:14 (8 weeks ago)] (current)
jbalasabas
Line 1: Line 1:
-====== Outlook Integration ====== +see https://wiki.windwardsoftware.com/doku.php?id=employee:outlookintegration
- +
-Freshdesk: [[https://support.windwardsoftware.com/a/solutions/articles/66000494961]] +
- +
-This feature provides one-way synchronization of events between System Five appointments and the Outlook 365 calendar Events are sent/updated from one side to the other, so it's 2 way in that regard, but if you edit an event that was synced, the changes will not be sent back.\\ +
- +
-====== Rules ====== +
-<note><color magenta>Events / tasks are only synced when the user has open and is logged into the calendar event sync web application.</color></note> +
- +
-Customer & Delivery Tasks created / updated in System5 are sent to Outlook if flagged to sync (There is a new Sync Checkbox in the appointment edit UI); they will be flagged with an Outlook Colour Category of Received From System5. They will only be sent if the Start time is greater than the time of the sync. +
- +
-{{:ss1.png?500|}} +
- +
-Tasks with customers attached will have a Google maps link embedded in the body for the Bill To, or Ship to address (as applicable)\\ +
- +
-==== Tasks synced to Outlook will==== +
-  * not be removed from Outlook if the source is deleted in System5\\ +
-  * Unordered List Itemnot be updated in System5 if changed in Outlook\\ +
-<color green>Unless you were to add the [sync] to the subject in Outlook, but you will likely see odd behaviour with address links (this is not a supported usage, but isn't prevented)</color>\\ +
-  * have previously synced values in Outlook overwritten if the source is updated in S5 (start / end / alarm / title / body / categories)\\ +
- +
-Tasks created / updated in Outlook with the word [sync] in the Subject will be flagged for import to System Five. They will only be sent if the Start time is greater than the time of the sync and the End time is less than or equal to 2 weeks past the current sync time.<color red> Only single instance events are synced from Outlook; Events that are part of a recurrence are not synced.</color>\\ +
- +
-==== Tasks synced to System5 will: ==== +
- +
-  * not be deleted in S5 if the source is deleted in Outlook\\ +
-  * have synced values in S5 overwritten if the source is updated in Outlook (start/end/alarm/title/body)\\ +
-  * be skipped if they are part of a recurrence; only single instance tasks are synced\\ +
-  * be flagged as needing review and when first opening System 5, if the option to show Today’s Tasks is enabled will show up in the list of tasks in light green. Regardless of what date is selected for display, these tasks needing review will show up listed under all dates until they have been opened and saved (if the Start Date has passed they’ll still be green, but won’t show up under all dates).\\ +
- +
-{{:ss2.png?900|}} +
- +
-===== Components ===== +
- +
-==== Calendar Event Sync Web Application ==== +
-  * When the web app is open and the onboarded user logged in, every 10 minutes Outlook 365 and System Five will be checked for new calendar items to sync.\\ +
-  * Reads / writes user and tenant config information in the CALENDAREVENT database.  Also tracks the Id mapping of synchronized events (Outlook event ID to System Five Task Id) to prevent duplicate event creation and to allow for updates. +
-  * Hosted in Azure +
-  * Dev version [[http://calendareventsync-dev.azurewebsites.net/]] +
-  * Repo [[https://windwardteams.visualstudio.com/SystemFiveOnCloud/_git/EventAPI]] +
- +
-==== Calendar Event Service ==== +
-  * Windows Service; installed either on prem, or in Cloud VM.  Requires network access to the Pervasive Server.\\ +
-  * Connects to the web application and handles the read / write of tasks to be synced on its behalf.\\ +
-  * Repo [[https://windwardteams.visualstudio.com/SystemFiveOnCloud/_git/CalendarEventService]] +
- +
-==== CalendarEvent Database ==== +
- +
-  * Database is multi-tenant +
-  * Contains the following tables: +
-{{:ss5.png?600|}} +
- +
-===== Setup ===== +
-==== System5 ==== +
-Setup Registry entry under APPOINTMENT_SCHEDULER => SYNC_ENABLED set to Y (data length 1) for index 0 +
- +
-=== Server === +
-  * Requires a 32 Bit Pervasive DSN (the typical setup) +
-  * Requires the following SQL to be installed via PCC (the UDF First) +
-{{:ss6.png?300|}} +
-  * CalendarEventService – windows service must be installed and running to communicate with the CalendarEventSync Web App in Azure (it connects via SignalR)\\ +
- There is a config file for the service that requires settings: ''CALENDAR_EVENT_SERVER_SETTINGS.JSON'' +
- +
-{{:ss3.png?800|}} +
- +
-  * The ''TENANTCODEPAGE'' will only need to be set if we run into Email body issues for items imported from Outlook to S5 (like weird accented characters in place of things like bullets and dashes), otherwise it can be left blank. +
- +
-==== Onboard Tenant/User ==== +
-  * Any tenant that needs to authenticate to the Web app and use the service needs to have a record added to the ''EVENTCONFIG'' table with values for ''TENANTID'' , ''SERVERNAME'' AND ''DSN'' +
-  * Any tenant user that wants to use the sync function needs to have a record added to the ''EVENTUSER'' table with the S''5USERID'', ''MSALID'', ''ISACTIVE'' fields set.  Easiest way to get the ''MSALID'' is to have the user go to the web app and sign in.  They will be forwarded to the following page with the required value displayed. (the ''MSALID'' is in the format of ''OID''<dot>''TENANTID'' +
-{{:ss4.png?500|}} +
-  * The S5UserId is the unique of their user in System Five.\\ +
- +
- +
- +
- +
- +
- --- //[[[email protected]|Jolib Balasabas]] 2020/09/11 21:00// +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-  +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
employee_outlookintegration.txt · Last modified: 2021/08/31 00:14 (8 weeks ago) by jbalasabas