A Widget end user's experience is completely contained with the Widget Manager. The end user will never log into the AtomSphere platform or see the underlying Process configuration. From the Widget Manager the user can create new Widget instances as well as manage and monitor existing Widget instances.
When end users set up a new Widget, they go through the steps defined in the Widget Wizard.
In this article:
General Information
Partner Managed vs. Boomi Managed Widgets
As of the June 8, 2011 release, Boomi Managed Widgets have been deprecated. See Understanding Widget User Management for more information.
For Boomi Managed Widgets, the end user will need to enter a user name and password to access the Widget Manager. If they do not currently have a user name, then must register for one by clicking Register. The login screen has an option to reset lost passwords as well.
For Partner Managed Widgets, the end user is identified by the embedding application and does not have to log in.
End User System Prerequisites
For the Widget Manager to load correctly, the end user's system must meet the following minimum requirements:
- Firefox 10.0 or higher, Internet Explorer 8.0 or higher.
System Requirements for Installing Widgets with Local Atoms
If the Widget is configured to install the Atom locally to connect to on-premise applications, there are several additional requirements:
- Java plugin 1.6 or higher. The Widget will prompt the end user to install/upgrade to the appropriate version if necessary.
- The browser's security settings must allow Java applets to run.
- General 9.1.2 - Atom System Requirements
| For Widgets that install an Atom locally, the end user must go through the wizard on the machine where the Atom is to be installed. |
Setting Up a New Widget
When you view the Widget Manager for the first time, you will see one of two things depending on the configuration of the Widget Manager:
- If there is only one Widget Assignment, you will be taken directly into the first panel of the Widget wizard.
- If there are more than more Widget Assignments, you will need to select one of the Widgets and click Create to launch the Widget wizard.
To navigate through the wizard, click Continue to go to the next panel and Previous to return to the previous panel. You can abort the wizard at any time by clicking Cancel. Continue through the wizard steps, entering information as required until you reach the last step. On the last panel, click Finished to complete the setup and provision the Widget. Upon completion, the wizard will return you to the My Integrations tab and display the newly created Widget instance.
Every new Widget instance is provisioned as a Trial, with a trial length as defined in the Widget Manager. More about Trials.
Special Panels
Map Fields
The Map fields allow the end user to tailor the Widget's field-level mapping for their specific business requirements. In addition to changing the mapping for standard fields, the Widget can retrieve the user's own custom fields from each object/connection defined in the mapping to be included in the mapping.
Custom field browsing is not supported by all application Connectors.
To define a mapping, Click to add new row and use the dropdowns to choose specific source and destination fields to link. Note that depending on the Connector and object type, the field list may contain fields from multiple objects. For example, the Salesforce Opportunity list could include fields from both the Opportunity and Opportunity Product objects.
To edit a mapping, simply select different fields from the dropdowns.
To remove a mapping, click the "X" to the right. You can add any number of rows for a given mapping.
It is important to understand that a given object mapping is for one direction only. If objects are integrated in both directions, there should be two mapping panels (one for each direction) and the fields must be defined in both mappings. This allows the greatest flexibility for the end user.
When modifying mappings after the initial setup, for security purposes you will need to re-enter any passwords needed for the connections used in the mapping. This is because password information is not stored in the AtomSphere platform. The mapping panel will display a login-related warning and display a button to Edit Credentials for you to re-enter the password(s). The Widget Manager will remember your password until you exit "Edit" mode.
Additional Notes:
- Mapping customizations are simple, field-to-field mappings. Data transformations or other logic are not supported.
- Fields "locked" in the Data Map and/or Object Extensions are hidden from end users.
Cross Reference Fields
Cross Reference fields allow the end user to customize the set of values for a given cross reference table. The end user can elect to customize a certain cross reference and modify, append, or replace the set of default values provided by the Widget developer.
To customize a given Cross Reference, expand the section, check the box to "Customize cross reference values?", make edits to the table rows and values as necessary.
Additional Notes:
- The end user can manually edit, remove, copy, or add rows to the existing table.
- The end user can import a set of values from a local CSV file and either append to or replace any existing values in the table.
- The end user cannot rename or change the number of columns.
- To reset the table with the set of Default values provided by the developer, the end user can uncheck the "Customize Cross reference values?" option. Upon confirming the loss of any customizations, the original Default values will be restored. To customize again, the end user can simply check the customize option and modify as needed.
- Columns may be sorted alphabetically by clicking a column header.
- Fifty rows are displayed per page. Use the Next and Previous buttons to page through larger sets of rows.
- For easy reference when collapsed, the section header bar indicates whether the given Cross Reference has been customized or not.
Scheduling Panel
The Scheduling panel configures when and how often the Widget's Process will execute. Configuring a schedule is optional during initial setup.
To add a schedule, click Add Schedule Entry, choose a type, and configure the settings as desired. See Scheduling Processes for complete details.
To modify an existing schedule, select the schedule from the list and make any changes below.
To remove a schedule, select the schedule from the list and click Remove from Schedule.
Sometimes it is preferable to advise end users to NOT set a schedule initially and run the Widget manually to get comfortable with the integration.
Installation Panel
The Installation panel is the last panel in every Widget. Here you can enter an arbitrary Name for the Widget instance and configure preferences for receiving automated email alerts (see About/Preferences, Email Alerts below for more information).
For Widgets that install an Atom locally, you will need to choose a local Install Directory. Widgets deployed to the a Cloud have no additional configuration. Click Finish to complete the setup and provision the Widget.
Locally deployed Atoms may take up to several minutes to download and install, depending on the end user's download speeds.
The local Atoms configured as Desktop Only must be started manually by the end user after installation. Local Atoms configured as NT Service as well as Cloud Atoms will start automatically.
Managing Existing Widgets
When you view the Widget Manager that already has a Widget instance created, you will be taken directly to the "My Integrations" tab. However, depending on the Widget Manager's Install Mode, you may have the option to return to the "Setup New Integration" tab to create another Widget instance.
Select the Widget instance to enable a variety of options:
- Run Now - Manually execute the Widget Process ad hoc.
- Edit - Modify any of the Widget's configuration.
- Delete - Permanently remove the Widget instance. This action cannot be undone.
- View Activity - View recent execution history and logs.
- About/Preferences, Email Alerts - Choose email alert preferences and view technical details.
Local Widgets should be removed by running the uninstall utility for the local Atom. Deleting the Widget instance through the Widget Manager will not uninstall the local Atom.
Editing Widget Configuration
After initial setup, end users can go back and change any of the Widget instance's configuration such as connection information, preferences, schedules, and field mapping. Clicking Edit essentially launches the Widget wizard in "edit mode". Here users can quickly jump to any panel by clicking its name along the left. When finished, click Save and then Close to save the changes, effective immediately. Simply click Close to exit without saving.
Viewing Widget Activity
Users can monitor the execution history of the Widget by clicking View Activity. This displays a list of the recent execution results, similar to AtomSphere's Manage Tab. Here users can filter results based on Status (Success/Error) and Date Range.
To view the detailed logs for a given Process execution, click the Log link under "Details" for that execution. Use the Next and Previous buttons to page through the log entries or the Status filter along to top to narrow the results. To view the full Message text for an entry, double click the Message cell. For SEVERE errors, click the Details link at the end of the Message to see the full error information.
As with the AtomSphere platform, the Atom must be running to view the detailed log information.
Document-level logs are not available through the Widget's View Activity.
About/Preferences, Email Alerts
To help monitor the Widget's activity, end users can choose to subscribe to the auto-generated alerts.
To view/edit email alert preferences, click About/Preferences and then click Edit Subscription. Email alert subscriptions can be set to only receive messages of a certain level (INFO, WARNING--recommended, and ERROR). For example, to only receive notifications when there is a problem with the Widget's execution, select "WARNING". To choose not to receive alerts, choose a level of "None" or simply leave the email address blank. Click OK when finished.
The About/Preferences screen also contains a number of ID values. The Account ID is used to activate Widget trials. The other IDs are used for advanced troubleshooting.
See also
This page
Other pages
Account
