Sprockit utilities

Sprockit provides a number of utilities to help you manage your Sprockit installation. Sprockit utilities are stored procedures with names that begin sprockit.usp__… (double underscore). These appear at the top of the list of sprockit SPs in SSMS Object Explorer.

sprockit.usp__LogExecutionEvent allows you to perform custom logging by writing ad hoc events into Sprockit's event log.

More information is available in Custom logging with Sprockit.

sprockit.usp__Rewind allows you to set Sprockit processing to start at an arbitrary process of your choice. The SP requires a single parameter: you must provide either a process ID or an unambiguous process name pattern.

More information is available in Restart and rewind.

sprockit.usp__ConfigureProcess takes a process configuration, specified as a piece of XML, and applies it in sprockit.Process and sprockit.Resource.

More information is available in Configuring processes in Sprockit.

sprockit.usp__ScriptProcessConfiguration generates the XML that would be required by sprockit.usp__ConfigureProcess to configure an existing process. This can be useful for inspecting existing configurations or generating templates for new ones.

The SP requires a single parameter: you must provide either a process ID or an unambiguous process name pattern.

sprockit.usp__CheckProcessConfiguration inspects all configured processes for possible irregularities, typos, configuration omissions etc.

For more readable results, set your query output results to text before running the procedure.

sprockit.usp__LogExecutionProperty allows you to perform custom logging by adding your own values into a process's existing Sprockit execution log record.

More information is available in Custom logging with Sprockit.

sprockit.usp__StopRunningBatch brings a running batch to a halt by stopping the process manager and all running handlers. The process manager is stopped first, to prevent it from starting new handlers as old ones are stopped.

If you need to stop a running batch, use this SP. This should rarely be necessary – if you need routinely to ensure that an over-running batch is stopped before the next one is scheduled to start, you can do this automatically by setting Sprockit's BatchTimeout property to an appropriate value.

sprockit.usp__UninstallSprockit removes all Sprockit components from a database. As a safety measure it requires you to specify the name of the database from which you wish to remove Sprockit, e.g.:

EXEC SprockitDb.[sprockit].[usp__UninstallSprockit] @dbName = 'SprockitDb'

You may never need to uninstall a working instance of Sprockit, but this SP can be useful to clean up if you accidentally install Sprockit in the wrong database location.