Client Connection

This class is used to create a connection to the Recipe Management Web API. The following constructors are used in the Recipe Management Client API.

System User Connection

This constructor will create a connection to the AVEVA Recipe Management Server as a System User. This user only has privileges to access functions in the RuntimeAPI.

ClientConnection(string rmpHostName)

• rmpHostName – The name of the machine that hosts the AVEVA Recipe Management Server.

UserToken Connection

This constructor will create a connection using the user Token obtained from AVEVA Identity Manager by AVEVA InTouch View Client or any other application using AVEVA Identity Manager.

ClientConnection(string rmpHostName, string userToken)

• rmpHostName – The name of the machine that hosts the AVEVA Recipe Management Server.

• UserToken – AVEVA Identity Manager user accessToken in string format.

Operator/Normal User Connection

Creates a connection using the provided username and password. This type of connection will consume a connection license when used. The permission configured in AVEVA Recipe Management for the passed in user will determine what API calls can be made.

ClientConnection(string rmpHostName, string UserName, string Password)

Any application that uses the Client API and runs as an Administrator uses this constructor, auto-registration will happen with AVEVA Identity Manager using the user credentials. If the auto-registration or addition of the SSL certificate to trusted store fails, the user has to install and configure the AVEVA Recipe Management Client Connection Configuration feature.

This feature will add the SSL certificates from the AVEVA Identity Manager node to a trusted store and register the AVEVA Recipe Management clients such as the Client API with AVEVA Identity Manager.

Client secret (a GUID) is created and stored in AVEVA Identity Manager and AVEVA Data Store.

The admin user running the configurator and the application using the RMPClientAPI will be added automatically to the list of whitelisted users/groups to access the client secrets.

You can add more users/groups who will be running the applications such as IDE, or applications involving Client API and Rest API. You must install and configure AVEVA Recipe Management Client Connection Configuration feature to whitelist users/groups. For more information, refer to the AVEVA Recipe Management Installation Guide.

Note: Administrators who are already whitelisted on a specific system can whitelist other users/groups by running the RMP Client Connection Configuration feature. If client has been registered automatically, then only a whitelisted administrator user has the privilege to whitelist other users/groups.