Widget Managers

Widget Managers are the provisioning mechanism for Widgets. End users setup and manage their Widget instances through the Widget Manager. The Manager is the console that is embedded within a hosting application to provide a seamless integration experience.

For end users to be able to access your Widget, you will need to create a Widget Manager and assign your Widget to it.

In this article:

Creating Widget Managers

To create a new Widget Manager:

1. Go to the Embed tab
2. Click Add Widget Manager
3. Configure the options and click OK.

Actions

• Delete Widget Manager - Removes the Widget Manager. See Deleting Widget Managers below.
• Generate Widget Manager Link/Authentication Token - Generates a URL to view/test the Widget. See Testing Widget Managers for more information.
• View Secret Partner Key - Displays the Secret Partner Key. This ID is used for Embedding Widgets.

Editing Widget Managers

To edit the properties of an existing Widget Manager, simply enter or select a new value and click Save. The changes are effective immediately.

Notes:
Modifying the Trial Length will only affect new Widget instances created after making the change. Existing Widget instances still in their trial period will not be affected.
You cannot change the User Management after creation. This is to protect currently installed Widget instances.

Deleting Widget Managers

To delete an existing Widget Manager, click the Delete button next to the Widget Manager name. Click OK to confirm.

You cannot delete a Widget Manager that still has Widgets assigned.

Assigning Widgets

For your Widget to be accessible via the Widget Manager, you must assign that Widget to the Manager. The Widget assignment represents a specific deployment version of the Widget Process that is released to end users.

You may assign any number of Widgets to a Widget Manager, however in practice, most "production" Widget Managers will typically have a single Widget assigned. When there are multiple Widgets assigned, the end user will see a list of Widgets to choose from when setting up a new integration.

To assign a Widget to a Manager:

1. Click Assign Widget.
2. Choose the Process, Widget, Environment (if enabled), and Deployment Version.
3. Click OK.

The Deployment Version selected in the Widget assignment is the version of the Process configuration released to all installed Widgets.

Over time, you will undoubtedly make changes to the Widget Process configuration for enhancements and bug fixes. You will deploy the Process to create a new Deployment Version as normal. Then, to push that version out to the Widget install base, edit the Widget assignment and select the new Deployment Version.

To modify the Widget assignment:

1. Click the Edit icon for the Widget assignment.
2. Choose the new Deployment Version.
3. Click OK.

Upon clicking OK, the new version will be pushed immediately to the entire Widget install base. If you need to rollback or undo a deployment, simply edit the assignment and select a previous Deployment Version.

To delete a Widget assignment from a Widget Manager, click the Delete icon next to the Widget assignment.

You cannot delete a Widget assignment that has active installations of that Widget. You will need to uninstall/delete all instances before you can remove the Widget assignment. It some cases it may be easier to simply rename the existing Manager (e.g. "DO NOT USE") and create a new Manager.

Widget Assignment Field Reference

Widget Install Mode

The Widget Install Mode setting controls how many instances of a Widget may be created by an end user within a given Widget Manager.

• Single Install Only - Allow the end user to install only one Widget instance across all assigned Widgets. For example, if there are two Widgets assigned to a Widget Manager, the end user may only pick and install one instance. This does not mean "one per assigned Widget".
• Unrestricted - Allow the end user to install any number of Widget instances for any of the assigned Widgets.

In most cases, "production" Widget Managers should be configured as "Single Install Only" to prevent end users from creating multiple concurrent instances, which may have technical and licensing implications depending on the nature of your integration and sales process. You may wish to configure "test" Widget Managers as "Unrestricted" to facilitate development efforts.

See also:

• Understanding Widget User Management
• Embedding Widgets
• Testing Widget Managers
• Widget Manager Styling