Configure the AVEVA Recipe Management View application

Before using the AVEVA Recipe Management v5.1 with InTouch OMI View Application, you must configure the AVEVA Recipe Management View application.

To configure the AVEVA Recipe Management View application

1. Open System Platform IDE as an administrator.

2. Click the Galaxy menu and then click Import > Object(s). The Import Objects dialog box appears.

   

3. Browse to locate the path where RecipeManagementOMIApp.aaPKG is located. Leave default choices on the Import Preferences.

4. Click OK. After import, the SampleRMOMIApplication is added to the Galaxy as a folder under MyContent which includes the following.

   • RecipeManagerPlusApp

   • RMLayout001

   • RMScreenProfile001

   • RMSymbol001

     Note:
     - If you have upgraded Recipe Management OMI Application from 4.2 or earlier version, you need to delete the existing RecipeManagerPlusApp.aaPKG object. Importing RecipeManagementOMIApp.aaPKG will provide the updated RecipeManagementOMIApp object along with additional samples.
     - The sample application is just an example for users to view settings. Any application you develop will only need the RecipeManagementPlusApp object, and the samples can be disregarded or deleted.
     - Below step 5 onwards are applicable only to develop a new InTouch OMI View application using AVEVA Recipe Management, not while upgrading the existing InTouch OMI View application to the latest version.

     

5. Open Layout RMLayout001. You can customize the layouts according to your Runtime application.

6. Now, select Pane1 and click the Properties tab. A list of all properties that are available from the RMPExecutionWebControl is displayed.

   You should specify the port number for HttpsPort field, if AVEVA Recipe Management application is configured with the custom port. You need not specify the port number if the application is configured with the default port 443.

   

7. In the Content Properties, do the following:

   1. Specify the AVEVA Recipe Management Server name in the Host box. The server name should be a Fully Qualified Domain Name (FQDN).

   2. In the EquipmentName field, click the drop-down list, and then select In. In the EquipmentName text box, type "MyViewApp.Navigation.CurrentAsset", so that the input for equipment name will come from the navigation tree selection.

   3. Leave the remaining Properties selected as by default.

8. Save and close the RMLayout_001.

9. Configure the system to point to the AVEVA Identity Manager.

Configuring the Application to point to AVEVA Identity Manager

NOTE: This is valid only if you are using the AVEVA Identity Manager.

To configure the application to point to AVEVA Identity Manager

10. Go to C:\Program Files (x86)\ArchestrA\Framework\Bin\ViewAppFramework.

11. Edit View.exe.config to have the following:

    <!-- Configure the AVEVA Identity Manager Service (the OpenId Connect endpoint) by adding the following key value pairs.

    Replace "your_token_server" and "your_client_id" with proper values. -->

    <add key="TokenServiceBase" value="https://<AIM Host Name>/IDENTITYMANAGER" />

    <add key="ClientId" value="SE_WSP_NG" />

    <add key="Scope" value="openid profile system offline_access" />

    Note:
    - Ensure to always enter the name of your AVEVA Identity Manager (AIM) Host for <AIM Host Name>, and update the ClientId value as SE_WSP_NG.
    - If AVEVA Identity Manager is configured to use a custom port, include the port number in the URL. For example: https://<AIM Host Name>:<portnumber>/IDENTITYMANAGER. However, for AVEVA System Platform 2023 R2 P01 and later versions, the AIM Host Name and Port Number are not required.
    - The <AIM Host Name> should be a Fully Qualified Domain Name (FQDN).
    - You need not specify the port number if AVEVA Identity Manager is configured with the default port 443.
    - Ensure the lines edited are uncommented.
    - Update View.exe.config file on remote node if InTouch OMI Application is deployed on the remote node.

If you want to view the application in Preview mode, update the View.exe.config file in C:\Program Files (x86)\ArchestrA\Framework\Bin\ModernEditors\Preview\ViewAppFramework.

Configuring the Operating System Security

12. Go to the Security menu in System Platform IDE.

    

13. In the Configure Security dialog box, select the OS User based option.

    

14. Click the Users tab and click the Add icon to add the user login, and click the associated Roles for the added user as Administrator.

    

15. Click OK. The System Platform IDE will close and reopen.

16. Enter the valid credentials.

17. Select ViewApp in the Galaxy and create a new derived template RMViewApp_001.

    

18. Double-click to open the RMViewApp_001.

19. Select the RMScreenProfile001 screen from Select Screen Profile, and then click Next. The Associate Layout dialog box appears.

    

20. Select the RMLayout001 layout from Associate Layout, and then click Finish.

    

21. Click Add to add the navigation item.

    

22. Select Navigationitem under Assets and select the Properties tab. Specify a title such as Recipe Execution Control. Click Reference to select and map all the equipment(s) that were imported from the AVEVA Recipe Management Server and are available at the plant area under Model.

    

23. Save and close the RMViewApp_001.

24. Right-click and create a view instance RMViewApp_001_001. A new RMViewApp_001_001 is added into the Unassigned area in the Model.

    

25. Rename the instance NGViewApp_001. You can customize the name as you want.

26. AVEVA Recipe Management equipment objects as shown below.

    Note: For earlier versions of System Platform IDE, you need to create new instance of AppEngine, ViewEngine, and Area. Also, place all the AVEVA Recipe Management Server equipment(s) in Area_001, place AppEngine_001 and ViewEngine_001 under Galaxy Platform.

    

27. Move NGViewApp_001 under ViewEngine.

    

28. Now right-click the Galaxy and then click Deploy.