Installation of officeGATE in a distributed company environment using Group Policy
Introduction
officeGATE supports Group Policy installation, which allows administrators to distribute officeGATE setups automatically to users in a domain. MSI setups are installed automatically when users sign in, while EXE setups are distributed to users, who can then decide whether to install officeGATE.
Group Policy installation can simplify deployment in distributed company environments by allowing officeGATE to be deployed to multiple users at once.
For detailed information, see the Installing officeGATE with Group Policy in a distributed company environment guide.
Group Policy installation
info
Note: System administrator rights are required to install officeGATE using Group Policy.
Multi-language support is not available for GPO installation. The application language is selected in the following order:
- officeGATE checks the language of an already installed officeGATE instance. If a language setting is found, it is used.
- If no language setting is found, officeGATE checks the Windows Registry. If a language setting is found, it is used.
- If no language setting is found in the Registry, officeGATE uses the language configured in MS Outlook for the user.
Configure officeGATE using configuration files
Additional providers can be pre-configured using officeGATE configuration files. The configuration files are located in the %AppData%\officeGATE directory.
The directory contains one global configuration file for officeGATE and separate configuration files for individual providers.
Configuration files
| File name | Description |
|---|---|
Settings.xml | Global configuration file for officeGATE. Most values can also be configured using the global settings dialog. |
OGcontentACCESSSettings.xml | Configuration file for the contentACCESS provider. Can be configured using the provider configuration dialog. |
SharePointCOMSettings.xml | Configuration file for the SharePoint provider. Can be configured using the provider configuration dialog. |
OneDriveSettings.xml | Configuration file for the OneDrive provider. Can be configured using the provider configuration dialog. |
EIMConfig.json | Contains configuration settings for the EIM connection. |
Global configuration file
The Settings.xml file contains the global configuration settings for officeGATE.
| Configuration key | Value | Description |
|---|---|---|
PanelShown | True/false | Specifies whether to show the officeGATE panel when Outlook starts. |
CtrlToUse | True/false | By default, dragging and dropping an item to Outlook copies the link to the document. Holding the CTRL key copies the document itself. Setting this value to true reverses this behavior. |
ShowTooltips | True/false | Specifies whether to show tooltips in tree view. |
ShowInMailCompose | True/false | Specifies whether to show the officeGATE panel in the mail compose window. |
HiddenProviders | List of tags | Identifiers of providers that should not be shown in officeGATE. |
SelectedLanguage | en, de, no, zh-Hans, pt, sk, ar, cs, pl, hu, el | Two-letter code of the user interface language. |
SwitchToGridViewWithMiddleMouseClick | True/false | Specifies whether to enable switching between tree and grid view using the middle mouse button. |
CloseFoldersAutomaticallyInTreeView | True/false | Specifies whether to close previously opened folders when opening a new folder in tree view. |
EnableOfflineAccess | True/false | Specifies whether offline synchronization is enabled. |
OfflineDatabaseSizeLimited | True/false | Specifies whether the size of the offline database should be limited. |
OfflineDatabaseMaxSize | True/false | Specifies the maximum size of the offline database in megabytes. |
OfflineSyncFilterItemByAge | True/false | Specifies whether to filter offline-synchronized items by age. |
OfflineSyncItemMaxAge | and tags | Specifies the maximum age of items that should be synchronized offline. |
OfflineSyncItemMaxAge.Value | Integer | The value for the OfflineSyncItemMaxAge configuration setting. |
OfflineSyncItemMaxAge.Unit | Day, Week, Month, Year | The time unit for the OfflineSyncItemMaxAge configuration setting. |
DisablePanelToggling | True/false | Specifies whether to hide the Show panel button on the Outlook ribbon. |
OfflineSyncThreadCount | Integer | Specifies the number of offline synchronization threads. The recommended value is 2; the maximum is 8. |
OfflineSyncThreadPriority | Lowest, BelowNormal, Normal, AboveNormal, Highest | Specifies the priority of offline synchronization threads. The recommended value is Lowest. |
OfflineAutoSyncEnabled | True/false | Specifies whether automatic offline synchronization is enabled. |
OfflineAutoSyncInterval | According to XML Schema duration | Specifies the interval of automatic synchronization. |
OfflineSyncThrottling | Integer | Specifies the length of artificial idle states during offline synchronization, in milliseconds. Set this value if offline synchronization causes high CPU utilization. |
MinimumFreeSpaceShouldLeft | Integer | Specifies the minimum free space that should remain on the drive containing the offline database, in megabytes. This value helps prevent the offline database from filling the disk. |
PageSize | Integer | Specifies the number of items loaded at a time by the list view. |
ShowItemCount | True/false | Specifies whether to show the total item count below the list view. |
contentACCESS provider configuration
The OGcontentACCESSSettings.xml file contains the configuration settings for the contentACCESS provider.
| Configuration key | Value | Description |
|---|---|---|
ServerName | String | Specifies the contentACCESS server name. |
GenerateURL | True/false | Specifies whether the server URL is automatically generated from the server name. The generated URL assumes that the server uses HTTPS. |
URL | String | Specifies the URL of the contentACCESS server. |
ShowSharingButton | True/false | Specifies whether to show the sharing button on the Outlook ribbon. |
EnableEmailArchive | True/false | Specifies whether to show the email archive buttons (Archive, Restore, and Search) on the Outlook ribbon. |
Token | String | Token of the user currently logged in to contentACCESS. |
CurrentUser | True/false | If true, Windows authentication is used (for contentACCESS 3.1 and earlier). |
Login | String | User name (for contentACCESS 3.1 and earlier). |
Password | String | User password (for contentACCESS 3.1 and earlier). |
AuthenticationConfigId | String | Authentication configuration identifier (for contentACCESS 3.1 and earlier). |
AuthenticationType | String | Authentication type (for contentACCESS 3.1 and earlier). |
SharePoint provider configuration
The SharePointCOMSettings.xml file contains the configuration settings for the SharePoint provider.
| Configuration key | Value | Description |
|---|---|---|
SiteSettings | List of tags | List of configured SharePoint sites. |
SiteSettings.SharepointSiteSettings | SharePoint site configuration values | Set of configuration values for a single site. |
SharepointSiteSettings.Id | Guid | Unique identifier of the site. |
SharepointSiteSettings.BaseURL | String | Specifies the site URL. |
SharepointSiteSettings.UseIntegratedAuthentication | True/false | Specifies whether to use integrated authentication for the site. |
SharepointSiteSettings.LogonWithGlobalUser | True/false | Specifies whether to use global user credentials when accessing the site. |
SharepointSiteSettings.LogonWithSpecificUser | True/false | Specifies whether to use specific user credentials when accessing the site. |
SharepointSiteSettings.Login | String | User name when LogonWithSpecificUser = true. |
SharepointSiteSettings.Password | String | Password, in encrypted form, when LogonWithSpecificUser = true. |
SharepointSiteSettings.IsEnabled | True/false | Specifies whether to show the site under the SharePoint provider. |
SharepointSiteSettings.WebId | Guid | SharePoint web identifier, filled automatically on first access to the site. |
SharepointSiteSettings.WebTitle | String | SharePoint web title, filled automatically on first access to the site. |
SharepointSiteSettings.WebUrl | String | SharePoint web URL, filled automatically on first access to the site. |
GlobalUserCredentials | and tags | Global user credentials that can be used by multiple sites. |
GlobalUserCredentials.Login | String | Name of the global user. |
GlobalUserCredentials.Password | String | Password of the global user. |
SharepointSiteSettings.IsEIMManaged | True/false | Specifies whether the site has been added and is managed by EIM. |
OneDrive provider configuration
The OneDriveSettings.xml file contains the configuration settings for OneDrive.
| Configuration key | Value | Description |
|---|---|---|
Accounts | List of tags | List of configured OneDrive accounts. |
Accounts.Account | OneDrive account configuration values | OneDrive account specification. |
Account.Type | Consumer/Business | Specifies the account type. |
Account.UserId | Guid | Identifier of the user associated with the account. |
Account.RefreshToken | String | Logon token. |
Account.Enabled | True/false | Specifies whether the account is enabled. |