Tracking Usage

You can track, query, print, export, and archive your organization's West km usage data. To access West km usage data for your organization, complete the following steps:

1. Open Internet Explorer and go to [hostname]/km/pldefault.aspx, where [hostname] is the name by which your West km server is known on your network.
2. Point to the Setup link, and then click Usage Reporting.

Querying Usage Data
Exporting Usage Data
Archiving Usage Data
Reporting on Administrative Changes
Turning Usage Reporting On and Off
Usage Transactions

Querying Usage Data

To query your usage data, click the report you want to view under Reports in the left frame of the Usage Reporting page, for example, Detailed Report. Then enter your criteria in the text boxes at the top of the page and click GO. The transactions that match your criteria are displayed in the usage reporting table.

• For the document number and West km client ID criteria, transactions whose values start with the letters you type will be found.
• For network ID, custom user name, and name criteria, transactions whose values contain the letters you type will be found.
• For the date criteria, click the Calendar icon , click a date, and click OK.
• If you select the Cost Recovery check box, transactions that are most pertinent to cost recovery purposes are retrieved. Transactions designated for cost recovery purposes are indicated in the usage transactions table with a Y in the Cost Recovery Y/N column.
• If you choose an option from the Type of Usage drop-down list, transactions that apply only to a particular West km module (i.e., litigation, transactions) are retrieved.

To retrieve all usage transactions, clear any values in the text boxes and click GO.

To print the usage transactions you have retrieved, click Print Report.

Exporting Usage Data

You can export data for the retrieved usage transactions to a file of comma-separated values. You can then compile that data in another program, such as Microsoft Excel, to create customized usage reports for your organization.

To export usage data to a file,

1. Click Export Report in the right frame of a displayed usage report.
2. In the File Download dialog box that is displayed, click Save.
3. In the Save As dialog box, navigate to the folder where you want to save the file, type a file name, and click Save.
4. In the Download Complete dialog box (if displayed), click Close.

The usage data that is exported for the Detailed Report includes the following:

• Document number
• West km client ID (for billing allocation)
• User's last name
• User's first name
• User's Westlaw password (numeric portion only)
• Transaction
• Transaction description
• Report units
• Date
• Time
• Library groups searched (for transactions involving search)
• Network ID or custom user name (depending on your authentication method)
• Domain
• West km session ID (used for troubleshooting)
• Search transaction ID (used for error reporting)
• Query (for transactions involving KeyCite and search)

The usage data that is exported for the other reports corresponds to the data that is displayed on-screen.

If you intend to compile the data in Microsoft Excel, you can import the data in two ways:

• To open the data file and convert it automatically, use the Open command in Excel (open the File menu and click Open).
• To open the data file using the Text Import Wizard, use the Import Data command in Excel (open the Data menu, click Import External Data, and click Import Data). The wizard provides additional flexibility and options before converting the file. For example, you can choose not to import (skip) columns you don’t need.

Note: The data files are delimited with commas.

If you would like assistance in compiling your organization's usage data, contact your West km representative.

[top of page]

Archiving Usage Data

To purge usage data from the West km system and save it to another location,

1. Click Archive Usage under Tasks in the left frame of the Usage Reporting page.

2. On the Archive Usage page, enter a date in the Date End text box. To enter a date, click the Calendar icon , click a date, and click OK. The date you enter, along with the value in the Date Start text box, creates a date range of data to be archived.

   The Date Start reflects the oldest usage data and cannot be modified.

3. To retrieve the usage data you want to archive, click GO.

4. Click Create Archive.

5. At the warning message, click OK.

6. In the File Download dialog box that is displayed, click Save.

7. In the Save As dialog box, navigate to the folder where you want to save the file, type a new file name if you want to change the name, and click Save.

8. In the Download Complete dialog box (if displayed), click Close.

For back-up purposes, a copy of the archive file is also saved on the West km delivery server from which the data was archived. It is saved in the Reports subfolder of the installation folder, e.g., C:\Program Files\Westkm\Reports.

To view the archive history, click Admin Usage in the left frame of the Usage Reporting page, select Archiving from the Type of Usage drop-down list, and run the report.

[top of page]

Reporting on Administrative Changes

You can track, print, and export the changes that have been made to the system by your organization's West km administrators. Data includes the name of the person who made the change, the date, and a detailed description of the change.

To access the administrator usage reports, complete these steps:

1. Click the Setup link, and then choose Usage Reporting.
2. Click Admin Usage in the left frame.
3. Enter your criteria in the text boxes at the top of the Admin Usage page.
   • For the date criteria, click the Calendar icon, click a date, and click OK.
   • If you select an option other than All from the Type of Usage and Specific Usage drop-down lists, administrative changes applying to those categories are retrieved. For a description of the usage types, see the "Usage Types for Administrative Changes" table below.
4. Click Search. The administrative changes that match your criteria are displayed in the admin usage table.

To retrieve all changes, clear any values in the text boxes and click Search.

To print the list of changes you have retrieved, click Print Report.

To export data the data you have retrieved to a file of comma-separated values, click Export Report.

Usage Types for Administrative Changes

Type of Usage	Description
Administer Fields	A field defined in the vetting toolkit from your DMS is added, changed, or deleted.
Vetting Display	The display of fields in the vetting toolkit is changed.
Administer Rule Groups	A rule group is added, edited, or deleted, or the global exclusionary rule group has been applied or removed from a rule group in the vetting toolkit.
Vetting Rules	Any of the following changes to a vetting rule in the vetting toolkit: a vetting rule is added, edited, or deleted the global date restriction is changed the global date restriction is applied or removed
Vetting Docs	A document is excluded from the vetting collection or an excluded document is restored from the vetting collection in the vetting toolkit.
DMS Connection	A data source connection is added, changed, or deleted.
Indexing Options	Indexing of a document collection is manually launched, or a document collection is added or edited.
Indexing Server	Any of the following changes to the setup of the indexing server: the temp directory is updated a server is added or deleted a service window is added, edited, or deleted an indexing component is suspended the "process by component" option is changed for an indexing component
Upload Files	A file is added, removed, or uploaded in the West km Web-hosted application.
Professionals	A West km professional profile is added or edited, or the list of professionals is exported.
Archiving	Usage data is purged from the West km system and saved to another location.
System Options	A value is changed for a system option.
Update Versions	The product key is changed or the version of a West km software component is changed due to an upgrade.
Hidden Options	A value is changed for a system option that is accessible only by West km Technical Support.

[top of page]

Turning Usage Reporting On and Off

By default, usage data is logged to the West km database. You can turn usage reporting off or on with the Record Usage Records setting. If this setting is selected, usage reporting is on. If not selected, usage reporting is off.

The Record Usage Records setting is located in the administrative tool at System Options, User Interface Display Settings in the General Settings section.

[top of page]

Usage Transactions

The following types of transactions are tracked in the table on the Usage Reporting page. A transaction is tracked for each individual activity performed.

Usage Transaction	Explanation	Cost Recovery
		Y/N	Transaction Desc
View Document
Load Copy of Document
Print Document/List
E-Mail Document/List
Litigation Search
kmSearchMIIMTask	On the Litigation tab, a document is deleted from a search result	N	West km Information Manager Update - Refresh Search Result
kmSearchMIRS	In the West km interface, the user re-sorts the result list for a currently displayed search result	N	West km Search - Resort List
kmViewResultListFederatedWL	In the WestlawNext interface, after the user performs a full-text search on both West km documents and Westlaw documents, the West km results are viewed	N	West km Federated Litigation Search - Westlaw
Transactions Search
View Profile/Summary
Limits and Locate
kmSearchLimitsMI	In the West km interface, the user restricts his or her West km search results using document metadata	N	West km Search Limits - West km
kmSearchLocateMI	In the West km interface, the user restricts his or her West km search results by searching within a search	N	West km Search Locate - West km

The Report Units column is displayed in the usage reporting table and is contained in exported reports. This column indicates the number of countable transactions at the document level. For example, if the transaction kmPrintLitigationDocsMI or kmPrintLitigationDocsWL indicates a unit number of 5, then five documents were printed. If kmInsertFlags indicates a unit number of 1, then KeyCite status flags were inserted in one word-processing document.

[top of page]