Skip to content

Commit 98c636d

Browse files
committed
feat(webtop): phonebook sync
1 parent 5a4fb1d commit 98c636d

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

webtop.rst

+79
Original file line numberDiff line numberDiff line change
@@ -1197,3 +1197,82 @@ through the `NethService category`_ in the Nethesis online shop.
11971197

11981198
Once the purchase is completed, Nethesis will provide instructions to
11991199
activate the license and configure the PEC Bridge.
1200+
1201+
NethVoice phonebook integration
1202+
===============================
1203+
1204+
Inside the WebTop application there is an automated workflow that allows to:
1205+
1206+
- export WebTop contacts to the NethVoice centralized phonebook
1207+
- import the NethVoice centralized phonebook to the WebTop contacts
1208+
1209+
The workflow is disabled by default, to enable it:
1210+
1211+
- make sure at least one NethVoice instance is installed inside the cluster
1212+
- in the ``Settings`` page, select the NethVoice instance from the ``Syncronize Phonebook with NethVoice instance``
1213+
field inside the ``Advanced`` section
1214+
- save the settings
1215+
1216+
The synchronization occurs every night, ensuring that the NethVoice centralized phonebook is regularly updated in WebTop.
1217+
This automated process helps maintain consistency and accuracy between the two systems, allowing users to access the most current contact
1218+
information without manual intervention.
1219+
1220+
From Webtop to NethVoice
1221+
------------------------
1222+
1223+
To add contacts from any WebTop 5 user address book to the NethVoice centralized phonebook,
1224+
simply share it with the system **admin** user named *Admin (NethServer)*.
1225+
1226+
Users can voluntarily choose to share their contacts for import into the NethVoice phonebook.
1227+
This operation must be performed individually by each user who wishes to share their contacts.
1228+
1229+
The user must follow these steps:
1230+
1231+
- open the ``Contacts`` section
1232+
- under the ``My Categories`` section, choose an address book to share, then
1233+
click on the kebab menu (three dots) and select the ``Sharing and Permissions`` menu item
1234+
- a drawer will open on the right side of the screen, click the :guilabel:`Add` button
1235+
- in the search field, type ``admin`` and select the user from the list
1236+
1237+
.. note::
1238+
1239+
The address book must be shared directly with the **admin** user.
1240+
Sharing it with a group containing the **admin** user is not sufficient.
1241+
1242+
Ensure that only individual address books are shared and not the entire category,
1243+
to prevent synchronization errors.
1244+
1245+
From NethVoice to WebTop
1246+
------------------------
1247+
1248+
When the synchronization is active, the NethVoice centralized phonebook is imported into WebTop 5 every night.
1249+
1250+
Contacts are imported into a newly created address book named *Rubrica Centralizzata*, within the administrator user account, named *Builtin Administrator user*.
1251+
The username corresponds to the one used to provision the user domain associated with the mail server connected to WebTop 5.
1252+
1253+
To allow other groupware users to access the address book, access with the administrator user and share it with the desired users or groups
1254+
as *READ-ONLY*.
1255+
To share it with all users, select the *Users* group.
1256+
1257+
It's possibile to override both the address book name and the user name by setting the following environment variables inside the `phonebook.env` file:
1258+
1259+
- ``PHONEBOOK_WEBTOP_ADMIN``
1260+
- ``PHONEBOOK_WEBTOP_FOLDER``
1261+
1262+
To do so, access the shell and enter the WebTop instance environment, replace *webtop1* with the actual WebTop instance name: ::
1263+
1264+
runagent -m webtop1
1265+
echo "PHONEBOOK_WEBTOP_ADMIN=myuser" >> phonebook.env
1266+
echo "PHONEBOOK_WEBTOP_FOLDER=MyPhonebook" >> phonebook.env
1267+
1268+
On next synchronization, the address book will be created with the specified name and shared with the specified user.
1269+
1270+
Manual synchronization
1271+
----------------------
1272+
1273+
To manually force synchronization and verify correct configuration, run the following
1274+
command from the shell: ::
1275+
1276+
runagent -m webtop1 systemctl --user start phonebook
1277+
1278+
Replace *webtop1* with the actual WebTop instance name.

0 commit comments

Comments
 (0)