Export or import widget resource files

In Telligent Enterprise 4.x, as part of localizing for this release, you must export the widget resources, translate them, and reimport the translated resources.  

Changing the widget language will only work if the language pack you're choosing has been installed and enabled in the web\languages\languages.xml file for the site.

You can selectively export some widgets' resources (by selecting their check boxes only) and then exporting and changing (such as translating) them, then import them.

Basic widget resource export and import

Export widget resources

1. Navigate to Control Panel Dashboard > System Administration > Site Administration > Widget studio > Manage widgets.

2. Select the check box at the top of the page beside the "Viewing" label.
   
   

3. At the right side of the page, click Export selection resources. The Opening Widget Resources dialog box appears.
   
   

4. Click Save file.

5. Click OK. Telligent Enterprise saves the widget-resources.xml file to your default download location.

Import widget resources

Whether you select "use imported resources" or "merge resources," there is a merge occurring with each widget in the import file. That is, the widget(s) are being customized to use the resources being imported. Here are the differences:

• With "use imported resources:"

  • The only resources available to the widget will be those provided by the import.

• With "merge resources:"

  • If there are any differences between the widget's current resources and those in the import, the user will have the option to choose what to do with those merge conflicts.
    • When the import contains new resources not currently in the widget, the new resources can be:
      • Added (default)
      • Ignored

• When the the existing widget contains resources not also in the import, the existing resources can be:

  • Retained (default)
  • Deleted

• When the import contains resources with different values than the current widget, then the conflicting resources can:

  • Use the existing value
  • Use the new value

To import widget resources:

1. Navigate to Control Panel Dashboard > System Administration > Site Administration > Widget studio > Manage widgets.

2. Select the check box at the top of the page beside the "Viewing" label.
   
   

3. At the right side of the page, click Import resources. The Import widget resources dialog box appears.
   
   

4. Browse to the widget-resources.xml file in your download location.

5. Click Import resources. A list of widgets available for download appears in the dialog.

6. In each case, you have options of either using imported resources or merging resources as outlined above this procedure.

Importing translated widget resources

What a resource is

A resource is text, identified by a programmatic name, that can be translated into multiple languages identified by language keys to enable rendering a single user interface implementation to users of multiple languages.  Resources can be exported, translated, and imported to add support for more languages.

Upgrading translated widgets

When widgets are translated, they are saved as a customized version of the widget.  For core widgets, this means that after upgrading the site, updates and new features will not be exposed immediately.  To enable upgrading a widget’s implementation while preserving the existing translation:

1. Select the desired widgets' check boxes on the Manage Widgets page.

2. Click Import resources.

3. In the Import Widget Resources dialog box, navigate to the widget resource file.

4. Select Merge resources from the drop-down list.
   
   
   
   Click Import. This enables new resources to be added or ignored and existing resources to be kept or removed. 
   
   By default, new resources will be added (or overwrite existing resources) and existing resources, otherwise, are left as is - this is the behavior you would normally employ when importing new language resources.
   
   None of the selections made are applied until the Import button below the merge options is clicked.  At that time, this change is applied in the database and will affect all nodes in the Telligent Enterprise server environment.

   When changes are committed, all widgets with imported resources will be versioned.  The factory default implementation is no longer used.

Update widget defaults post-upgrade

If you want to keep the applicable translated resource information and get the new widget features post-upgrade, you can do this with the Revert option. To get new features post-upgrade:

1. Select the that should be reverted to their updated/factory-default version on the Manage Widgets page by clicking their check boxes.

2. Click Delete/Revert Selection. This will open the Revert Widgets dialog box.

3. In the first drop-down list, select Merge with factory default. In the third drop-down list, select Merge factory default resources. This enables the translations to be kept while reverting the implementation of the widget.
   
   

   Making these selections enables the existing resources to be reviewed with respect to the current factory default implementation.  Resources can be kept or removed and missing/new resources will be identified.

   None of the selections made are applied until the Revert button below the merge options is clicked.  At that time, the change is applied in the database and will affect all nodes in the Telligent Enterprise server environment.

   When changes are committed, all widgets with merged resources will continue to be versioned (not using the factory default implementation), but, instead the factory default implementation will be reverse imported into the versioned implementation of the affected widgets.  The result is the factory default implementation with the customized language resources.