You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[DOCS-7482] Outlook replaced with Calendar connector (#1235)
* [DOCS-7482] Outlook replaced with Calendar connector
* [DOCS-7482] Minor fixes in outlook.md
---------
Co-authored-by: Adelaide Nxumalo <27953420+anxumalo@users.noreply.github.com>
Copy file name to clipboardExpand all lines: process-automation/latest/model/connectors/outlook.md
+15-14Lines changed: 15 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,25 @@
1
1
---
2
-
title: Microsoft Outlook connector
2
+
title: Calendar connector
3
3
---
4
4
5
-
The Outlook connector uses the [Microsoft Graph](https://docs.microsoft.com/en-us/graph/use-the-api){:target="_blank"} API to integrate with Microsoft Outlook.
5
+
The Calendar connector uses the [Microsoft Graph](https://docs.microsoft.com/en-us/graph/use-the-api){:target="_blank"} API to integrate with Microsoft Outlook.
6
6
7
-
The Outlook connector is displayed on the process diagram with the Outlook logo.
7
+
The Calendar connector is displayed on the process diagram with the calendar icon.
8
8
9
-
> **Important**: The Outlook connector and user both require a Microsoft Outlook client. The Outlook connector requires a Microsoft Outlook account. The account is separate to the Alfresco hosted environment and should be created and managed by an administrator.
9
+
> **Important**: The Calendar connector and user both require a Microsoft Outlook client. The Calendar connector requires a Microsoft Outlook account. The account is separate to the Alfresco hosted environment and should be created and managed by an administrator.
10
10
11
-
The actions that can be executed using the Outlook connector are:
11
+
The actions that can be executed using the Calendar connector are:
12
12
13
13
*[Create a calendar event](#create-a-calendar-event) creates an event or appointment in the calendar.
14
-
*[Update a calendar event](#update-a-calendar-event)update an event or appointment in the calendar.
14
+
*[Update a calendar event](#update-a-calendar-event)updates an event or appointment in the calendar.
15
15
*[Get schedule availability](#get-schedule-availability) retrieves user availability.
16
16
17
17
## Configuration
18
18
19
-
### Outlook connector configuration parameters
19
+
### Calendar connector configuration parameters
20
20
21
-
The configuration parameters for the Outlook connector are:
21
+
The Calendar connector uses the Microsoft Teams credentials to connect with a Microsoft account.
22
+
The configuration parameters for the Calendar connector are:
22
23
23
24
| Parameter | Description |
24
25
|-----------|-------------|
@@ -27,9 +28,9 @@ The configuration parameters for the Outlook connector are:
27
28
| TEAMS_SCOPE | The scopes requested by the connector in the Teams instance OAuth protocol. |
28
29
| TEAMS_TENANT | The Teams tenant to be used by the connector. |
29
30
30
-
### Outlook connector errors
31
+
### Calendar connector errors
31
32
32
-
The possible [errors]({% link process-automation/latest/model/connectors/index.md %}#errors) that can be handled by the Outlook connector are:
33
+
The possible [errors]({% link process-automation/latest/model/connectors/index.md %}#errors) that can be handled by the Calendar connector are:
33
34
34
35
| Error | Description |
35
36
|-------|-------------|
@@ -39,11 +40,11 @@ The possible [errors]({% link process-automation/latest/model/connectors/index.m
39
40
| SCHEDULE_ERROR | An error occurred from attempting to get the availability. |
40
41
| UNKNOWN_ERROR | An unexpected error occurred during the execution of the action. |
41
42
42
-
In addition to the above configuration the following properties are required to perform Outlook operations:
43
+
In addition to the above configuration the following properties are required to perform calendar operations.
43
44
44
45
## Create a calendar event
45
46
46
-
The `createTeamsEventCalendar` action is used by the Outlook connector to create a calendar event in Microsoft Outlook.
47
+
The `createTeamsEventCalendar` action is used by the Calendar connector to create a calendar event in Microsoft Outlook.
47
48
48
49
The input parameters to create a calendar event in Microsoft Outlook are:
49
50
@@ -108,7 +109,7 @@ The output parameters to get the schedule availability in Microsoft Outlook are:
108
109
| Property | Type | Description |
109
110
| --- | --- | --- |
110
111
| availabilityView | String |*Required.* Merged view of availability for the specific period of time. The merged view is a string that consists of time slots covering that day, with each time slot using the following convention: `n0` - free, `n1` - tentative, `n2` - busy, `n3` - out of office, `n4` - working elsewhere. |
111
-
| availability | String |*Required.* Single value that represents a global availability status for the required period. 0 - a user is free during the whole interval. `1` - all the existing slots in the required period are either free or tentative (at least one of them is tentative). `2` - all the existing slots in the required period are either free or tentative or busy (at least one of them is busy). `3` - all the existing slots in the required period are either free or tentative or busy or out of the office (at least one of them is out of the office). `4` - all the existing slots in the required period are either free or tentative or busy or out of the office or working elsewhere (at least one of them is working elsewhere). |
112
+
| availability | String |*Required.* Single value that represents a global availability status for the required period. `0` - a user is free during the whole interval. `1` - all the existing slots in the required period are either free or tentative (at least one of them is tentative). `2` - all the existing slots in the required period are either free or tentative or busy (at least one of them is busy). `3` - all the existing slots in the required period are either free or tentative or busy or out of the office (at least one of them is out of the office). `4` - all the existing slots in the required period are either free or tentative or busy or out of the office or working elsewhere (at least one of them is working elsewhere). |
112
113
| scheduleItems | JSON |*Required.* List of objects containing each of the events in the user`s calendar. |
113
114
| workingHours | JSON |*Required.* Indicates the days of the week and time intervals when the user can be available. |
114
115
@@ -120,4 +121,4 @@ The input parameters to remove an event or appointment in Microsoft Outlook are:
120
121
121
122
| Property | Type | Description |
122
123
| --- | --- | --- |
123
-
| id | String |*Required.* Identifier of the calendar event.|
124
+
| id | String |*Required.* Identifier of the calendar event.|
0 commit comments