Module Setup - Overview

Updated Feb. 20, 2008

Generally, these are the steps you must follow to successfully set up and configure your Doyle ITS Roster instance. Each step is detailed below.

1. Configure module Settings
   1. General Settings
   2. Roster Settings
   3. Member Settings
   4. Term Settings
   5. Explorer Settings
2. List Administration
   1. Roster Types
   2. Position Types
3. Add or Edit Roster
4. Terms Administration
   1. Managing Terms
   2. Adding a Range of Terms
   3. Importing Terms
5. Member Administration
   1. Managing Members
   2. Edit Member
   3. Importing Members
6. Configure member terms

Section 1: Module Settings 

In addition to the standard module settings which can be configured, all Doyle ITS Roster settings will also be configured at this point.

General Settings

• Map-It URL - This is a substitution field-based URL which will be used to to show a map of an address, provided you elect to use this functionality. By default the URL is for MapQuest, but you can choose Google Maps, MapPoint, Yahoo! Maps, etc.
  • MapQuest: http://www.mapquest.com/maps/map.adp?address=[ADDRESS]&city=[CITY]&state=[STATE]&zipcode=[POSTALCODE]&country=[COUNTRY]&cid=lfmaplink
  • Google: http://maps.google.com/maps?f=q&hl=en&q=[ADDRESS],+[CITY],+[STATE]+[POSTALCODE]+[COUNTRY]
• Image Filters - If enabled, this setting allows you to restrict image types that users can upload for rosters, members, etc.
• Image Size Limit - If enabled, this setting allows you to restrict the image size of uploaded images
• Save Image In Database - This specifies whether the uploaded images will be saved to the web server's file system or in the database. Important note - this setting cannot be changed after the initial Settings configuration!
• Thumbnail Height and Width - This determines the thumbnail size of images (but will not restrict the size of the actual uploaded image)
• Valid DateTime / Decimal / Integer / String / TimeSpan Expression - These settings are reserved for future use for "statistics" (see Product Roadmap)

Roster Settings

• Enable Address - Enables address, city, state (region), zip code (postal code), and country
• Enable Map-It! - If the address is enabled, a link will be displayed to show a map of the address
• Enable Email - Enable email address
• Enable Telephone - Enable telephone number
• Enable Website - Enable website (will be displayed as a clickable link)
• Enable Effective Date and Effective Date Label - The effective date is a customizable start date which can be enabled. If enabled, the label or caption can be specified to customize the meaning of this date: established, born, joined, etc.
• Enable Expires Date and Expires Date Label - The expires date is a customizable end date which can be enabled. If enabled, the label or caption can be specified to customize the meaning of this date: closed, died, left, etc.
• Enable Image Upload and Max Images - If image uploads are enabled for each roster, a maximum number of images can be set
• Terms Layout - This determines how the "terms" (see Terminology) will be displayed: along the left-hand side, in a drop-down list, or paged.
• Roster Text (single and plural) - The caption of a "roster" can be customized to be more relevant: team, group, company, etc.

Member Settings

• Enable Address - Enables address, city, state (region), zip code (postal code), and country
• Enable Map-It! - If the address is enabled, a link will be displayed to show a map of the address
• Enable Email - Enable email address
• Enable IM - Enable IM (instant messenger)
• Enable Telephone - Enable telephone number
• Enable Website - Enable website (will be displayed as a clickable link)
• Enable Effective Date and Effective Date Label - The effective date is a customizable start date which can be enabled. If enabled, the label or caption can be specified to customize the meaning of this date: established, born, joined, etc.
• Enable Expires Date and Expires Date Label - The expires date is a customizable end date which can be enabled. If enabled, the label or caption can be specified to customize the meaning of this date: closed, died, left, etc.
• Enable Image Upload and Max Images - If image uploads are enabled for each member, a maximum number of images can be set
• Enable Paging and Page Size - If paging is enabled, the page size when browsing members can be set
• Enable Import - If member importing is enabled, the user can import members into a roster, from another roster within the same module, another roster module within the portal, or your DNN portal members.
• Enable Self-Invite - If enabled, a user can invite or register themselves as a member of a roster. If the user has Edit permissions on the roster module, they will then be able to update their information, as well as manage their terms and posistions.
• Member Export, Export As, and Export Delimiter - If member exporting is allowed, the export can be as an Excel spreadsheet or CSV document. If CSV is selected, the delimiter will be the specified character(s). Member export can be configured with the following settings:
  • Disabled - Exporting is not allowed
  • Admin Only - Only Administrators can export
  • Owner / Admin - Only Administrators or the creator of each roster can export its members
  • Registered Users - All Registered Users can export
  • Public - All users (registered or not) can export
• Member Text (single and plural) - The caption or name of a "member" can be customized to be more relevant: player, associate, etc

Term Settings

• Start and End Date Label - Customizable captions for the term start and end dates
• Enable Import - If term importing is enabled, the user can import terms into a roster, from another roster within the same module, or another roster module within the portal
• Term Text (single and plural) - The caption or name of a "term" can be customized to be more relevant: year, season, etc.

Explorer Settings

• Enable Explorer - Select whether to enable the explorer, which allows for multiple rosters. If the explorer is disabled, only one roster will be displayed and editable
• Display Type - This option specifies whether to display the roster type in each roster's title
• Enable Paging and Page Size - If paging is enabled, the page size when browsing rosters can be set
• Listing Text (single and plural) - This is similar to the Roster Text, except this is displayed in the explorer

Section 2: List Administration 

In List Administration, the roster types will be managed, as well as their respective positions. Both roster types and positions are stored in the DotNetNuke Lists table; they are not module instance-specific, and are therefore accessible throughout the site.

Each roster module supports any number of roster types, so a roster module instance is not confined to a single roster type. If multiple roster types are used, the explorer mode will categorize rosters for each roster type.

Note: List administration is only available to site administrators. Users allowed to "edit" a roster module cannot modify the roster types or position types.

Roster Types

• Move Entry [Up] and [Down] - Changes the list order of the selected item, and determines the order in which the roster type will be displayed in the Explorer treeview, as well as the Roster Type drop-down list when editing a roster.
• Actions [Edit], [Delete], and [Add] - Edit or delete the selected item, or add a new roster type
• List Name - This is the DotNetNuke list name (not editable)
• Parent - Unused
• Entry ID - DotNetNuke list ID
• Entry Name - This is the publicly displayed long name of the roster type ("Major League Baseball")
• Entry Value - This is the publicly displayed abbreviation or code of the roster type ("MLB")
• Manage Position Types - This link navigates to the position list administration for the currently edited roster type

Position Types

• Move Entry [Up] and [Down] - Changes the list order of the selected item, and determines the order in which the position type will be displayed when displaying members in terms.
• Actions [Edit], [Delete], and [Add] - Edit or delete the selected item, or add a new position type
• List Name - This is the DotNetNuke list name (not editable)
• Parent - The parent roster type list value 
• Entry ID - DotNetNuke list ID
• Entry Name - This is the publicly displayed long name of the position type ("Pitcher")
• Entry Value - This is the publicly displayed abbreviation or code of the position type ("P")

Section 3: Adding or Editing a Roster 

• ID - Roster ID
• Name - Roster's publicly displayed name
• Summary - Short description that is displayed in the Explorer
• Type - Roster type, selected when the roster is created. This cannot be modified once saved.
• Contact Email - Publicly displayed email address (if enabled)
• Address, City, Country, State/Region, Zip/Postal Code - Publicly displayed address information (if enabled). If Map-It! is enabled, it will use this address information
• Telephone - Publicly displayed telephone number (if enabled)
• Website - Publicly displayed website. If enabled, this will be displayed as a clickable external link
• Effective Date - Publicly displayed, customizable "start" date (if enabled). It is shown here as "Established"
• Expires Date - Publicly displayed, customizable "end" date (if enabled). It is not shown here.
• Published - Indicates whether the roster is publicly displayed. If not, it is only visible to the creator and administrators
• List Order - Order in which the roster will be displayed
• Description - This is the full description of the roster. This supports rich text and HTML
• Images - For each image (up to the "max" number of images), the following is displayed
  • Upload image (will overwrite existing image) - This must be checked to upload an image
  • Current file - If an image has been uploaded previously, the file name will be displayed
  • Remove - If an image has been uploaded previously, this option will be available to remove the image

Section 4: Terms Administration 

Managing Terms 

•  Term List - This list box displays the list of all terms, in order of their start and end date (ascending). The default date (explained below) is denoted by an asterisk (*).
• Actions [Edit], [Delete], [Add], [Manage Term's Members] - Edit or delete the selected term, or add a new term. [Manage Term's Members] allows you to configure member terms for the selected term.
• Term ID - Term database ID
• Term Name - Name of the term, which can be a year, month, season, or any meaningful name.
• Default Term - Indicates whether the term will be the default term displayed when the roster is viewed. The user will be able to view other terms by selecting them
• Start Date - Term start date
• End Date - Term end date

Adding a Range of Terms 

The choice is given, when adding a term, to add a single term or range of terms. The range entry will automatically generate a list of terms based on the user criteria.

• Action - [Single] allows for the addition of a single term. [Range] allows for the addition of a range or list of terms.
• Term Name - This is customizable term name for each term in the range. Each term can have a generated name based upon string formatting information, which is explained beneath Generating the Term Name. Those familiar with Microsoft .NET string formatting will recognize the patterns used.
• Start Date - This is the start of the range of terms
• End Date - This is the end of the range of terms
• Frequency - This is the interval at which each term is generated
• Time Period - This is time period which gives meaning to the frequency.

A simple example follows:
- Start Date = "1/1/2000" (Jan. 1, 2000)
- End Date = "12/31/2003" (Dec. 31, 2003)
- Frequency = "1"
- Time Period = "Year(s)"
Four new terms will be generated, representing each year: 2000, 2001, 2002, 2003. If the End Date were "1/1/2004", a fifth term would have been generated representing 2004.

Importing Terms 

• Import From - The choice is given to import from the current module, or another module (within the portal).
• Member - If importing from another module, the list of modules will be displayed (not shown here)
• Roster - A drop-down list will display all rosters, depending on the Import From choice
• Terms - Once a roster has been selected, the list of terms for that roster will be displayed

Section 5: Member Administration 

Managing Members 

• Member List - This list box displays the list of all members, in order of their member name (ascending). 
• Actions [Edit], [Delete], [Add], [Manage Member's Terms] - Edit or delete the selected member, or add a new member. [Manage Member's Terms] allows you to configure member terms for the selected member.

Edit Member 

• Member ID - Member database ID
• Member Name - Customizable member name
• First Name - Member first name
• Last Name - Member last name
• Contact Email - Member contact email
• Effective Date - Publicly displayed, customizable "start" date (if enabled). It is shown here as "Joined"
• Expires Date - Publicly displayed, customizable "end" date (if enabled). It is not shown here.
• Description - This is the full description of the member. This supports rich text and HTML

Importing Members 

• Import From - The choice is given to import from the current module, another module (within the portal), or the DNN registered users.
• Module - If importing from another module, the list of modules will be displayed (not shown here)
• Roster - A drop-down list will display all rosters, depending on the Import From choice, or the module selected
• Members - Once a roster has been selected, or importing from the DNN users, the list of members for that roster will be displayed

Section 6: Configuring Member Terms 

• Roster - Name of the current roster
• Roster Type - The current roster's type
• Member Name
  • If member terms are being managed by clicking the [Manage Member's Terms] button in Member Administration, this will be the name of the member being managed
  • If member terms are being managed by clicking the [Manage Term's Members] button in Terms Administration, this will be a drop-down list of all members for the current roster.
• Term Name
  • If member terms are being managed by clicking the [Manage Member's Terms] button in Member Administration, this will be a drop-down list of all terms for the current roster
  • If member terms are being managed by clicking the [Manage Term's Members] button in Terms Administration, this will be the name of the term being managed
• Position - This is a drop-down list containing all positions for the current roster's type
• Member Term List
  • If member terms are being managed by clicking the [Manage Member's Terms] button in Member Administration, this will be a list of all positions assigned to the current member, ordered by the term and position
  • If member terms are being managed by clicking the [Manage Term's Members] button in Terms Administration, this will be a list of all members assigned positions in the current term, ordered by position and member