Configuration

This section explains each of the properties in the configuration blade.

Fig 1: OSIsoft PI Histogram configuration blade

General

Property	Description
Name	The name that will be visible when selecting a data source.

Authentication

Property	Description
Use Connection Variables	Tick to use variables for the Web API Url, Username, and Password settings, or enter them manually.
Web API Url	The OSIsoft PI web API address.
Username	The username used to log into the OSIsoft PI Web API.
Password	The password used to log into the OSIsoft PI Web API.

Configuration

Property	Description
Server	The server which connected to the OSIsoft PI Web API.
Database	The database from which data is retrieved.
Template	The list of Asset Framework (AF) templates configured in OSIsoft PI AF.
Maximum Number of Records	The maximum number of records to be returned.
Max Count (PI Server Setting)	Overwriting max count settings for OSIsoft PI Web API setting.
Metadata Cache Duration (in minutes)	The duration to cache the metadata and refresh when the specified time period is expired.
PI ArcMaxCollect (PI Settings)	Used to limit the maximum number of compressed events that can be retrieved by a single query from a single client.

Access Control

Access Control ensures that App users view data they are authorized to see.

The App user is the input parameter to a stored procedure, which returns the PI attribute values in the access column that the user is authorized to view.

The data source is filtered by these values to generate the Connector output, i.e. what the user sees.

In the example below, both access control key columns are named "Site" - but the names can differ. The user can view sites A and B - other sites are excluded from the Connector output.

Fig 2: Access Control Example

Please contact XMPro for assistance in setting up the Data Access Control.

Please note that the Access Control properties can only be configured with System Variables.

Property	Description
Apply Access Control	Tick to restrict the Connector output based on the App user.
Access Control SQL Server	The address, either URL or the IP address, where the Access Control SQL database is hosted.
Access Control SQL User Name	The username used to authenticate to SQL.
Access Control SQL Password	The Password used to authenticate to SQL.
Access Control Database	The database from which Access Control data is retrieved.
Access Control SQL Stored Procedure	A stored procedure that takes the user as input and outputs the authorized values.
Stored Procedure Input Mapping	The input mapping grid for passing the stored procedure's input parameter. Possible options are: UserName UserId
Access Control Key Column in Stored Procedure	The stored procedure's output column name whose values are used to filter the Access Control Key Column in PI Response.
Access Control Key Column in PI Response	The PI Attribute name that is filtered using the values from the Access Control Key Column in Stored Procedure.