CITRIX DEPLOYMENT GUIDELINES

Transcription

1 March 2017 UpSlide CITRIX DEPLOYMENT GUIDELINES

2 Table of contents 1 Summary Folder and Registry Replication Customization Updates Enable UpSlide only for certain users Registry and Personal Folder Replication Why this is important? How should I do that? Customizations Updates Concept Shared Customization Folder setup Customization Update Installation Deploy UpSlide only for certain users UpSlide Registry Keys UpSlide Users GPO Creation Citrix Servers GPO Creation

3 1 Summary This Section introduces the main actions to deploy UpSlide on Citrix environment. For a step by step guide, please refer to the rest of this guide. 1.1 Folder and Registry Replication UpSlide has user settings stored in the user Profile. For it to work optimally, you need to enable Roaming Profiles. You need to make sure that these registry keys and Folders are synchronized between your Citrix servers: KHEY_CURRENT_USERS\Software\Microsoft\Office\Excel\AddIns\Finance3point1.UpSlide.Excel, %APPDATA%\UpSlide Folder (C:\users\{username}\AppData\Roaming\UpSlide). 1.2 Customization Updates ADMIN WORKSTATION CITRIX END USERS FILE TRANSFER Citrix Customization Shared folder When UpSlide is installed locally, the customization (settings and content shared across the organization) is stored locally. An administrator can then update his local content and use the build in update system to propagate his local modifications to other users. For a server install, another approach is needed as multiple users could be accessing the same files at any given time. The solution is to have UpSlide use a customization stored on a central location and follow these steps: Use the PathToConfigFolder installer switch to make all Citrix servers point to the same folder, Provide a local installation to the Administrators, Copy the files from the administrator workstation to the central location. 3 15

4 1.3 Enable UpSlide only for certain users UpSlide load is controlled by a registry key in the user hive and can be overridden by the same key in the machine hive. You must therefore move all keys installed by default in the machine hive on the user hive. 2 Registry and Personal Folder Replication 2.1 Why this is important? UpSlide is an Add-In for the Microsoft Office suite. As such, it needs to store user-specific settings like license activation status or regional settings. These information s are stored in two places: KHEY_CURRENT_USERS\Software\Microsoft\Office\Excel\AddIns\Finance3point1.UpSlide.Excel, %APPDATA%\UpSlide Folder (C:\users\{username}\AppData\Roaming\UpSlide). If you use a Citrix Server farm to deploy the Office Suite, you must ensure that HKEY_CURRENT_USERS Hive is properly replicated between all your Citrix Servers as well as the AppData\Roaming folder of the user s session. 2.2 How should I do that? The solution that we recommend is to enable Roaming Profiles for Citrix Users. If you don t want to replicate the whole Hive on your Citrix Servers, you will need to install Citrix Profile Management, and set GPO s. You will also need to replicate the %APPDATA%\UpSlide Folder across your servers, this is handled by default with Roaming Profiles. 4 15

5 2.2.1 Enable Citrix Profile Management Open the Group Policy Editor and create a new GPO with the scope of your users. Figure 1: Group Policy Creation Once created, open the new GPO. Figure 2: GPO Opened Go to Computer Configuration -> Policies -> Administrative Templates (ADMX Files) -> Citrix Components - > Profile Management and set the following Policies: 5 15

6 Enable Profile Management: Set to Active, Path to User Store: Set to Active and specify path to Roaming Profile location on your network, Active write back Registry: Set to Active. Once these settings are set, Citrix will replicate the integrality of HKEY_CURRENT_USER Hive across your Server Farm, you can push the configuration further and specify Citrix to replicate only specific keys Setup Citrix to replicate specific keys during logoff Open your Group Policy and go to Computer Configuration -> Policies -> Administrative Templates (ADMX Files) -> Profile Management -> Registry -> Inclusion List and specify these settings: Inclusion List: Add Software\Microsoft\Office\Excel\AddIns\Finance3point1.UpSlide.Excel Figure 3: Inclusion List 3 Customizations Updates 3.1 Concept UpSlide offers the ability to manage and share content and formatting between different teams in your organization. For Example, users have direct Access to: A Slide Library, A Shape Library, Templates in Excel, PowerPoint and Word. 6 15

7 This content is by default shared stored on each computer. A specific admin license allows to edit the content locally and to export the modifications on a shared folder. At which point the following will happen: At next UpSlide startup, the Add-In will check on the specified shared folder if an update is available, If UpSlide detects a new version, the download is launched by using BITS Protocol, Once download is complete, UpSlide will install it at next Office Startup. ADMIN BASE CUSTOMIZATION UPDATE NEW CUSTOMIZATION PUSH Shared Folder PULL USERS NEW CUSTOMIZATION Figure 4: UpSlide Customization Update Scheme Of course, this scheme can t be used in Citrix Environments. 7 15

8 To update the customization with Citrix environment the following process should be used instead: ADMIN BASE CUSTOMIZATION UPDATE NEW CUSTOMIZATION FILE TRANSFER Citrix Customization Shared folder DIRECT ACCESS CITRIX END USERS NEW CUSTOMIZATION Figure 5: UpSlide Customization Updates with Citrix This operation needs to be done when no users are using the Office Pack on Citrix. Follow the steps below to push an Update through Citrix. 3.2 Shared Customization Folder setup In the previous section, we seen that UpSlide customization updates should be handled differently in case of Citrix deployments, two steps are required to handle this properly: create a Shared Folder to store the Customization, configure UpSlide on Citrix Servers to use this Shared Folder. 8 15

9 3.2.1 Shared Folder Creation On a File Server, create a new folder that can be accessed by Users with Read Only permissions. Figure 6: Folder Sharing Settings Under this folder, you will need to Create another folder named Config: UpSlide configuration To have the same Customization Folder Across all your Citrix servers, you will need to add a Command Line Switch during installation: For MSI Packages: EXEOPTIONS= PathToConfigFolder=\\Server\UpSlideFolder Figure 7: UpSlide MSI Silent Install + Configuration Folder For EXE Packages: PathToConfigFolder=\\Server\UpSlideFolder Figure 8: UpSlide EXE Silent Install + Configuration Folder NOTE: The Path to the Shared Folder should not include the Config folder. Once applied, all Citrix servers will use the same customization folder. 3.3 Customization Update Installation 9 15

10 WARNING: This should be done when no users are using Office Suite on Citrix. First, erase the content of the Config folder under the previously created Citrix Shared Folder. On Admin Workstation, go to C:\ProgramData\UpSlide\Config: Figure 9: UpSlide Customization Location Next, copy all the content of this folder and paste it under Config folder on the previously created Shared Folder: Figure 10: File Copy Once the copy is done you can allow users to connect again to Citrix

11 4 Deploy UpSlide only for certain users. 4.1 UpSlide Registry Keys To have UpSlide automatically loaded at Office startup, UpSlide installer deploys registry keys. By default, these keys are located on HKEY_LOCAL_MACHINE Hive. When using Office 64 bits on a computer running Windows 64 bits: HKEY_LOCAL_MACHINE\Software\Microsoft\Office\Excel\Addins\Finance3point1.UpSlide.Excel: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for Excel LoadBehavior (DWord): 3 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.Excel.vsto local HKEY_LOCAL_MACHINE\Software\Microsoft\Office\PowerPoint\Addins\Finance3point1.UpSlide.P owerpoint: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for PowerPoint LoadBehavior (DWord): 3 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.PowerPoint.vsto local HKEY_LOCAL_MACHINE\Software\Microsoft\Office\Word\Addins\Finance3point1.UpSlide.Word: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for Word LoadBehavior (DWord): 3 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.Word.vsto local Note: when using Office 32 bits on a computer running Windows 64 bits (or a 32 bits machines, simply replace Software by Software\WOW6432Node. If you don t want to deploy UpSlide to All Users on your Citrix environment, these keys need to be moved from HKEY_LOCAL_MACHINE Hive to HKEY_CURRENT_USERS. This can be easily done by using a GPO deployed only on UpSlide users

12 4.2 UpSlide Users GPO Creation This Group Policy will create the keys into HKEY_CURRENT_USER Hive (User Configuration) Create a new GPO and link it to UpSlide Users on the Group Policy Console. Figure 11: New GPO Creation On the newly created GPO, go to User Configuration -> Preferences -> Windows Settings -> Registry: Figure 12: User Registry Configuration Next, add new registry elements to HKEY_CURRENT_USER Hive: HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\Addins\Finance3point1.UpSlide.Excel: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for Excel LoadBehavior (DWord): 3 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.Excel.vsto local HKEY_CURRENT_USER\Software\Microsoft\Office\PowerPoint\Addins\Finance3point1.UpSlide.Po werpoint: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for PowerPoint LoadBehavior (DWord): 3 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.PowerPoint.vsto local HKEY_CURRENT_USER\Software\Microsoft\Office\Word\Addins\Finance3point1.UpSlide.Word: Friendly name (String): A set of customized tools designed by UpSlide for Office Description (String): UpSlide for Word LoadBehavior (DWord):

13 Manifest (String): C:\ProgramData\UpSlide\Finance3point1.UpSlide.Word.vsto local 4.3 Citrix Servers GPO Creation Figure 13: HKEY_CURRENT_USER Registry Key Creation This Group Policy will disable UpSlide by default on Citrix Servers, 6 Registry Keys needs to be deleted in the HKEY_LOCAL_MACHINE Hive (Computer Configuration). Create a new GPO and link it to UpSlide Users on the Group Policy Console. Figure 14: New GPO Creation Create another GPO, linked to Citrix Servers and go to Computer Configuration -> Preferences -> Windows Settings -> Registry: Figure 15: Computer Registry Modification 13 15

14 Set the GPO to delete the Key named LoadBehavior on these registry Path: HKEY_LOCAL_MACHINE\Software\Microsoft\Office\Excel\Addins\Finance3point1.UpSlide.Excel HKEY_LOCAL_MACHINE\Software\Microsoft\Office\PowerPoint\Addins\Finance3point1.UpSlide.P owerpoint HKEY_LOCAL_MACHINE\Software\Microsoft\Office\Word\Addins\Finance3point1.UpSlide.Word: HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft\Office\Excel\Addins\Finance3point1.UpSlide.Excel HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft\Office\PowerPoint\Addins\Finance3 point1.upslide.powerpoint HKEY_LOCAL_MACHINE\Software\WOW6432Node\Microsoft\Office\Word\Addins\Finance3point 1.UpSlide.Word Figure 16: Citrix Servers Registry GPO 14 15

15 PARIS 20, Avenue de l Opéra, Paris LONDON Level 39, One Canada Square, Canary Wharf, London, E14 5AB NEW YORK 1460 Broadway, New York, NY 10036