Skip to main content

How to Use Templates on Demand and User Defined Templates

  1. Last updated
  2. Save as PDF

myAvatar supports the ability to use templates within scrolling text fields. This allows you to enter standard data quickly when filling out text fields on client-specific myAvatar PM and myAvatar CWS forms, including all modeled forms.

Template On Demand functionality is not currently in the following myAvatar areas:

  • Treatment Plan
  • myAvatar eMAR
  • CareConnect Inbox
  • Orders Console
Widget Wizard

Prerequisites:

  • The form in which the template is going to be used must have a client and episode pre-display in order to pull in the correct widget data.
  • The Enable Templates On Demand for SQL Widgets registry setting must be enabled.
  1. Go to Avatar PM > RADplus Utilities > Widget Management > Widget Wizard.
  2. Enter the Widget ID. This must be alphanumeric with underscores.
  3. Enter the Title. This is the description seen by the end user.
  4. Enter a category in the Widget Category field. This is used to create sub-menu items on the right-click menu of scrolling text fields in order to organize the widget templates. This is not required, but helps to make templates easier to find when you have many.
  5. Remember to set the Use for Templates On Demand field to Yes. Once enabled, the Record Selection fields become available for use.
  6. Select whether or not to Suppress Column Headers.
  7. Select whether or not to Suppress Additional Line Breaks.
  8. Select whether or not to Display Widget Content Vertically in Templates On Demand?
  9. Define the data to include in the widget by clicking Select Table, and choosing the table from the menu.
  10. Define which fields from the table to include by selecting them from the Select Fields to Display field. You can also edit the order in which these fields appear through the Display Fields in Following Order field.
  11. Define how the data will be sorted through the Sort fields.
  12. Define which Rows To Return, and then the Number of Rows To Return.
  13. Define the Record Selection parameters to prompt you when importing the widget template into a scrolling text field.
  14. Submit when finished.

In the View Definition form, add the widget to the Assigned column of the appropriate views so that the correct users have access to it. Widget templates will be hidden on the right-click menu unless a user has permission for that widget. The widget can be added to any view associated with the user in order for them to have access to it; it does not have to be their Home View and does not need to be on the layout.

The widget is now defined for use as a template, and can be accessed from the right-click menu of any scrolling free text field.

Widget Definition

This functionality works the same way as the Widget Wizard form with the exception that it is only available for multiple row SQL widgets.

  1. Enable the Enable Templates On Demand for SQL Widgets registry setting.
  2. Open the Widget Definition form to set up tables for the widget you want to use as a template.
    ​​​​​​Each myAvatar application (PM, CWS, MSO, CFMS) comes with its own version of this form. You will only be able to use tables from the application where you created the widget.
  3. Enter the Widget ID. This must be alphanumeric with underscores.
  4. Enter the Title. This is the description seen by the end user.
  5. In the Widget Type field, select Multiple Row SQL.
  6. Set the Use for Templates On Demand field to Yes. Once enabled, the other Templates On Demand fields become enabled.
  7. Select whether or not to Display Widget Content Vertically in Templates On Demand?
  8. Select whether or not to Suppress Column Headers.
  9. Select whether or not to Suppress Additional Line Breaks.
  10. Enter all of the SQL statements applicable to this template in the Multiple Row SQL Statement field.
  11. Click Submit.

In the View Definition form, add the widget to the Assigned column of the appropriate views so that the correct users have access to it. Widget templates will be hidden on the right-click menu unless a user has permission for that widget. The widget can be added to any view associated with the user in order for them to have access to it; it does not have to be their Home View and does not need to be on the layout.

The widget is now defined for use as a template, and can be accessed from the right-click menu of any scrolling free text field.

Using Your Widget Template
  1. Open the form you want to add the data to, and navigate to a scrolling free text field.
  2. From the desired place within the field, right-click and select the template from the Widget Templates menu.
    • Any Categories you defined will appear in this menu.
    • Widget categories appear combined from multiple namespaces, if available.
  3. Select the desired template to add the data pulled from the defined tables. You can import multiple widgets into the same text field.
    When you select a widget with Record Selection filters (Widget Wizard), a popup menu appears. Once entered, the widget contents will be inserted into the field.
Predefined Widget Templates

There are five predefined widget templates that come standard with the myAvatar system and can be useful. These are:

As with user-defined widget templates, the Enable Templates on Demand for SQL Widgets registry setting must be enabled, and access to the widgets granted through the View Definition form in order to use these predefined widgets as scrolling free text templates.

Each of these widgets will be located in the Client category in View Definition. Be sure to move them from Available over to Assigned.

Show Me How!

User Defined Templates

User Defined templates allow you to create a template to use in a scrolling text field without leaving the current form. This functionality requires that the Enable Templates on Demand for SQL Widgets registry setting is enabled.

Whereas Widget Templates are available to all users who have access to that specific widget through View Definition, User Defined Templates are associated only with the specific user who created them.

  1. From a scrolling text field, right-click and select User Defined Templates > Manage. This launches the User Defined Templates screen.
    When the Enable Templates On Demand for SQL Widgets registry setting is set to Yes, this screen can also be accessed via the Help menu through Manage User Defined Templates.
  2. Enter a title for the new template in the Template Name field.
  3. Select the contents of the template by dragging patient-specific data elements from the Available Fields list on the right, into the Template area, or by typing directly into the field.
  4. Click Preview to view the content of the template as it will appear in the scrolling text field.
  5. When satisfied, click Add to save the template to the Organize Templates section below.
  6. To categorize the templates into groups, enter a title for a folder in the Group Name field and click Add.
  7. Manage templates by dragging them into the desire groups.
  8. To delete a template, select it from the Organize Templates section and click the red X.
  9. Click Save.
  10. Now, from the desired place within the same scrolling text field, right-click and select the template from the User Defined Templates menu. You can import multiple templates into the same text field.
Other Types of Scrolling Free Text Templates

In addition to the methods discussed so far, there is an alternative way to create templates that involves tying a template into a specific scrolling free text field.

There are three different ways to accomplish this:

Product Scrolling Free Text Templates

These are SFT templates that are tied to specific SFT fields on product forms.

  1. Navigate to the Product Scrolling Free Text Templates form to begin, and select the form for which you want to create a template.
  2. Then, select the specific SFT field to which you want to associate the template.
  3. As was the case with the other types of templates that have been discussed, you can pull in patient-specific information, this time from the Keywords field on the Template Definition section. You can also type in free text.
  4. There is also the option to associate these templates with particular Users or User Roles (there’s a section for each).
    Unless it is specified that the template is to be tied to specific Users/User Roles, it will be available to all users who have access to the form and the template-enabled SFT field.
  5. In order to use the template, simply right-click in the SFT field that the template has been linked to, select System Templates, and choose the desired template.
Scrolling Free Text Templates

These are SFT templates that are tied to specific SFT fields on user-defined/modeled forms. They are available to any user who has access to that user-defined form/table.

  1. Navigate to the Scrolling Free Text Templates form, and select a user-defined table.
  2. Choose the specific SFT field that you want to enable with a template.
  3. You can pull in patient-specific information from the Keywords field on the Template Definition section.
  4. In order to use the template, right-click in the SFT field that the template has been linked to, select System Templates, and choose the desired template.
User Scrolling Free Text Templates

These are SFT Templates that are tied to specific SFT fields on user-defined/modeled forms. They are also tied to a particular myAvatar user.

The difference between User Scrolling Free Text Templates and the User Defined Templates discussed earlier is that User Scrolling Free Text Templates are linked to a specific SFT field, whereas User Defined Templates are available to use on any SFT fields to which the user has access.

  1. Open the User Scrolling Free Text Templates form, and select a user-defined table.
  2. Choose the specific field that you want to enable with a template.
  3. You can pull in patient-specific information from the Keywords dropdown.
  4. In order to use the template, right-click in the SFT field that the template has been linked to, select User Templates, and choose the desired template.