Understand the Flow Network Export Command Line tool parameters

-f (--file)

Required

The name of the .simx file created in AVEVA Process Simulation (APS). When uploaded to the RealTime database (RTDB), this will be the name of the Flow Network model.

Notes: The .simx file must exist or an error will be generated.

If the .simx file is imported into an existing workspace (that does not contain the pipeline yet) or into a new workspace created with the Flow Network Export Command Line tool, the pipeline will automatically be assigned a "Flow Network" type so that it can be uploaded to RealTime.

-e (--export)

Optional

The target RealTime system where the Flow Network will be uploaded.

If the specified target RealTime system is not found when the export is started, an error message will be returned.

-p (--project)

Optional

The AVEVA Pipeline Integrity Monitor (SimConstruct) project or workspace to use.

Notes: If the parameter is set to a non-existing project/workspace, a new one with the specified name will be created.

If the parameter is not set, a temporary project/workspace will be created and deleted at the end of the process.

The possibility exists for a non-critical error to be logged—yet the Flow Network export process succeeds. For example, if the APS project set up is incomplete, the "Missing Pipeline Options" error may be generated—but the Flow Network export process will still be performed successfully.

-d (--dataset)

Optional

The name of the dataset the Flow Network should be attached to in the target RealTime system.

Notes: The provided value will only be used if a new Flow Network is being loaded. In the case of an update, this value will be ignored and the RealTime system will keep using the previously assigned dataset.

If the parameter is not set, the first available dataset on the target RealTime system will be automatically assigned.

-c (--changeset)

Optional

The Management of Change (MoC) changeset to use.

Notes: This parameter only applies to distributed systems.

It is only relevant when MoC is used to promote changes across systems.

-u (--update)

Optional

This flag indicates to the tool to refresh the existing Flow Network model in the specified SimConstruct workspace using the .simx file before uploading the Flow Network model from the SimConstruct workspace into the RTDB.

If this flag is not set, the tool will upload the Flow Network model from the specified SimConstruct workspace into the RTDB without refreshing the Flow Network model in the SimConstruct workspace using the .simx file.

Note: If a project is not specified, this flag is irrelevant.

-j (--json)

Optional

The folder path to export the generated .json file.

Note: The generated file name format is "{PipelineName}_{MM-dd-yyyy-HH-mm}.json"

-l (--logfile)

Optional

This sets the log file path. The path set can be absolute or relative. If it is not set, the log will be saved in C:\Users\<CurrentUser>\AppData\Local\AVEVA\SimSuite\log\FnetExport.log.

Note: Ensure that you have permission to write files to the selected path.

--verbose

Optional

This flag sets whether debug messages will be saved in the log file.

If set, it will log the complete stack trace if an unexpected error happens and any debug log messages raised during the export.

--silent

Optional

This flag will hide all log messages in the console output.

--version

Optional

Displays the program version in use.

Note: This parameter is exclusive and cannot be executed with any other parameter.

--help

Optional

Displays Flow Network Export Command tool help.

Notes: This parameter is exclusive and cannot be executed with any other parameter.

Executing FnetExport without any parameters will also display the Flow Network Export Command tool help.