Skip to Content

Changes for page Users Widget

Last modified by Sean Hetherington on 2021/09/09 20:56
From version 6.1
edited by colinw
on 2021/09/09 18:01
Change comment: Import
To version 8.2
edited by Sean Hetherington
on 2021/09/09 20:47
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +ISYMDOCS.Home.iSymphony User's Guide.Widgets.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.colinw
1 +XWiki.seanh
Tags
... ... @@ -1,0 +1,1 @@
1 +account|number|state|user|extension|phone|call
Content
... ... @@ -1,14 +1,25 @@
1 1  {{layout}}
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -The Users widget allows you to view the state of other Users in the system along with Extension State, Call State and Presence. You can also filter and sort the list of Users to your liking.
4 +The Users Widget allows you to view the state of other users in the system along with extension state, call state and presence. You can also filter and sort the list of users to your liking.
5 5  
6 += User Display Modes =
7 +
8 +(% style="color: rgb(0,0,0);" %)The Users Widget provides two different display methods for users, Box View and List View. You can switch between each view type via the view selection buttons ([[image:attach:user-box-view-off.png]] [[image:attach:user-list-view-off.png]]) on the top right hand corner of the Users Widget.
9 +
10 += Box View =
11 +
12 +Box View displays a user box for each user in the system (excluding your own). This box provides a display of the user's accounts, calls and presence state while providing functionality to interact with and manage the user's Accounts, calls and presence.
13 +
6 6  |=(((
7 -
15 +(% class="content-wrapper" %)
16 +(((
17 +\\
8 8  
9 9  [[image:attach:user_widget.png]]
10 10  
11 -
21 +\\
22 +)))
12 12  )))|=(((
13 13  1. User login status
14 14  1. Presence status icon
... ... @@ -16,23 +16,29 @@
16 16  1. Caller ID of call
17 17  1. Presence status text
18 18  1. Call time
19 -1. E-mail icon
30 +1. E-mail
20 20  1. Chat
21 -1. Agent button
22 -1. Do Not Disturb toggle
32 +1. Agent
33 +1. Do Not Disturb
23 23  1. Voicemail
24 24  1. Record
25 25  1. Barge
26 26  )))
38 +
39 +(% class="auto-cursor-target" %)
40 +\\
27 27  {{/layout-cell}}
28 28  
29 29  {{layout-cell}}
44 +(% class="auto-cursor-target" %)
45 +\\
46 +
30 30  {{panel}}
31 31  **//On this page~://**
32 32  
33 33  
34 34  
35 -{{toc maxLevel="2"/}}
52 +{{toc maxLevel="3"/}}
36 36  {{/panel}}
37 37  
38 38  (% style="background-color: rgb(221,221,221);" %)
... ... @@ -42,24 +42,54 @@
42 42  
43 43  {{layout-section ac:type="single"}}
44 44  {{layout-cell}}
45 -= (% style="color: rgb(0,0,0);" %)User Boxes(%%) =
62 += List View =
46 46  
47 -The Users Widget will have a User box for each user in the system (excluding your own). This box provides a display of the User's Accounts, Calls and Presence state while providing functionality to interact with and manage the User's Accounts, Calls and Presence.
64 +List View displays all users in the system (excluding your own) in a table format. Each row provides a display of a user, including their user accounts, calls, and presence, while providing functionality to interact with and manage the user's accounts, calls and presence. When a user is on a call you can use the expand collapse button to view all calls the current user is on. Each call will be displayed as another row under the user row.
48 48  
66 +(% class="wrapped" %)
67 +|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
68 +(((
69 +(% class="content-wrapper" %)
70 +(((
71 +[[image:attach:listview.png]]
72 +)))
73 +)))
74 +|(% class="highlight-grey" colspan="1" %)(% class="highlight-grey" colspan="1" %)
75 +(((
76 +1. **Expand/Collapse row**
77 +1. **User login status**
78 +1. **Call and extension status icon**
79 +1. **Presence status icon**
80 +1. **User name**
81 +1. **Presence status text**
82 +1. **Currently selected user account**
83 +1. **Caller ID of call**
84 +1. **Call time**
85 +1. **E-mail**
86 +1. **Chat**
87 +1. **Agent**
88 +1. **Do Not Disturb**
89 +1. **Voicemail**
90 +1. **Record**
91 +1. **Barge**
92 +)))
93 +
94 +\\
95 +
49 49  === User Login Status ===
50 50  
51 -The bar on the left hand side of the User box will display the current iSymphony login status of the User. By default logged out Users will be grey and logged in Users will be green.
98 +The user login status signifies if the user is currently logged into iSymphony or not. By default, logged out users will be grey and logged in users will be green.
52 52  
53 53  === Call and Extension Status ===
54 54  
55 -The user boxes will change color to show the users current call or extension registration status. For a list of default status colors and what they represent see [[doc:Call Status]].
102 +Call and extension status displays the current registration or call status of the user. Each status will be represented by a different color. In Box View, the entire user box will change colors when state changes. In List View, the call and extension status icon will change colors when state changes. For a list of default status colors and what they represent see [[doc:Call Status]].
56 56  
57 57  ===== User Registration Status =====
58 58  
59 -A general registration status will show on the User Box for all of the user's extensions.
106 +A general registration status will show or all of the user's bound extensions.
60 60  
61 -* The User Box itself will show the registered status color if the user has at least one extension assigned to them that is registered.
62 -* The unregistered status will show on the User Box only if all the user's extensions are unregistered.
108 +* If the user has at least one extension assigned to them that is registered, the call and extension status will show registered.
109 +* If all the user's extensions are unregistered, the call and extension status will show unregistered.
63 63  \\
64 64  
65 65  {{info}}
... ... @@ -68,71 +68,76 @@
68 68  
69 69  ===== Extension Registration Status =====
70 70  
71 -You can view individual extension registration status for each of a user's assigned extensions by selecting the user's name in the User Box in order to open the Account Selection List.
118 +You can view individual extension registration status for each of a user's assigned extensions by selecting the user's name in the Box View, or the currently selected user account cell in the List View. When selected an account selection list will open allowing you to view the state of each of the user's extensions.
72 72  
73 73  = User Actions =
74 74  
75 -There are several buttons that will appear on a User box that will allow other Users in the system to perform actions on that User.
122 +There are several buttons that will appear on each user that will allow you to perform actions on that user.
76 76  
77 -* Email: If the User has a configured email address you can select the email button to initiate a mailto for that address. This will utilize the default email client on your OS.
78 -* Chat: This button allows a User to start a Chat session with this User. See [[doc:Chat]] for more information.
124 +* Email: If the user has a configured email address you can select the email button to initiate a mailto for that address. This will utilize the default email client on your OS.
125 +* Chat: This button allows a user to start a chat session with this User. See [[doc:Chat]] for more information.
79 79  
80 80  = Sorting And Filtering =
81 81  
82 -The Users Widget allows for sorting and filtering of the listed Users. The Sort and Filter bar can be opened and closed via the **Magnifying Glass Icon** on the top right in the Users Widget header.
129 +The Users Widget allows for sorting and filtering of the listed users. The Sort and Filter bar can be opened and closed via the m**agnifying Glass Icon** on the top right in the Users Widget header. You can also sort by clicking on the column headers when using List View.
83 83  
84 84  === Sorting ===
85 85  
86 86  You can sort the user list by several different user properties. The **Arrow** to the left of the sort dropdown can be used to change the sort direction from Descending to Ascending.
87 87  
88 -* None: No sorting.
89 -* Availability Status: Sorts by the current Status set on the User. See Presence for more information.
90 -* Call Status: Sorts by the User's Account call status.
91 -* Caller ID (Name): Sorts by the User's Account call Caller ID name.
92 -* Caller ID (Number): Sorts by the User's Account call Caller ID number.
93 -* Login: Sorts by the User's iSymphony login status.
94 -* Name: Sorts by the User's display name.
95 -* Talk Time: Sorts by the Users Account Call time.
135 +* **None**: No sorting.
136 +* **Availability** **Status**: Sorts by the current status set on the user. See [[doc:Presence Management]] for more information.
137 +* **Call Status**: Sorts by the user's account call status.
138 +* **Caller ID (Name)**: Sorts by the user's account call caller ID name.
139 +* **Caller ID (Number)**: Sorts by the user's account call caller ID number.
140 +* **Login**: Sorts by the user's iSymphony login status.
141 +* **Name**: Sorts by the user's display name.
142 +* **Talk Time**: Sorts by the users account call time.
96 96  
97 97  === Filtering ===
98 98  
99 -You can utilize the **Search** field in the Sort and Filter bar to search for specific Users and Accounts. The text entered in the **Search** field will match on the following.
146 +You can utilize the **Search** field in the Sort and Filter bar to search for specific users and accounts. The text entered in the **Search** field will match on the following.
100 100  
101 101  * User Display name.
102 102  * Account Display name.
103 103  * Account number.
104 104  
105 -You can also select an Extension Group from the dropdown on the right corner of the Sort and Filter bar. This will only show Users and Accounts for Extensions that are in the selected Extension Group. See Extension Groups for more information.
152 +You can also select an Extension Group from the dropdown on the right corner of the Sort and Filter bar. This will only show users and accounts for extensions that are in the selected extension group. See [[doc:Extension Groups]] for more information.
106 106  
107 107  {{info}}
108 -It is possible to filter out specific extensions on a User to the point where the Account List on a User box does not list all Accounts for that User. For example, if a User has Extension 100 and Extension 200 as Accounts and you enter "100" in the **Search** field the User box will show in the User list but he Account list in the User box will only show Extension 100 and not 200.
155 +It is possible to filter out specific extensions on a user to the point where the account List does not list all accounts for that user. For example, if a user has extension 100 and extension 200 as accounts and you enter "100" in the **Search** field, the user will show up in the User list, but he account list will only show extension 100 and not 200.
109 109  {{/info}}
110 110  
111 111  = =
112 112  
113 -{{id name="Accounts"/}}AccountsJust like in the [[doc:My Stream Widget]] the User boxes in the Users Widget will display information about all the specified User's Accounts.
160 +{{id name="Accounts"/}}AccountsJust like in the [[doc:My Stream Widget]] the user display items will display information about all the specified user's accounts.
114 114  
115 115  === Selecting The Active Account ===
116 116  
117 -The selected Account on a User box determines what Account the action buttons of the User box and drag and drop actions will effect. For example, if I select the User's Extension 100 Account and a call is dropped on the User box the call will be transferred to Extension 100. You can select the active Account by clicking on the header, where the User name is displayed, which will open a drop down menu of all available Accounts for you to select from.
164 +The selected account on a user determines what account the action buttons of the user and drag and drop actions will effect. For example, if I select the User's extension 100 account and a call is dropped on the user the call will be transferred to extension 100. You can select the active account by clicking on the header, where the user name is displayed in Box View, or the user account cell in List View, which will open a drop down menu of all available Accounts for you to select from.
118 118  
119 119  {{info}}
120 -Unlike the [[doc:My Stream Widget]] the selected Account will not effect what calls are displayed for that User. All calls for all Accounts on that User will be displayed at all times.
167 +Unlike the [[doc:My Stream Widget]] the selected account will not effect what calls are displayed for that user. All calls for all accounts on that user will be displayed at all times.
121 121  {{/info}}
122 122  
123 123  === The "User" Account ===
124 124  
125 -All Users will have one Account labeled **User** in the Account list. This Account is the default selection for all User boxes and will allow you to perform actions on whatever Account is currently selected as the User's Default Account. See the **Default Account Selection** section on the [[doc:My Stream Widget]] page for more information.
172 +All users will have one account labeled **User** in the account list. This account is the default selection for all user display items and will allow you to perform actions on whatever account is currently selected as the user's Default Account. See the **Default Account Selection** section on the [[doc:My Stream Widget]] page for more information.
126 126  
127 127  === Drag From Accounts ===
128 128  
129 -Users can drag Extension Accounts from the User box to the following destinations in order to originate calls from the dragged Account to the dropped destination. The Account that is currently selected in the User box will determine which Account is dragged to perform the origination.
176 +Users can drag extensions and accounts from the User to the following destinations in order to originate calls from the dragged account to the dropped destination. The account that is currently selected on the user will determine which account is dragged to perform the origination.
130 130  
131 131  {{info}}
132 -The location where you drag from in the User box will determine what object is dragged.
179 +The location where you drag from in the user box will determine what object is dragged.
133 133  
134 -* Drag from the User box header: Will drag the Account for origination. The drag image will be that of the entire User box.
135 -* Drag from non-header areas in the User box: Will drag the call that the User is on for transferring. The drag image will be the caller id of the call only.
181 +* **Drag from the user box header**: Will drag the account for origination. The drag image will be that of the entire user box.
182 +* **Drag from non-header areas in the user box**: Will drag the call that the user is on for transferring. The drag image will be the caller id of the call only.
183 +
184 +When dragging from the List View, the users current state will determine what is dragged.
185 +
186 +* **Drag while the user is not on a call**: Will drag the account for origination.
187 +* **Drag while the user is on a call**: Will drag the call that the user is on for transferring.
136 136  {{/info}}
137 137  
138 138  * Users
... ... @@ -143,9 +143,9 @@
143 143  
144 144  === Drag To Accounts ===
145 145  
146 -Users can drop Accounts from the other User boxes or the [[doc:My Stream Widget]] on Accounts in the User box in order to perform an origination from the Account that was dropped to the Account that was dropped on. The Account that is currently selected in the User box will determine which Account is the destination Account for the origination.
198 +Users can drop accounts from the other users or the [[doc:My Stream Widget]] on accounts in the user in order to perform an origination from the account that was dropped to the account that was dropped on. The account that is currently selected in the on the user will determine which account is the destination account for the origination.
147 147  
148 -Users can drop calls from the following locations on Accounts in the User box in order to transfer that call to the Account that was dropped on. The Account that is currently selected in the User box will determine which Account is the destination Account for the transfer.
200 +Users can drop calls from the following locations on accounts on the user in order to transfer that call to the account that was dropped on. The account that is currently selected on the user box will determine which account is the destination account for the transfer.
149 149  
150 150  * Users
151 151  * Queues
... ... @@ -153,32 +153,32 @@
153 153  * Conference Rooms
154 154  
155 155  {{info}}
156 -During a drag to a User box you can hover over the header in the User box to open the Account list. From here you can drop on a specific Account in the list in order to perform an origination or transfer to that Account without having to select it before hand.
208 +During a drag to a user you can hover over the header in the user box, or the currently selected user account cell in List View , to open the account list. From here you can drop on a specific account in the list in order to perform an origination or transfer to that account without having to select it before hand.
157 157  {{/info}}
158 158  
159 159  === Account Actions ===
160 160  
161 -Several buttons will appear on the User box that will allow you to perform actions on the currently selected Account.
213 +Several buttons will appear on a user that will allow you to perform actions on the currently selected account.
162 162  
163 -* Agent: Allows you to manage this Account's agent login along with pause state and penalty.
164 -* DND: Allows you to toggle this Account's DND status.
165 -* Voicemail: Allows you to originate and transfer calls directly to this Account's voicemail box.
166 -** If clicked a call will be originated to the Account's voicemail box using your selected Default Account.
167 -** If an Account is dropped on the button a call will be originated from the dropped Account to the Account's voicemail box.
168 -** If a call is dropped on the button the call will be transferred directly to the Account's voicemail box.
215 +* **Agent**: Allows you to manage this account's agent login along with pause state and penalty.
216 +* **DND**: Allows you to toggle this account's DND status.
217 +* **Voicemail**: Allows you to originate and transfer calls directly to this account's voicemail box.
218 +** If clicked a call will be originated to the account's voicemail box using your selected Default Account.
219 +** If an Account is dropped on the button a call will be originated from the dropped account to the account's voicemail box.
220 +** If a call is dropped on the button the call will be transferred directly to the account's voicemail box.
169 169  ** Actions using the voicemail button will not ring the extension.
170 170  
171 171  = Calls =
172 172  
173 -The User box will display all active calls for the User's Accounts and allow you to manage those calls.
225 +Users will display all active calls for the user's accounts and allow you to manage those calls.
174 174  
175 175  === Selecting The Active Call ===
176 176  
177 -The User box will only show one call at a time and allow you to manage that call. There may be a case where a user is on multiple calls across one or more Accounts. If the User has more than one active call **up** and **down** arrows will appear to the right of the caller ID section in the User box which will allow you to select the current active call. The currently selected call will specify which call the User box call actions and drags will be performed on.
229 +Box View will only show one call at a time and allow you to manage that call. There may be a case where a user is on multiple calls across one or more accounts. If the User has more than one active call **up** and **down** arrows will appear to the right of the caller ID section in the User box which will allow you to select the current active call. The currently selected call will specify which call the user box call actions and drags will be performed on. In List View the user row will only show one call at a time, and allow you to manage that call. To manage other calls on the user, you can use the expand/collapse button on the user row to show a list of each individual call the user is on, and allow you to manage each call individually.
178 178  
179 179  === Dragging Calls ===
180 180  
181 -Users can drag calls from the User boxes to the following locations in order to transfer that call to the destination.
233 +Users can drag calls from users to the following locations in order to transfer that call to the destination.
182 182  
183 183  * Users (can utilize the Default Account, See **The "User" Account** section above and [[y Stream Widget>>doc:My Stream Widget]] for more information)
184 184  * User Extensions
... ... @@ -190,26 +190,30 @@
190 190  
191 191  === Call Actions ===
192 192  
193 -Several buttons will appear on the User box that will allow you to perform actions on the currently selected Call. If there are no calls for the User no call action buttons will be visible on the User box.
245 +Several buttons will appear on the User that will allow you to perform actions on the currently selected call. If there are no calls for the User no call action buttons will be visible on the User.
194 194  
195 -* Record: Toggle on demand recording of this call on and off.
196 -* Barge: Allows users to barge in on this call. See [[doc:My Stream Widget]] for more information on barge types.
247 +* **Record**: Toggle on demand recording of this call on and off.
248 +* **Barge:** Allows users to barge in on this call. See [[doc:My Stream Widget]] for more information on barge types.
197 197  
198 198  = Presence =
199 199  
200 -Users can view and manage other Users presence from a User box. See Presence for more information.
252 +Users can view and manage other users presence in the Users Widget. See [[doc:Presence Management]] for more information.
201 201  
202 202  = Settings =
203 203  
204 204  Settings for the Users Widget can be access by clicking the cog icon in the top right hand corner of the Users Widget.
205 205  
258 +(% class="wrapped" %)
206 206  |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
207 207  (((
208 208  **User Box Width:**
209 209  )))|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
210 210  (((
211 -Allows you to specify the width of the user boxes in pixels.
264 +Allows you to specify the width of the user boxes in pixels. (This option will not be available if List View is selected)
212 212  )))
266 +
267 +(% class="auto-cursor-target" %)
268 +\\
213 213  {{/layout-cell}}
214 214  {{/layout-section}}
215 215  {{/layout}}
listview.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +9.9 KB
Content
user-box-view-off.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +134 bytes
Content
user-list-view-off.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +161 bytes
Content
user_widget.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +41.5 KB
Content