sprockit.Property

[ v1.3 ] [ v1.4 ] [ v1.5 ] [ Back to Sprockit home page ]

This table contains properties (configuration options) and associated values used to control aspects of Sprockit's behaviour.

Column name1) Column type Description Notes
PK PropertyName NVARCHAR(128) Unique property identifier.
PropertyValue NVARCHAR(MAX) The value currently configured for this property.
DataType NVARCHAR(128) The property's data type.
Description NVARCHAR(512) A description of the property.

Relationships with integrity enforced by a foreign key constraint have identifiers prefixed with FK; others are prefixed RL.

Click here to view the data model diagram.

Attributes
(in this table)
Referenced table Referenced attributes
(in referenced table)
(None).
Relationship Attributes
(in referencing table)
Referenced attributes
(in this table)
(None).

The following properties are available:

Since Sprockit v1.4. You can prevent batches from over-running (and causing subsequent batches to fail to start) by specifiying a batch timeout, in minutes, that will cause the process manager (if still running) to exit before the next scheduled start. By default this is set to 1400 – this is an appropriate value for an ETL batch that is scheduled to start every 24 hours.

If you wish batches to have no effective timeout, set this property to a high number. 32767 is the SMALLINT type maximum value and corresponds to a timeout period exceeding three weeks.

Sprockit can optionally be configured to perform index maintenance tasks. This option, expressed as a percentage, indicates the maximum fragmentation permitted in an index by default before it requires maintenance.

Sprockit can optionally be configured to perform index maintenance tasks. This option controls Sprockit's default index maintenance behaviour.

Since Sprockit v1.4. Sprockit trims the execution activity log by removing entries over a certain age at each execution. This is normally controlled by the LogRetentionPeriod property, but this log can grow more quickly than others so you may wish to trim it more frequently (particularly if you have disabled general log trimming to enable support for process lineage tracking)).

This option, if given a value less than that of LogRetentionPeriod, specifies that age in days.

Sprockit can optionally be configured to perform index maintenance tasks. This option controls how much index maintenance activity is reported in sprockit.IndexMaintenanceTask.

Sprockit trims its own log tables by removing entries over a certain age at each execution. This option specifies that age in days.

The option can be disabled (no logs trimmed) by setting its value to -1. This is particularly important if you rely on sprockit.Execution entries to track ETL process lineage.

The option can be overridden for sprockit.ExecutionActivity using ExecutionActivityRetentionPeriod.

The maximum number of process handlers permitted to run at the same time.

Typically you will find that end-to-end processing time decreases as this option's value increases, but only up to a point – a value too low will fail to make use of available resources, while a value too high will cause individual processes to become starved and slow down. You should tune this value to make best use of your system's resources.

The name of the SQL Agent Job which runs the process manager.

You can change the name of the agent job if you wish, but you should also update this property value to match. (The property is used by utility SP sprockit.usp__StopRunningBatch to find and stop the process manager job, and used at upgrade to determine whether the job already exists).

Sprockit's process manager runs in an infinite loop as long as processes are running. At each iteration, the process manager:

  • assesses handler capacity and demand, and adds a new handler if indicated;
  • logs handlers' current activity;
  • waits for a number of seconds.

The number of seconds it waits before entering the next iteration is specified by this property.

The rolling average batch count indicates the number of (most recent, successful) executions to be used by Sprockit when calculating a process's average duration (recorded in sprockit.Process.[AvgDuration]).

Indicates the version of Sprockit currently installed.


Page generated from database metadata by DbScout.


1)
Columns with names in bold are non-nullable; columns with underlined names are participants in the table's primary key.