Sandbox Migration Checklist

this page describes the most important steps one will typically take for migrating embedded help from a pre production environment, such as a sandbox, to a production org the precise to do list will vary depending on your pre production setup and production requirements these steps assume deployment into the lightning user experience whilst many steps are the same or similar in salesforce classic , some will vary install unaric guide into destination org ensure the destination org contains the desired version of embedded help for more information, see docid 0fctl9zopm9eievgz0sw4 and docid 4fdylq4xcjoiu 3cokhm6 extract reusable materials from source org if the source org contains help related content to be used in production, gather these materials in preparation for migration local components and files take copies of relevant images, code and other resource files items you may need to migrate include the following local lightning components if you have created any local wrapper lightning components that extend or use those shipped with unaric guide, obtain a copy of the relevant code files so they can be re created in the destination other documents and resources if your help portal branding and / or individual help topics reference salesforce ( https //ihdev dev ed lightning force com/a00d000000o6j0naaa ) assets, such as documents or static resources, from the source org, obtain copies of these for upload into the destination extract source help content records export any help content you wish to replicate in the destination org if topics, reading lists, guides, details of embedded help etc are to be migrated, export the desired content help content of this kind largely consists of salesforce records, so can be migrated using a variety of specialist tools for details of a simple, free content migration utility available from improved apps for simple needs, please see related help list associated with this topic extract local configuration items mark locally customised help configuration items and export all records unaric guide configuration item records are used to define clickables (buttons, menu items etc) on our lightning components and also certain items of metadata if any of these records have been modified to suit local requirements, the relevant items should be exported for porting to the destination org ensure any customised configuration records are marked as such by checking the prevent import overwrites field on the records in question i f you have modified your lightning css, this will be stored as a configuration item, so this should be marked too e nsure that the skip export check box is not checked on these items ticking skip export prevents the record in question from being included in downloads, so only check this box if you specifically do not wish to migrate a particular clickable unaric guide sets the skip export check box for certain ,etadata records where this is the case, please do not amend this setting export your source configuration items as described in the topics related to this one import reusables into destination org import help content plus configuration items as well as any custom wrappers to import help content , use the upload additional help facility on the data migration tab of the help global settings page to import configuration items , use the upload configuration items facility on the data migration tab of the help global settings page create lightning page layouts add the desired help lightning components to user page layouts and create help authoring app pages page layouts for helped users salesforce offers many ways to migrate the metadata that defines lightning page layouts, including any improved help components, between orgs for more information on what's the most convenient for you, refer to salesforce's documentation page layouts for help authoring unaric guide includes a number of page layouts designed to get you started with help authoring please refer to the listing tiles on the welcome tab of the app for more information you are free to define as many of your own authoring layouts as you require for authoring collections of topics for multiple help domains (if desired) create a new lightning page layout from the lightning app builder name the page domain editor or similar select the header and 3 page section template in the header area, add an improved help 'tree selector' component, as follows height 100 available tree ids enter a comma separated list of the help topic ids that are to act as the 'root' of a tree for each desired help domain tree node providers enter x commas, where 'x' is the number of desired selector buttons minus 1 for example, if you entered a comma separated list of 3 topic ids in the 'available tree ids' parameter, enter ",," (2 commas) tree labels enter a comma separated list of the labels to use for each tree selector button each label corresponds to one of topics in the list of available topic ids entered component id selector in the left hand column, add an improved help listing component, as follows height 2 callout option topic selected event only listing type fixed help overall listing style narrow component id list in the centre column, add an improved help tree viewer component, as follows height 2 default tree \[none] enable drag and drop checked component id tree listens to topic selector in the right hand column, add an improved help topic viewer component, as follows height 2 default help topic \[none] component id topic listens to tree, list save and activate the page, adding it (or not) to apps / navigation as desired create app & add list, tree & detail and tree selector for helped languages migrate custom wrapper components create help index wrapper component if locally defined lightning wrapper components for help were extracted as part of the migration, these can be recreated in the destination org at this point to do this, open developer console, create new lightning components and paste in the relevant code, as gathered during extraction set up help domains set up and test help domains to show different help to different groupings of users if help is to serve multiple audiences, for example defined by language or business role, each of which should see differing collections of help, help domains should be created in the destination org see docid 91aze 2cvp3nob6ktamah once help domains have been created, we recommend creating domain specific test user accounts with appropriate sharing group membership and custom permission set assignments one can then log in as these users to verify that (only) the desired help appears setup contextual help for the utility bar use the improved help utility bar component to make contextual help available throughout your salesforce apps unaric guide ships with a ready made utility bar component (utility 1) that combines a tree viewer and linked topic viewer that is ideal for providing a 'help index' or corporate glossary of available help content the content can be made to contextualise (i e , the tree can be made to change the topics it displays) as users navigate in salesforce setup , navigate to the app manager and edit the lightning app to which a utility is to be added in the app settings sidebar, select utility items click add utility item and select improved help utility 1 tick the start automatically check box in the general\ root topic field, add the id of the desired default root for the tree in the contextualisation navigation checking interval field, enter a number representing the time in milliseconds between checks of user location any change in location can be used to recontextualise where recontextualisation is desired, we recommend a minimum value of no less than 1000 for this contextualisation occurs on any change of url subject to two conditions unaric guide must be able to locate a helped page layout record that corresponds to the page being visited add helped page layouts manually for pages that cannot be help enabled via point and click (using our improved help autoform component) the helped page layout must have an associated helped element record with the special identifier of contexttreeroot