FmsClient Properties

The FmsClient object contains the following properties. The Connect method must be called before the properties will be populated.

Property	SubType	Read Only	Description
AccessControlService	String	Yes	Returns the name of the ACS associated with a given service. If no ACS is associated with a given service, an empty string is returned.
AuditService	String	Yes	Returns the name of the AUD associated with a given service. If no AUD is associated with a given service, an empty string is returned.
AuxiliaryService1	String	Yes	This property is currently not used by the Client object.
AuxiliaryService2	String	Yes	This property is currently not used by the Client object.
CommonAlarmService	String	Yes	This property is currently not used by the Client object.
ConfigurationManagementService	String	Yes	This property is currently not used by the Client object.
GeneralNotificationService	String	Yes	This property is currently not used by the Client object.
IsConnected	Boolean	Yes	Returns True if the Client object is connected to a SITE.SERVICE. Returns False if it is not.
SecurityApplication	String	Yes	Returns the configured security application for the service. This is the ACS_APPLICATION keyword in the service configuration file.
SecurityEvent(index)	String	Yes	Returns the configured security event for the service. This Property requires an index parameter (ex. FmsClient.SecurityEvent(0)). The index identifies the security event keyword. Index 0 references the MAIN_SEC_EVENT keyword. Index 1 references the SEC_EVENT_1 keyword. Index 2 references the SEC_EVENT_2 keyword. And so on.
SecurityLevel(index)	String	Yes	Returns the security level of the current user for the configured app and event at the specified level. This property can be one of the following values: N — Access Level 0: No Access R — Access Level 1: Read Access U — Access Level 2: Update Access A — Access Level 3: Add Access D — Access Level 4: Delete Access M — Access Level 5: Admin Access.
ServiceDirectory	String	Yes	Returns the name of the ARS configured for this service.
ServiceType	String	Yes	Returns the type of service to which the client is connected.
SiteService	String	Yes	The site and service to connect to, in "site.service" format.
SystemAdministrationService	String	Yes	This property is currently not used by the Client object.
SystemLoggingService	String	Yes	Returns the name of the ELS configured for this service. If no ELS is associated with a service, an empty string is returned.
TableReferenceService1	String	Yes	This property is not recommended for use by the FmsClient object. Note: If used, this property will return a blank value.
TableReferenceService2	String	Yes	This property is not recommended for use by the FmsClient object. Note: If used, this property will return a blank value.
TableReferenceService3	String	Yes	This property is not recommended for use by the FmsClient object. Notes: If used, this property will return the name of the AUD service configured for the connected FMS service. Use the AuditService property for this purpose.
UserId	String	Yes	Returns the current user ID of the client program.
ValueHistoryService	String	Yes	This property is currently not used by the Client object.

Property

SubType

Read Only

Description

AccessControlService

String

Yes

Returns the name of the ACS associated with a given service. If no ACS is associated with a given service, an empty string is returned.

AuditService

String

Yes

Returns the name of the AUD associated with a given service. If no AUD is associated with a given service, an empty string is returned.

AuxiliaryService1

String

Yes

This property is currently not used by the Client object.

AuxiliaryService2

String

Yes

This property is currently not used by the Client object.

CommonAlarmService

String

Yes

This property is currently not used by the Client object.

ConfigurationManagementService

String

Yes

This property is currently not used by the Client object.

GeneralNotificationService

String

Yes

This property is currently not used by the Client object.

IsConnected

Boolean

Yes

Returns True if the Client object is connected to a SITE.SERVICE. Returns False if it is not.

SecurityApplication

String

Yes

Returns the configured security application for the service. This is the ACS_APPLICATION keyword in the service configuration file.

SecurityEvent(index)

String

Yes

Returns the configured security event for the service. This Property requires an index parameter (ex. FmsClient.SecurityEvent(0)).

The index identifies the security event keyword.

Index 0 references the MAIN_SEC_EVENT keyword.

Index 1 references the SEC_EVENT_1 keyword.

Index 2 references the SEC_EVENT_2 keyword.

And so on.

SecurityLevel(index)

String

Yes

Returns the security level of the current user for the configured app and event at the specified level. This property can be one of the following values:

N — Access Level 0: No Access
R — Access Level 1: Read Access
U — Access Level 2: Update Access
A — Access Level 3: Add Access
D — Access Level 4: Delete Access
M — Access Level 5: Admin Access.

ServiceDirectory

String

Yes

Returns the name of the ARS configured for this service.

ServiceType

String

Yes

Returns the type of service to which the client is connected.

SiteService

String

Yes

The site and service to connect to, in "site.service" format.

SystemAdministrationService

String

Yes

This property is currently not used by the Client object.

SystemLoggingService

String

Yes

Returns the name of the ELS configured for this service. If no ELS is associated with a service, an empty string is returned.

TableReferenceService1

String

Yes

This property is not recommended for use by the FmsClient object.

Note: If used, this property will return a blank value.

TableReferenceService2

String

Yes

This property is not recommended for use by the FmsClient object.

Note: If used, this property will return a blank value.

TableReferenceService3

String

Yes

This property is not recommended for use by the FmsClient object.

Notes:

If used, this property will return the name of the AUD service configured for the connected FMS service.

Use the AuditService property for this purpose.

UserId

String

Yes

Returns the current user ID of the client program.

ValueHistoryService

String

Yes

This property is currently not used by the Client object.