Contents


Exporting a Live Text Widget from IBM Notes

Comments

If you want to use your IBM Notes Live Text widgets in IBM Verse, you can migrate them with the Notes Live Text Widget Export Plug-in. To use the plug-in, first install it, which adds it to your My Widgets panel. Then use the plug-in to export each Live Text widget from Notes to a JSON file that can be imported into Verse as an extension.

Note: You can post feedback and report bugs on the Verse Developer site in GitHub.

Installing the Live Text Widget Export Plug-in

Configure plug-in settings and install the plug-in in your Notes client.

  1. Download the plug-in to your computer (posted here) and extract it to a local folder.
  2. Start Notes.
  3. In Notes, click View > Right Sidebar Panels > My Widgets.
  4. In the My Widgets panel, click the menu icon to display the options.
  5. In the menu, click Configure a Widget from > Features and Plugins on an Update Site.
  6. In the "Configure Features and Plugins from an Update Site" box, complete the following steps:
    1. In the Enter the URL field, type the path where the plugin is stored on your computer.

      For the path, use the format: file:///{update_site_path}\site\site.xml

      For example, in Windows: file:///C:\temp\site\site.xml
    2. Click Load.
    3. In the Select Features to install list, select the com.ibm.notes.livetext.widget.export.feature.
    4. Click Next. Configure a widget dialog box
      Configure a widget dialog box
    5. In the "Update the settings for the feature" section, click Next.
    6. In the "Preview and edit the install manifest" section, click Next (you don't need to edit the manifest).
    7. In the "Test and Publish" section, click Finish.
  7. In the "Notes Live Text Widget Export Plug-in" box, select Install this plugin and click OK.

    After the plugin is installed, you must restart Notes.

  8. When prompted to restart the Notes client, click Restart Now.

    The plug-in displays in the My Widgets panel.

    My Widgets panel
    My Widgets panel

Use the Live Text Widget Export Plug-in to export a Live Text widget from Notes. You must export one widget at a time and use a different file name for each one.

  1. Start Notes.
  2. In Notes, click View > Right Sidebar Panels > My Widgets.
  3. In the My Widgets panel, right-click a Live Text widget and select Export for Verse.
  4. In the "Export Widget to" box, complete the following steps:
    1. In the address field, browse to the folder where the exported data will be stored.
    2. In the File name field, type a name for the exported file.
    3. Click Save.
    The Live Text widget is exported to JSON format and saved using the file name and location that you provided.

Troubleshooting the Live Text export

Sometimes you might see one or more of the following messages during the export operation.

  • Informational: The widget was exported to c:\widget.json. The regular expression defined by "match" property did not convert during the widget export process. Confirm that the regular expression in the file is supported in JavaScript, otherwise the exported widget might not work as expected in Verse.

    The info symbol indicates that this is not an error, but you might see unexpected behavior. The export was completed; however the regular expression in the Live Text widget is a Java regular expression, which is not converted during the export process and might not work correctly in Verse. You might want to modify and test the regular expression to make sure it is supported in JavaScript before importing the widget to Verse.

  • Warning: Text selection action was not exported because it is not supported in Verse.

    A warning means that the export operation was completed; however the text selection action in your Notes Live Text widget could not be included in the output because it is not supported in Verse.

  • Error: Cannot export a widget created from a Form.

    A Live Text widget in Notes was created from a form, and cannot be migrated to Verse because Verse does not support forms.

  • Error: Cannot export the widget because there is no supported Live Text action.

    A Live Text widget in Notes contains a text selection action, which cannot be migrated to Verse. If the text selection action is the only action in the widget, the widget is not exported; however, if the widget contains additional actions that are supported in Verse, the widget is exported without the text selection action.

  • Error: Cannot export the widget because it does not contain any Live Text actions.

    A Live Text widget in Notes does not contain any actions, so it was not migrated.

  • Error: Internal error. Widget not exported.

    An internal error occurred that prevented the widget from being exported.

Importing the migrated Live Text widgets into Verse

For information on importing the Live Text into Verse, see Managing extensions for Verse or the Top Navigation Bar in the Connections Cloud Developers wiki.

For information on creating new Live Text extensions for Verse, see the Live Text Extension Point for Verse tutorial.

Uninstalling the Live Text Widget Export Plug-in

If necessary, you can remove the plug-in from your Notes client by completing the following steps.

  1. Start Notes.
  2. In Notes, click View > Right Sidebar Panels > My Widgets.
  3. In the My Widgets panel, right-click on the Live Text Export widget and select Remove.
  4. Click Yes when prompted to remove the selected item.

Downloadable resources


Comments

Sign in or register to add and subscribe to comments.

static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Collaboration
ArticleID=1045682
ArticleTitle=Exporting a Live Text Widget from IBM Notes
publish-date=05102017