Adding a Web Page Area Widget

Licence Required: Basic operator or higher.

The following describes how to add a widget to a configuration that will present users with information from either a specific web page or a script. Web pages may either be internal (part of the admin portal) or from an external source, as appropriate.

Because it is often used to display operator scripts, this type of widget is sometimes called a "script widget".

Implementation

  1. Access the list of configurations for the intended customer.

    1. Access the resources page for the intended customer.

      1. Access the details page for the intended customer.

        1. Type the customer’s name into the search field at the top of any page.
        2. Click the intended customer in the search results. This opens the Customer Details page.
      1. Select the Customer Resources tab.
    1. Click the CC4Web Configurations hyperlink.
  1. Launch the intended configuration.

    When viewing the list of available configurations:

    1. If you don't want the configuration to appear in a new window, un-tick the first check box.
    2. Use the first drop-down to select the name of an operator to simulate when you launch the configuration.
    3. Locate the configuration you want to access, and click its Launch button.

    Always remember to save any intended changes before exiting this mode.

  1. Click Enter Design Mode.
  2. Click Whole Config Properties. This will open the Properties page for the configuration. On the left-hand side of this page you will see a hierarchy of all current widgets.
  3. Click the Add Another Widget option for where you'd like the widget to appear, which can be either the main window or a tab strip.

    You can add a new tab strip here if needed, as explained in Adding a Tab Strip.

  4. On the right-hand side of the page, locate the Web Page Area widget.

    The widgets listed here are sorted according to the type of licence required to operate them.

  5. Click Add This Widget. The page will update, and the new widget will be selected, presenting you with its General tab.
  1. Type a suitable Widget Title.
  1. If you want the widget to display a particular web page when it first loads, type the relevant Starting URL into the field provided.

    If you intend to use this widget to display a script, you should not specify a starting URL. For more information, refer to Nominating a Web Page Area to Display Operator Scripts.

  2. Use the remaining options in this tab to make further changes as needed.
    OptionDescription
    Option: AUTO_SUBMITWhen displaying a script, at the end of each call the data entered against the script will be compiled. When the next call comes in and the script reloads, the previously compiled data will be saved to the previous call's details screen.
    Option: SHOW_BUTTONSPresents the user with buttons such as Back, Forwards, and History, to assist with browsing the presented content.
    Option: REQUEST_CAMERAThe user will be prompted to share their camera and microphone, for situations where such inputs are needed by the hosted content.
  1. Select the Styles and Layout tab.
  2. Use the options provided to fine-tune the appearance of the widget.

    Header

    OptionDescription
    Option: NO_HEADERWhether the widget’s header should be hidden.

    Font Size and Colours

    OptionDescription
    Zoom / Magnification LevelUse the drop-down to select a UI scale for this widget, from 10% (x0.1) to 1000% (x10). This defaults to 100% for all new widgets.
    Highlight (Larger) Font Size and ColourUse the two drop-downs to select an alternative font size and colour for certain text in the widget, including its heading. The default size is 16, and the default colour is black.

    Widget Background and Borders

    OptionDescription
    Background ColourUse the drop-down to select a background colour of the widget. The default is white.
    Border ColourUse the drop-down to select a border colour for the widget. The default is black.

    Auto-sizing (to fill window space)

    OptionDescription
    Auto-size optionsUse the drop-downs to select whether the widget should adjust in response to the browser window being re-sized. This is done individually for horizontal and vertical changes.
    Option: Fill TabIf the widget has been placed inside a tab, enabling this option will cause it to occupy the maximum available space in that tab.
  1. Click Save Changes to confirm creation of the widget.
  2. Repeat this process until you have all the widgets you need.
  3. Click Return to CC4Web.

    You should ensure each new widget is appropriately sized, positioned, and styled to fit in with the rest of the configuration. This can be done after adding each new widget, if you prefer.

  4. When you've finished making changes to the configuration, click Exit Design Mode. It is now safe to close the current window or tab and return to the admin portal.

Further Reading