Migrating Vinteo Desktop settings via group policies

General description

Starting with version 3.15 each time the desktop client is launched the settings are loaded from the ClientSettings file for subsequent migration to the desktop client. The ClientSettings file needs to be added to a specific folder:

• for Windows - %appData%/VinteoDesktop
• for MacOS - /Users/y/Library/Application Support/VinteoDesktop
• for Linux - /home/.config/VinteoDesktop

The settings transferred in the ClientSettings file are stored in json format and are validated by the json schema at the stage of reading the file. С полным списком настроек, доступных для миграции, можно ознакомиться по ссылке. A full list of settings available for migration can be found at the link.

The ClientSettings file has two groups of settings:

• profile - corporate profile settings
• settings - application settings

Migrated settings parameters

Each setting in a group is a simple object with two properties:

Свойство	Описание
value	It contains the setting value that will be migrated to the application. Can be of type "string", "number" or "boolean" depending on the specific setting.
overwriteUserSettings	Optional forced migration flag. When setting the true value from the file will forcefully overwrite the user's setting in the client. If false or the flag is missing the setting will be overwritten only if the user has not changed its value since the client was first launched.

Client settings (settings)

The settings group contains the following settings:

Setting	Value type	Description
displayName	string	User display name
remoteMicControl	boolean	Allow moderator to turn microphone on and off
remoteCameraControl	boolean	Allow moderator to turn camera on and off
moveContentVideoToFullscreen	boolean	Run incoming presentation in full screen mode
autoOpenChat	boolean	Automatically open chat when starting a call or broadcast
autoOpenParticipants	boolean	Automatically open the participant list when starting a call or broadcast
autoAnswer	boolean	Auto answer for incoming call
autoMute	boolean	Mute microphone when auto answer
autoFullscreen	boolean	Full screen mode on auto reply
hardwareNotification	boolean	Hardware alert
autorun	boolean	Auto start
minimizeOnClose	boolean	Minimizing the application on close
disableConfirms	boolean	Disable all confirmation dialogs
disableNotifications	boolean	Turn off all notifications
disableErrors	boolean	Turn off all error notifications

Important: when attempting to enable autoOpenChat and autoOpenParticipants the autoOpenParticipants flag takes precedence. That is autoOpenParticipants will be enabled and autoOpenChat will remain disabled. The order and simultaneity of the flags transmission does not matter.

Corporate profile

The corporate profile is the profile that is created and updated by the migration scripts. The difference between a corporate profile and others is its unique uuid which is equal to "uuid-corporate-profile-0fa76dd5-9c48-48de-be1b-75b8df1b2208". This profile is created if it is not yet in the list of connection profiles it is updated during migration.

Corporate profile settings (profile)

The profile settings group contains the following settings available for corporate profile migration:

Setting	Value type	Description
name	string	User login. Optional parameter
serverUrl	string	Connection server address. May contain URL or IP of the server.
profileName	string	Corporate Profile Name will be specified as the name for the corporate connection profile. Optional parameter

Important!

• the user password cannot be passed through the profile settings group;
• each time a corporate profile is rewritten the password for the previous profile is deleted from the client;

If the profile settings group does not contain enough data for connection then when the client is launched the InitialSetupWizard dialog box will open in which you must fill in the missing data. This step can be skipped.

Examples of missing data in the profile settings group

• serverUrl (connection server address) is not filled in;
• displayName is not filled;
• displayName, serverUrl and name are filled in (password is missing).

Examples

Below is an example of a ClientSettings file:

{
	"version": 1,
	"values": {
		"settings": {
			"displayName": {
				"value": "New signature",
				"overwriteUserSettings": true
			}
		}
	}
}

Email invitation templates (emailInvitationTemplate)

This option allows you to setting the conference invitation template via email.

Template parameters

Name	Value type	Description
value	TEmailInvitationTemplate	Email invitation template
overwriteUserSettings	boolean	Template usage flag. If true uses the given template for email invitations. Otherwise it uses the standard application template. Default is false.

Email invitation template (TEmailInvitationTemplate)

Name	Value type	Description
subject	string	Invitation title
body	TBodyEmailInvitationTemplate	Message body

Message body (TBodyEmailInvitationTemplate)

Name	Value type	Description
value	string	Message text template
optional	TOptionalBodyEmailInvitationTemplate	Optional parameters

Optional parameters (TOptionalBodyEmailInvitationTemplate)

Name	Value type	Description
pinText	{ textWhenFilled: string; textWhenEmpty: string }	Template for displaying conference pin code. The text of the textWhenFilled parameter is used when the conference has a pin code. Otherwise the text from the textWhenEmpty parameter is used.

Fillable template fields

Setting	Value type	Description
{userName}	string	The name of the user who sent the invitation
{conferenceUrl}	string	https link to connect to the conference
{dialedNumber}	string	conference number@domain
{pin}	string	pin code
{pinText}	string	Template for displaying conference pin code

Examples

Below is an example file ClientSettings:

{
  "version": 1,
  "values": {
    "emailInvitationTemplate": {
      "value": {
        "subject": "mailto:?subject=Invitation to the conference",
        "body": {
            "value": "&body={userName} invites you to take part in a video conference.%0A- link: {conferenceUrl};%0A- conference number: {dialedNumber}{pinText}",
            "optional": {
                "pinText": {
                    "textWhenFilled": ";%0A- PIN code: {pin}.",
                    "textWhenEmpty": "."
                }
            }
        }
      },
      "overwriteUserSettings": false
    }
  }
}