Publish Data from Command Line
- Last UpdatedOct 06, 2025
- 3 minute read
Data can also 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 first change to the installation folder of AVEVA™ E3D Design using the cd command and then run the following command: AVEVA.Gateway.UE.Draw.exe
The following parameters must be provided with the command:
Note: For more information about the optional parameters, see Settings for Common Export Options.
|
Parameter |
Required? |
Purpose |
|---|---|---|
|
-TokenPath |
Yes |
To specify the location of the token that has been generated using AVEVA™ Administration |
|
-SelectedElements |
Yes |
To specify the names of the elements that need to be exported. The element names must begin with "/". More than one element name can be separated by a space. Example: "/APS-1000/1 /APS-1001/1" |
|
-CfgNames |
Yes |
To specify the names of the configurations using which the export needs to be done. The syntax for specifying the Draw configuration together with Model Configuration is "DrawConfig#ModelConfig". You can specify more than one configuration separated by a space. Example: "DrawPiping#ModelPiping DrawEquipment#ModelEquipment" |
|
-EIWMFileSuffix |
No |
To specify the file suffix |
|
-GenerateFolderVNETFIle |
No |
To specify if the physical SVG file needs to be added to the class and context in AVEVA™ Asset Information Management. By default, the value is set to True. |
|
-GenerateTriggerStartFile |
No |
To specify if the generated output files (EIWM and SVG) 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. |
|
-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:
C:\Program Files (x86)\AVEVA\Everything3D3.1>AVEVA.Gateway.UE.Draw.exe -TokenPath "<C:\Users\XXX\Desktop\Draw Gateway output\New folder\token path\projectentry.mac>" -SelectedElements "/APS-1000/1 /APS-1001/1" -CfgNames "DefaultConfiguration DrawPiping#AvevaPipeSample" -EIWMFileSuffix "null" -EIWMContext "SRP+VPD " -GenerateFolderVNETFIle True -GenerateTriggerStartFile True
Unified Engineering :
ue -t:Drawgateway -args:-TokenPath "<C:\Users\XXX\Desktop\Draw Gateway output\New folder\token path\projectentry.mac>" -SelectedElements "/APS-1000/1 /APS-1001/1" -CfgNames "DefaultConfiguration DrawPiping#AvevaPipeSample" -EIWMFileSuffix "null" -EIWMContext "SRP+VPD " -GenerateFolderVNETFIle True -GenerateTriggerStartFile True
Note: Any errors about the export are added to the log file. The location of the log file is displayed on the screen.
Other Available Commands
The following table lists the other commands available for using the gateway.
|
Command |
Purpose |
|---|---|
|
AVEVA.Gateway.UE.Draw.exe -TokenPath "<location of .mac file>" -CfgList |
To view the list of Draw configurations available |
|
AVEVA.Gateway.UE.Draw.exe -help |
To view the help for command line export |
The following table lists the exit codes for command line export.
|
Exit Code |
Meaning |
|---|---|
|
0 |
Success |
|
1 |
At least one error occurred during export process. Check log for details. |
|
12 |
"-CfgNames" argument contains all non-existing configuration names |
|
13 |
"-SelectedElements" argument is not given |
|
14 |
"-SelectedElements" argument contains all non-existing elements |
|
100 |
"-TokenPath" argument is not given |
|
101 |
"-TokenPath" argument points to missing token file |
|
102 |
Given login token is incorrect |
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 E3D.