VHS Endpoint

The following table describes unique properties in the VHS endpoint section of the sample_appsettings.json file. It specifies DynaCard data to be published, which can be consumed by ForeSite.

See CygNet Service Endpoints for the common properties for all service endpoints.

Property Description Required Property: Value Example

publish

Specifies the history data to be published to the target. The VHS endpoint contains properties that describe the following:

yes

"publish": [

{

"dynaCard": "CYGNET.UIS::WELLPILOTC001",

"qualityOfService": "Low"

}

]

dynaCard

For a VHS endpoint dynaCard specifies the site service and facility portion of the full DynaCard tag for which data will be provided to the target endpoint. Each dynaCard value will resolve to a set of points that uses DynaCard UDCs (e.g., DYNLIBCRNT, DYNLIBFULL, DYNLIBPMOF, DYNLIBALRM, DYNLIBFAIL, DYNLIBIDEA, DYNLIBSTRT, DYNLIBREFR, and DYNLIBPTRN). dynaCard values take the form of SITE.SERVICE:FACILITY or SITE.SERVICE::FACILITY.

yes

See publish above.

qualityOfService

The value used to determine how data is sent to the server in the case of intermittent communication failure. This optional property can be used to override the default quality of service (QoS) specified with defaultQualityOfService. Possible values include:

  • Low — The message delivered to the server at most once
  • Medium — The message delivered to the server at least once
  • High — The message delivered to the server exactly once

no

See publish above.