AVEVA Recipe Management Architecture

AVEVA Recipe Management can be implemented in one of the two modes: Standalone or Integrated with AVEVA Application Server. Standalone mode means that you use the AVEVA Recipe Management web client to configure and run all aspects of your application, including mapping IO and running the execution.

If you are integrating AVEVA Recipe Management with AVEVA Application Server, you use OI-Gateway for IO reference mapping and execution.

AVEVA Recipe Management is made up of the following components:

• Server Components. Manages the configuration of Web Application, Database, Execution mode, OPC UA Client Service and Client registration component.

• Components for AVEVA System Platform. Installs the RestAPI Scripting Library, Event Library, AVEVA Recipe Management Application object, and AVEVA System Platform Extension components.

  By default, the AppObject, RestAPI, and Event Library are installed at C:\Program Files (x86)\AVEVA\Recipe Management\AppObjects.

  • AppObject - RecipeManagerPlus.aaPKG

  • Rest API - ArchestrA.Web.RestAPI.dll

  • Client API - RMPClientAPI.dll. This is installed at C:\Program Files (x86)\AVEVA\Recipe Management\Bin.

  • Event Library - ArchestrA.Events.Scripting.aaSLib

• AVEVA Single Sign-On Service - This feature installs AVEVA Identity Manager feature responsible for authenticating AVEVA Recipe Management users, maintaining AVEVA Recipe Management client information, and returning tokens for the registered AVEVA Recipe Management clients.
  This feature installs AVEVA Certificate Manager that will generate or import SSL certificates. It will also configure AVEVA Identity Manager with the SSL certificate selected.

• Client Connection Configuration - Installs the AVEVA Recipe Management Client Connection Configuration Utility for registering clients with AVEVA Identity Manager.

  NOTE: The installation and configuration of this feature is only needed on AVEVA System Platform node, or any application that uses AVEVA Recipe Management' REST API or the new Client API to run under non-admin privileges. After configuration of this feature, these applications can run successfully.

• AVEVA Data Store: AVEVA Recipe Management uses AVEVA Data Store for storing client secrets in an encrypted form. The information is stored securely and can only be accessed by users running the applications that optionally are white-listed to access it. AVEVA Data Store will be installed on all computers that have AVEVA Recipe Management applications running.

  AVEVA Data Store is installed when you select any one of the following features in AVEVA Recipe Management for installation.

  • AVEVA Recipe Management Server Components

  • Components for AVEVA System Platform

  • Client Connection Configuration

• Documentation - Installs AVEVA Recipe Management related user documentation in the CHM, PDF, or HTML format.

• Input/Outputs - You can use an OPC UA Server or AVEVA System Platform to provide IO references and execution for recipes.

  • If you are using an OPC UA Server, you must configure the OPC UA Client service on the AVEVA Recipe Management Server to communicate with the OPC UA Server. For more information, refer to Configuring the OPC UA Client Service.

  • If you are using AVEVA Application Server, you must install the components for the AVEVA System Platform on the AVEVA Application Server node and then configure the IO reference mapping using the AVEVA Recipe Management ApplicationObject within the IDE. For more information, refer to Configure Integration with Application Server.

• AVEVA Enterprise Licensing - The license information for AVEVA Recipe Management is configured and managed using the dedicated AVEVA Enterprise License Manager. This License Server allows AVEVA Recipe Management to acquire/release licenses.

• Execution service - The execution service is only used by AVEVA Recipe Management in standalone mode.

• Archive Utility - You can use the Archive Utility to archive the existing current History database and create new operational archive database.

You use the post-install Configurator to configure the Server database, Web application, Client connection, and License Server. You can configure the OPC UA Client service using the Configure ArchestrA Services application. You do not need to configure the execution service.

For information about how to set up integration with Application Server, see the AVEVA Recipe Management User Guide.