View on GitHub

equella.github.io

Home

Wizard Controls Reference Guide

Table of Contents

Wizard controls overview

The EQUELLA Administration Console enables the creation and customization of a variety of user wizards. Each of these wizards contains a range of controls that translate to checkboxes, buttons and fields etc. to prompt users to input text, make selections, upload files and various other actions.

The purpose of this reference guide is to describe the controls available to contribution wizards; where and why each control is used and how they are configured in the Administration Console Collection Definition Editor. Some of the wizard controls are also used to configure advanced searches in the Administration Console Advanced Search Editor and these controls are referenced accordingly.

Please note that this guide has been developed to best reflect the full capabilities of EQUELLA, and as such may differ in appearance to your own installation.

Wizard controls

Wizard controls are configured in the Administration Console. A choice of controls can be added to:

All wizard controls can be added to a contribution wizard while an Advanced search wizard can contain only the following controls:

The Collection Definition Editor and the Advanced Search Editor contain common configuration elements such as the Hierarchy pane (also known as the Control list pane in the Advanced Search Editor) and the Control Editor pane.

Hierarchy pane

Wizard controls are added to the Hierarchy pane located on the left-hand side of the editor.

In the Collections Definition Editor, the hierarchy provides the structure for the controls that make up the wizard. All controls are added as children of the selected control node, with the exception of the DRM (Digital Rights Management), Navigation Builder, Page and Static Metadata controls which are always added as new root elements in the hierarchy.

Wizard control icons within the Hierarchy pane are:

In the Advanced Search Editor, only basic controls can be added and they are listed by title.

Control Editor pane

The Control Editor pane is located on the right-hand side and displays the details of the control currently selected in the Hierarchy pane. The contents of this pane are dependent on the control that is selected.

Common control elements

To maintain control configuration consistency, some panes, fields and buttons are common to many controls. This section describes these common elements. Control-specific elements are described in the section detailing the individual control.

Title

Enter a succinct and descriptive title name for the control (e.g. Title) in the Title field. The title is displayed to users above the control. HTML tags can be used if required, such as

<b></b>

Description

Enter a brief instruction or explanation in the Description field if the function of the control is not fully explained by the title. The description is displayed above the control and below the title.

Scripting button

Click Scripting to display the Script Editor. Scripting can be used to modify controls based on resource metadata, user roles or resource status. For example, a control could be hidden or displayed based on previous data entered. (NOTE: When a control has a script, a red dot appears beside the control name in the list in the left-hand pane.) The Script Editor provides two options:

This control is mandatory

Check the This control is mandatory checkbox to enforce that data must be entered in the associated control before the wizard can be completed. A red asterisk displays beside mandatory controls in the contribution wizard.

When a user attempts to submit a resource without entering data into a mandatory field it causes a warning dialog to be displayed and the resource cannot be published.

Select metadata target(s) for this control

Most controls require schema elements to be designated as the storage area for entered data. These schema elements are called metadata targets. Multiple metadata targets can be selected for controls.

The elements of this section are:

Select a schema element (e.g. ‘xml/item/itembody/name’) then click OK to display it as the selected metadata target on the control page.

Wizard control reference

This section describes the controls that can be added to a contribution wizard in the Collections Definitions Editor. Some of the controls can be added to an Advanced search wizard in the Advanced Search Editor and these controls are referenced accordingly.

Advanced Scripting

Customized wizard controls and content can be created using an Advanced Scripting control in a contribution wizard.

The Advanced Scripting control:

The Advanced Scripting control requires advanced knowledge of scripting languages.

Attachments

The Attachments control enables the configuration of attachments and the various attachment types that can be linked to resources during the contribution process.

The attachments control has the following elements:

When the Add a resource link is clicked, and there is more than one attachment type enabled, the Select type page displays.

If only one attachment type is enabled, the page specific to that type opens immediately.

Echo360 Presentations

The Echo360 Presentations attachment type enables users to link Echo360 presentations to their EQUELLA resources.

EQUELLA Resources

The EQUELLA Resources attachment type enables users to search for and link to other resources or attachments within the EQUELLA repository or from external sources.

The attachment type can be configured to allow searching within the entire repository and other repositories, or searches can be restricted to particular collections and sources.

The EQUELLA Resources control elements are:

If a search or contribution option has been restricted (checked) but no collections, searches or sources have been selected and moved to the right-hand pane, that option will not be available from the Select or Search page. For example, if the Restrict contribution to the collections: checkbox has been selected, but no collections have been moved to the right hand pane, the Contribute portlet does not display on the Select page.

External tool provider (LTI)

Selecting the External tool provider (LTI) attachment type enables users to select LTI tools from external providers to be added as links to a resource during contribution.

Files

Selecting the Files attachment type enables users to upload one or more files or archives to attach to a resource during contribution.

The Files attachment type configuration options are:

Flickr photos

Selecting the Flickr photos attachment type enables users to add Flickr photo links to a resource during contribution. The Flickr photos section allows the user to configure API key information, if required.

The Flickr configuration elements are:

Google Books

Selecting the Google Books attachment type enables users to search for Google Books™ content to be added as links to a resource during contribution.

iTunes U Tracks

Selecting the iTunes U Tracks attachment type enables users to add iTunes U™ tracks to a resource during contribution. The iTunes U Tracks section allows the user to configure channel definitions, if required. The iTunes U Tracks configuration element is:

Kaltura streaming media

Selecting the Kaltura streaming media attachment type enables users to search for Kaltura streaming media items to be added as links to a resource during contribution. Additionally, new media can be uploaded to the Kaltura server during contribution.

The Kaltura streaming media configuration elements are:

Selecting the URL Links attachment type enables users to enter one or more URL links to a resource during contribution.

Web Pages

The Web pages attachment type enables users to author, edit or import web pages.

YouTube Videos

Selecting the YouTube attachment type enables users to add YouTube™ video links to a resource during contribution. The YouTube Videos section allows the user to configure channel definitions, if required.

Check the Enable YouTube channels checkbox to configure YouTube channel information. The YouTube videos configuration elements are:

To add a YouTube channel

  1. Enter a name to display in the drop-down list during contribution in the Channel Name field (e.g. Monty Python).
  2. Enter the YouTube Channel ID (e.g. UCGm3CO6LPcN-Y7HIuyE0Rew).
  3. Click Add.

Use the up arrow and down arrow buttons to change the order of the list. This will change the order they appear in the drop-down list during contribution.

To remove a channel, highlight the required channel and click Remove.

Button

The Button control enables the user to create a button with a function determined by an associated script.

The Button control elements are:

Calendar

The Calendar control allows the selection of a date or date range. For example, a publication creation or modification date, or to control resource use or availability.

The Calendar control elements are:

The Calendar control is also available in the Advanced Search Editor.

Check Box Group

The Check Box Group control creates a checkbox group from which one or more elements can be selected. The Check Box Group control elements are:

Add checkboxes to the Check Box Group pane

The Check Box Group control is also available in the Advanced Search Editor.

DRM

The DRM (Digital Rights Management) control is used to manage digital rights for resources uploaded to the repository.

The DRM control can only be added as a new root element in the hierarchy.

Adding a DRM control displays one or two pages in a contribution wizard. These pages gather information on the digital rights associated with the contributed resources.

Edit Box

The Edit Box control allows entry of basic text such as names, descriptions, tags, keywords, comments or other details.

The Edit Box control elements are:

The Edit Box control is also available in the Advanced Search Editor.

Email Selector

The Email Selector control allows for the selection of the email addresses associated with registered EQUELLA users.

The Email Selector control elements include:

File Manager

The File Manager control is a Java™ applet that allows for advanced management of resources being contributed. Users can:

The File Manager control elements are:

An example of the File Manager with WebDAV enabled displayed in a contribution wizard.

Group

The Group control is used to create a group of controls that exist under a group heading in a contribution wizard. It is primarily for display purposes; to create a clear relationship between associated controls. This control cannot be used in isolation, it must be configured with child controls. To add specific controls to the group, a Group item must first be added as a child of the Group.

The Group control elements are:

Group Item

The Group Item control cannot be used in isolation, but must be added as a child of the Group control.

The elements of the Group Item control are:

Further controls can be added to the Group Item control, and further Group Item controls with child controls can be added to the Group control.

Group selector

The Group Selector control enables the selection of groups during contribution and stores the details with the resource metadata. For example, the group selector could be used with a Dynamic metadata ACL to select groups whose users have access to a collection or even specific item.

The Group Selector control elements are:

Select group(s)

Select the parent groups that users can select using the group selector during contribution.

HTML Edit Box

The HTML Edit Box control provides an inline editor within the contribution wizard that allows users to create web page content during contribution.

The HTML Edit Box control elements are:

Select the [Click here to edit] link to enable the HTML Editor.

Enter and/or edit content as required, then select the [Click here to lock] link to store updated content and return the Editor to a read-only state.

Leave the Only load this editor on-demand checkbox unchecked to load the HTML Editor automatically.

The Insert EQUELLA Content button can be configured to allow searching within the entire repository, or searches can be restricted to particular collections, dynamic collections or advanced searched. Additionally, the collections available for contributions can be restricted.

The Insert EQUELLA Content control elements are:

If a search or contribution option has been restricted (checked) but no collections, searches or sources have been selected and moved to the right-hand pane, that option will not be available from the Select or Search page. For example, if the Restrict contribution to the collections: checkbox has been selected, but no collections have been moved to the right hand pane, the Contribute portlet does not display on the Select page.

List Box

The List Box control consists of a drop-down list where a single value can be selected.

The List Box control elements are:

Add options to the List Box

Click on the down arrow to display a drop-down list of available options.

The List Box control is also available in the Advanced Search Editor.

Multi-Language Edit Box

The Multi-Language Edit Box control can be used in place of a normal edit box that only stores non-language specific values. It allows users to input multiple language strings into the resource XML, so that the control will then display the string relevant to the selected language.

The Multi-Language Edit Box control elements are:

Enter data in one or both language fields (e.g. Username in the English field and Nama pengguna in the Indonesian field).

Clicking the language drop-down (e.g. English) displays the option to select the other languages, or Show all. Data can be entered in either language in the corresponding field.

Select the Collapse link to return to the default view.

The Navigation Builder control adds a page to the contribution wizard that allows users to:

A Navigation Builder control will always be added as a new root element in the hierarchy.

Page

Page controls provide logical steps and group relevant wizard controls in a contribution wizard, with each wizard comprising at least one page. Pages are displayed as links on the right-hand side of a contribution wizard.

The Page control element is:

A Page control is always added as a new root element in the hierarchy.

Radio Button Group

The Radio Button Group control displays a group of options where only one can be selected.

The Radio Button Group control elements are:

The Radio Button Group control is also available in the Advanced Search Editor.

Raw HTML

The Raw HTML control enables the entry of HTML to enhance the design and usability of wizard pages.

The Raw HTML control elements are:

The Raw HTML control is also available in the Advanced Search Editor.

Repeater

The Repeater control creates a field that can be duplicated on the wizard page. It can be used in instances such as copyright, when entering several book chapters, where each chapter consists of repeated input elements like title, chapter number, author and so on.

A Repeater control cannot be used in isolation—it requires at least one child to be added. Depending on the type of data being collected, any controls can be used.

The Repeater control elements are:

Click the Add +noun (e.g. Add Additional Section) button to insert a duplicate section to the wizard page.

Role selector

The Role Selector control enables the selection of roles and stores the details with the resource metadata. For example, the role selector could be used with a Dynamic metadata ACL to select roles whose users have access to a collection or even specific item.

The Role Selector control elements are:

Shuffle Box

The Shuffle Box control allows users to select one or more items by moving them from one pane to another using arrow buttons.

The Shuffle Box control elements are:

Add items that will be shown in the left-hand side of the Shuffle Box

The Shuffle Box control is also available in the Advanced Search Editor.

Shuffle Group

The Shuffle Group control allows users to add, delete or edit groups of details in a list (e.g. multiple contributor or publisher details). It requires one or more children, in the form of Edit Box and List Box controls, to be added and cannot be used in isolation.

Clicking the Add link opens a window displaying the child controls.

Entering any required information and clicking OK will close the window and populate the control with the entered information.

Shuffle List

The Shuffle List control allows users to add any number of elements to a list (e.g. a list of multiple authors relating to a single document).

The Shuffle List control elements are:

The Shuffle List control is also available in the Advanced Search Editor. An additional Tokenise values checkbox is available for this control in the Advanced Search Editor.

This option is selected by default. If selected, each line of text entered in the shuffle list is split up into words for searching purposes. For example, the line English 101 will be searched by ‘English’ and ‘101’. If the option is not selected, each line of text is matched exactly in a search, returning only resources that have the exact term (e.g. ‘English 101’).

Static Metadata

The Static Metadata control stores information that is fixed for all resources of a collection. Static metadata is held in selected schema nodes nominated as metadata targets.

A Static Metadata control is always added as a new root element in the hierarchy.

The Static Metadata control elements are:

The value of Schema Item/Value pairs displayed in the association list become editable if double-clicked.

NOTE: Static metadata is not visible to users during resource contribution.

Term Selector

The Term Selector control is used for the selection of terms associated with a pre-authored taxonomy.

The Term Selector control elements are:

Click the Select terms link to open the pop-up browser.

The Term Selector control is also available in the Advanced Search Editor.

User Selector

The User Selector control enables the selection of users and stores their details with the resource metadata. For example, the user selector could be used to assign workflow tasks to specific users during the workflow process.

The User Selector control elements are:

Select group(s)

NOTE: If the wildcard symbol (*) is entered or the search field is left blank, all groups will be returned when the Search button is clicked.

Click on a group to select it (e.g. Int – Content Administrators), then click OK. Hold the CTRL key while clicking to select multiple groups. The selected group is added to the Select group(s) pane. Only users belonging to this group can be selected during resource contribution.

If the collection is designed to use this control as a moderator assigning tool with an associated workflow, the same group must be selected in the Workflow Task Editor—Moderators tab.

The User Selector control is also available in the Advanced Search Editor.