Reporting on Usage
You can query, print, and export your organization's West km usage data. To access West km usage data for your organization,
- Click Setup.
- Click the Usage Reporting tab.
- In the left frame, click Usage Reports.
Querying Usage Data
Exporting Usage Data
Reporting on Administrative Changes
Turning Usage Reporting On and Off
Usage Transactions
Querying Usage Data
To query your usage data, from the Report Type list, select the report you want to view, e.g., Detailed Report. Then, in the Usage Search Criteria section, enter your search criteria and click View Report. The usage data for the report you selected are displayed on the Usage Reports page.
- If you select an option from the Type of Usage list, transactions that apply only to a particular West km module (i.e., litigation, transactions) are retrieved.
- If you select the Cost Recovery Only check box, transactions that are most pertinent to cost recovery purposes are retrieved. Transactions designated for cost recovery purposesOK are indicated in the usage transactions table with a Yes in the Cost Recovery column.
- For Detailed Reports where the document number and West km client ID criteria is entered, transactions whose values start with the letters you type will be found.
- For Detailed Reports where the name and network ID criteria is entered, transactions whose values contain the letters you type will be found.
- For the date criteria, click in the Begin Date and End Date boxes and select a date.
To retrieve all usage transactions, clear any values in the Usage Search Criteria section and click View Report.
To print the usage transactions you have retrieved, click the Print icon.
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, click Export at the top of a displayed usage report and follow the steps for your browser type to download and save the document.
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
- Transaction
- Transaction description
- Source (e.g. West km or WestlawNext)
- 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 (on the File menu, click Open).
- To open the data file using the Text Import Wizard, use the Import Data command in Excel (on the Data menu, click Import External Data, and then 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.
Reporting on Administrative Changes
You can query, 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,
- On the Usage Reports page, in the Report Type list, click Admin Usage.
In the Usage Search Criteria section, enter your criteria.
- For the Type of Usage and Subtype lists, if you select an option other than All, administrative changes applying to those usage types are retrieved. For descriptions of the usage types, see the Usage Types for Administrative Changes table below.
- For the date criteria, click in the Begin Date and End Date boxes and select a date.
- Click View Report.
The administrative changes that match your criteria are displayed.
To retrieve all changes, clear any values in the Usage Search Criteria section and click View Report.
To print the list of changes you have retrieved, click the Print icon.
To export data the data you have retrieved to a file of comma-separated values, click Export.
|
Type of Usage |
Description |
|
Archiving |
Usage data is purged from the West km system and saved to another location. |
|
Data Source Management |
A data source connection is added, changed, or deleted. |
|
Hidden Options |
A value is changed for a system option that is accessible only by West km Technical Support. |
|
Indexing |
Document indexing is scheduled; index flags set; or a document collection is added, edited, or deleted. |
|
Indexing Server |
Any of the following changes to the setup of the indexing server:
|
|
Manage Vetting Groups |
A vetting group is added, edited, or deleted. |
|
Professionals |
A West km professional profile or group is added, edited, or removed; or the list of professionals is exported. |
|
System Settings |
A value is changed for a system setting. |
|
Update Versions |
The product key is changed or the version of a West km software component is changed due to an upgrade. |
|
Vetting Display |
The display of fields in the vetting toolkit is changed. |
|
Vetting Documents |
One or all documents excluded from the vetting collection or excluded documents are restored from the vetting collection in the vetting toolkit. |
|
Vetting Rules |
Any of the following changes to a vetting rule in the vetting toolkit:
|
|
Vetting Toolkit Configuration |
A field defined in the vetting toolkit from your document management system is added, changed, or deleted. |
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. 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 kmPrintLitigationDocuments 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.
Usage Transaction |
Explanation |
Cost Recovery |
|
|
Y/N |
Transaction Desc |
||
|
View Document |
|||
|
Load Copy of Document |
|||
|
Print Document/List |
|||
|
E-Mail Document/List |
|||
General Search |
|||
|
kmLitigationAndTransactionsSearch |
In the West km interface, the user runs a search across both Litigation and Transactions content |
Y |
West km Search |
|
kmClauseSearchLocateExt |
From an external client, the user restricts his or her Clause search results by searching within a search |
N |
West km Clause Search Locate - External Client |
|
kmFilterClauseSearchResultsExt |
From an external client, the user restricts his or her Clause search results using document metadata |
N |
West km Clause Search Limits - External Client |
|
kmDefinedTermLocateExt |
From an external client, the user restricts his or her Defined Term search results by searching within a search |
N |
West km Defined Term Search Locate - External Client |
|
kmFilterDefinedTermSearchResultsExt |
From an external client, the user restricts his or her Defined Term search results using document metadata |
N |
West km Defined Term Search Limits - External Client |
|
Other Administrative Transactions |
|||
|
EditVettingDisplay |
Change Vetting Display |
N |
Change Vetting Display |
|
TestVettingRule |
Test Vetting Rule |
N |
Test Vetting Rule |
|
DeleteVettingRule |
Delete Vetting Rule |
N |
Delete Vetting Rule |
|
VettingIncludeDoc |
Vetting - Include Document |
N |
Vetting - Include Document |
|
VettingExcludeDoc |
Vetting - Exclude Document |
N |
Vetting - Exclude Document |
|
EditVettingRuleGroups |
Edit Vetting Group |
N |
Edit Vetting Group |
|
EditVettingField |
Edit Vetting Field |
N |
Edit Vetting Field |
|
DeleteVettingField |
Delete Vetting Field |
N |
Delete Vetting Field |
|
DeleteVettingRuleGroups |
Delete Vetting Group |
N |
Delete Vetting Group |
|
ChangeGlobalDateBoolean |
Apply or Remove Global Date Restriction |
N |
Apply or Remove Global Date Restriction |
|
GlobalDateRestrictionChange |
Change Global Date Restriction |
N |
Change Global Date Restriction |
|
AddVettingRuleGroups |
Add Vetting Group |
N |
Add Vetting Group |
|
AddVettingField |
Add Vetting Field |
N |
Add Vetting Field |
|
AddVettingRule |
Add Vetting Rule |
N |
Add Vetting Rule |
|
EditVettingRule |
Edit Vetting Rule |
N |
Edit Vetting Rule |
|
DeleteUser |
Delete User |
N |
Delete User |
|
DeleteGroup |
Delete Group |
N |
Delete Group |
|
EditGroupPermissions |
Edit Group |
N |
Edit Group |
|
ExportUsers |
Export Usere |
N |
Export User |
|
EditUserPermissions |
Edit User |
N |
Edit User |
|
AddUser |
Add User |
N |
Add User |
|
AddUsersFromActiveDirectory |
Add Users from Active Directory |
N |
Add Users from Active Directory |
|
AddGroup |
Add Group |
N |
Add Group |
|
UpdatedVersion |
Upgrade |
N |
Upgrade |
|
ChangeProductKey |
Change Product Key |
N |
Change Product Key |
|
ChangeHiddenOptions |
Change Hidden Options |
N |
Change Hidden Options |
|
ChangeSystemOptions |
Change System Settings |
N |
Change System Settings |
|
RemoveIndexingServer |
Remove Indexing Server |
N |
Remove Indexing Server |
|
AddIndexingServer |
Add Indexing Server |
N |
Add Indexing Server |
|
IndexingProcessByComponent |
Process By Component |
N |
Process By Component |
|
SuspendIndexingComponent |
Suspend Component |
N |
Suspend Component |
|
AddServiceWindow |
Add Service Window |
N |
Add Service Window |
|
EditServiceWindow |
Edit Service Window |
N |
Edit Service Window |
|
EditTempIndexingDirectory |
Edit Temp Directory |
N |
Edit Temp Directory |
|
EditCollection |
Edit Collection |
N |
Edit Collection |
|
DeleteCollection |
Delete Collection |
N |
Delete Collection |
|
DeleteServiceWindow |
Delete Service Window |
N |
Delete Service Window |
|
AddCollection |
Add Collection |
N |
Add Collection |
|
EditConnection |
Edit Connection |
N |
Edit Connection |
|
DeleteConnection |
Delete Connection |
N |
Delete Connection |
|
AddConnection |
Add Connection |
N |
Add Connection |
|
ArchiveUsage |
Archive Usage |
N |
Archive Usage |
|
ScheduleBulkJob |
Schedule Bulk Job |
N |
Schedule Bulk Job |
|
ScheduleIncrementalJob |
Schedule Incremental Job |
N |
Schedule Incremental Job |
|
SetPriorityFlag |
Set Priority Flag |
N |
Set Priority Flag |
|
SetProfileMetaDataFlag |
Set Profile MetaData Flag |
N |
Set Profile MetaData Flag |
|
SetCiteRecognitionFlag |
Set Cite Recognition Flag |
N |
Set Cite Recognition Flag |
|
SetClassificationFlag |
Set Classification Flag |
N |
Set Classification Flag |
|
SetLitigationAnalysisFlag |
Set Litigation Analysis Flag |
N |
Set Litigation Analysis Flag |
|
SetLitigationStorageFlag |
Set Litigation Storage Flag |
N |
Set Litigation Storage Flag |
|
SetTransactionalAnalysisFlag |
Set Transactional Analysis Flag |
N |
Set Transactional Analysis Flag |
|
SetTransactionalStorageFlag |
Set Transactional Storage Flag |
N |
Set Transactional Storage Flag |
|
ClearForcedJobs |
Clear Forced Jobs |
N |
Clear Forced Jobs |
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 kmPrintLitigationDocuments 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.
|
|