Skip to main content

Create a Scheduling Console Widget

  1. Last updated
  2. Save as PDF

You can create SQL table widgets based upon Appointment Scheduling forms, similar to the Scheduling Calendar.

Likewise, the resulting rows in the widget feature right-click menu links to select Appointment Scheduling forms, however, not all menu links supported in the Scheduling Calendar are supported within the widgets.

Like Widget Definition, these Appointment Scheduling widgets support the ?PATID and ?EPID keywords to fetch results based on the currently selected Client ID.

  1. Go to: AvatarPM > RadPlus Utilities > Widget Management (Search for Console Widget Configuration and select PM)
  2. In the Form to Create Widget For field, select the form.
  3. In Add New or Edit Existing, select Add.
  4. In the Widget ID field, enter a unique ID for the widget.
    The Widget ID is a unique identifier. If a value is edited, it will create a new widget. 'SCHEDULE_' is automatically appended to this scheduling widgets to make them easily identifiable. With a scheduling widget, up to 40 characters may be entered to produce a 50 character unique ID key.
  5. In the Title field, enter a name for the widget.
  6. Click Edit Default Configuration to change the default widget configuration.
    From the resulting screen:
    • The SQL Column Name shows the SQL table name, and Display Name shows its given title.
    • You can select the SQL columns to display in the widgets.
    • You can add or delete rows to customize the Console Widget display.
    • When finished, click Save.
  7. In the Widget Entity Type field, select whether or not this widget is client based. 
    Note: Any query using the ?PATID parameter keyword should have this field set to Client Based.
  8. In the SQL Query Override field, enter an SQL query if you wish to override the fields selected in the Edit Default Configuration screen.
    • Include the ID property of either SYSTEM.AppointmentData, or SYSTEM.appt_data in any query in order to successfully launch into Appointment Scheduling forms. The first occurrence of this property in any query will be hidden within the resulting table.
    • The headings of table columns inside the widget are the SQL Column names from the query.
      For example, 'SELECT ID, service_description FROM SYSTEM.AppointmentData' produces one column in the widget headed 'service_description'.  Use SQL Column Aliasing to specify an alternate heading for the table column in the widget. e.g. 'SELECT ID, service_description As Service FROM SYSTEM.AppointmentData' produces one column in the widget headed 'Service'.  
      Note: The Cache SQL utilities employed validate SQL Column Aliases without either double or single quotes. For example, 'SELECT ID, service_description As 'Service' FROM SYSTEM.AppointmentData' OR 'SELECT ID, service_description As "Service" FROM SYSTEM.AppointmentData' produces an 'IDENTIFIER expected' error on submission.

If the intention of the widget is for it to be placed in 'Chart View' for users, since there is no "Episode" selection in the Chart View, consequently no Episode parameter value can be coming from the query. Therefore the ?EPID parameter must be removed from the query for data to display for the query in Chart View.

  1. In the Time Limit (seconds) field, enter the number of seconds that the query will be allows to run. Additional time needed to complete processing on the returned results may mean the widget runs for longer than this Time Limit value.
  2. In the Allow the following actions on this widget via Right Click field, select the additional actions to enable in the right-click menu for users with the appropriate permissions for those actions.
  3. In the Allow Find New Appointment field, select whether or not to add the Find New Appointment button to the scheduling widget. This buttons will allow you to launch the Scheduling Calendar - Find New Appointment screen.
  4. In the Maximum number of rows to display field, enter the number of rows to display on the widget.
  5. Click File.