VI Setparm Output Object

The Visual Integrator (VI) Setparm output object sets parameters to use in later tasks within the same VI script. The Setparm output object expects a single row containing values to set as parameters. If the Setparm object encounters multiple rows, an error occurs.

Icon for the VI Setparm output object

The Setparm object is similar to the Iterate object, except it sets the parameters once and makes them available to subsequent tasks in the VI script instead of needing to run another task.

The Setparm object is useful for Tunnel scripts where the parameters to be set need to be calculated based on values passed into the tunnel. The first task of the Tunnel script has the Setparm object, setting parameters that are used in subsequent tasks.

The Setparm output object has Closedthree panes where you set attributes.

VI Setparm Object All Panes

You set attributes for the Setparm output object in the Closedobject attributes pane.

Example of the attributes pane for a VI Setparm output object

Attribute Description
Input

Defines the object from which the data flow arrives. Use one of the following methods to attach the Setparm output object to an input data flow object:

  • Right-click the data flow object, and click New Object after this > Output > Setparm.

  • Place the Setparm output object on the task flow, and click its Input attribute's browse button. Move the pointer to the canvas and note that a dotted-line connector is attached to the Setparm output object. Attach this connector to the data flow object.

    NOTE: The Setparm output object's Input attribute is populated with the name of the input data flow object.

Each object has an area where you can enter comments.

It is a DI best practice to enter a note for every object in a VI script. You can set a VI preference to give a warning for each object without a note. For more information, see Visual Integrator Preferences.

ClosedSetparm output object with comments

Example of a VI Setparm output object with comments

In the Closedcolumn grid, set which of the input columns become parameters.

Example of a VI Setparm output object's column grid

Attribute Description
Input Column Displays the name of each input column. This attribute is read-only.
Source Object Displays the name and object type of the source object. Double-click the Source Object for a column to change the task flow focus to that object.
Parameter

Defines which of the input columns become parameters in this script. Each input column with a Parameter check mark is listed in the ClosedParameters sub-tab.

Example of Parameters in the Parameters sub-tab for a VI Setparm output object