2.8. VCollab Node

This node is located in the Analysis folder in the Modules pane.

This node is only available on Windows systems. It is used to convert a certain set of supported CAE file formats to the VCollab CAX file format. The node calls the VMoveCAEBatch.exe executable and appends the arguments provided in the Additional arguments tab.

The VMoveCAEBatch.exe command line syntax is:

VMoveCAEBatch.exe [option=value] <model_file> [results_file] <cax_file>

The VMoveCAEBatch.exe executable is located using the following heuristics:

  • VMOVE_EXECUTABLE environment variable

  • VCollab VMoveCAEBatch executable application setting

  • VCollab native default installation location (%PROGRAMFILES%\VCollab\VMoveCAE[32;64]\VMoveCAEBatch.exe)

Additional Arguments Tab

Defines the arguments to be passed to the VMoveCAEBatch.exe process. This tab is a text field where you can enter the arguments.

For example, entering my_file.odb my_reduced_file.cax calls VMoveCAEBatch.exe my_file.odb my_reduced_file.cax and converts my_file.odb to my_reduced_file.cax.

Input Files Tab

Displays a list of input files. The working file name can be relative or absolute.

PropertyDescription
  Adds an input file to the list.
  Removes the selected input file.
Input file path/slot nameSets the location of the input file.
  • Existing File: Uses an input file path from an existing file. After selecting this option, define the file path.

  • From Slot: Uses an input slot name to point to the input file.

A copy of the file is stored in the working directory.

Output Files Tab

Displays a list of all output files.

PropertyDescription
  Adds an output file to the list.
  Removes the selected output file.
Working file name

Defines the working file name. The working file name can be relative or absolute. If the file exists only once in the design directory, only the file name is defined. If the file exists in several subdirectories of the design directory, you should define the relative path.

You can use RegExes as working file names. To do so, select RegEx from the menu to the left of the field. When selected, the archival option is selected for all files that comply with the regular expression.

Wildcards are not regular expressions. The following is a list of the most important conversions for wildcards and some examples for RegExes.

  • Wildcard conversion:

    * → .*

    ? → .

    . → \.

  • all files with special ending (*.out): .*\.out

  • all files with special prefix (prefix.*): prefix\.*

  • all files with special ending and prefix (prefix*.out): prefix.*\.out

  • file names with numbers (prefix<number>.out): prefix[0-9]?\.out

  • file names with different endings: output\.(foo|bar)

Importance

Defines the importance of files using the following options.

  • Optional: The existence of this output file is optional and has no effect on the success of the node.

  • Required: The existence of this output file after the process finished is required or the node fails.

  • Wait: The process node succeeds as soon as all of the indicated output files are available.

  • Wait, indicates failure: Once one of these output files exists, the process node fails.

You must specify the maximum runtime in the additional options when using the Wait and Wait, indicates failure settings. These settings wait at most until the expiration of this value, even if the (executed) process has already finished.

By default, conditions are checked every one second. The interval of the check can be changed in the configuration settings.

If only one of Wait or Wait, indicates failure is set, but the associated files are not created, the process node waits until the maximum runtime.

ArchivalSets the type of file archiving.
  • Default

    File remains in working directory.

  • Compressed

    File is stored compressed in working directory.

  • Remove

    File is removed.

Slot nameBy default, the slot name is the file name but it can be changed manually.

Environment Tab

Displays a list of all environmental variables with their values.

PropertyDescription
  Adds an environment variable to the list.
  Removes the selected environment variable. The override for a default environment variable is removed or the variable entry is removed entirely if it does not exist in the default environment.
Default environmentSets the conditions for the default environment variables.
  • Merge: Keeps the default environment variables and adds new user-defined variables. In a merged environment the color of the table entries represents whether the variable has its default value (faded text) or has a custom value (normal text).

  • Replace: Uses only user-defined variables and some special variables for optiSLang 3 compatibility.

Prepend project directory and its bin subdirectory to PATHWhen selected, two directories are inserted in front of the PATH variable. For example, if your project path is C:\mypath, the variable PATH will be PATH = C:\mypath; C:\mypath\bin; C:\Windows instead of PATH = C:\Windows

Execution Settings Tab

PropertyDescription
Designs per process

When selected, activates the launch of a single process for multiple designs. The process node creates a file with designs to be calculated and provides the following environment variables for the executing script:

  • OSL_DESIGNS_BASE: Base directory to the design working directories.

  • OSL_DESIGNS_LIST: File path with the listing of design folders to calculate in the current process call.

If this option is enabled, the environment variables OSL_DESIGN_NO, OSL_DESIGN_NAME, and OSL_DESIGN_DIR are not available.

An example implementation for the script in process node:

REM This is a Windows batch script (*.bat)
copy ..\..\..\py\run_multi_cpfunc.py
python run_multi_cpfunc.py %OSL_DESIGNS_BASE% %OSL_DESIGNS_LIST%

An example code snippet to process the designs:

# This is the Python script "run_multi_cpfunc.py"
...
basedir=normpath(sys.argv[1]) # base directory
listfile=normpath(sys.argv[2]) # path of the file containing the listing of design folders
for folder in listfilereader(listfile):
    pd=myreader(join(basedir,folder,'inp_cpfunc.txt')) # pd stands for parameter dictionary
    results={'Y': 0.5*pd['X1']+pd['X2']+0.5*pd['X1']*pd['X2']+5*sin(pd['X3'])+0.2*pd['X4']+0.1*pd['X5']}
    mywriter(join(basedir,folder,'out_cpfunc.txt'),results)
...
Ignore process exit codeWhen selected, ignores the process exit code, avoiding problems if the code is not evaluable.
Distinct working directoryWhen selected, creates an extra directory in the design directories for calculations.
Execute through command shellWhen selected, interprets the command line or the script as a shell command. When cleared, the process is started at the operating system level.
Note:
  • The option is enabled by default, and is the behavior up to version 7.0.

  • The redirection of the output to files with the > operator is only possible with shell execution.

  • If the shell itself causes problems, you should turn this option off.

Additional Options

To access the options shown in the following table, in any tab, click Show additional options.

OptionDescription
Delay before start

Configures a delay before a process is started. This delay also works as a minimum delay for multiple parallel process starts.

Example: delay one second,three parallel processes.

  • The start of the first process: total start delay one second.

  • The start of the second process: total start delay two seconds (The start of second process is delayed until at least one second after the start of the first process).

  • the start of the third process: total start delay three seconds (The start of third process is delayed until at least one second after the start of the second process).

Maximum runtimeIf a process takes longer than this number of seconds to execute, the run is counted as failed. The process is terminated automatically if maximum runtime is exceeded.
Maximum in parallelSets the maximum number of parallel runs.
Auto-save behavior

Select one of the following options:

  • No auto-save

  • Actor execution finished

The project, including the database, is auto-saved (depending on defined interval) after calculating this node/system (either when the calculation succeeds or fails).

By default, No auto-save is selected.

Read modeWhen selected, the node does not execute, but forwards outputs (files).
Retry executionWhen selected, retries a node execution if it failed. Set the following options:
  • Number of retries: Maximum number of retry attempts

  • Delay between attempts: Time in milliseconds between each retry attempt