Publish Data from Command Line
- Last UpdatedOct 06, 2025
- 4 minute read
Data from AVEVA™ E3D Design can be published from the command line.
For this, you must first create a token using AVEVA Administration. The token must contain the values for username, password and MDB. Then, the token path must be referred to in the command. For more information about tokens and how to create them, see the AVEVA Administration User Guide or see Generate Secure Login.
Note: You must ensure that the token contains the values for username, password and MDB. An error message is displayed if the token does not contain the values for these fields.
If you are using AVEVA's Licensing as a Service (LaaS) to license your product, you must export the data through the user interface at least once before exporting from the command line. When you export the data through the user interface using AVEVA's LaaS, you are prompted to provide your credentials. After the credentials are validated, you can export the data through the command line.
To export the data from the command line, you must either change to the installation folder of AVEVA™ E3D Design using the cd command, or provide the full path of the installation location, and then run the following command: AVEVA.Gateway.UE.Model.exe
The following parameters must be provided with the command:
Note: For more information about the optional parameters, see Specify Common Settings for Export. The values specified through command line override the values set in the configuration.
|
Parameter |
Required? |
Purpose |
|---|---|---|
|
-CfgNames |
Yes |
To specify the names of the configurations using which the export needs to be done. You can specify more than one configuration separated by a space. Example: "D6 D7" |
|
-EIWMContext |
No |
To specify the context name. You can specify a nested context using the ‘+’ or '|' symbol. The highest context must be provided first. Example: "PARENT|CHILD" |
|
-EIWMFileSuffix |
No |
To specify the file suffix. |
|
-GenerateFolderVNETFIle |
No |
To specify if the physical XGL/ZGL file needs to be added to the class and context in AVEVA™ Asset Information Management. By default, the value is set to false. |
|
-GenerateTriggerStartFile |
No |
To specify if the generated output files (EIWM and XGL/ZGL) must be picked automatically for processing by AVEVA™ Asset Information Management. By default, the value is set to false. Note: If you set the value to True, make sure that the staging area of the output files is listed as a watch folder in the Import Controller. |
|
-help |
No |
Displays the help. |
|
-SelectedElements |
Yes |
To specify the names or reference ids of the elements that need to be exported. More than one element can be separated by a space. Example: "/SITE-EQUIPMENT-AREA01 =453746/8768" |
|
-TokenPath |
Yes |
To specify the location of the token that has been generated using AVEVA™ Administration |
|
-SelectedReports |
No |
To specify the location of the report files (*.repv) that must be exported. This command considers the entire project as scope for reporting. Example: -SelectedReports "%%AVEVA_DESIGN_DFLTS%%data\reports\DESIGN-Pipe_List.repv" |
|
-SelectedScopedReports |
No |
To specify the location of the report files (*.repv) files that must be exported. This command considers the selected elements as scope for reporting. Example: -SelectedScopedReports "%%AVEVA_DESIGN_DFLTS%%data\reports\DESIGN-Equipment_List.repv" |
|
-AutoCfgUpgrade |
No |
To auto-upgrade the configuration that will be used for exporting. Example: -AutoUpgrade true |
An example command is as follows:
AVEVA.Gateway.UE.Model.exe -TokenPath "<<Location path>>\projectentry.mac" -SelectedElements "/SITE-EQUIPMENT-AREA01" -CfgNames "DefaultConfiguration" -EIWMFileSuffix "avngate" -EIWMContext "Avngate" -GenerateFolderVNETFIle False -GenerateTriggerStartFile False
Unified Engineering :
ue -t:Modelgateway -args:-Tokenpath "<C:\Users\XXX\Desktop\model Gateway output\New folder\token path\projectentry.mac>" -SelectedElements "/E1302B" -CfgNames "e" -EIWMContext "avngate" -EIWMFileSuffix "avngate" -AutoCfgUpgrade "True" -GenerateFolderVNETFile "True" -GenerateTriggerStartFile "True -SelectedReports "C:\Users\Public\Documents\AVEVA\Everything3D\Data\DFLTS3.1\data\reports\DESIGN-Equipment_List.repv"
Note: Any errors about the export are added to the log file. The location of the log file is displayed on the screen. You can cancel the command line export using CTRL+C.
Other Available Commands
The following table lists the other commands available for using the gateway.
|
Command |
Purpose |
|---|---|
|
AVEVA.Gateway.UE.Model.exe -TokenPath "<location of .mac file>" -CfgList |
To view the list of configurations available |
|
AVEVA.Gateway.UE.Model.exe -help |
To view the help for command line export |
Return Codes
The following table lists the return codes.
|
Return Code |
Description |
|---|---|
|
0 |
Success |
|
1 |
At least one error occurred during export process. Check log for details. |
|
12 |
"-CfgNames" given does not exist |
|
13 |
"-SelectedElements" is not given |
|
14 |
"-SelectedElements" given does not exist |
|
100 |
"-TokenPath" is not given |
|
101 |
Token file at "-TokenPath" does not exist |
|
102 |
Incorrect token |
Note: To view the exit code for an export operation, after the export is complete, type %errorlevel% at the command prompt. It may not be applicable to Unified Engineering application and it would work in .msi application of .
Transitioning from AVEVA™ Gateway for Unified Engineering 1.8.0.0 or earlier Commands
The following table describes the equivalent command for AVEVA™ Gateway for Unified Engineering version 1.5 or later.
|
AVEVA™ Gateway for Unified Engineering Version |
1.5 or later |
1.8.0.0 |
|---|---|---|
|
Command Line Tool |
AVEVA.IED.Gateway.Model.exe |
AVEVA.Gateway.UE.Model.exe |
|
Command Mappings |
-prj <ProjectName> |
-proj <ProjectName> |
|
-EIWMContext <ContextName> |
-EIWMContext <ContextName> |
|
|
-EIWMFileSuffix <EIWMFileSuffix> |
-EIWMFileSuffix <EIWMFileSuffix> |
|
|
-SelectedElements "<Selected element names>" |
-SelectedElements "<Selected element names >" |
|
|
-CfgNames "<Configuration names>" |
-CfgNames "<Configuration names>" |
|
|
-GenerateFolderVNETFile <boolean> |
-GenerateFolderVNETFile <boolean> |
|
|
-GenerateTriggerStartFile <boolean> |
-GenerateTriggerStartFile <boolean> |
|
|
-dataset <Dataset name> Note: No longer supported. Dataset objects mapping is now controller by configuration administrator within configuration. Manual configuration adjustment is necessary after upgrading to 1.5 or later |
-dataset <Dataset name> No longer supported. Dataset objects mapping is now controller by configuration administrator within configuration. Manual configuration adjustment is necessary after upgrading to 1.5 or later |
|
|
-user <User name> -pwd <Password> -MDB <MDB name> These are no longer supported. Replaced with -TokenPath "<Token path>" command. Token is a file that will hold encrypted MDB, user and password information. It can be generated using AVEVA™ Administration |
-user <User name> -pwd <Password> -MDB <MDB name> These are no longer supported. Replaced with -TokenPath "<Token path>" command. Token is a file that will hold encrypted MDB, user and password information. It can be generated using AVEVA™ Administration |
|