Office Container registry configuration reference

Note

When configuring Office Container registry settings are added here: HKLM\SOFTWARE\Policies\FSLogix\ODFC

Office Container is a special sub-set of Profile Container used to enable and enhance Office in a non-persistent environment. All Office Container functionality is also delivered when using Profile Container. Office Container is generally used in conjunction with a full non-persistent profile solution.

For a full non-persistent profile solution see Profile Container registry configuration reference.

AccessNetworkAsComputerObject

Type DWORD

Default Value 0

Data values and use 0: default – attach as user. 1: attach as computer - folder must have permissions for computer objects.

AttachVHDSDDL

Type REG_SZ

Default Value N/A

Data values and use SDDL string representing the ACLs to use when attaching the VHD.

Name

CCDLocations

Type REG_SZ

Default Value N/A

Data values and use See FSLogix Cloud Cache Configuration Settings for details about configuring.

ConcurrentUserSessions

Type DWORD

Default Value 0

Data values and use 0: don’t handle concurrent sessions. 1: handle concurrent sessions. Note: This setting is used to when the Windows server feature that allows concurrent logins for the same Windows account on the same server is enabled. This scenario is seen most often with Citrix XenApp, when using this configuration this setting should be set to 1

DiffDiskParentFolderPath

Type REG_SZ

Default Value %TEMP%

Data values and use Specifies the path where difference disks will be created (when ProfileType is configured to use them). Variables may be used in this value. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable.

Enabled

(required setting)

Type DWORD

Default Value 0

Data values and use 0: Office Containers disabled. 1: Profile Containers enabled.

FlipFlopProfileDirectoryName

Type DWIRD

Default Value 0

Data values and use When set to ‘1’ the SID folder is created as “%username%%sid%” instead of the default “%sid%%username%”. This setting has the same effect as setting SIDDirNamePattern = “%username%%sid%” and SIDDirNameMatch = “%username%%sid%”.

IncludeOfficeActivation

Type DWORD

Default Value 1

Data values and use 1: Office activation data is redirected to the container. 0: Office activation data is not redirected to the container.

IncludeOfficeFileCache

Type DWORD

Default Value 1

Data values and use 1: Office Cache Data is redirected to the container. 0: Office Cache Data is not redirected to the container. Note: This setting is specific to Office 2016 and later.

IncludeOneDrive

Type DWORD

Default Value 1

Data values and use 1: OneDrive cache is redirected to the container. 0: OneDrive cache is not redirected to the container.

IncludeOneNote

Type DWORD

Default Value 0

Data values and use 1: OneNote notebook files are redirected to the container. 0: OneNote notebook files are not redirected to the container.

IncludeOneNote_UWP

Type DWORD

Default Value 0

Data values and use 1: OneNote UWP notebook files are redirected to the container. 0: OneNote UWP notebook files are not redirected to the container. |

IncludeOutlook

Type DWORD

Default Value 1

Data values and use 1: Outlook data is redirected to the container. 0: Outlook data is not redirected to the container.

IncludeOutlookPersonalization

Type DWORD

Default Value 1

Data values and use 1: Outlook personalization data is redirected to the container. 0: Outlook personalization data is not redirected to the container.

IncludeSharepoint

Type DWORD

Default Value 1

Data values and use 1: Sharepoint data is redirected to the container. 0: Sharepoint data is not redirected to the container.

IncludeSkype

Type DWORD

Default Value 1

Data values and use 1: Skype for Business Global Address List is redirected to the container. 0: Skype for Business Global Address List is not redirected to the container. |

IncludeTeams

Type DWORD

Default Value 0

Data values and use 1: Teams data is redirected to the container. 0: Teams data is not redirected to the container. NOTE: User will be required to sign in to teams at the beginning of each session.

IncludeOneNote

Type DWORD

Default Value 1

Data values and use

IsDynamic

Type DWORD

Default Value 1

Data values and use If set to ‘1’ the VHD(X) that is created will be dynamic. If set to ‘0’ the created VHD(X) will be fixed size. This setting is used in conjunction with the SizeInMBs setting to manage the size of Profile and Office Containers. Setting IsDynamic to 1 causes the profile container to use the minimum space on disk, regardless of the allocated SizeInMBs. As a users profile contains more data, the amount of data on disk will grow up to the size specified in SizeInMBs. SizeInMBs is the maximum size that a user will be allowed to use on disk, if the user's profile grows beyond what is specified in SizeInMBs the user will experience errors. Setting IsDynmaic to 1 does NOT allow the user profile to grow larger than what is specified in SizeInMBs.

KeepLocalDir

Type

Default Value

Data values and use 1: The “local_%username%” folder will be left on the system, after sign out. It will also be used again if the same user signs on again.

LockedRetryCount

Type DWORD

Default Value 12

Data values and use Specifies the number of retries attempted when a VHD(X) file is locked (open by another process or computer).

LockedRetryInterval

Type DWORD

Default Value 5

Data values and use Specifies the number of seconds to wait between retries (see LockedRetryCount).

MirrorLocalOSTToVHD

Type DWORD

Default Value 0

Data values and use 0: Do nothing with an existing OST file. 1: When a new VHD is created, and there are contents in the local OST folder, they will be copied to the VHD before the user is given access. 2: When a new VHD is created, and there are contents in the local OST folder, they will be moved to the VHD before the user is given access.

NoProfileContainingFolder

Type DWORD

Default Value 0

Data values and use 1: Profile Container won't use or create a SID containing folder for the VHD(X) file. This setting is intended for situations where storage provides a location that is already unique per-user. Default settings for matching VHD names won't work correctly if this setting is enabled, and VHDs for multiple users are stored in the same location.

NumSessionVHDsToKeep

Type DWORD

Default Value 2

Data values and use This setting is used when VHDAccessMode is set to '3'. This controls the number of session VHDs that are persistent. For example, if this is set to '2' and the user creates a 3rd session, a new session VHD will be created and used, but it will be deleted when the 3rd session ends.

OutlookCachedMode

Type DWORD

Default Value 0

Data values and use 1: Only when the Profile Container is attached, the Outlook setting that enables cached mode will temporarily be set until the container is detached. This setting insures cached mode is used only when the container is attached. 0: Prevents FSLogix from doing anything with cached mode. NOTE: Outlook must be configured for online mode for this feature to work. This insures if FSLogix gets disabled, that large OST files won't be downloaded. HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\office\16.0\Outlook\OST\NoOST:DWORD = 2

OutlookFolderPath

Type REG_SZ

Default Value "%userprofile%\AppData\Local\Microsoft\Outlook"

Data values and use The path to the user’s Outlook folder.

PreventLoginWithFailure

Type DWORD

Default Value 0

Data values and use If set to 1 Profile Container will load FRXShell if there's a failure attaching to, or using an existing profile VHD(X). The user will receive the FRXShell prompt - default prompt to call support, and the users only option will be to sign out.

PreventLoginWithTempProfile

Type DWORD

Default Value 0

Data values and use If set to 1 Profile Container will load FRXShell if it's determined a temp profile has been created. The user will receive the FRXShell prompt - default prompt to call support, and the users only option will be to sign out.

ReAttachRetryCount

Type DWORD

Default Value 60

Data values and use Specifies the number of times the system should attempt to reattach the VHD(X) container if it's disconnected unexpectedly.

Re-AttachIntervalSeconds

Type DWORD

Default Value 10

Data values and use Specifies the number of seconds to wait between retries when attempting to reattach the VHD(X) container if it's disconnected unexpectedly.

RebootOnUserLogoff

Type DWORD

Default Value 0

Data values and use A value of ‘0’ means, “Take no action”. A value of ‘1’ means, “Reboot when any user signs out”, a value of ‘2’ means, “Reboot when a FSLogix Profile user signs out”.

Name

RedirectType

Type DWORD

Default Value 2

Data values and use A value of '1' means, Use legacy redirection. A value of '2' (default) means, Use FSLogix advanced redirection.

RefreshUserPolicy

Type DWORD

Default Value 0

Data values and use If a GPO is configured for an Office Product that is included in Office Container, there may be a conflict with a previous user setting. Standard behavior is for the GPO to be applied, but when the Office Container is read, the GPO will be over-written by the setting in Office Container. If the desire is for the GPO change to be universally applied, then this setting should be set to 1 prior to the GPO update being applied. When this setting is set to 1, then Office Container will overwrite the previous user setting with the GPO setting. NOTE: there is a performance implication to setting RefreshUserPolicy to 1. RefreshUserPolicy should not be set, or should be set to 0, unless there is a specific GPO event. After the GPO event, the setting should be referted to default

RemoveOrphanedOSTFilesOnLogoff

Type DWORD

Default Value 1

Data values and use A value of '0' or lack of this setting results in no action. A value of '1' will cause duplicate OST files to be removed. NOTE: Review the following, in full, before setting. In rare cases, duplicate OST files are created for a user. This circumstance has been documented to occur with and without the use of a non-persistent profile. When the profile is stored in the standard file system, administrators may remove orphaned or stale OST files by deleting them. When using Profile Container the OST file in a VHD, isn't as visible. Over long periods of time duplicate OST files may consume incremental disk space. Setting this option to 1 will cause Profile Container and Profile Container for Office to remove all OST files in a VHD(X), except the OST with the latest modify date. Administrators should be familiar with the use of OST files, and potential implications, before choosing to enable this setting.

RoamSearch

Type DWORD

Default Value 0

Data values and use Used to control the Profile Container Search Roaming feature. Set to '1' or '2' to enable the feature. See Roaming the Windows Search Database for details. See Configure Search Roaming for details. NOTE: RoamSearch is set prior to GPOs being applied, it is not possible to rely on GPOs to set RoamSearch in environments where a GoldImage is applied at boot. NOTE: Windows Server 2019 and Windows 10 Entperprise multi-session support per user search. RoamSearch should not be enabled in these environments.

SIDDirNameMatch

Type REG_SZ

Default Value %sid%_%username%

Data values and use Specifies a string pattern used when creating a SID container folder. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, SIDDirNameMatch and SIDDirNamePattern should match. Unless there's a well understood use case that requires these settings to be different, verify SIDDirNameMatch and SIDDirNamePattern are the same when setting either.

SIDDirNamePattern

Type REG_SZ

Default Value %sid%_%username%

Data values and use Specifies a string pattern used when creating a SID container folder. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, SIDDirNameMatch and SIDDirNamePattern should match. Unless there's a well understood use case that requires these settings to be different, verify SIDDirNameMatch and SIDDirNamePattern are the same when setting either.

SIDDirSDDL

Type REG+SZ

Default Value N/A

Data values and use SDDL string representing the ACLs to use when creating the SID container folder. See the What are ACLs and SDDL? appendix for more information.

SizeInMBs

Type DWORD

Default Value 30000

Data values and use Specifies the size of newly created VHD(X) in number of MBs. Default of 3000 = 30 GB

VHDAccessMode

Type DWORD

Default Value 0

Data values and use 0: Normal direct access behavior. This is the simplest access model, but only allows one concurrent session. 1: A difference disk will be used and stored on the network. This allows for simultaneous session access. This mode should not be used if the O365 Container is being used with Outlook Cached Exchange mode. 2: A difference disk will be used and stored on the local machine. This allows for simultaneous session access. This mode should not be used if the O365 Container is being used with Outlook Cached Exchange mode. 3: A unique VHD(X) will be used for each concurrent session. These VHD(X) files will typically persist so that they can be used the next time a user creates a session. To control the number of VHD(X) files that will persist, see the NumSessionVHDsToKeep setting. NOTE:If the O365 Container is being used with Outlook Cached Exchange mode or With OneDrive, VHDAccessMode 0 or 3 must be used. Failure to follow this instruction may result in data loss. |

VHDNameMatch

Type REG_SZ

Default Value Profile*

Data values and use Specifies a string pattern used to match (find) the profile VHD(X) file. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%,%osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE-1: In almost all cases, if VHDNameMatch and VHDNamePattern are changed from the default they should match. Unless there's a well understood use case that requires these settings to be different, verify VHDNameMatch and VHDNamePattern are the same when changing either setting. NOTE-2: Beginning in 2.9.4 VHDNameMatch appends either .vhd or .vhdx to the Name Match string. Before 2.9.4 this search used a . rather than specifying the file type. the VolumeType setting will determine which file type is appended.*

Name

VHDNamePattern

Type REG_SZ

Default Value Profile_%username%

Data values and use Specifies a string pattern used when creating a profile VHD(X) file. Variable names are delimited with '%' characters. Supported variables are %username%, %userdomain%, %sid%,%osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, %clientname%, and any environment variable. NOTE: In almost all cases, if VHDNameMatch and VHDNamePattern are changed from the default they should match. An administrator should have a well understood use case that requires these settings to be different, verify VHDNameMatch and VHDNamePattern are the same when changing either setting.|

VHDLocations

(required setting)

Type MULTI_SZ or REG_SZ

Default Value N/A

Data values and use A list of file system locations to search for the user’s profile VHD(X) file. If one isn't found, one will be created in the first listed location. If the VHD path doesn't exist, it will be created before it checks if a VHD(X) exists in the path. These values can contain variables that will be resolved. Supported variables are %username%, %userdomain%, %sid%, %osmajor%, %osminor%, %osbuild%, %osservicepack%, %profileversion%, and any environment variable. When specified as a REG_SZ value, multiple locations can be separated with a semi-colon.

VHDXSectorSize

Type DWORD

Default Value 0

Data values and use Sector size to use if the file being created is a VHDX. Currently can only be 512 (0x200) or 4096 (0x1000). Setting of 0 (default setting) results in system default being used.

VolumeType

Type REG_SZ

Default Value "vhd"

Data values and use A value of "vhd" means that newly created files should be of type VHD. A value of "vhdx" means that newly created files should be of type VHDX.

VolumeWaitTimesMS

Type DWORD

Default Value 20000

Data values and use Specifies the number of milliseconds the system should wait for the volume to arrive after the VHD(X) has been attached.