Register ViewX or Virtual ViewX to Use Single Sign-on
You have to register ViewX or Virtual ViewX as an AVEVA Identity Manager client in order to use the single sign-on (SSO) feature. Geo SCADA Expert includes an AVEVA Identity Manager Client Registration tool with its installer. Use the tool to register ViewX or Virtual ViewX as a client within the AVEVA Identity Management system. The registration permits ViewX or Virtual ViewX to perform logons using AVEVA Identity Manager, enabling streamlined and secure user authentication and authorization processes within the system.
You must run the tool on a machine that has PCS configured as a node and is associated with the relevant SMS (see Define the Node Name for a Client - System Connection). The Geo SCADA Expert installer installs the registration tool as part of the ViewX or Virtual ViewX installation process.
To run the AVEVA Identity Manager Client Registration tool:
- Open a command line or terminal application, such as cmd.exe, and navigate to the following location:
C:\Program Files(x86)\SchneiderElectric\ClearSCADA
-
Run
AIMClientRegistration.exe
After the .exe file is executed, the response is displayed within the command prompt interface.On a particular system, the following response is displayed in the command prompt interface:
Fetching endpoint address from PCS configuration...
Registering client to endpoint 'https://abcxyl23456.aveva.com:453/'
- id = 'SE.GeoSCADA.ViewX'
- name = ''
- access token lifetime = 1 hrs 0 mins
Registered client successfully.
Running the tool for ViewX or Virtual ViewX client registration is a one-time requirement and is not required for each machine on which ViewX or Virtual ViewX will be used. You can modify the registration by re-running the tool.
If you intend using SSO for logons from both ViewX and Virtual ViewX, you have to perform this procedure twice, once on a Geo SCADA Expert server to register a ViewX client, and once on the Virtual ViewX server to register a Virtual ViewX client.
You can provide AIMClientRegistration.exe with the following command line arguments to obtain more information or change the registration settings:
| Command Line Argument | Description |
|---|---|
| -a, --accesslifetime | This is the lifetime of the access token in minutes. The default lifetime is 60 minutes. |
| -d, --deleteonly |
Deletes an existing registration without performing a new registration.
>AIMClientRegistration.exe -d Fetching endpoint address from PCS configuration... Deleting existing client 'SE.GeoSCADA.ViewX' if already registered... Existing client registration deleted. |
| -e, --endpoint | This is the address of the AVEVA Identity Manager endpoint to register with. This is an optional argument. If it is not provided then the tool will attempt to obtain the correct address automatically. |
| --help | Displays the help information. For example, this describes the command line arguments. |
| -l, --list |
Displays a list of all the registered clients.
>AIMClientRegistration.exe -l Fetching endpoint address from PCS configuration... Fetching client list... - AIM_DefaultManagementClient - SE_WSP_NG - Asb.Agent.abcxy123456 - Asb.Runtime.abcxy123456 - SE.GeoSCADA.ViewX |
| -r |
Applicable to Virtual ViewX only. Registers a callback web address in the following format: https://<Virtual ViewX Host>.<domainname>:<Virtual ViewX port>/<OAUth VirtualPath> |
| -v, --verbose | Renders detailed information of the registration. |
| --version | Displays version information. |
To register Virtual ViewX to use single sign-on, the Virtual ViewX server machine has to have PCS configured as a node (see Geo SCADA Expert Prerequisite Components).