Office plugin registry keys

Introduction

This document describes all the registry keys you can use to change the behaviour of the Zivver Office plugin in Outlook.

Each chapter is divided into four sections.

  • How does a setting work
  • When to use this setting?
  • How to enable
  • How to disable

Table of contents

  1. Change account cache location
  2. Automatic File Decryption
  3. Automatic log in via SSO
  4. Extend active session duration
  5. Do not show user tutorials
  6. Turn off WebSockets
  7. Enable unsecure forwarding of Zivver messages
  8. Exempt recipient domains from business rules checks
  9. Block users from sending with Zivver
  10. Plugin assisted mail submission
  11. Enable attachments with plugin assisted mail submission
  12. Use email verification by default
  13. Set maximum attachment size for unencrypted messages
  14. Extensive logging

Account caching stored on different location

How does AccountCacheLocation work

This setting changes the location where the plugin stores cached files. These cached files are stored in the user roaming profile (%AppData%\Zivver\OfficePlugin\email_data) by default.

Requirements

  • The location is within the user’s home folder or is in a folder that the user has (writing) rights to.
  • The folder is automatically emptied after ending the user session.
  • The folder is on a physical device that allows reasonably fast writes and reads, preferably the same physical drive as the installation of Outlook itself.

(1) Flash-based storage, like SSD, NVMe or PCI-E storage devices.

When to use AccountCacheLocation

Turn this setting on during troubleshooting of performance issues.

How to enable AccountCacheLocation

In the table below %Temp% is used as an example location on the drive.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ AccountCacheLocation %Temp%

How to disable AccountCacheLocation

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ AccountCacheLocation %AppData%\Roaming\Zivver\OfficePlugin\email_data

Automatic File Decryption

How does EnableAutomaticFileDecryption work

This setting enables the automatic decryption of files that are received via Zivver.

When to use EnableAutomaticFileDecryption

When your organization has the policy to store unencrypted copies of Zivver messages and their attachments, for example for archiving purposes.

This setting can be disabled to improve performance.

How to enable EnableAutomaticFileDecryption

The setting is enabled by default.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableAutomaticFileDecryption 1

How to disable EnableAutomaticFileDecryption

Use the registry key below to disable automatic file decryption.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableAutomaticFileDecryption 0

Automatic login via SSO

Read all about the “Automatic login via SSO” registry key

Extend active session duration

Available from Office plugin version 5.4.10 and higher.

How does ShortRefreshTokenTTLHours work

This setting extends the duration an user stays logged in to the Office plugin. By default the session duration is 12 hours. This means users have to log in to Zivver every 12 hours, which in practice means every day.

When to use ShortRefreshTokenTTLHours

When your organization uses the Office plugin in controlled working environments such as Citrix or Remote Desktops it makes sense to extend the duration. This will improve the user experience because users are logged in for a longer period of time in Zivver.

Do not use on personal or public devices
Zivver does not recommend to use this setting on personal or public devices.

How to enable ShortRefreshTokenTTLHours

The example below sets the value for the ShortRefreshTokenTTLHours to 720 (in hours), which is roughly equal to a token that expires every month. You can change the value to any value that you like as long as this potential security risks for extended token duration is considered.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD ShortRefreshTokenTTLHours 720 (decimals)

How to disable ShortRefreshTokenTTLHours

This setting is always enabled, however you can revert back to default by using 12 as value.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD ShortRefreshTokenTTLHours 12 (decimals)

Do not show user tutorials

How does DoNotShowTutorials work

This setting determines if users see a tutorial when the user is first logged in to the Zivver Office plugin. The tutorial shows the main points in the Office plugin and can be skipped by the user.

When to use DoNotShowTutorials

When your organization is implementing Zivver and users are being exposed to the Office plugin for the first time. If your organization provides user training for the Office plugin for each user, then this setting may be disabled.

How to enable DoNotShowTutorials

When enabled the user will not see any Zivver tutorials.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD DoNotShowTutorials 1

How to disable DoNotShowTutorials

This setting is disabled by default.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD DoNotShowTutorials 0

Turn off WebSockets

How does ZivverWebSocket work

This setting allows the Office plugin to dynamically update information displayed by the plugin via WebSockets, such as message contents.

When to use ZivverWebSocket

When Zivver recommends to turn this setting on during troubleshooting of performance issues.

How to enable ZivverWebSocket

WebSockets are enabled by default.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ ZivverWebSocket On

How to disable ZivverWebSocket

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ ZivverWebSocket Off

Enable unsecure forwarding of Zivver messages

How does EnableUnsecureForwarding work

This setting allows a user to forward Zivver messages unencrypted (i.e. in an unsecure manner).

When to use EnableUnsecureForwarding

When users are required to forward sensitive information unencrypted for a specific (internal) workflow.

How to enable EnableUnsecureForwarding

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ EnableUnsecureForwarding True

How to disable EnableUnsecureForwarding

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_SZ EnableUnsecureForwarding False

Exempt recipient domains from business rules checks

Read all about the “HighlyConfidentialDomains” registry key

Block users from sending with Zivver

Available from Office plugin version 5.4.10 and higher

How does HighlyConfidentialDomainsBlocksZivverSending work

This setting blocks users from sending a Zivver message when a domain is on the HighlyConfidentialDomains list. It is required to have the HighlyConfidentialDomains list enabled before enabling this setting.

When to use HighlyConfidentialDomainsBlocksZivverSending

The Zivver Office Plugin checks draft messages for business rules violations by default. This check is performed by the Zivver backend servers. However, organizational policies or laws may mandate that some messages should not be sent to the cloud (i.e. Zivver backend servers).

How to enable HighlyConfidentialDomainsBlocksZivverSending

Only enable together with HighlyConfidentialDomains
It is required to have the HighlyConfidentialDomains list enabled before enabling this setting.
Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD HighlyConfidentialDomainsBlocksZivverSending 1

How to disable HighlyConfidentialDomainsBlocksZivverSending

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD HighlyConfidentialDomainsBlocksZivverSending 0

Plugin assisted mail submission

Read all about the “Plugin assisted mail submission” registry key for Exchange Online
Read all about the “Plugin assisted mail submission” registry key for Exchange on-premise

Enable attachments with plugin assisted mail submission

How does EnableZivverAttachmentsWithMailAssistedSubmission work

This setting disables the Zivver paperclip button to add large attachments to Zivver messages when plugin assisted mail submission is enabled.

When to use EnableZivverAttachmentsWithMailAssistedSubmission

You can enable this setting if your organization does not want to send emails with large attachments. The maximum attachment size depends on the maximum message size configured in your mail server.

You can disable this setting if your organization requires all attachments to pass through your mail server, for example for document management software.

How to enable EnableZivverAttachmentsWithMailAssistedSubmission

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableZivverAttachmentsWithMailAssistedSubmission 0

How to disable EnableZivverAttachmentsWithMailAssistedSubmission

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableZivverAttachmentsWithMailAssistedSubmission 1

Use email verification by default

How does UseEmailVerificationAsDefault work

This setting automatically applies “Email verification” instead of prompting the user to set a verification method for added security. This setting decreases the average security of all sent Zivver messages. If a verification method is already available in Zivver for the recipient, then that verification method will be used over Email verification.

When to use UseEmailVerificationAsDefault

When your organization has all available verification methods uploaded in Zivver and you want to use Email Verification for all other Zivver messages.

How to enable UseEmailVerificationAsDefault

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD UseEmailVerificationAsDefault 1

How to disable UseEmailVerificationAsDefault

This setting is disabled by default.

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD UseEmailVerificationAsDefault 0

Set maximum attachment size for unencrypted messages

How does MaxSizeForAttachmentsToAttachToMail work

Email attachments are saved with the email when Zivver messages are stored locally unencrypted. Attachments larger than 5 megabyte(MB) will referenced to by a download link to the Zivver portal. Reasoning for this feature is that attachments of Zivver messages can be much larger than the standard 20MB attachment size of Microsoft Exchange server.

This setting allows you to set the maximum email size that is saved unencrypted so that it matches your Exchange maximum email size.

When to MaxSizeForAttachmentsToAttachToMail

Use this setting when you need to save emails that are larger than 20MB together with the attachments.

How to enable MaxSizeForAttachmentsToAttachToMail

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_DWORD MaxSizeForAttachmentsToAttachToMail 50

The above example allows for emails with attachments up to 50MB in size. The value needs to be a decimal and can be smaller or larger than the example above. The value should not exceed the Exchange attachment size limit.

How to disable MaxSizeForAttachmentsToAttachToMail

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings REG_DWORD MaxSizeForAttachmentsToAttachToMail 20

Extensive logging

Do not enable this setting
Only enable this setting when recommended by Zivver.

How does EnableExtensiveLogging work

This setting enables additional logging for debug purposes only in special debug Office plugin versions.

When to use EnableExtensiveLogging

This setting should be turned on at the recommendation of Zivver support, during troubleshooting.

How to enable EnableExtensiveLogging

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableExtensiveLogging 1

How to disable EnableExtensiveLogging

Key Type Name Value
HKEY_CURRENT_USER\SOFTWARE\Zivver\OfficePlugin\Settings DWORD EnableExtensiveLogging 0

Was this article helpful?

thumb_up thumb_down