Base Subproperties
- Updated2025-07-21
- 3 minute(s) read
Base Subproperties
The Base property contains subproperties that specify functionality common to all plug-ins. The process model uses the subproperties of the Base property to determine how to invoke plug-in entry points and other aspects of plug-in operation.
The Base property includes the following subproperties. The data type appears in parentheses.
- Enabled (Boolean)—Specifies whether the model invokes the instance of the plug-in at run time.
- DisplayNameExpression (Expression)—An expression that specifies the name to display in the Result Processing dialog box to identify the instance of the plug-in, such as "<Company Name> Production Database" , including the quotation marks. The value is an expression so that the default value the plug-in defines can refer to localized text using the ResStr expression function. You can edit the text in the Output Name column of the Result Processing dialog box.
- NewThread (Boolean)—Specifies whether the plug-in performs some operations in a separate thread.
- UseDefaultNewThreadImplementation (Boolean)—Specifies whether the process model automatically calls the Model Plugin – UUT Done and Model Plugin – Batch Done entry points in a new thread when the NewThread property is True . Set this property to False if the plug-in provides its own implementation for processing in a new thread when the NewThread property is True .
- OnTheFlyDisablesNewThread (Boolean)—Specifies that the value of the NewThread property is implicitly considered False when the ProcessOnTheFly property is True .
- CompleteBeforeNextUUT (Boolean)—Specifies whether the ModelSupport.seq file waits for the Post UUT thread of the process model plug-in to complete before calling any further entry points for the current execution except for the Post UUT entry points of other result processors.
- ProcessOnTheFly (Boolean)—Specifies whether the process model calls the Model Plugin – OnTheFly Step Results entry point.
- CanProcessOfflineOnTheFlyResults (Boolean)—Indicates whether the plug-in can process an offline results file written on-the-fly. Set this property to False for plug-ins that do not use the OnTheFly Step Results entry point or that access the Step or Context parameters within that entry point. The entry point must not access the Step or Context parameters because TestStand does not pass any data to these parameters when processing data from an offline results file.
- CanProcessOfflineResultsTree (Boolean)—Indicates whether the plug-in can process an offline results file that was not written on-the-fly. A value of True indicates that the UUT Done and Model Plugin – Post UUT entry points completely process the results without requiring a call to the OnTheFly Step Results entry point.
- OptionsDescriptionExpression (Expression)—The result of the expression evaluation is the text you want to display to summarize the option settings in a configuration dialog box. Use the ModelPlugin prefix to access the properties of the plug-in instance in the expression. For example, you could use the following expression to display the path of a plug-in-specific output directory: "My plug-in stores its output files at: " + ModelPlugin.PluginSpecific.Options.MyPluginOutputPath
- SequenceFileName (String)—The process model sets this property to the filename of the sequence file that implements the instance of the plug-in. The filename is relative to the enclosing ModelPlugins directory.
- IconName (String)—Set this property to the name of an icon that represents the instance of the plug-in. The leftmost column of the Result Processing dialog box displays this icon. The icon name must be a valid argument to the Images.FindImage method.
- GUID (String)—A string that uniquely identifies the instance of the plug-in.
- AlwaysInitialize (Boolean)—If this property is True , the process model calls the Model Plugin – Initialize entry point and the ModelPluginOptions callback for the plug-in even when the Enabled property is False . The entry point and callback can set the Enabled property to True . This option adds overhead for a disabled plug-in instance because the process model must load the plug-in sequence file at run time.
- RequiresBatchControllerAndSocketSynchronization (Boolean)—If this property is True , the Batch process model allows the plug-in instance to perform controller and socket synchronization between the Model Plugin – Batch Start and Model Plugin – UUT Start entry points and between the Batch Done and UUT Done entry points. This property is True by default. If you do not require controller and socket synchronization, setting this property to False can slightly improve performance when executing the Batch process model.
- RunOrder (Number)—If the RunOrder properties of two plug-in instances are not equal, the process model invokes entry points on the plug-in with the lower RunOrder value first.
- RuntimeVariables (NI_ModelPluginRuntimeVariables)—Variables the process model updates to control and indicate the execution state of the instance of the plug-in.
- AutoAddToConfigurations (Boolean)—Specifies whether TestStand automatically adds an instance of a new plug-in to existing configurations. Refer to Automatically Adding or Removing a Plug-In File to or from Configurations for more information.