How to upgrade the Telligent Enterprise user experience

Upgrading from Telligent Enterprise 3.x: Post-Upgrade

To determine how the user experience should be upgraded, consider the following matrix to determine the upgrade option to review.

• All theme-defined style changes will be overridden
• All widget implementation customizations to factory default widgets (if they exist) are removed (custom widgets are persisted)

1. Import the Site Theme:
   The updated site theme for Telligent Evolution 7.0 is located at FullTheme\SiteTheme.xml in the installation ZIP file. To import it,
   1. Go to Control Panel > Administration > Site Administration > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\SiteTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged," select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
2. Import the Group Theme:
   The updated group theme for Telligent Evolution 7.0 is located at FullTheme\GroupTheme.xml in the installation ZIP file. To import it,
   1. Go to Control Panel > Administration > Site Administartion > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\GroupTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged", select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
3. Import the Blog Theme:
   The updated blog theme for Telligent Evolution 7.0 is located at FullTheme\BlogTheme.xml in the installation ZIP file. To import it,
   1. Go to Control Panel > Administration > Site Administration > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\BlogTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged," select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
4. Revert Factory Default Widgets:
   Next, factory default widgets will be reverted to ensure that all new functionality is exposed.
   1. Go to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets.
   2. Select to filter widgets to "Viewing [default (user edited)] widgets with [Any] theme version and []."
   3. Select all widgets (if any are displayed).
   4. Click the "Delete/Revert Selection" in the "X widgets selected" sidebar.
       
   5. Leave the default option for each widget, "Revert to factory default." 
      If widgets were previously translated to a new language, you can choose to "Merge with factory default."  This will cause two additional options to appear.  The second option, "Use factory default resources," can be changed to "Merge factory default resources" to enable the review and merging of existing modified resources in the widget.
   6. In the "Revert Widgets" modal, click "Revert."
5. Ensure the Enterprise Theme is Used:
   If the site was previously using a theme other than Enterprise (that is, a custom theme or Evolution2), the active site, group, and blog theme should be updated to use Enterprise. If the site was previously using the Enterprise theme, skip to step 6.
   1. Go to Control Panel > Administration > Site Administration > Site Content > Site Theme.
   2. Open the "Select Site Theme" drop-down and select the "Enterprise" theme.
   3. Click the "Save" button.
   4. Go to Control Panel > Administration > Group Administration > Configuration > Default Group Theme.
   5. Open the "Default Theme" drop-down and select the "Enterprise" theme.
   6. Click the "Save" button.
   7. Go to Control Panel > Administration > Blog Administration > Configuration > Default Presentation.
   8. Open the "Default Theme" drop-down and select the "Enterprise" theme.
   9. Click the "Save" button.
   10. To force groups and blogs to use the Enterprise theme, custom themes should be removed from the site. Go to Control Panel > Administration > Site Administration > Site Content > Manage Themes and for each theme type, select the custom theme, export the theme as a backup, and delete the theme. This will prevent groups and blogs from being able to use the custom theme and they will automatically fallback to using the configured default theme, Enterprise.
6. Revert Theme Files
   Next, files associated to the updated version of the site theme will be reverted to ensure that the latest styling updates are applied to the site.
   
   1. Go to Control Panel > Administration > Site Administration > Site Content > Site Theme.
   2. Click "Revert." The "Revert Theme Options" modal should open.
   3. Ensure that all checkboxes are checked.
   4. Update the first reversion option to read "Revert [core] page layouts in this theme to [factory defaults] for the following page types."
   5. Update the second reversion option to read "Revert [headers and footers] in this theme to [factory defaults] for the following theme types."
       
   6. Click "Revert" on the "Revert Theme Options" modal.
7. The theme is now reverted.  All new features and functionality should now be exposed.

• After the user experience is upgraded, customized widgets should be manually reviewed
• All theme-defined style changes will be overridden (additions are persisted)
• Not all new features and functionality may be exposed

1. Import the Site Theme
   The updated site theme for Telligent Evolution 7.0 is located at FullTheme\SiteTheme.xml in the installation ZIP file. To import it:
   1. Go to Control Panel > Administration > Site Administration > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\SiteTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged," select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
2. Import the Group Theme:
   The updated group theme for Telligent Evolution 7.0 is located at FullTheme\GroupTheme.xml in the installation ZIP file. To import it,
   1. Go to Control Panel > Administration > Site Administartion > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\GroupTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged", select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
3. Import the Blog Theme:
   The updated blog theme for Telligent Evolution 7.0 is located at FullTheme\BlogTheme.xml in the installation ZIP file. To import it,
   1. Go to Control Panel > Administration > Site Administration > Site Content > Manage Themes.
   2. Click the "Import" button.
   3. Select the FullTheme\BlogTheme.xml file from the installation ZIP file.
   4. When import options appear, leave the defaults but under "The following widgets can be imported or merged", select "Ignore (don't import)" for "All" widgets.
       
   5. Click the "Import" button on the "Import Theme" modal.
4. Revert Factory Default Widgets:
   Next, factory default widgets will be reverted to ensure that all new functionality is exposed.
   1. Go to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets.
   2. Select to filter widgets to "Viewing [default (user edited)] widgets with [Any] theme version and []."
   3. Select all widgets (if any are displayed).
   4. Click the "Delete/Revert Selection" in the "X widgets selected" sidebar.
       
   5. Leave the default option for each widget, "Revert to factory default." 
      If widgets were previously translated to a new language, you can choose to "Merge with factory default."  This will cause two additional options to appear.  The second option, "Use factory default resources," can be changed to "Merge factory default resources" to enable the review and merging of existing modified resources in the widget.
   6. In the "Revert Widgets" modal, click "Revert."
5. Revert Theme Files:
   Next, files associated to the updated version of the site theme will be reverted to ensure that the latest styling updates are applied to the site.
   
   1. Go to Control Panel > Administration > Site Administration > Site Content > Site Theme.
   2. Click "Revert." The "Revert Theme Options" modal should appear.
   3. If the "Revert configured theme files" option is not shown, there is nothing to revert. Continue to step 6.
   4. Uncheck all reversion options except "Revert configured theme files."
   5. Check the "All" check box under "Files with defaults to be reverted."
       
   6. Click "Revert" on the "Revert Theme Options" modal.

6. Restore Customized Widgets:
   Next, widgets that were customized prior to the upgrade are restored.
   1. Go to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets.
   2. Click the "Import Widgets" button in the right sidebar. The "Import Widgets" modal should appear.
   3. Select the "EditedWidgetsBackup.xml" created as part of the pre-upgrade process.
   4. Click the "Import" button on the "Import Widgets" modal.
7. The theme is now upgraded.
   The theme is upgraded. It may be beneficial to review edited factory default widgets to ensure that the desired functionality is implemented. New features can be added to edited widgets by leveraging the widget API documentation.

• New features are not exposed post-upgrade

First, we'll restore the customized widgets as they were prior to the upgrade,

1. Restore Pre-Upgrade Widgets:
   Widgets are restored to their pre-upgrade state to ensure the user experience starts in an unchanged state.
   1. Go to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets.
   2. Click the "Import Widgets" button in the right sidebar.  The "Import Widgets" modal should appear.
   3. Select the "AllWidgetsBackup.xml" created as part of the pre-upgrade process.
   4. Click the "Import" button on the "Import Widgets" modal.
2. The site should now look as it did prior to the upgrade.

At this point, the site should already be fully functional using the pre-upgrade user experience. Edited widgets can be listed by going to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets and setting the filter to "Viewing [default (user edited)] widgets with [Any] theme version and []."  These widgets should be reviewed for potential feature addition. New features can be added to widgets using one of two techniques:

• Reversion of Individual Widgets:
  Individual widgets can be completely reverted to their factory default implementation using Widget Studio. This option is a good choice when edits to a widget are minor and can easily be reapplied or when the changes are no longer necessary.
  1. Go to Control Panel > Administration > Site Administration > Widget Studio > Manage Widgets.
  2. Find the widget that should be reverted and click it.  
  3. Ensure that the correct theme version is selected (by the label "Theme Version").  If a theme-specific version does not exist for your theme, the "Default For All Themes" version is being used.
  4. From the right sidebar, click "Revert to Default."
  5. When prompted to verify the reversion, click "OK."
  6. The changes made to this widget are now reverted. The widget should be reviewed within the context of your site's theme to ensure proper styling of new functionality. At this point, new changes can be applied to the widget within Widget Studio.
• Manual Inclusion of New Functionality:
  When widgets are heavily customized, new features can be manually included by modifying the widget using Widget Studio. Review the Telligent Evolution 7.0 Developer Documentation for information about APIs that expose new functionality and how those APIs can be used in custom widgets.
  
  For example, to add a like button to an existing customized widget, the widget can be edited via Widget Studio and the following code can be inserted where the like button should be shown (this example assumes that the widget defines a variable $blogPost and it represents a coreBlogPost entity):
  
  

  $core_v2_ui.Like($blogPost.ContentId, $core_v2_blogPost.ContentTypeId)  

  
  See Adding 7.x Features to Existing Widgets and the Telligent Evolution 7.0 Developer Documentation for more information about upgrading widgets manually.