Output Tab

Specifies the output stream or CSV file to log sweep data to. An output stream is not required, but if one is specified, at least one sweep parameter must be logged. Failing to log any sweep parameters with output enabled results in a run-time error.

The Output tab contains the following option for all non-Stream parameter types:

• Enable Output to Stream/CSV File —Check this box to enable output for this loop. If checked, the output controls are enabled, and the Sweep Loop will write sweep parameters with the log option set at the end of each iteration.
• Output to CSV File —Browse to and select the CSV file to write.
  • Specify file path by expression —Check this box to choose the Directory Path and CSV File Path by entering an expression.
  • Directory Path —Browse to and select the directory path of the CSV file to write.
  • CSV File Name —Specify the CSV file name.
  • Data Tag —Expression that specifies a string data tag to write to the CSV file before any headers or data.
  • File Open Mode —Expression that specifies the file open mode for the underlying CSV file. The mode can be any of the following FileOpenModes constants:
    • FileOpenMode_NoOptions —Create the file if it does not exist. Fail with a runtime error if the file exists.
    • FileOpenMode_Truncate —If the file exists, overwrite it, deleting the previous contents. Create a new file if it does not exist.
    • FileOpenMode_Append —If the file exists, append to the end of it, preserving the existing contents. Create a new file if it does not exist.
    • FileOpenMode_Uniquify —Create a new file if it does not exist. If a file with the specified path exists, attempt to make the file name unique by appending “_” (underscore) plus a numeric suffix to the file name. For example, if AlreadyExists.csv already exists, AlreadyExists_2.csv is tried, then AlreadyExists_3.csv, etc. until a unique name has been found. If a unique name is not found after 10000 attempts, the operation fails with a runtime error.
  • Separator Character —Choose a separator character from the drop down menu.
  • Output to Stream
    • Output Record Stream —Specifies the stream to log sweep parameters to. The expression can be either an object reference or a string. If it is an object reference, it must refer to an OutputRecordStream or ExecutionOutputRecordStream . If it is a string, it must be the name of an ExecutionOutputRecordStream attached to the current execution.
    • Auto Close —Check this box to automatically clean up the output stream at the end of the loop. When this box is checked, upon terminating the loop, the Sweep Loop step closes the stream. If the stream was specified by an object reference, the loop sets the object reference in the Output Record Stream expression to Nothing .
      Note Automatic cleanup only occurs if the loop terminates normally by completing its sweep or through a Break step . Cleanup does not occur if execution flow exits the loop for some other reason, such as through a Goto step .

See Also

Sweep Loop Step

Sweep Loop Parameters Tab

Sweep Loop Input Tab