CLASS Device

This class requires the CONWRKS-FE-BASELINE license. It uses only standard functions to perform Device related operations

Class Field Properties

Name Codename Description Ability Length
curpriv CurrentPrivs Current Privileges RO 255
created Created Created RO 255
created_by CreatedBy Created By RO 255
updated Updated Updated RO 255
updated_by UpdatedBy Updated By RO 255
exampver ExampleVersion Example Version RO 255
exampoutofdate ExampleOutOfDate Example Out Of Date RO 255
disabled Disabled Disabled RO 255
locked Locked Locked RO 255
status Status Status Icon RO 255
statustext StatusText Status RO 1000
color Color Status Color RO 1000
liccount LicenseCount License Count RO 255
ovrflwliccount OverflowLicenseCount Overflow License Count RO 255
ref_console_count ConsoleCount Console Count RO 255
ref_guiconn_count GraphicalCount Graphical Count RO 255

Class Functions

Name Description
static add Device.add(name) takes an argument, Device name. The Device name can be explicit or checked for existence then retrieved with Device.getNames(). User must have create privileges. Device.add() creates a named Device object.
static cancel Device.cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with Device.get(name).
static close Device.close() takes no arguments.
static connect Device.connect() takes no arguments.
static create Device.create() takes no arguments.
static delete Device.delete() takes 6 arguments.
static Disable Device.Disable() takes 1 argument.
static DownloadLog Device.DownloadLog() takes no arguments.
static Enable Device.Enable() takes no arguments.
static ExclusiveConnect Device.ExclusiveConnect() takes no arguments.
static exists Device.exists() takes no arguments.
static get Device.get(name) takes an argument, name. This standard function gets and returns the named Device object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static getCount Device.getCount() takes no arguments. This standard function gets the number of defined Device resources.
static getFetchLevel Device.getFetchLevel() takes no arguments.
static getList Device.getList() takes no arguments. This standard function gets and returns an arrary (list) of Device resources.
static getLog Device.getLog() takes no arguments.
static getLogCalendar Device.getLogCalendar() takes no arguments.
static getNames Device.getNames() takes no arguments. This standard function gets and returns an array of strings object with the Device names.
static getRange Device.getRange() takes no arguments.
static getUsage Device.getUsage() takes no arguments.
static isConnected Device.isConnected() takes no arguments.
static isNew isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called.
static log Device.log() takes no arguments.
static logScannable Device.logScannable() takes no arguments.
static monitor Device.monitor() takes no arguments.
static read Device.read() takes no arguments.
static refresh Device.refresh() takes no arguments.
static Rename Device.Rename() takes 1 argument.
static save save() takes no arguments. User must have save privileges. This standard function saves to the server a Device object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails.
static setFetchLevel Device.setFetchLevel() takes no arguments.
static setLock Lock or Unlock a Device, pass lockdown as ether "Lock" or "Unlock", case insensitive. lockreason is only applicable when lockdown=="Lock".
static update Device.update() takes no arguments.
static write Device.write() takes no arguments.

Class Privilege Properties

Type Name
AWARE Aware
CREATE Add
VIEW View
MODIFY Edit
DELETE Delete
RENAME Rename
DISABLE Disable
ENABLE Enable
USAGE View Usage
REMEDIATE Remediate
CONNECT Connect
MONITOR Monitor
EXCLUSIVECONNECT Exclusive Connect
CMDCTRLCONNECT Controlled Connect
VIEWEVTOCC View Event Occurrence
VIEWLOG View Log
VIEWRECORDINGS View Recordings
BCMVIEW View Baseline Runs
LOCK Lock Device

Class Association Properties

Type Name
devicetype Device to DeviceType
tag Device to Tag