Run AVEVA MSIX Installed Products using Commands

Prerequisite

• Open Command Prompt.

To display the command help for AVEVA Unified Engineering

1. Type:

   ue -help.

   

2. Press Enter.

   Result

   -UE.exe [--help,-?,-h] [--module,-md]:<module> [--projectsdir,-pd]:<projectsdir> [--project,-proj,-p]:<project> [--username,-user,-u]:<username> [--password,-pass,-pw]:<password> [--mdb,-m]:<mdb> [--macro,-mc]:<macro> [--console,-tty,-c] [--interactive,-i]:<true|false> [--logfile,-l]:<logfile> [--tool,-t]:<tool> [--args]:<args>

   

   

   In the examples, XXXX indicates the product version number, for example, 3000.

To re-run the initial run wizard for AVEVA Unified Engineering

Note:
AVEVA recommends to close all application sessions before configuring AVEVA Unified Engineering before initial start.

3. Type:

   ue --tool:Setup

4. Press Enter to display the AVEVA Unified Engineering - Initial Configuration window.

   

To run the AVEVA Credential Manager from AVEVA Unified Engineering

5. Type:

   ue --tool:CredentialManager

6. Press Enter to display the AVEVA Credential Manager window.

   

   You can select the application that runs and generates a CONNECT Access Token token. If you select Generate, you are invited to log into CONNECT and the resulting credentials/CONNECT instance is stored.

   In batches where the you want to use these stored credentials and completely suppress the CONNECT login dialog, you must set the interactive argument -i (or -–interactive) to false:

   -i:false

To run a project in the Model module of AVEVA Unified Engineering

7. Type:

   ue --module:Model --project:APS --username:USERNAME --password:123456 --mdb:/ALL

8. Press Enter to display the Proj - projAPS | MDB- all | Model - AVEVA Unified Engineering window.

   

9. Variants

To additionally enable TTY mode:

ue --module:Model --project:APS --username:USERNAME --password:123456 --mdb:/ALL -tty --

To additionally run the Model_export.pmlmac macro stored at C:\temp\:

ue --module:Model --project:APS --username:USERNAME --password:123456--mdb:/ALL --macro:c:\temp\Model_export.pmlmac

To suppress the connect login if CONNECT (LaaS) is in use and to add logging (which is an equivalent of alpha log in the command line of the product):

ue --module:Model --project:APS --username:USERNAME --password:123456--mdb:/ALL --interactive:false --logfile:c:\temp\Model_export.log

To open a project held in a different project environment

Note:
The batch expects to find a custom_evars.bat file at the path which defines the projects to use.

10. Type:

    ue -md.Model -projectsdir:C/projects/ --project:APS --username:USERNAME --password:123456

11. Press Enter, the evar %project_dir% is redefined temporarily for the batch. AVEVA Unified Engineering is opened using the APS project as defined by the custom_evars.bat file stored in C:\projects\ (with evar %projects_dir% set to C:\projects\) even though in initial run it has been set to a path in the C:\Projects\UE.

Variant

To suppress the connect login if CONNECT (LaaS) is in use:

ue -md.Model -projectsdir:C/projects/ --project:APS --username:USERNAME --password:123456-i:false

To run the APS project in Paragon Module with a different Multidatabase

12. Type:

    ue -module:Paragon -p:APS --username:USERNAME --password:123456 -mdb:/SCHEMATICS

13. Press Enter to display the Proj - projAPS | MDB - all | Paragon - AVEVA Unified Engineering window.

    

Variant

To additionally run the spec export.pmlmac macro stored at C:\temp\:

ue -module:Paragon -p:APS --username:USERNAME --password:123456 -mdb:/SCHEMATICS macro:c:\temp\"spec report.pmlmac"

Note:
Because there are spaces in the macro name, put the macro argument in quotation marks.

To use encrypted credentials log into APS in AVEVA Unified Engineering

14. Start AVEVA Administration with the Admin module.

    

15. On the Manage tab, in the Admin Elements group, click Users to display the Users window.

    

16. Click Create Script to display the Command Script Generation window.

    

17. Click OK.

    The projectentry.mac file is created in C:\Temp.

    

    The PML macro, which is targeted by the command line call, now has an additional first line to run this encrypted file to give the encrypted log in parameters.

    

18. On the Project tab, click Save Work.

19. In the Command Prompt window, type:

    ue -macro:C:\temp\pml.pmlmac -tty -i:false

    Note:
    The argument for "--module" will not work here, as the user credentials are encrypted and not openly passed in the cmd at first. In this case, the macro called from the encrypted script will have to include an appropriate module switch, for example "RUN MODEL".

20. Press Enter.