Using Automation Interface to Add or Modify Security

[sbeadle1]

📖 Home  Back  
The automation interface supports two methods to configure security on objects in the ClearSCADA database, GetSecurity and SetSecurity.

GetSecurity Method

GetSecurity returns the security settings on an ClearSCADA object as a comma separated string. For example,

User:Username:Full,Guest:View+BRS

indicates that the user named Username has full access and the guest users have read only and Browse permissions on the selected object.

Similarly,

Everyone:Full

indicates that Everyone has full access on the selected object.

SetSecurity Method

SetSecurity accepts a string of the same format that GetSecurity returns. A second parameter to SetSecurity determines if security settings should also be applied to the objects descendants.

Security Parameters

A security parameter element consists of

UserType:UserName:Permissions

• UserType

One of the following:

• User - A named user

• Group - A named user group

• Everyone - Everyone

• Guest - Guest users

• Web - Web users

• UserName

The full path and name of the user or user group. For example,

• "~Config.Users.Engineer".

For built in accounts such as "Everyone", leave the UserName empty. In this case the format is, UserType:Permission.

• Permissions

The set of permissions to assign. This uses the same format as the security editor dialogue in ViewX. For example,

• Operator+CFG.

Permissions Options

There are different permissions that can be set. These are listed below with their corresponding security format:

Description	Option
None	None
Read	View
Browse	BRS
Control	CTL
Override/Release	OVR
Acknowledge Alarms	ALM
View Alarms	VWA
Remove Alarms	RMA
Edit Notes	NOT
Retrieve Data	RET
Promote	PRM
Tune Limits	TUN
Annotate History	AHS
Modify History	MHS
Validate History	VHS
Disable Points	DIS
Disable Alarms	DLM
Disable Controls	DCT
Switch Line	SWL
Diagnostics	DIA
Exclusive Control	EXC
Manage Exclus Ctrl	MEC
Configure	CFG
Security	SEC
System Admin	ADM

For every security permission other then None, "View + " must be at the beginning of the security string. For example, to set a permission to allow Read, Browse, Control and View Alarms Permissions, the string would look as follows.

View+BRS CTL VWA

This list is subject to change as new security levels can be added to the product in new releases of ClearSCADA. Check the security dialog to determine the exact options supported by your version of ClearSCADA.

Predefined Permission Sets

Some predefined permission sets allow multiple selections without needing to manually configure each one. These levels are as follows:

• View

• Operator

• Advanced

• Full.

Each of these cover the following permissions:

Predefined Set	Associated Permissions
View	Read
Operator	Read, Browse, Control, Override / Release, Acknowledge Alarms, View Alarms, Remove Alarms, Edit Notes, Retrieve Data, Promote, Tune Limits, Annotate History
Advanced	All permissions except Configure, Security, System Admin
Configuration	All permissions except Security, System Admin
Full	Includes all permissions

Sample Code

Below is some sample code that allows reading and setting security permissions using the automation interface.

Dim objServer As ScxV6Server'Connect to databaseSet objServer = New ScxV6Server'Configure your username and passwordobjServer.Connect "MAIN","user","pwd"'Find my point called testDim myPoint As ScxV6ObjectSet myPoint = objServer.FindObject("test")'gets current security settings and display using msgboxDim securityState As StringsecurityState = myPoint.GetSecurity()MsgBox securityState'sets the new security settings on the objectmyPoint.SetSecurity "User:Username:Full",1objServer.DisconnectSet objServer = Nothing

Go: Home Back