Business objects USAGE TRACKING INSTALLATION GUIDE

Download

USAGE TRACKING

INSTALLATION, CONFIGURATION,

AND ADMINISTRATION

Version 8.7.2

Chapter 1: Install Usage Tracking

Table of Contents

Chapter 1: Install Usage Tracking ............................................................................. 5

Information Tracked...............................................................................................5

The tool tracks and stores the following information in the database: ................. 5

Install the Usage Tracking Server.............................................................................. 6

Configure SQL Authentication..................................................................................7

Create a SQL Database for Usage Tracking.............................................................. 8

Create a New SQL Login (optional)..........................................................................8

Chapter 2: Configure Usage Tracking ..................................................................... 11

Change the Setup Password ................................................................................. 11

Configure the Database Settings ..........................................................................11

Set the Authentication Mode................................................................................12

Save the Setup ...................................................................................................... 14

Modify the Configuration ........................................................................................14

Install Content on the Web Server...........................................................................14

Configure the IIS Permissions ................................................................................. 15

Usage Tracking Security Permissions ................................................................. 16

Build the Database and Load Standard Reports......................................................16

Create an Admin User (Forms Authentication only) ..............................................17

Post Configuration Tasks ......................................................................................... 17

NTFS Settings ..........................................................................................................17

Chapter 3: User Administration ...............................................................................19

Add a New User ....................................................................................................... 19

Edit an Existing User – Form Authentication ......................................................... 19

Delete a User and Usage History – Form Authentication.......................................20

Viewing the Error Log ............................................................................................. 21

View the User Summary .......................................................................................... 21

Chapter 4: Reporting .................................................................................................22

Usage Tracking Reports...........................................................................................22

The Report List......................................................................................................... 22

View a Report........................................................................................................... 22

View Report Details................................................................................................. 23

Modify a Report ....................................................................................................... 23

Copy of a Report with a New Name........................................................................ 24

Delete a Report.........................................................................................................24

Refresh Outline ........................................................................................................25

Chapter 5: Filtered Reports ......................................................................................27

Run Filtered Reports ................................................................................................27

Date Range Filter .....................................................................................................27

Usernames Filter ...................................................................................................... 28

Outline Section Filter ...............................................................................................28

Playback Mode Filter ...............................................................................................29

Report Format ..........................................................................................................29

Deleted: 7

Deleted: 8

Deleted: 9

Deleted: 12

Deleted: 13

Deleted: 15

Deleted: 16

Deleted: 17

Deleted: 18

Deleted: 19

Deleted: 20

Deleted: 21

Deleted: 22

Deleted: 23

Deleted: 24

Deleted: 25

Deleted: 26

Deleted: 29

Chapter 6: Design New Reports ............................................................................... 31

Reports Overview .................................................................................................... 31

Create a New Report................................................................................................ 31

Name a Report ......................................................................................................... 31

Add Report Groups.................................................................................................. 32

Preview a Report...................................................................................................... 33

Remove a Group from a Report .............................................................................. 33

Save a New Report .................................................................................................. 34

Add Data Columns to the Report ............................................................................ 34

Sort Data Columns ............................................................................................... 35

Breakout by Mode................................................................................................ 35

Select Report Filters ................................................................................................ 36

Default Values for a Date Filter .............................................................................. 38

Default Values for a Usernames Filter .................................................................... 38

Default Values for an Outline Section Filter .......................................................... 39

Default Values for a Playback Mode Filter............................................................. 40

Format a Report ....................................................................................................... 40

Report Options ......................................................................................................... 41

Chapter 7: Import and Export Reports................................................................... 42

Import Reports ......................................................................................................... 42

Export the Report Structure..................................................................................... 42

Index............................................................................................................................. 44

Deleted: 34

Deleted: 35

Deleted: 36

Deleted: 37

Deleted: 39

Deleted: 40

Deleted: 41

Deleted: 42

Deleted: 43

Deleted: 44

Deleted: 46

iii

Chapter 1: Install Usage Tracking

The Usage Tracking tool is used to:

- Access and view the Knowledge Accelerator – Player Package

- Track user’s progress within the Knowledge Accelerator – Usage Tracking tool

The Usage Tracking tool allows an organization to capture data as users view topics in the Knowledge Accelerator - Player Package (Player). Administrators can then run usage reports on the tracked data. The Usage Tracking tool has standard pre-packaged reports. The administrators can also create custom reports to capture the data they need.

Information Tracked

The tool tracks and stores the following information in the database:

• User name

• Application name

• Module name

• Topic name

• Start and end dates for topics and modes

• Topic launch count

• Playback mode (See It!, Try It, Do It!, or Know It?) the topic was played in

• Required score, achieved score, and calculation of pass/fail for Know It? mode

Usage tracking has almost no impact on the users who are viewing content and taking assessments. Depending on the configuration of the Usage Tracking module, a user may be asked to log in to the Player.

This chapter includes steps for installing the Usage Tracking server on the Web server, configuring the database, adding content to the Web server, and configuring the setup.

Many of the server configurations are made either by the installer application or by entering variables into the configuration page (e.g. database name, server name, etc). It is assumed the person performing the installation has the necessary rights and working knowledge of Microsoft SQL enterprise manager, Microsoft IIS and Microsoft Windows Server. The person installing this application needs a familiarity with basic server terminology (domains, user groups, virtual directories, etc.) and must know how to:

• create a new SQL database

• add new users to an SQL database and/or assign users to an SQL database

• A basic knowledge of Windows authentication methods (anonymous, Windows

integrated, etc.).

• create users and groups in Windows

Before installing the Usage Tracking Server, you should complete following steps:

Chapter 1: Install Usage Tracking

• Set up a Windows 2000 server or Windows Server 2003 computer

The Usage Tracking server requires either a Windows 2000 Server or a Windows Server 2003 operating system. Since the Usage Tracking server is a web-based application, Microsoft Internet Information Server 5.0 or 6.0 is required along with the WWW service. In addition, the Microsoft .NET Framework 1.1 is required. This is installed if necessary during the installation of server.

If you are using Windows Server 2003, open the IIS Manager application and check the Web Server Extensions that are allowed. Be sure that the ASP.NET extension is allowed on the server.

• Determine the location where the software and content will be installed

Although it is possible to install the Usage Tracking server in the Internet Information Server home directory (wwwroot in a default installation of IIS), we recommend that the server be installed to a new directory in a different location. This is recommended to maintain tight control over permissions. By installing the server in a different location you are ensuring better security when updating content. The content can be installed within the same folder as the Usage Tracking server, or it can be located anywhere on the Web server machine.

• Prepare the required amount of disk space

The Usage Tracking server requires 10MB for the software and additional space for the content (the amount of space depends on the specific content). The space needed for the content on the server will vary. Allow between 250 KB and 900 KB of disk space for each topic. This is the average size of topics without sound. If sound is associated with a topic, it will be larger The actual size depends on many factors including length of topic, screen resolution, and color depth. When the Microsoft SQL Server database is initially created, 30 MB of space is allocated for the database and transaction log files. Based on various factors such as number of users and amount of content, the database may increase in size.

• Determine the security mode for the SQL server

The Usage Tracking server stores information in a database on an SQL server, and it needs to access the database. Two authentication modes are available for an SQL server. The authentication mode should be set to SQL Server and Windows on the server.

• Determine the authentication mode for the Administration Module

The Usage Tracking server supports two methods of authenticating users: Forms and Windows. When Usage Tracking is configured for Forms authentication, users are authenticated by a list of users and permissions maintained within the database. When Usage Tracking is configured for Windows authentication, users are authenticated based on their Windows group and login, which is maintained as part of Windows security.

For installation of IIS and SQL, see the documentation provided by the software vendor

Deleted: Chapter 6: Design New Reports

Install the Usage Tracking Server

The Usage Tracking server is intended for installation on a Web server. Microsoft IIS should be installed and the WWW service should be running prior to running the Usage Tracking server setup.

Before installing the Usage Tracking server application files, the installer checks for IIS, Microsoft .NET Framework 1.1 and MDAC 2.7 SP 1. If IIS is not installed, you will not be able to install the server application files. If either MDAC or the .NET framework are not installed, or the installer cannot determine if they are installed, you will be presented with a message that they must be installed.

During the installation procedure, you will need to enter a destination folder and a name for your Usage Tracking virtual directory. The destination folder is the physical location to where the Usage Tracking server application files will be installed. You can accept this default or specify another location. The virtual directory name allows you to specify the name of the virtual directory on the Web server that points to the physical location of the files. The default virtual directory name is ODS, but you can specify another name if you wish.

If there is more than one Web site on the Web server, you can specify the Web site.

1. Insert the Usage Tracking server CD into the appropriate drive or download the Usage

Tracking file from the Electronic Software Delivery (ESD) site and unzip it.

2. Open Windows Explorer.

3. Launch Setup.exe. If the .NET Framework is not installed, a message box prompts you to

install it.

4. Select the install language and click OK.

5. Click Next.

6. Accept the default folder or use the Browse button to specify another location and click

Next.

7. Accept the default virtual directory name or enter a different name.

8. Select the location where you want to create the virtual directory. If you choose a location

other than the Default Web Site, you must indicate the Web site.

9. Click Next.

10. Select the language that is used for Usage Tracking and click Next.

11. Click Next.

12. Click Finish.

Configure SQL Authentication

The Usage Tracking server stores information in a database on an SQL server. To create the database, you should allow SQL authentication.

1. Click the Windows Start menu.

2. Select the All Programs option.

3. Point to the Microsoft SQL Server command.

4. Select the Enterprise Manager command.

5. Expand the Microsoft SQL Servers group.

6. Expand the SQL Server Group.

7. Right-click the appropriate server name.

8. Select the Properties command.

Chapter 1: Install Usage Tracking

9. Click the Security tab.

10. In the Authentication group, select the SQL Server and Windows option, if necessary.

11. Click OK

Create a SQL Database for Usage Tracking

You must create a new SQL database to hold the tracking data. The database must be installed and configured before launching the administrative applications, or the administrative applications will not launch.

1. Open Enterprise Manager, if necessary.

2. Expand the Microsoft SQL Servers group, if necessary.

3. Expand the SQL Server Group, if necessary.

4. Expand the appropriate server group.

5. Right-click the Databases folder.

6. Select the New Database command.

7. Enter a name for the database. The suggested default is ODS.

8. Click OK.

Create a New SQL Login (optional)

Once you have created the SQL database, you can create a new login that has rights to the new database. This is a general login to allow the Usage Tracking server to access and communicate with the SQL server and store data in the database.

Creating a new login is optional. You can use an existing SQL account and give that account db_owner rights to the database you created for Usage Tracking.

It is possible to use Windows Integrated Security to allow the Usage Tracking server to access the SQL database. Assistance from Technical Support in configuring Usage Tracking will only be provided for SQL Authentication.

1. Open the Enterprise Manager, if necessary.

2. Expand the Microsoft SQL Servers group, if necessary.

3. Expand the SQL Server Group, if necessary.

4. Expand the appropriate server group.

5. Expand the Security folder.

6. Right-click the Logins item.

7. Select the New Login command.

8. Enter a name. The suggested default is ODServer.

9. In the Authentication group, select the SQL Server Authentication option.

10. Enter a password.

11. In the Defaults group, use the Database dropdown list and select the database (ODS, if

default).

12. Click the Database Access tab.

13. Click the checkbox next to the database (ODS, if default).

Deleted: Chapter 6: Design New Reports

14. In the Database roles for '<database name>', click the checkbox next to db_owner.

15. Click OK.

16. Enter the password you assigned in step 10 and click OK.

17. Close the Enterprise Manager.

Chapter 2: Configure Usage Tracking

The Configuration Utility must be run prior to launching the Administrative tool. It is required to enable usage tracking. There are three steps for configuring the server, which must be performed in this order:

1. Set the configuration password, define the connection to the SQL database, and

set the authentication options for the users.

2. Build the SQL database.

3. Create an administrative user, if you choose to use Forms authentication.

You can access the configuration page for the first time by opening your browser and entering a URL that points to the “default” page within the virtual directory on the Web server. For example, if the name of the Web server is myweb, and the name of the virtual directory is ODS, the URL would be http://myweb/ODS/ “default” page name.

When you run the Configuration Utility for the first time, you create a configuration file in the Usage Tracking server directory. Therefore, you must have administrative rights to the Usage Tracking server folder on the Web server to run the Configuration Utility.

The initial password for the Configuration utility is tracking. It is highly recommended that you change it.

1. Open your browser.

2. Enter the appropriate URL for the “default” page.

3. Enter the default password of tracking and click Submit.

. You do not have to enter the

Change the Setup Password

It is highly recommended that you change the setup password for security purposes. This password is for accessing and running the configuration utility only.

1. Launch the Step 1 (Configuration) page.

2. Enter a new password in the Password textbox.

3. Enter the password again in the Confirm Password textbox.

Configure the Database Settings

The options in the Database Settings group allow the Usage Tracking server to establish the connection to the database. The Content Directory Path indicates the physical path to the directory on the Web server where the content will reside. The Content Directory Name indicates the virtual path to the folder where the content will reside. The Database connection string consists of the following parameters that specify a valid connection string to the SQL database. You must edit the Database connection string to include the appropriate information.

Chapter 2: Configure Usage Tracking

Parameter Description

user id The SQL login you created or assigned for the Usage

Tracking server.

Password The password for the SQL login you created.

initial catalog The name of the SQL database you created.

data source The name of the SQL server on which the database

resides.

integrated security Indicates the type of authentication for the SQL

database. This should be set to FALSE, which means that an SQL account will be used for authentication.

1. Launch the Step 1 (Configuration) page.

2. Edit the Content Directory Path to point to where the content is installed.

Note: The content path is the physical location of the content to be tracked. For example, if you have your content in the directory I:\Content, this appears in the Content Directory Path field.

3. Edit the Content Directory Name.

Note: The directory name is the name of the virtual directory for the content (if the content is in a virtual directory), as opposed to its physical location. This is usually the same name as the physical folder where the content is located, but it may be different. For example, if the content is located in a virtual directory (in IIS) named OnDemand that is associated with the physical location I:\Content, then OnDemand appears in the Content Directory Name field.

4. Edit the Database connection string to be a valid connection string; e.g. the user,

password, database, SQL server, and authentication mode that you created.

5. Click the Test Connection button.

6. You should receive a message Database connection OK. Build database after

saving configuration. If the connection failed, edit the string and click the Test Connection button again.

Deleted: Chapter 6: Design New Reports

Set the Authentication Mode

For data to be tracked, the Usage Tracking module must be able to identify the users who are viewing content. This is called authentication. There are two possible methods of authenticating a user for the Administration tool of Usage Tracking, Windows and Forms.

Once you pick authentication mode, you should configure the permissions in IIS for the virtual directory appropriately. See the Configure the IIS Permissions section below for further information.

If you change the authentication type from Forms to Windows after it has been configured, the existing tracking data will be preserved.

Windows Authentication

This authentication method uses network login information.

The end users and administrators are automatically signed in. If the user is not logged in with the network information, he or she will be prompted to enter their network username and password.

With Windows authentication, you can identify Windows user groups that will have administrative permissions. You can select the same group for all administrative permissions or a different group for each administrative permission. Once you have added a user into an appropriate user group, the user will be able to access the Administration tool with the specified rights.

If you choose to use Windows authentication, there are two user settings you can make on the server.

Option Description

Permission Allows you to map Windows user groups or

users to the appropriate permission.

Language Allows you to specify the default language to be

used for the Administration tools.

Locale Allows you to specify the locale to control the

date format, numerical display, etc.

Windows authentication affects the available options on the Main Page of the Administration tool. Since the Usage Tracking server cannot add, edit, or delete accounts in Windows, only the Delete user and usage history option appears on the Main Page. This option will only be available to the users or groups listed in the Delete Data pane.

Forms Authentication

With Forms authentication, you must create users in the Usage Tracking server database and assign appropriate rights to each user. With Forms authentication, administrators with the appropriate permissions can add, edit, and delete user accounts, as well as remove tracking data.

If you choose to use Forms authentication, there are several settings you can make on the server that affect administrators as well as users.

Option Description

Allow users to create their own account

Allows a user, on initial login, to create a new account and specify a user name and password.

Chapter 2: Configure Usage Tracking

Option Description

Allow users to save username & password to bypass login

Username is email address

Minimum password length

Default Language Allows you to specify the default language to be

Default Locale Allows you to specify the locale to control the date

Provides a Save user name and password link on the login page. This option allows users to store their username and password so that it does not need to be entered each time to log in (the login page is bypassed).

Indicates that the user name must be a valid email address.

Allows you to specify a minimum number of characters for a user password. A minimum length of zero means that blank passwords are allowed.

used for the Administration tools.

format, numerical display, etc.

1. Launch the Step 1 (Configuration) page.

2. In the Authentication Mode group, select the Windows option or the Forms

option.

Save the Setup

When you have established the database connection, chosen the authentication mode, and specified the options, you save the setup by clicking the Save Setup button at the bottom of the page. You should receive a Configuration saved successfully message at the top of the page.

Deleted: Chapter 6: Design New Reports

Modify the Configuration

You may need to modify the configuration at some point, for example, to change the administration user name or password. To access the configuration page, open your browser and go to the setup.aspx file in the Configuration folder within the Usage Tracking server folder. For example, if the name of your Web server is Myweb and the virtual directory for the Usage Tracking server is ODS, the URL would be http://myweb/ODS/configuration/setup.aspx.

Install Content on the Web Server

You can deploy the Knowledge Accelerator – Player Package to the Usage Tracking server. Content must be published as the Player Package. It must also be content published from the OnDemand Developer 8.7 installation. The default folder is called Content, but you can specify a different folder in the Database Settings section in the Configuration utility. The content should be installed in this folder.

There are two ways to add the Knowledge Accelerator to the Usage Tracking:

- Install the Knowledge Accelerator to main content folder (users can see

all Knowledge Accelerators that are available on Usage Tracking) at C:\Program Files\BusinessObjects Knowledge Accelerator \Usage Tracking\ODS\content

- Install the Knowledge Accelerator to folder inside content folder (users

can see only those Knowledge Accelerators that you give them link(s)). For this option, browse to the content folder of the Usage Tracking Server and within the content folder create a new folder for each Knowledge Accelerator.

C:\Program Files\BusinessObjects Knowledge Accelerator\Usage Tracking\ODS\content\<newfolder>

1. You will need to have a published Knowledge Accelerator. If you don’t have it

published, publish the Knowledge Accelerator to the Player Package using the default options.

2. Navigate to the published Knowledge Accelerator.

3. Browse to the published Player folder and open the installers folder.

4. Double-click the ContentSetup.exe

5. Browse to the content folder where the Usage Tracking Server is installed. For

example if you installed the Usage Tracking Server using the defaults the path is listed below:

C:\Program Files\BusinessObjects Knowledge Accelerator \Usage Tracking\ODS\content

Or browse to the folder you created for this Knowledge Accelerator

C:\Program Files\BusinessObjects Knowledge Accelerator\Usage Tracking\ODS\content\<newfolder>

6. Finish installation.

7. Repeat steps 3-6 for each Knowledge Accelerator.

Configure the IIS Permissions

After you have chosen the type of authentication for the Usage Tracking server, the IIS permissions for the virtual directory on the Web server must be set to match the selected security mode. Note that if you change the type of authentication mode on the Usage Tracking server, you should update the security permissions appropriately.

IIS Virtual Directory Authentication Mode

Authentication mode

Forms Anonymous Inherit setting from

Windows Windows Inherit setting from

Windows Anonymous Windows Windows All users logged

Server root directory

Server Admin directory

root directory

Server Config directory

Windows Usage Tracking

Windows Windows

Outcome

controls the users

in as Anonymous

Use the last option in the table above if you want to track usage but do not want statistics for individual users. With this option, all usage is tracked and reported under a single Anonymous user account.

Chapter 2: Configure Usage Tracking

Use the following procedure to configure the permissions on the Server virtual directory. (These procedures refer to Windows Server 2003, IIS 6. The procedures for Windows 2000 Server and/or IIS 5 may be different.)

1. Open Internet Information Services (IIS) Manager, if necessary.

2. Expand the IIS Server group.

3. Expand the Web Sites group.

4. Expand the Default Web Site group

5. Expand the virtual directory.

6. Right-click the ODS virtual directory and select the Properties command.

7. Click the Directory Security tab.

8. Click the Edit button on the Authentication and Access control section.

9. Select the Authentication type(s).

10. Click OK.

Usage Tracking Security Permissions

In Windows2003, upon installation, Usage Tracking creates a virtual directory that uses the DefaultAppPool. This will use the application pool identity set in DefaultAppPool. By default, the security account used is predefined to be the Network Service account. In this default setting, the Network Service account must have the appropriate permissions to the ODS directory. The permissions needed for this account on the directory and subdirectories are Read & Execute, Read, and List Folder Contents. The Network Service account, by default, is a member of the Users group. Therefore, when the Users group is removed from the Security tab for the ODS directory, so is the identity for the application pool which results in the web server failing to serve Usage Tracking web pages.

To remedy this problem in Usage Tracking configured to use Forms Authentication, the account configured in the default application pool identity must be given Read & Execute, Read and List Folder Contents permission to the ODS directory. Also, the account of the system administrator who will be configuring Usage Tracking must have Read & Execute, Read, List Folder Contents and Write permission to the ODS directory. Also, the configuration sub-directory should use Integrated Security and anonymous should be disabled.

To remedy this problem in Usage Tracking configured to use Windows Authentication, all users who will be accessing Usage Tracking must have read permissions to the ODS directory. Again, the configuration sub-directory should use Integrated Security and anonymous should be disabled.

If adding the necessary security account to a group which has permissions to the ODS directory, then IIS must be restarted before that group can access the directory.

Deleted: Chapter 6: Design New Reports

Build the Database and Load Standard Reports

After you have saved the configuration, you must build the database. This step creates the proper tables in the SQL database. You also have the option of loading the standard reports that come with Usage Tracking.

1. Launch the Step 1 (Configuration) page.

2. Enter the configuration information and save the settings.

3. Click the Step 2 (Build database) link.

4. Click the Build Database button.

5. Click the Load Reports button.

Create an Admin User (Forms Authentication only)

If you choose to use Forms authentication, you must create at least one administration user. This user has all of the administration privileges, which include creating, editing, and deleting users, assigning administration privileges to other users, and creating and running reports.

1. Launch the Step 1 (Configuration) page.

2. Enter the configuration information and save the settings.

3. Build the database.

4. Click the Step 3 (Create Admin User) link.

5. Enter a user name.

6. Enter a password.

7. Enter the password again to confirm it.

8. Click the Create Admin User button.

Post Configuration Tasks

To install Usage Tracking, the SQL login must have db_owner rights to the database. Once the database is installed and running, you may want to remove the db_owner role from this login and change the role to db_datareader and db_datawriter.

1. Open Enterprise Manager.

2. Expand the Microsoft SQL Servers group.

3. Expand the SQL Server Group.

4. Expand the appropriate server group.

5. Expand the Databases folder.

6. Expand the SQL database you created (e.g. ODS).

7. Select the Users group.

8. Double-click the name of the user who has owner rights to the database.

9. Deselect the db_owner role.

10. Select the db_datareader and db_datawriter roles.

11. Click OK.

12. If necessary, stop and restart the server.

NTFS Settings

Specific permissions must be set for the physical directory in which the Usage Tracking server is installed. If you need to verify them, they are listed in the following table:

Chapter 2: Configure Usage Tracking

User or Group NTFS permissions

Usage Tracking server root directory and subdirectories

OnDemand server root directory and subdirectories

Windows 2000: ASPNET

Windows Server 2003: NETWORK SERVICE

User running the configuration setup.aspx page

Read & Execute

Modify, Read & Execute, Read Write

Deleted: Chapter 6: Design New Reports

Chapter 3: User Administration

Add a New User

To validate whether a user has access to play content, the system must be able to validate the user. If your company is using Windows authentication, this validation is handled by IIS (the Web server). If your company is using Forms authentication, the user names must be stored in the Usage Tracking database.

Usernames must be unique in the system. If you try to create a new user with the same name as an existing user, you will receive an error message. User names are not case sensitive; however, passwords are case sensitive.

If you are using Form authentication, users can create their own accounts and password if the Allow users to create their own account option is enabled on the Configuration screen.

If you have the rights to set administration permissions, you can assign four different access rights to a new user.

Permission Rights

Add Users The user can add or edit users.

Run reports The user can run reports, create new

Delete User and Tracking Data The user can delete users (if available) and

Set Administration Permissions The user can set or change permissions.

If you are using Windows authentication, you set the Administration access through the Usage Tracking server configuration page. You give the appropriate permissions to Windows users or user groups.

Form authentication

From the Main Page, click the Add new user link. Enter the name in the User name textbox. Enter a password in the Password textbox. Enter the same password in the Confirm Password textbox. Select the appropriate options in the Administrative Permissions section, if applicable. Click Save.

reports, and refresh the outline.

purge tracking data for users.

Edit an Existing User – Form Authentication

You can edit the information for a user. This allows you to correct misspellings in the user’s name, or change a password that someone may have forgotten. It also allows you to change a

Chapter 3: User Administration

user’s status from active to inactive, or back again. If a user is inactive, their user name and password are still in the database, but they are prevented from accessing the software.

When you click the Edit existing user link, a page appears that allows you to search for the user that you want to edit. This page consists of two panes, the Find User pane and the Search Results pane. The options in the Search pane allow you to search for usernames that contain or start with specific text. In addition, you can limit the number of users found. For example, you can restrict the search to finding only five users or expand it to find 30 users. After entering the search criteria, you can perform the search. Searching without entering search parameters displays all the usernames in the database.

From the Main Page, click the Edit existing user link. Click the down arrow next to Search for names that. Click the start with, match exactly, or contain option. Enter the search criteria in the textbox. To limit the search results, enter the desired number in the Number of search results

textbox. Click Search. Click Edit next to the user that you want to edit, or click the user name. Update the user name and password as necessary. Edit the user status as appropriate. Change permissions as necessary. Click Save.

You can also combine user records by editing users. For example, if a user forgets his or her user name and creates a new one, but has previously taken training under the other name, you can edit one of the user names to merge the tracking data for both user names into one user name.

If you are using Windows authentication, the option to merge the tracking data for two user names into one user will not be available.

Edit the username of the user account whose data you want to merge into another account.

Note: This is the account that you want to remove. In the User name box, enter the username of the other account into which you want to

merge the tracking data. Enter the password for the other account in the Password and Confirm Password boxes. Click Save. Click Yes to merge the users. Follow the instructions in the next section to delete the user account whose data was

merged.

Deleted: Chapter 6: Design New Reports

Delete a User and Usage History – Form Authentication

Usage tracking data remains in the database until it is purged. Making a user inactive prevents the user from logging in, but it does not erase their tracking data. If your company is using Forms authentication, you can delete the user and purge the tracking data.

If your company is using Windows authentication, you cannot delete a user, but you can erase the

tracking data. In Windows authentication, access is defined by Windows users and user groups.

Since Usage Tracking cannot delete a Windows account, it is only possible to remove the data

stored in the Usage Tracking database, i.e. the usage records.

Use the following procedure to delete a user and purge tracking data:

From the Main Page, click the Delete user and usage history link. Click the down arrow next to Search for names that. Click the start with, match exactly, or contain option. Enter the search criteria in the textbox. To limit the search results, enter the desired number in the Number of search results

textbox. Click Search. Click Delete next to the user that you want to delete, or click the user name. Click the Delete button.

Viewing the Error Log

All errors are written to an error log, including informational messages and database error messages. You can view the error log by clicking the View Error Log link on the Main Page.

Each error message listing includes the severity of the message (information or error), the error number, the date and time, the source of the message, and a brief description. There are fields at the bottom of the listing that allow you to limit the list by date. You can choose to display log entries that occurred on or after one date and on or before another date. You can change the dates and click the Reselect button to redisplay the results for the dates.

You can also purge the error log. In the textbox next to the Purge button, enter a date. When you click the Purge button, all log entries on or before that date are cleared.

View the User Summary

The View User Summary option is available for either Windows or Forms authentication. This option produces a report showing the number of registered users and active users. You can use this report to determine how many people are using the player. Data cannot be calculated for this report if you are using anonymous logins to Usage Tracking.

Chapter 4: Reporting

Usage Tracking Reports

Administrators and users with appropriate rights can use Usage Tracking to create and run training reports. Training reports query the database to provide summary statistics. Users can either select the predefined sample reports included with the application or build their own custom reports. It is easy to create custom reports by selecting pre-defined fields, filter criteria and sort orders. Furthermore, custom reports can be saved, so they can easily be run again.

The predefined sample reports summarize data based on content and user information. Depending on the report, you may be prompted to enter filter criteria, such as a date range or username. Sample reports can be modified or used as the basis for new reports.

Report results are viewed in a browser and can be printed using the browser’s print function. In addition, report data can be copied and pasted into other applications, such as an Excel worksheet to further manipulate the information.

Usage tracking report options are available from the Main Page of the Administration tool. From this page, you can open the Report List to run, create, and manage reports.

1. Click the Edit/Run reports link on the Main Page.

The Report List

The Report List displays the names of the custom and predefined reports you have permission to use. Reports you have created for your own use are called per-user reports. Per-user reports, marked with an asterisk (*), appear only in your Report List. Global reports, available to all users with appropriate rights, appear in everyone’s Report List. The Report List displays your per-user and global reports in alphabetical order.

Icons appear next to the names of all per-user, sample and global reports in the Report List. Using these icons, you can run a report, modify its design, or even delete it. Page links provide the options to create a new report in design mode, import XML code to create a new report, and return to the Main Page.

Any user with reporting access can run reports for the entire system.

Deleted: Chapter 6: Design New Reports

View a Report

Users can view reports by clicking the report name or the corresponding View Report icon in the Report List. The results of the report appear in a browser. If a filter has been applied to a report, you may be prompted to enter filter values before the report appears. When you view a report, a message appears indicating that the report is being processed. Some reports may take more time than others to process.

After viewing a report, you can use the Return to report list link at the top of the report page to close the report and return to the Report List page. The Go to Report Design link opens the report in design view for modifications.

Administrators can view reports while other users are using the system.

13. Click the Edit/Run reports link on the Main Page of the Usage Tracking program to

open the Report List.

14. Click the name of the report or the corresponding View Report icon

15. If prompted to enter filter criteria, enter the appropriate criteria and click OK.

You can also view a report by clicking the name of the report from the Report Name column of the Report List.

View Report Details

After running a report, users have the option to view the details of the report data. Selecting the Details icon next to a summary row displays the Selected Details page with a table of all the records that produced the summary row statistics. Report details are sorted and the sort field is listed above the column headings. The details can be sorted in ascending or descending order. While the default number of records on a page is 100, you can change this value. Regardless of the report view, the detail view shows the same data.

Details are available on a per-record basis. Details show the raw data, so if a Know It? were taken three times by the same user, there would be a separate row for each instance of Know It?. Details are not grouped or summarized.

While you can print the Selected Details pages using the print function in your browser, each screen page must be printed separately. A screen page may print on several physical pages.

Open the Report List and run a report.

16. Click Details

17. To change the sort order, click the down arrow next to Sort by

sort order.

18. To change the number of records on a page, select the text in the Records Per Page

textbox and type a number.

19. Click OK to apply the changes.

20. To scroll through the detail pages, click the Previous Page or Next Page link.

21. Click the Return to report link to display the report.

at the end of the summary row whose details you want to view.

and select the desired

Modify a Report

Users with rights to create reports can also modify them. You may want to modify a report that does not provide the data you need. After making the changes in the design form, you can save the report, which overwrites the original with your changes.

Chapter 4: Reporting

You can also modify a report when you are viewing it in the browser by clicking the Go to Report Design link.

Open the Report List.

Deleted: Chapter 6: Design New Reports

22. Click Modify Report

23. Make the desired changes.

24. Click the Save button.

for the report you want to modify.

Copy of a Report with a New Name

You can create a copy of any report by saving it with a new name. This allows you to use a standard report as the basis for a new report and still keep the original report. You can create a copy of it by using the Save as button and entering a new name for the copy.

It is a good idea to open the predefined sample reports that you use and save them with another name. This prevents your versions from being overwritten when new samples are issued.

Open the Report List.

25. Click Modify Report

26. Click Save as.

27. Click Save as textbox.

28. Type a name for the report.

29. Click Save as.

for the report you want to save with a new name.

Delete a Report

Any user who can create reports can delete them. After confirming the report deletion, the view refreshes and the report no longer appears in the Report List. The deleted report is removed from the database, and from all views. Predefined sample reports can also be deleted from the Report List.

Although you can delete the sample reports, new versions of the Usage Tracking tool may reinstall the reports, and they will need to be deleted again.

You should be careful when deleting a report. There is no undo action for a deleted report.

Open the Report List.

Click Delete Report Click OK.

for the report you want to delete.

Refresh Outline

When new content is installed, the outline should automatically update. If the reports do not appear to be synchronized with the content outline, the Refresh Outline link updates the outline with the new content.

Click the Refresh Outline link on the Main Page.

Chapter 5: Filtered Reports

Run Filtered Reports

You can create reports with filters. Filters limit the reporting data to specific values, such as reporting on a specific application or date range. Depending on the report, filter values may be preset and unchangeable, or may prompt you to enter your own filter values. If a report is set to ask the user for filter values, the Report Data page opens displaying the filter parameters that can be changed. Parameters can include selecting a date range, user names, outline section, or playback mode.

A single report can include multiple filters. If no values are selected for a filter, the report is processed using all data. Therefore, if you only enter a username and no date range for a report that filters on both usernames and dates, the report will use all dates in the database when gathering information about the specified user.

A No data to report message appears if there is no data for the filters you specified. You can return to your filter entries using your browser’s Back button.

Date Range Filter

When a date range filter is applied to a report, the Report Data page opens allowing you to enter date range values. You can enter a date range, or a single beginning or ending date. Entering dates in the From and To textboxes limits the report to information between, and including, those dates. Entering a From date only gathers data from that date to the present date. Conversely, entering a To date only reports on all data up to and including the entered date. If you omit both beginning and ending dates, the entire database is used for the report.

Dates should be entered in the regional format set for your locale. You will be prompted if you enter an invalid date, such as 6/31/2004. You can also specify times using date filters. Times can be entered in 24-hour format or the format set for your locale. By default, 12:00 AM is the time assigned to the start date and 11:59:59 PM is the default time assigned to the end date.

Depending on the report design, the selected date range may appear at the top of the report.

Although you can omit both starting and ending dates for a date filtered report, omitting both dates may cause a problem if you are viewing a formatted report with a large amount of data.

Open the Report List and run a report that prompts you to filter for dates. Enter a starting date in the From textbox, if desired. Enter an ending date in the To textbox, if desired. Click OK.

Chapter 5: Filtered Reports

Usernames Filter

Reports can be filtered to display information for individual users only. When a report is filtered for usernames, you can type the name(s) in the Usernames list box or use the Lookup users link to select users. If you are using Forms Authentication, you must enter the username exactly as it exists in the Usage Tracking database. Windows authentication users should enter fully qualified usernames (including domain name). If using anonymous authentication, all user information will appear combined under the username “anonymous”.

Search for Usernames

When running a report that filters for usernames, you can use the Lookup users link to select usernames rather than type them in.

The Lookup User page consists of two panes, the Search pane and the Search Results pane. The options in the Search pane allow you to search for usernames that contain or start with specific text. In addition, you can limit the number of users found. For example, you can restrict the search to finding only five users or expand it to find 30 users. After entering the search criteria, you can perform the search. You must enter a parameter, or you will receive an error message.

The results of a search appear in the Matched User Names list box in the Search Results pane. You can then select the usernames you want to include in the report and add them to the Selected User Names list box.

Open the Report List and run a report that prompts you to filter for usernames. Type the usernames in the Usernames list box. Click the Lookup users link. Click the down arrow next to Search for names that. Select the start with or contain option. Enter the search criteria in the textbox. To limit the search results, enter the desired number in the Number of search results

textbox. Click Search. Select the checkboxes for the usernames you want to include in the report. Click Add to list. Click OK. Click OK.

Deleted: Chapter 6: Design New Reports

Outline Section Filter

When you run a report that can filter data for a specific outline section, you will be prompted to select the desired application, lesson, module or topic. The Lookup link opens the Lookup Outline page with the outline of all your content listed in hierarchical order by application. You can expand and contract outline sections to display or hide subordinate levels. Reports can be filtered for an entire application, module, lesson, or just a single topic.

You can use the Clear link in the Report Data page to clear the current outline section.

Select a report that prompts you to filter for an outline section.

Click the Lookup link. Click Click

next to the sections you want to expand.

next to the sections you want to collapse. Select the desired application, module, lesson or topic. Click OK. Click OK.

Playback Mode Filter

Reports can be filtered for a specific playback mode. When you run a report that prompts you to select a playback mode, you can choose to view all modes or a specific mode (See It!, Try It!, Know It? or Do It!).

Select a report that prompts you to filter for a playback mode. Click the down arrow next to Playback mode. Select a mode option. Click OK.

Report Format

While most reports display with a specific format applied, a report may ask you to select a format when you run it. Reports can be viewed using three different formats as described below:

Format Description

Formatted Report A Formatted Report, also known as a normal report,

XML Report The XML format displays the report data using the

Tab Delimited Tab-delimited reports display all the data in

You can use the File menu and the Save As command to save the report as a text file. You can then open the file in any application that opens or imports tab-delimited text files. You can cut and paste the tab-delimited data from your browser into another application, such as Excel, for further data manipulation.

is the default format for reports. Formatted reports are created using a style sheet, which produces an HTML page.

schema supplied with the program.

When you view an XML report, there are no links to return to the Report List page. However, you can use your browser’s Back button to return to the Report List.

columns, separated by tabs. In a formatted report, identical items are grouped together and only appear once. In tab-delimited report, each row contains the full data, and the headings are incorporated into the row.

When you view a tab-delimited report, there are no links to the Report List page. However, you can use your browser’s Back button to return to the Report List.

Chapter 5: Filtered Reports

Open the Report List and run a report that prompts you to filter for a playback mode. Select the down arrow next to Format. Select a mode option. Click OK.

Deleted: Chapter 6: Design New Reports

Chapter 6: Design New Reports

Reports Overview

Users with the appropriate rights can create new reports. Reports are created or modified using a design form called the Design Report page. When you create a new report, you start with a blank design form.

The design form consists of six sections.

Section Description

Reports Name the report and specify its availability.

Groupings Select what information you want to display and how

Data Select the statistical columns you want to include.

Filters Select the filters that can be applied to the report.

Format Select a format for the report.

Options Allows you to report the data tracked for content that

After making initial selections for each component of the report, you can use the View this report link to see the resulting data. You can then return to the report design and add or modify the components until the desired report is created.

Create a New Report

When you first open the design form, only one row appears for the Groupings, Data, and Filters sections. As you add content to these sections, additional rows appear allowing you to add additional values. Report column headings are predefined and cannot be changed.

Open the Report List. Click the New Report link.

to group the information. This section determines the rows that appear in the report.

has been deleted.

Name a Report

Report names must be unique. You cannot name a per-user report with the same name as another per-user report in your Report List. Furthermore, you will not be allowed to name a global report with the same name as another global report. You may have two reports with the same name, as long as one is a per-user report and the other is a global report.

By default, a new report is created on a per-user basis and is available only to the report creator. Selecting the Make this report available to everyone option creates a global report available to all users with permission to use the program. Anyone with permission to create reports can create or modify a global report. The Report List does not indicate the name of the person who created a global report.

Per-user reports appear with an asterisk (*) next to the report name in the Report List.

Chapter 6: Design New Reports

Create a new report. In the Reports section, type a name for the report in the Name textbox. If desired, select the Make this report available to everyone checkbox to create a global

report.

Add Report Groups

Groups indicate how the report data should be organized. Adding a group creates a row heading for each value in the group. For example, if you group on Username, a separate row appears for each user. You can organize your report data using the following groups:

Group Description

Application An application corresponds to a Title in the Developer.

Grouping on the application creates a heading for each title that has tracking data associated with it.

Module Module defines the highest organizational level within a

title. Grouping on modules creates a heading for each module that has tracking data associated with it.

Lesson Lessons provide another level of organizational

structure in a title. Each module is made up of one or more lessons. Grouping on lessons creates a heading for each lesson that has tracking data associated with it.

Topic Topics are the lowest level of grouping on the outline

structure. Each topic has at least one playback mode associated with it (e.g. See It!, Try It!, Know It?, Do It!). Grouping on topics creates a heading for each content unit in your training material.

Username Grouping on username will show a breakdown of

content usage by each user. Each user’s records are summarized in one section, with a new section created for each user. Users with no data are not included in the report.

Playback mode When a user takes training, he or she selects a mode

(See It!, Try It!, Know It?, Do It!). Grouping on playback mode allows you to see how the users are choosing to learn the material.

Reports can contain more than one grouping. After selecting the first group, a second row appears in the Groupings section. If you add multiple groups to the report, there will be multiple levels of headings. For instance, if you group by Username and then Application, you will see a row heading for each user with a subcategory heading row for each application. The order in which you add new groups determines how the data is organized in the report.

Selecting the individual outline components (application, module, lesson, and topic) under Groups only shows topics where data exists. However, if you are designing your report to track usage for each outline component, you may want to list all the topics in your report. Selecting the Show full outline as primary grouping option displays all the topics in a report even if there is no data for them. After enabling the full outline, the Username and Playback mode can be added from the Groups list.

Deleted: Chapter 6: Design New Reports

After you select a grouping, you can select options that control the display of the information in the report. These options are described below:

Option Description

Sort After selecting a grouping, you can. The Sort list has three

Order Order defines whether the items in the group should be

values – ascending, descending and none. Sorting order is determined by the order in which the fields appear. To make a field the primary sort, make it the first grouped field.

organized as they appear in the outline or alphabetically by name. The Order option only appears for outline components (application, module, lesson, or topic). The default is to show items as they appear in the outline.

Usage Tracking only reports down to the topic level; it does not track information down to the frame level.

Create a new report or modify an existing one. Under the Groupings section, click the down arrow next to (Select a group to add) in the

Groups column. Select the first field on which you want to group. If applicable, click the down arrow next to Sort. Select the desired sort option None, Ascending or Descending. If applicable, click the down arrow next to Order. Click Outline or Name. Under the Groupings section, click the down arrow next to (Select a group to add) in the

Groups column. Continue adding groups and group options as desired.

Preview a Report

You can preview a report while you are creating it. This is helpful in determining if the design selections you are making will yield the desired results.

In the Design Report page, click the View this report link. To return to the Design Report page and continue working on the report, click the Go to

Report Design link.

Remove a Group from a Report

You can remove a group from a report. When a group is removed from the Design Report page, the view refreshes and the group row no longer appears in the design form.

Create a new report or modify an existing one.

Chapter 6: Design New Reports

Under the Groupings section, click the down arrow for the Groups column for the group

you want to remove.

Click (Remove this group).

Save a New Report

After naming a report and providing at least one group or data column, you can save it to the Report List. As you continue to build and modify the report, you should continually save your changes. The Save button saves the changes and overwrites the existing version. The report remains open after it is saved.

The Save as button allows you to make a copy of a report by saving it with another name. You will be prompted to enter another name for the report.

Other users will see the report if it has been made available to everyone.

An error message appears if you try to save the report using the same name as an existing report with the same availability. You cannot save a per-user report with the same name as another per-user report. Nor can you save a global report with the same name as another global report.

Click the Save button.

Deleted: Chapter 6: Design New Reports

Add Data Columns to the Report

You can select the type of statistical data to include in the report. Each statistical value is displayed in a column in the report. The statistics (and groups) appear in columns from left to right in the order that they are selected in the design form. After adding a statistical column, a new blank row appears in the Data section for additional columns.

The statistical columns available are described below:

Statistic Description

View Count Each time a user plays a topic, it is counted. The View

Count provides a summary of all the times the content was launched.

• If the same user plays the same topic in See It mode three times, it counts as 3 in the View Count.

• If, in the same topic, one person views See It and a second person views Try It, it is counted as 2 in the View Count.

Know It Count This value provides a summary of the number of times a

Know It was taken. Users can take Know Its multiple times. This value provides the total number of times the Know It was taken to completion.

• If a user takes the same Know It three times, it is counted as 3 in the Know It Count.

Statistic Description

View Time Average This value represents the average amount of time (in

Total Time This value represents the total amount of time (in hours,

Average Score This value provides an average Know It score. Based on

Maximum Score This value provides the highest Know It score.

Minimum Score This value provides the lowest Know It score.

Pass Percentage This value calculates the percentage of passing Know It

Pass Count This value represents the total number of times the

seconds) that users are spending on the content.

minutes and seconds) that users have spent on the content using any mode.

the groupings selected, this score can be averaged for an application, module, lesson, topic or user.

scores.

• If a user takes a Know It five times, and passes only once, each of his attempts are included in this percentage (and the value for the passing percentage is 20%).

required score on Know It was achieved.

• If one user takes a Know It five times, and passes once, the pass count is 1.

Tracked data is based on a user launching a topic in a playback mode. User completion of a topic is not tracked.

Sort Data Columns

After selecting a statistical column, you can select a sorting option. The Sort list has three values – ascending, descending and none. Sorts are applied in the order they appear.

Breakout by Mode

The Breakout by mode option determines whether the data will be reported as a summary statistic of all modes, or a summary of each individual mode (See It!, Try It!, Know It?, Do It!). Selecting the breakout mode displays a separate column for each mode. You should only use the Breakout by mode option for statistics that apply to all modes, such as View Count, View Time Average and Total Minutes. The other statistics only apply to data for the Know It? mode.

Breakout mode displays a column for all modes, whether there is data for the mode or not. You can limit the data columns in the report to a single mode by clearing the breakout mode option and setting a playback mode filter.

Create a new report or modify an existing one. Under the Data section, click down arrow next to (Select a column to add) in the

Parameters column. Select the statistical column you want to add to the report. To sort the data in the column, click down arrow next to Sort.

Chapter 6: Design New Reports

Click None, Ascending or Descending. To display a statistical column for all modes, select the Breakout by mode option. Continue adding statistical columns as desired.

Select Report Filters

Filtering data allows you to view only the information with which you want to work by hiding the information you do not want to see. For example, you can filter a username report so that only the information about a particular user appears.

You can filter data on four parameters. These include:

Filter Description

Date Range Use a Date Range filter to show data for a specific

time interval. All averages and totals are based solely on the data that falls within that range.

Username Use a Usernames filter to show data for a specific

user or users.

Outline Section Use an Outline Section filter to limit the report data

to a specific application, module, lesson, or topic.

Playback mode Use a Playback mode filter to limit the report data

to all modes or a specific playback mode (See It!, Try It!, Know It?, Do It!).

Reports can contain more than one filter. For example, you can add a Username filter to display statistics for a specific department, or group of users, and also add a Date Range filter that prompts you to enter a date range when you run the report.

After you select a filter, you must select the appropriate options for that filter. These options include:

Deleted: Chapter 6: Design New Reports

Option Description

Persistence Persistence options determine whether the user can

Include in Report Selecting the Include in Report option prints all the

Default Value You can enter or select default values for a filter in the

change the default values set for the filter parameters when they run the report. If you want to use the same filter values every time you run the report, you can enter the default values for the parameter and set the Persistence option to Save. The report will automatically run using those values without prompting you to select another filter value. For example, if you select a Date Range filter and enter dates for the first quarter, those dates will always be used when you run the report.

If the persistence for a filter is set to Ask, you will have the opportunity to select the values you want to use for that parameter when you run the report. Therefore, when you run a report with a Date Range filter, you can enter different starting and ending dates each time you run the report.

Another option is to set the persistence to Ask, but also enter common default values for the filter. This combination of options allows you to quickly run a report with the values you frequently use, but also creates a report that is flexible enough to be used to enter new criteria.

selected filter values above the report for the Date Range, Outline Section and Playback mode filters. Values for the Usernames filter are printed at the bottom of the report data.

Default Value column. The values in this column change, depending on the selected parameter. For instance, the default values for a date range filter would be a specific beginning date and a specific ending date. The report will always use those dates when it is run.

Create a new report or modify an existing one. Under the Filters section, click the down arrow next to (Select a parameter to add) in the

Parameters column. Select the desired parameter. Click the down arrow next to Persistence. Click Save to save the default filter values or Ask to prompt the user to enter filter values. Click the Include in Report option to display the filter values at the top or bottom of the

report. Enter the values in the Default Value column, if desired. Continue adding report filters as desired.

Chapter 6: Design New Reports

Default Values for a Date Filter

When you filter for dates, the Default Value column displays From and To textboxes where you can enter starting and ending dates for the report data. You may enter a starting or ending date only or specify both dates. Times may also be entered (e.g. 2/1/2003 10:00 AM).

When a date filter is applied, the report is limited to data that falls between, and includes, those dates. You do not have to enter both dates. Entering a From date only gathers data from that date to the present date. Conversely, entering a To date only reports on all data up to and including the entered date. Dates should be entered in the regional format set for your locale. You will be prompted if you enter an invalid date, such as 2/31/2003.

You can also add a time to the date criteria. Times can be entered in 24-hour format or the format set for your location. By default, 12:00am is the time assigned to the start date and 11:59:59pm is the default time assigned to the end date. Users can enter specific times in the From and To textboxes.

Setting the persistence to Save automatically runs the report with the default dates. Setting the persistence to Ask gives you the opportunity to enter a different date range each time you run the report.

Create a new report or modify an existing one. Add a Date Range filter to the Filters section. Click the down arrow next to Persistence and click Save to run the report with the default

dates or Ask to allow the user to enter starting and ending dates.

Click the Include in Report option to display the filter values at the top or bottom of the

report. In the Default Value column, enter a starting date in the From textbox. In the Default Value column, enter an ending date in the To textbox.

Deleted: Chapter 6: Design New Reports

Default Values for a Usernames Filter

Reports can be filtered to display information for individual users only. To filter a report for specific users, you can enter the username(s) in the Usernames list box. If you don’t know the exact username, you can use the Lookup users link to select users.

Windows authentication users should enter fully qualified usernames (including domain name). If using anonymous authentication, all user information will appear combined under the username “anonymous”.

Set Persistence for Username Values

Setting the persistence to Save automatically runs the report with the default usernames. Setting the persistence to Ask gives you the opportunity to enter other users or add more users to the list each time you run the report.

Search for Usernames

You can use the Lookup users link to open the Lookup User page and browse for usernames rather than type them in. Names you have manually entered in the Default Value column appear when you open the Lookup User page.

The Lookup User page consists of a Search pane and a Search Results pane. The options in the

Search pane allow you to search for usernames that contain or start with specific text. In addition,

you can limit the number of users found. For example, you can restrict the search to finding only

five users or expand it to find 30 users. After entering the search criteria, you can perform the

search. Performing the search without entering search parameters displays all the usernames in

the database.

The results of a search appear in the Matched User Names list box in the Search Results pane.

You can then select the usernames you want to include in the report and add them to the Selected

User Names list box.

Create a new report or modify an existing one. Add a Username filter to the Filters section. Click the down arrow next to Persistence and click Save to run the report with the default

usernames or Ask to allow the user to change the default usernames.

Click the Include in Report option to display the filter values at the top or bottom of the

report. In the Default value column, type the usernames in the Usernames list box. To search for users, click the Lookup users link. Click the down arrow next to Search for names that. Click the start with or contains option. Enter the search criteria in the textbox. To limit the search results, enter the desired number in the Search Limit textbox. Click Search. Click the checkboxes for the usernames you want to include in the report. Click Add to list. Click OK.

Default Values for an Outline Section Filter

Reports can be filtered to display information for a specific outline section (application, lesson, module or topic). You can search for an outline section using the Lookup link, which opens the Lookup Outline page with the outline of all your content listed in hierarchical order by application. You can expand and contract outline sections to display or hide subordinate levels. To filter for an outline section, you can select an entire application, a module, a lesson, or just a single topic.

You can use the Clear link to clear the currently selected values for the outline sections.

Set Persistence for Outline Section Values

Setting the persistence to Save automatically runs the report with the default outline section. Setting the persistence to Ask gives you the opportunity to select a different outline section each time you run the report.

Create a new report or modify an existing one. Add an Outline Section filter to the Filters section.

Chapter 6: Design New Reports

Click the down arrow next to Persistence and click Save to run the report with the default

outline section or Ask to allow the user to change the default outline section. In the Default Value column, click the Lookup link. Click

next to the sections you want to expand. next to the sections you want to collapse.

Click Click the desired application, module, lesson or topic. Click OK.

Default Values for a Playback Mode Filter

You can create a report that filters the data for a specific playback mode (See It!, Try It!, Know It? or Do It!) or includes all modes.

Set Persistence for Playback Mode Values

Setting the persistence to Save automatically runs the report with the default playback mode. Setting the persistence to Ask gives you the opportunity to select a different playback mode each time you run the report.

Create a new report or modify an existing one. Add a Playback mode filter to the Filters section. Click the down arrow next to Persistence and click Save to run the report with the default

playback mode or Ask to allow the user to change the default playback mode. In the Default Value column, click the down arrow next to Playback mode. Select the desired mode option.

Deleted: Chapter 6: Design New Reports

Format a Report

You can save a report with a selected format, or allow the user to choose a format when they run the report. If you set the persistence to Save, the report will always produce the same format whenever it is run. Setting the persistence to Ask gives you the opportunity to select a different format each time you run the report.

Reports can be viewed using three different formats as described below:

Format Description

Formatted Report Formatted reports are created using a style sheet,

XML Reports The XML format displays the report data using the

Tab Delimited Tab-delimited reports display all the data in columns,

Create a new report or modify an existing one. Under the Format section, click the down arrow

Select a format.

which produces an HTML output.

schema supplied with the program.

separated by tabs. In a formatted report, identical items are grouped together and only appear once. In tab-delimited report, each row contains the full data, and the headings are incorporated into the row.

Format column.

in the

Click the down arrow next to Persistence and click Save to run the report with the default

report format or Ask to allow the user to change the default report format.

Report Options

You may have tracking data for topics that have been removed from the content. Since the topics

no longer appear in the outline, the data will not be included in the report. If you want to include

the data for deleted topics in the report, select the Include deleted topics option.

Create a new report or modify an existing one.

30. Under the Options section, click the Include deleted topics that have tracking data

option.

Chapter 7: Import and Export Reports

Import Reports

Pre-existing reports can be imported into the Usage Tracking system. You import XML code by first copying the XML code from the report you want to import. The Import Report link, located on the Report List page, opens the Report Data page where you can paste the copied code. The copied XML code opens in Design Report. By default, the report uses the name and availability (per-user or global) as the original report. You can change the name or other elements as desired and save it.

The import validates the XML code to make sure that it matches the program’s report requirements. An error message appears if the XML code cannot be validated.

Once a report is imported, it is treated like any other report and can be edited or deleted.

If another user has a report that you wish to copy, they can export it, copy the XML code to a text file in Notepad, and send you the text file. You can create a new report from the text file by opening the file in Notepad, copying all the XML code, and using the Import Report link to paste the text.

Display the XML code for the report you want to import. Select the XML code you want to copy. Copy the XML code. Open the Report List page in Usage Tracking. Click the Import Report link. Right-click in the textbox and select the Paste command. Click OK. Enter a new report name in the Name textbox. Make the desired changes. Click Save.

Deleted: Chapter 6: Design New Reports

Export the Report Structure

Report creators have the option to export the XML code for the structure of a report using the Export Report button in the Design Report page. When you export a report, the XML code for the report structure appears in a textbox in the Report Data page. You can copy and paste the XML code or save the XML code as a file using the Save command from your browser’s File menu.

You can use the export feature to send a report structure to another user. After using Export Report button, copy all the XML code to the Clipboard. Then, open Notepad, paste the copied code, and save the file as a text file. You can then send the report to another user, who can open Notepad, copy the code, and use the Import Report link on the Report List page to paste the copied code and create a new report.

Open the Report List.

Click Modify Report Click Export Report. Right-click in the textbox and click the Select All command. Right-click in the textbox and click the Copy command. Click OK. Open the application where you want to paste the XML and paste it.

for the report you want to export.

Chapter 7: Import and Export Reports

INDEX

Deleted: Chapter 6: Design New Reports

Authentication mode

Forms, 13 setting, 12 Windows, 13

Average Score, 35 Breakout by mode

data columns, 36

Configuration

building the database, 11 database settings, 11 modifying, 14 setting the password, 11 setup password, 11

Criteria

filters, 27

Data columns

adding, 34 breakout by mode, 36 sorting, 36

Date range

entering a default value, 38 setting persistence, 38

Defaults values

filters, 37

Deleting

reports, 24

Details

showing, 23

Filtering

for a date range, 27 for a playback mode, 29 for a username, 28 for an outline section, 28

Filters

adding a date range filter, 38 adding a usernames filter, 38 adding an outline section filter, 39 adding to a report, 36 asking for filter values, 37 entering filter values, 27

persistence, 37 printing criteria in the report, 37

running reports with, 27

saving filter values, 37 selecting default values, 37

using criteria, 27

Format

selecting a report format, 40

selecting persistence, 40

Formatted Report, 41 Forms authentication, 13

creating an admin user, 17

Grouping

report data, 32

Groups

ordering, 33 removing from a report, 34 selecting, 32 showing the full outline, 32

sorting, 33

Know It Count, 35

Lookup

usernames, 28, 39

Main Page

opening the Report List, 22 refreshing the outline, 25

Maximum Score, 35 Microsoft .NET Framework, 7 Minimum Score, 35 Modifying

reports, 23

Options

include deleted topics, 41

Outline section

entering a default value, 39 setting persistence, 40

Pass Count, 35 Pass Percentage, 35 Persistence, 37

Playback mode

selecting defaults, 40 setting persistence, 40

Query database

reports, 22 Refreshing outlines, 25 Report List

Delete Report icon, 24

Modify Report icon, 23

opening, 22

using, 22

View Report icon, 22 Reports, 22

adding data columns, 34

adding groups, 32

adding new filters, 36

availability, 31

creating, 31 deleting, 24 details, 23 exporting, 42 filtering, 22 formatted, 29, 30, 41 global, 22 importing, 42 include deleted topics, 41 modifying, 23 naming, 31 new, 31 per-user, 22 previewing a report, 33 removing a group, 34 running date filtered reports, 27 running outline section filtered

reports, 28

running playback mode filtered

reports, 29 running usernames filtered reports, 28 samples, 22 saving, 34 saving with a new name, 24, 34 selecting a format, 29 tab-delimited format, 30, 41 using, 22 viewing, 22 XML format, 29, 41

Sample reports, 22

deleting, 24

Save as

copy report, 24, 34

Setup

saving, 14 Setup password, 11 SQL

authentication, 7

creating a database, 8

creating a login, 8

removing the owner role from the

Statistical columns

adding, 34

Tab-delimited

reports, 30, 41 Total Time, 35

Usage Tracking

reports, 22 Usage Tracking server

installation, 7 Usernames

adding default values, 38

searching for, 28, 39

setting persistence, 39

View Count, 35 View Time Average, 35

Windows authentication, 13 XML

exporting, 42

importing, 42

reports, 29, 41

Page 5: [1] Deleted Licensed User 2/15/2007 3:29:00 PM

Chapter 6: Design New Reports

Page 5: [2] Deleted Licensed User 2/15/2007 3:29:00 PM

Chapter 6: Design New Reports

Business objects USAGE TRACKING INSTALLATION GUIDE

Specifications and Main Features

Frequently Asked Questions

User Manual