Widget Wizard

The Widget Wizard in myAvatar is used to create custom widgets that pull specific information from the SQL database. The Widget Wizard is also used to enable specific widget templates within scrolling text fields. This allows for quick entry of standard data when filling out text fields on client-specific forms, including all modeled forms.

• Each myAvatar application (PM, CWS, MSO, CFMS) comes with its own version of this form. Widgets can only use the tables from the application where the widget is created. ​​​​​​Regardless of which application is used, however, the widget is be usable in scrolling free text fields across all of them. For example, widgets created in Widget Wizard (CWS) version can be used in the Admission form (PM).

► Create a widget

1. Go to Avatar PM > RADplus Utilities > Widget Management > Widget Wizard.
2. In the Widget ID field, enter the ID or choose Select Widget to find and edit an existing widget created in this form.
   Note: It is suggested to use alphabetical or numeric characters and separate words with an underscore ( _ ) when naming a new widget.
3. In the Title field, enter the widget's display title. This field is required.
4. Select the category to define the widget template in the Widget Category field. Categories create sub-menu items that allow you to organize your widgets, making them easier to locate.
5. In the Widget Attributes field, select the attributes that apply.
6. In the Time Limit (seconds) field, enter the maximum number of seconds the widget is allowed to run. This prevents widgets running for too long and degrading server performance. This field is required and defaults to 1. Allowable limits are between 0.001 and 10 seconds.
   Note: Netsmart recommends widgets have a time limit of 1.0 second if the widget will be placed on many users' home or chart views. This prevents a scenario where many long-running widgets running at the same time slows system performance.
7. Choose whether or not this widget is used for Templates on Demand. Selecting Yes enables the Record Selection Filters and the following fields are available for configuration:
   • Select whether or not to Suppress Column Headers.
   • Select whether or not to Suppress Additional Line Breaks.
   • Select whether or not to Display Widget Content Vertically in Templates On Demand?
8. Select Yes in Enhanced Widget View? to enable those configuration options.

Table Selection

This section defines which data is displayed in the widget.

1. Choose Select Table to search for and locate the SQL table to be used in this widget.
2. The Current Table field displays the table name once one is selected.
3. In Select Fields to Display, choose the SQL fields from the selected table.
   Note: It is suggested to select the fields in order of how they should be displayed in the widget. This reduces the need to manually change the order in Display Fields in Follow Order.
4. Display Fields in Following Order field allows you to change the display order of selected table columns. Alternate column names can also be created here.
   • In the Display Fields in Following Order field, edit the entry to include an alternate name, in parenthesis, after the column name and before the separating comma, if any.
     Example: Editing this entry: SYSTEM.staff_current_demographics.sex_value, to this: SYSTEM.staff_current_demographics.sex_value (Gender), produces alternate column heading Gender in the widget.
     • Use only this specific format as standard SQL assignments will not validate on submission.
     • Double quotes, extra parentheses, and any character requiring XML translation may cause the temporary name to be truncated or cause the widget to fail population. These will be rejected on submission.
5. In Associate Which Field to Link?, select a field to operate as a link to the widget's associated form.
   Note: This field is only enabled if the table specified in Current Table has a column called option_id. There must be at least one row of data returned in the widget for links to display.

Enhanced Widget View

This section is available for configuration when the previous option Enhanced Widget View? is set to Yes.

1. Load Results without Entity Selected defines whether or not the widget displays data without an entity selected.
2. Primary Entity Selection defines whether or not the widget brings the entity into context when selecting a row in the widget.
3. Clear Entity on Row Deselect defines how an active row within the widget behaves when deselecting it.
4. Limit Results Based on Current User limits the results in the widget to the selected value chosen, based on the user ID of the currently logged in user.
5. Additional Form Links can be added to the widget. When the Column and Form columns are specified with values, that column in the widget appears as a blue underlined hyperlink to launch the form related to that value.

Table Sort

This section defines how the data is sorted within the widget.

1. In the Primary Sort Column field, select the field for the primary sort. This field is populated with columns selected for display.
2. In the Primary Sort Order field, select order of the primary sort.
3. In the Secondary and Tertiary Sort Column and Sort Order fields, if appropriate, select additional sorts and sort orders.
4. In the Rows To Return field, select how to display a defined number of (N-Number of Rows to Return field) in the widget output.
   • Select First-n-Rows to display the initial number of rows.
   • Select Last-n-Rows to display the ending number of rows.
5. In the N-Number of Rows to Return field, enter the number of rows of data to display.
6. Select Submit.

Record Selection Filters

This section is available for configuration when the previous option Templates on Demand is set to Yes. These filters are used within the widget to further define the data displayed.

1. Starting with Record Selection 1, choose the table that is used to filter data in the widget.
2. Select the appropriate Data Type for the selected table.
3. In Record Selection Operator 1, choose how the filter processes the data.
4. Enter a title in the Record Selection Parameter Label 1.
5. Repeat steps 1-4 for up to 5 record selection filters.

► Delete a widget

1. Go to Avatar PM > RADplus Utilities > Widget Management > Widget Wizard.
2. Choose Select Widget to find and select an existing widget created in this form.
3. Select Delete Widget.
4. A delete confirmation dialog displays. Select OK.

► Edit a widget

1. Go to: myAvatar > RADplus Utilities > Widget Management > Widget Wizard
2. Click Select Widget.
   Result: The Select Widgets screen displays and widgets created in this form are available.
3. Select the widget.
4. When you are finished editing, select OK.

► Registry Setting

• Enable Templates On Demand for SQL Widgets

► See Also

• How to Use Templates on Demand