StackHash Command Line Plugin

Reports products, events, cab information and debug script results to a command line (batch file, script or program).

To configure the plugin specify a command line to run for the events that you're interested in handling. The possible events are: Product Added, Product Updated, Event Added, Event Updated, Event Note Added, Cab Added, Cab Updated, Cab Note Added and Debug Script Executed. The command line should be the full path to the script or program you wish to run.

Command line parameters passed to each script are listed below.

Note that the plugin runs with permissions from the StackHash Service account. By default this is NETWORK SERVICE.

Only report manually submitted events: Enter True to only report events on demand. To do this, right-click an event and choose Send event to Plugin -> StackHash Command Line Plugin. Enter False to automatically report new events during synchronization.

Hit threshold for automatically reporting events: Prevents events from being automatically reported unless the event has this number of hits. Enter 0 to report all events. Note this setting only applies to events added or updated during synchronization. Manually submitted events are always reported.

Command Line Parameter Reference

The first parameter always indicates the type of report. This is set to Automatic when the event is being reported to the plugin as a result of synchronizing with WinQual. If the report was initiated by the user the report type is set to Manual.

A Manual report can be triggers by Tools -> Synchronize with Plugins (to report all current data to one or more plugins: note that this triggers Product Added, Event Added and Cab Added scripts), or by right-clicking an event choosing Send event to Plugin (to report a single event).

When handling Event Added and Event Updated note that the Event Id is not guaranteed to be unique. To identify an event correctly use the Event Id AND the Event Type Name together. Also note that the Event Id may be a negative number.

Product Added

Called when a new WinQual product mapping is added.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version

Product Updated

Called when a WinQual product mapping is updated.

Parameters:

1 Automatic
2 Product Id
3 Product Name
4 Product Version

Event Added

Called when an event is added.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Bug Reference
8 Plugin Bug Reference
9 Total Hits
10 Signature: applicationName
11 Signature: applicationVersion
12 Signature: applicationTimeStamp
13 Signature: moduleName
14 Signature: moduleVersion
15 Signature: moduleTimeStamp
16 Signature: exceptionCode
17 Signature: offset

The Plugin Bug Reference may be set by returning an exit code greater than 0 from the Event Added script. If the exit code is 0 or negative then the Plugin Bug Reference is not set.

Event Updated

Called when an event is updated.

Parameters:

1 Automatic
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Bug Reference
8 Plugin Bug Reference
9 Total Hits
10 Signature: applicationName
11 Signature: applicationVersion
12 Signature: applicationTimeStamp
13 Signature: moduleName
14 Signature: moduleVersion
15 Signature: moduleTimeStamp
16 Signature: exceptionCode
17 Signature: offset

The Plugin Bug Reference may be updated by returning an exit code greater than 0 from the Event Updated script. If the exit code is 0 or negative then the Plugin Bug Reference is not updated.

Event Note Added

Called when a note is added to an event.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Plugin Bug Reference
8 Note source
9 Note user
10 Note time
11 Path to file containing the contents of the note. This is a temporary file that is deleted once the script exits.

Cab Added

Called when a cab is added.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Plugin Bug Reference
8 Cab Id
9 Cab size (bytes)
10 Cab downloaded (true/false)
11 Cab purged (true/false)
12 StackHash Analysis: .NET Version
13 StackHash Analysis: Machine Architecture
14 StackHash Analysis: OS Version
15 StackHash Analysis: Process Uptime
16 StackHash Analysis: System Uptime

Cab Updated

Called when a cab is updated.

Parameters:

1 Automatic
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Plugin Bug Reference
8 Cab Id
9 Cab size (bytes)
10 Cab downloaded (true/false)
11 Cab purged (true/false)
12 StackHash Analysis: .NET Version
13 StackHash Analysis: Machine Architecture
14 StackHash Analysis: OS Version
15 StackHash Analysis: Process Uptime
16 StackHash Analysis: System Uptime

Cab Note Added

Called when a note is added to a cab.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Plugin Bug Reference
8 Cab Id
9 Note source
10 Note user
11 Note time
12 Path to file containing the contents of the note. This is a temporary file that is deleted once the script exits.

Debug Script Executed

Called when a debugger script has been executed.

Parameters:

1 Report type: Automatic or Manual
2 Product Id
3 Product Name
4 Product Version
5 Event Id
6 Event Type Name
7 Plugin Bug Reference
8 Cab Id
9 Script name
10 Script run date/time
11 Path to file containing the debugger script results. This is a temporary file that is deleted once the script exits.
StackHash | © Copyright Cucku, Inc and the stackhash.codeplex.com contributors.