Widget maintenance

Widget maintenance

Overview


The Widget maintenance page allows you to create and maintain HTML widgets used in TMS. To access the Widget maintenance page in TMS, select Dashboard maintenance from the menu in the drop-down Header pane, then select Widget maintenance from the left-hand navigation pane.


When you first navigate to the Widget maintenance page you will see the following message:




There is one option available from this page:


  • New HTML widget — to create a customisable widget providing access to an external web site or information.


Any widgets you create appear in a list on this page, for example:



Click on the name of the Widget to open the Modify HTML widget page.


Click the relevant Delete button to delete a Widget.


Adding a new HTML widget


An HTML widget is a customisable widget which is used to provide access to an external web site or information. For example, you may wish to display the local weather on your Dashboard.


To create a new HTML widget, first navigate to the Widget maintenance page in TMS, select Dashboard maintenance from the menu in the drop-down Header pane, then select Widget maintenance from the left-hand navigation pane. Select New HTML widget in the left-hand navigation pane to open the New HTML widget page:



There are four fields to complete:


  • Title — enter a Title or name for the Widget. Note: leave this field empty to have no header on display (in Dashboard maintenance an <untitled> header will be displayed)

  • Height — the height of the Widget on the Dashboard. Select a value from 1-12 where 12 represents the height corresponding to the full length of the Dashboard

  • Style — the colour of the heading or title bar for the Widget. Select from:

    • None: No border

    • Default: Grey

    • Primary: Blue

    • Success: Green

    • Info: Pale grey

    • Warning: Yellow

    • Danger: Red

  • URL — the URL or path to the web site or information you wish to display in the Widget


Click  Submit  to save the Widget and return to the updated Widgets maintenance page. The following shows the updated page with one HTML widget called 'Local weather':




To preview the Widget you will need to add it to a tab.



Clicking Cancel returns you to the Widgets maintenance page.


Youtube videos can also be displayed in HTML widgets.


If you click  Submit  without entering a Title and/or URL for the Widget, the Widget is not created and the relevant field(s) are highlighted as required:



Enter the required information and click  Submit .


Modifying an HTML widget


After you create an HTML widget, you can change its name (title), height, the colour of the title bar and even the web site or information it displays.


To do this, first navigate to the Widget maintenance page by selecting Dashboard maintenance from the menu in the drop-down Header pane, then select Widget maintenance from the left-hand navigation pane. Click on the name of the Widget in the list that you wish to modify. The Modify HTML widget page opens, for example:



Make your changes then click  Submit  to return to the Widgets maintenance page. To preview the modified Widget you will need to add it to a tab.


Clicking Cancel leaves the Widget unchanged and returns you to the Widgets maintenance page.


YouTube HTML widgets


Youtube videos can be embedded and displayed within HTML widgets. To create a new Youtube HTML widget, first navigate to the Widget maintenance page in TMS, select Dashboard maintenance from the menu in the drop-down Header pane, then select Widget maintenance from the left-hand navigation pane. Select New HTML widget in the left-hand navigation pane to open the New HTML widget page. For example:



Enter and select the Title, Height and Style of your Youtube HTML Widget.


To find the correct URL to embed a Youtube video, first navigate to the Youtube video you wish to display. For example:




Select the 'Share' option underneath the  Subscribe  button and then select the 'Embed' option. A long URL will appear in a text box. Copy the section of the URL that appears in the src element of the text box (without the quotation marks). For example:



Paste the URL into the New HTML widget URL text box.


Click  Submit  to save the Widget and return to the updated Widgets maintenance page.


To preview the Widget you will need to add it to a tab.


Clicking Cancel returns you to the Widgets maintenance page.


Deleting an HTML widget


After you create an HTML widget, you may decide that you no longer need it and wish to delete it.


To do this, first navigate to the Widget maintenance page by selecting Dashboard maintenance from the menu in the drop-down Header pane, then select Widget maintenance from the left-hand navigation pane. Click the Delete button for the relevant Widget in the list. The Delete widget pop-up opens displaying the name of the selected Widget, for example:



Click  Delete  to permanently remove the Widget from TMS and return to the updated Widgets maintenance page.


Click Cancel to abandon the deletion, retain the Widget and return to the Widgets maintenance page.


Note: a list of User profiles will be listed in the warning message if they had been used for the Widget. For example:



    • Related Articles

    • Dashboard maintenance

      The Dashboard maintenance feature is only available to Supervisors with Dashboard maintenance enabled in their TMS user profile. To access Dashboard maintenance in TMS, select Dashboard maintenance from the menu in the drop-down Header pane. When you ...
    • Widget public URLs

      To find the public URL for a Widget, first navigate to the Dashboard maintenance page and locate the relevant Widget. Click on Public URL from the Widget drop-down menu. A Public URL pop-up opens. For example: The pop-up window contains a unique URL ...
    • Tab maintenance

      Creating a new tab To create a new tab, navigate to the Dashboard maintenance page and select New tab in the left-hand navigation pane. The New tab page opens. For example: The fields available are: Title — the name of your tab. This is a mandatory ...
    • Reports widget

      It is possible to add a Reports widget (generated using the Reports Generator) to tabs, which will allow Employees to see a selected Report on their Dashboard (in Grid format), and also Run the Report in the desired format by clicking on the Report ...
    • Profile maintenance

      Overview The Profile maintenance page allows you to view the dashboard and add tabs to each individual User profile. To access the Profile maintenance page in TMS, select Dashboard maintenance from the menu in the drop-down Header pane, then select ...