NIVeriStandAdd-Ons / VeriStand-steps-for-TestStand

NI TestStand Step Types for automating NI VeriStand.
Other
8 stars 16 forks source link

[feature request]: Document/improve method to pass references to subsequences #22

Closed adchurch closed 5 years ago

adchurch commented 6 years ago

How do you share VeriStand references with a subsequence in a separate sequence file? This doesn't work without some sort of extra work to assign the correct FileGlobal in the "child" sequence to the value in the "parent" sequence.

A subsequence located in the same sequence file as the original calling sequence should not require adding or setting any additional File Globals in the subsequence. This is true even if you run the subsequence in a new thread.

A subsequence located in a separate sequence file must contain the FileGlobals.Veristand.GatewayIP variable set to the correct GatewayIP in order for certain steps to work.

As of version >7.0.0 most of the references used by the step types are actually stored in a functional global variable within the packed project library containing the run-time modules. The File Globals are still populated with .NET references so they can be used by other user step types or directly with the VeriStand .NET API.

The only File Globals still required by certain steps are FileGlobals.Veristand.GatewayIP and FileGlobals.Veristand.ProjectPath.

FileGlobals.Veristand.GatewayIP is required by RT Sequence Steps, Stimulus Profile Steps, and Logging Steps.

FileGlobals.Veristand.ProjectPath is required by Initialize VeriStand and Open Project.

This problem is described in : https://forums.ni.com/t5/NI-TestStand/Share-File-Globals-between-sequence-files/m-p/3627086"

adchurch commented 6 years ago

My previous answer was incomplete and doesn't address variables needed to configure the steps at edit-time. The SystemDefinitionPath File Global is required to configure the step types using the configuration GUIs.

This variable is necessary unless the step types are already configured or you are configuring the steps by setting the step properties directly.

There is updated documentation for the use of References and Subsequences available in the VeriStand Steps for TestStand User Manual as well as on the project's GitHub Wiki. We will include an example demonstrating the use of references and subsequences in a future release.

Wiki Page: Understanding References

adchurch commented 5 years ago

An example demonstrating the use of references with subsequences is now included with the step types.

https://github.com/NIVeriStandAdd-Ons/VeriStand-steps-for-TestStand/tree/master/Documentation/Examples/References%20and%20Subsequences