Ares TABLE Tag
The TABLE tag displays a table with customizable formatting, header text, columns and order of records. These customizations are made within the tag itself and are not editable by the web user within the web interface to re-order requests or remove items from the table.
An example of how this tag would display in the HTML:
<#TABLE>
info
Beginning with version 4.7, tables with action links will have the action-link CSS class applied. Tables with action links are designated below.
Attributes Applicable to any TABLE Tag​
| Attribute | Description |
|---|---|
| Name | The type of table that will be generated. Possible options are AuthorizedUsers, CloneInstructors, CloneItems, Course, CourseCrossList, CourseImport, CourseUsage, CourseValidation, Item, ItemHistory, ItemNonUsage, ItemNotes, ItemRestriction, ItemTracking, ItemUsage, MessageBoard, MessageBoardThread, NotificationInformation, Proxy, SharedList, SharedListItem, StudentList, ViewNotifications |
| ID | The ID value for the table. |
| HeaderText | Header text to be displayed at the top of the table spanning all columns. |
| FooterText | Footer text to be displayed at the bottom of the table spanning all columns. |
| NoDataAction | Indicates how the table should be generated in the event there is no data. There are 3 possible options: ShowMessageRow, ShowEmptyTable, and ShowNone. |
| NoDataMessage | The text that is displayed when a table has no data to display and NoDataAction is set to ShowMessageRow. |
| AllowJSHover | Enables a JavaScript hover effect for the data row. |
| HideColumnHeaders | The header row for columns that shows the column label will not be generated if this is set to true. There are 2 possible options: true and false. |
| Class | The CSS class to apply to the table. |
| LegacyStyle | Tables have a border set to 1 and cellpadding set to 2. This is considered obsolete and CSS should be used to mimic the same behavior. There are 2 possible options: true and false. If not specified, this value defaults to false. |
| ShowMessageRow | Displays text that spans all columns. The text that is displayed is set using the NoDataMessage parameter. |
| ShowEmptyTable | The base table and all columns will display but there will be no rows created and no message will be displayed. |
| ShowNone | If the value provided for NoDataAction is not a valid option it is treated as if it was ShowNone. The table will not be generated. |
| Column | Individual columns from the table results can be included that overrides the default display. If the table tag has any columns explicitly set, all columns must be explicitly set that wish to be displayed. If no columns are specified the default columns listed for each table will be used. The column attribute can be added for as many columns that need to be displayed. Default columns will only be displayed if no column attributes are defined. The values for the column can contain the field or a field and label. If only a field is specified, it will be used as the column header if HideColumnHeaders is set to false. Labels can be specified by appending a colon (:) and adding any label that should be used in the column header. |
| IconColumn | Specifies the column in which to display item icons. May be used instead of the BothTitlesIcon and BothTitlesViewedIcon special columns. See Creating Item Tables with Icons for more information. |
| IconAlign | Valid values are "Left" (default) and "Right". When IconColumn is specified, controls the alignment of the icon within the table cell. See Creating Item Tables with Icons for more information. |
| IconStyle | Valid values are "Icon" (default) and "IconViewed". When IconColumn is specified and when viewed in a student context, will control whether or not to display the "New" icon next to the regular item icon if the student has not yet viewed an item. See Creating Item Tables with Icons for more information. |
Ares Web Tables​
AuthorizedUsers​
This table will display all students in a course.
Default Columns​
- LibraryID (Library ID)
- LastFirst (Last name, first name)
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| NotRegisteredName | Text to display when the student has not yet registered, shown in lieu of LastFirst, LastName, or FirstName. Defaults to 'Not a registered user'. |
| OrderBy | Specifies the sort order for the table. Default is SortOrder, Title, ArticleTitle. |
<#TABLE name="AuthorizedUsers">
CloneInstructors​
Displays instructors that may be cloned along with a course.
Default Columns​
- ItemCheck (Shows a checkbox, allowing the user to select the row)
- UserName (User Name)
- LastName (Last Name)
- FirstName (First Name)
Special Columns​
None
Additional Parameters​
None
<#TABLE name="CloneInstructors">
CloneItems​
Displays item available to be cloned.
Default Columns​
- ItemCheck (Shows a checkbox, allowing the user to select the row)
- BothTitlesIcon (Title + item icons)
- Author
- StartDate (Start Date)
- StopDate (Stop Date)
- ListID (Shared List ID, if any)
- ListName (Shared List Name, if any)
Special Columns​
| Column | Description |
|---|---|
| BothTitles | Displays the item "title" on one line, and the "article title" below. |
| BothTitlesIcon | Same as BothTitles, also includes the item icon. |
| OrderBy | Specifies the sort order for the table. Default is Title, ArticleTitle. |
Additional Parameters​
| Parameter | Description |
|---|---|
| CalendarText | Text to be shown on Date columns when the popup calendar is shown. |
| IncludeJavascriptCalendar | Flag to indicate whether to show the popup calendar. Default is yes. |
| includeSharedListRelationship | Valid values are 'Yes' or 'Conditionally', both of which allow for shared list information to be returned with item data. These columns may then be manually added to the columns list and displayed on the table. |
| OnlyHotListItems | Display only the hot list items. Customization key 'UseHotList' must be true. |
| Type | Valid value is blank or "import". When set to import, will use the course start and end dates when cloning. |
<#TABLE name="CloneItems">
Course​
Displays a table containing courses.
Default Columns​
- CourseNumber (Course)
- CourseCode (Section Number)
- Name
- ReserveItems (Reserve Items)
Special Columns​
| Column | Description |
|---|---|
| Disassociate | Shows a link to disassociate a shared list from the course, displaying text specified in 'DisassociateText'. |
| Import | Shows a link to import an item, displaying text specified in 'ImportItemText'. |
| ImportItemText | Text to be displayed when importing an item. |
| ImportToSharedList | Shows a link to import a shared list, displaying text specified in 'ImportItemText'. |
| CourseSection | Shows a link based on the 'type' parameter provided, then displays the course number and course code on a new line. - Import: uses the course import link type. - ImportToSharedList: uses the import to shared list link type. - If no type specified: uses the link to course information type. |
| CrossListed | Shows a link to a cross listed course based on the type parameter provided. - Import: uses the course import link type. - ImportToSharedList: uses the import to shared list link type. - If no type specified: displays the course number and course code. |
| ReserveItems | Shows a link based on the 'type' parameter provided as well as the item count. If the user is an instructor, will also display the count of all items visible to the instructor. - Import: uses the course import link type. - ImportToSharedList: uses the import to shared list link type. - If no type specified: uses the link to course information type. |
| LinkColumn | Specified the column that will be the actual link, as set by other values. |
Additional Parameters​
| Parameter | Description |
|---|---|
| addCourseText | Text displayed in the 'AddCourse' column. |
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| DepartmentSearch | When true, will filter table to a department specified in a 'Department' parameter. |
| InstructorSearch | When true, will filter the table to an instructor specified in an 'Instructor' parameter. |
| CourseSearch | When true, will filter the table to a course specified in the following parameters: - CourseType: Allows filtering of a course by course type. - CourseField: Allowable values are 'Course Code', 'Course Number', 'Course Name'. This will filter the table based on a value stored in the parameter 'Course'. |
| Type | Used to control CourseSection, CrossListed, and Reserve item columns. Allowable values are 'Import', 'ImportToSharedList', 'SharedListCourses', 'AddCourse'. |
| LimitRecentMonths | Establishes parameters on how many months back the list of courses will display (default 2 months). |
| Role | If set to 'Instructor', table will be filtered by a 'Session' value. |
| Session | Table will filter based upon course criteria set in "session" value: - Current (courses available right now) - Future (future courses) - ItemAddition (active courses or course that will be available in the future) - Previous (finished courses) - PreviousOrCurrent (past or present courses) - IActiveCourseList (courses available right now) |
| OrderBy | Specifies the sort order for the table. Default is course number. |
<#TABLE name="Course">
info
The Course table includes CSS classes for the following action link(s):
- view-course
- import-items-course
- import-items-sharedlist
- add-course
CourseCrossList​
Displays courses that are cross listed.
Default Columns​
- CourseNumber (Course)
Special Columns​
| Column | Description |
|---|---|
| RemoveCrossList | Generates a link allowing for the removal of the cross listing. |
Additional Parameters​
| Parameter | Description |
|---|---|
| ShowParentCourseField | When true, displays the parent course. |
| RemoveCrossListText | Text to display in the RemoveCrossList column. |
<#TABLE name="CourseCrossList">
info
The CourseCrossList table includes CSS classes for the following action link(s):
- remove-crosslist
CourseImport​
Displays a listing of all courses eligible for import.
danger
Course Import is a legacy tag. Please see suggested alternative coding below in the 'Recommended Changes'.
Default Columns​
- CourseNumber (Course)
- CourseCode (Section Number)
- Name
- ReserveItems (Reserve Items)
Special Columns​
| Column | Description |
|---|---|
| AddCourse | Shows a link to add a course, displaying text specified in 'addCourseText' or 'previouslyAddedText'. |
| Import | Shows a link to import an item, displaying text specified in 'ImportItemText'. |
| CourseSection | If specified as the LinkColumn, will display a link to the course. Text contains the course number and course code, along with any crosslinked courses. |
| CrossListed | If specified as the LinkColumn, will display a link to the course and all crosslisted courses. Text contains course number and course code. |
| ReserveItems | If specified as the LinkColumn, will display a link to the course. Text contains course name and number of reserve items. |
Additional Parameters​
| Parameter | Description |
|---|---|
| addCourseText | Text displayed in the 'AddCourse' column. |
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| ImportItemText | Text to be displayed when importing an item. |
| LinkColumn | Specified the column that will be the actual link, as set by other values. |
| OrderBy | Specifies the sort order for the table. Default is CourseNumber. |
| Role | If set to 'Instructor', table will be filtered by a 'Session' value. |
| Session | Table will filter based upon course criteria set in "session" value: - Current (courses available right now) - Future (future courses) - ItemAddition (active courses or course that will be available in the future) - Previous (finished courses) - PreviousOrCurrent (past or present courses) - IActiveCourseList (courses available right now) |
Recommended Changes
<#TABLE name="Course">
Legacy Tag Code
<#TABLE name="CourseImport">
CourseUsage​
Displays the number of viewings of an item within a course.
Default Columns​
- BothTitles (Displays the item "title" on one line, and the "article title" below.)
- Author
- TotalUsage (Usage)
Special Columns​
| Column | Description |
|---|---|
| BothTitlesIcon | Same as BothTitles, also includes the item icon. |
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowSort | When true, allows table sorting by clicking on the column title. |
| DetailLinkText | Text displayed on the link displaying usage details. |
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="CourseUsage">
info
The CourseUsage table includes CSS classes for the following action link(s):
- view-usage
CourseValidation​
Displays the contents of the CourseValidation table.
Default Columns​
- AddCourse
- CourseNumber (Course)
- CourseCode (Section Number)
- Name
Special Columns​
| Column | Description |
|---|---|
| AddCourse | If InstructorModify is true, allows an instructor to instantly add and edit a course. Otherwise, displays a link to allow the immediate import of the course. Link text will either be "Add course" (default) or the AddCourseText parameter. |
Additional Parameters​
| Parameter | Description |
|---|---|
| InstructorModify | See AddCourse column above for usage. |
| AddCourseText | See AddCourse column above for usage. |
<#TABLE name="CourseValidation">
info
The CourseValidation table includes CSS classes for the following action link(s):
- create-course
Item​
Displays a table of items
Default Columns​
- BothTitles (Title)
- Author
- Department
- Course
Special Columns​
| Column | Description |
|---|---|
| CloneItem | When used, displays a checkbox allowing selection of the item for cloning. |
| BothTitles | Displays the item "title" on one line, and the "article title" below. |
| BothTitlesIcon | Same as BothTitles, also includes the item icon. |
| BothTitlesViewedIcon | Same as BothTitlesIcon, also includes the icon indicating the item has been viewed. |
| Tags | Displays the tags for the item, along with links to other items with the same tag. |
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowAjax | When adding or deleting from hotLists, when set to "yes" hot lists are updated without refreshing the entire page. |
| AllowPublic | When true, allows anonymous users to see the table. |
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| AllowSort | When true, allows table sorting by clicking on the column title. |
| HotListAdd | When valued, allows items to be added to a hot list. |
| HotListDelete | When valued, allows items to be removed from a hot list. |
| HotListAddText | Allows custom text to be used when prompting the user to add items to a hot list. |
| HotListDeleteText | Allows custom text to be used when prompting the user to add items to a hot list. |
| ItemStatus | Semicolon delimited list of statuses to display. |
| Keyword | Allows filtering by the value specified in 'Keyword'. Works in conjunction with the following attributes: - KeywordType: Allowed values are 'TagOnly' and 'KeywordTag'. The value of 'tag' will filter rows by the item tag value. - If the keyword is 'TagOnly', the following fields will also be added as search criteria: Title, ArticleTitle, Author, ISXN. |
| LimitTo | Cancelled, Finished. |
| LinkColumn | Specified the column that will be the actual link, as set by other values. |
| LinkType | Link type options: - ItemInfo: Links will view information/details about the item. - ItemEdit: Links will redirect users to edit the item. - ItemContent: Links will redirect users to view the contents of an item. |
| OnlyHotListItems | Display only the hot list items. Customization key 'UseHotList' must be true. |
| OrderBy | Specifies the sort order for the table. Default is Title, ArticleTitle. |
| ReadItem | When valued, indicates that an item has been read. |
| ShowHiddenItems | When true, displays all items regardless of availability status. |
| Type | Type options: - CourseItems - CloneItems |
| UserViewed | When valued, shortcut to set the OrderBy to 'AccessCount, Title, ArticleTitle, Author'. - HotListItems: When set to 'on', limits search results to only hot list items. Sets OrderBy to 'UserHotListItem, Title, ArticleTitle'. |
| UnreadItem | When valued, indicates that an item has not been read. |
<#TABLE name="Item">
info
The Item table includes CSS classes for the following action link(s):
- view-item-detail
- view-item-content
- edit-item
ItemHistory​
Displays the item history.
Default Columns​
None - You must specify columns in the item history table.
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| OrderBy | Specifies the sort order for the table. Default is SortOrder, Title, ArticleTitle. |
<#TABLE name="ItemHistory">
ItemNonUsage​
Displays a listing of students who have not viewed an item.
Default Columns​
- LastFirst (Last name, first name)
- Library ID (ID)
Special Columns​
None
Additional Parameters​
None
<#TABLE name="ItemNonUsage">
ItemNotes​
Displays a listing of ItemNotes.
Default Columns​
None - You must specify columns from the ItemNotes table.
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| OrderBy | Specifies the sort order for the table. |
| ExcludeNoteTypes | Comma delimited list of NoteTypes that should not be displayed. |
<#TABLE name="ItemNotes">
ItemRestrictions​
Displays a listing of ItemRestrictions.
Default Columns​
- CourseNumber (Course Number)
- Name
- StartDate (Start Date)
- StopDate (Stop Date)
Special Columns​
| Column | Description |
|---|---|
| CourseCheck | Shows a checkbox, allowing the user to select the row. |
Additional Parameters​
| Parameter | Description |
|---|---|
| CalendarText | Text to be shown on Date columns when the popup calendar is shown. |
| CourseChoice | Enables the CourseCheck special column. |
| OrderBy | Specifies the sort order for the table. Default is CourseNumber. |
| IncludeJavascriptCalendar | Flag to indicate whether to show the popup calendar. Default is yes. |
<#TABLE name="ItemRestrictions">
ItemTracking​
Displays a listing of ItemTracking entries.
Default Columns​
None - You must specify columns from the ItemTracking table.
Special Columns​
| Column | Description |
|---|---|
| Status | Displays the current status of the item. |
Additional Parameters​
| Parameter | Description |
|---|---|
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="ItemTracking">
ItemUsage​
Displays ItemUsage information. Anonymous usage is controlled by the customization key AnonymousUsageStatistics.
Default Columns​
If using anonymous usage:
- AccessDate (Date)
- UsageCount (Usage)
For non-anonymous usage:
- LastFirst (Last name, first name)
- AccessDate (Date)
- UsageCount (Usage)
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowSort | When true, allows table sorting by clicking on the column title. |
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="ItemUsage">
MessageBoard​
Lists the various threads of a message board.
Default Columns​
- Title (Subject)
- FullName (Started By)
- LastPostInfo (Last Post)
Special Columns​
| Column | Description |
|---|---|
| LinkColumn | Specified the column that will be the link to the message board thread. Default is Title. |
| LastPostInfo | Displays the post date and post author. |
| FullName | Displays the first and last name of the post author. |
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="MessageBoard">
info
The MessageBoard table includes CSS classes for the following action link(s):
- view-thread
MessageBoardThread​
Displays all posts within a message board thread.
Default Columns​
- FullName (Author)
- FormattedPostDate (Date)
- Message
Special Columns​
| Column | Description |
|---|---|
| FormattedPostDate | Displays the post date, formatted. |
| FullName | Displays the first and last name of the post author. |
Additional Parameters​
| Parameter | Description |
|---|---|
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="MessageBoardThread">
NotificationInformation​
Displays information about email messages
Default Columns​
- Field
- Value
If no fields are specified, Subject, EmailDate, and Body will be used.
Special Columns​
| Column | Description |
|---|---|
| Subject | The email message subject. |
| Body | The email message body. |
| EmailFrom | The From address. |
| EmailTo | The To address. |
| EmailCC | The CC address. |
| EmailBCC | The BCC address. |
| Item | If present, will display a link to the item along with the item title. |
| EmailDate | The email date. |
| Status | The message Status. |
| Note | The message note. |
Additional Parameters​
None
<#TABLE name="NotificationInformation">
Proxy​
Displays proxy instructors associated with a course.
Default Columns​
- UsernameFirstnameLastname
Special Columns​
| Column | Description |
|---|---|
| DeleteUsernameFirstnameLastName | Creates a link to remove a proxy user, includes the username, first and last name and DeleteText. |
| UsernameFirstNameLastName | Creates a link to remove a proxy user, includes username, first and last name. |
| FirstNameLastName | Creates a link to remove a proxy user, includes first and last name. |
| Delete | Creates a link to remove a proxy user, includes DeleteText. |
Additional Parameters​
| Parameter | Description |
|---|---|
| LinkColumn | Specified the column that will be the link. |
| DeleteText | Text to display on the delete links. |
| Type | Sets the type of link for remove a proxy user. - Full: Uses the proxy user's username. - Course: Uses the proxy user's username and course ID. |
<#TABLE name="Proxy">
SharedList​
Displays a list of available Shared Lists.
Default Columns​
- ListID (List ID)
- ListName (List Name)
- ListType (List Type)
- ListReference (List Reference)
Special Columns​
| Column | Description |
|---|---|
| ListReference | Column reference |
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| LinkColumn | Specified the column that will be the link. |
| ListType | List type options: - Instructor - Department - System |
<#TABLE name="SharedList">
info
The SharedList table includes CSS classes for the following action link(s):
- view-list-details
- import-items-sharedlist
SharedListItem​
Displays a table of shared list items
Default Columns​
- ListItemID (ID)
- Title
- Author
Special Columns​
| Column | Description |
|---|---|
| BothTitles | Displays the item "title" on one line, and the "article title" below. |
| BothTitlesIcon | Same as BothTitles, also includes the item icon. |
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowSort | When true, allows table sorting by clicking on the column title. |
| AllowRowClick | Allows an entire table row to be the link, as set by other values. |
| IconDirect | Allows linking directly to the shared list item. |
| IconDirectSameWindow | If false, links to the shared list item in a new browser window. |
| LinkType | Link type options: - SharedListItemEdit: Links will redirect users to edit the shared list item. - SharedListItemContent: Links will redirect users to view the contents of a shared list item. - SharedListItemInfo (default): Links will view information/details about the SharedListItem. |
| LinkColumn | Specified the column that will be the link. |
<#TABLE name="SharedListItem">
info
The SharedListItem table includes CSS classes for the following action link(s):
- view-shared-item-detail
- view-shared-item-content
- edit-shared-item
SharedListItemRestrictions​
This will display a listing of Shared Lists that an Item can be added to. This tag will work on Item request forms where the Type=16 (the ISLRF request forms). This table tag is very similar to the ItemRestrictions tag. It can be used to select multiple Shared Lists to add an Item to (such as on the OpenURL request forms). It can also be used on the regular request forms as a reminder of which Shared List they are about to add the Items too if they change the SharedListChoice parameter to "One". This is similar to how the regular IRF request forms work where a single course is shown. When a new Item is added to a single Shared List, the DLL will redisplay the Shared List home page. If the Item is being added to multiple Shared Lists, the DLL will redirect back to the Ares main page.
info
This only applies to Instructors or their Full Proxies. Course proxies will not be able to see the Shared Lists since they normally don't have permissions to add Items to Shared Lists.
Default Columns​
- SharedListCheck
- ListID (List ID)
- ListName (List Name)
- ListType (List Type)
- ListReference (List Reference)
Special Columns​
| Column | Description |
|---|---|
| SharedListCheck | Shows a checkbox, allowing the user to select the row. |
Additional Parameters​
| Parameter | Description |
|---|---|
| SharedListChoice | Indicates if the SharedListCheck should show. Valid values: One or blank. If set to One, a shared list must be active. |
| OrderBy | Specifies the sort order for the table. Default is ListName. |
<#TABLE name="SharedListItemRestrictions">
StudentList​
Displays a list of students enrolled in a course.
Default Columns​
- UserName (User Name)
- LibraryID (Library ID)
- LastName (Last Name)
- FirstName (First Name)
- EmailAddress (Email Address)
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| AllowSort | When true, allows table sorting by clicking on the column title. |
| OrderBy | Specifies the sort order for the table. |
<#TABLE name="StudentList">
ViewNotifications​
Displays a table of email notifications.
Default Columns​
- Subject
- EmailDate (Sent)
Special Columns​
None
Additional Parameters​
| Parameter | Description |
|---|---|
| OrderBy | Specifies the sort order for the table. |
| EmailType | Indicates what type of email notifications to display. - User: Shows email notifications/messages for the current user. - Item: Shows email notifications/message about the current item. |
<#TABLE name="ViewNotifications">