Points > Points Overview > Understanding the CVS Metadata File

Understanding the CVS Metadata File

The CVS Metadata (CvsMetadata.xml) is an XML file found in the CygNet\Services\ARS directory that defines the configuration for point schemes, colors, alarm priority categories, point state definitions, status bits and definitions, and point state instances and definitions for a CygNet domain.

For CygNet installations that use the default point scheme, which is known as the CygNet Standard Point Scheme (Point Scheme number 0), modification of the CvsMetadata.xml file is not possible.

For CygNet installations that want to use an alternate point scheme, the CygNet Enhanced Point Scheme (Point Scheme number 1-15) is available as a separately licensable entity, and modification of the CvsMetadata.xml must be completed by a CygNet Administrator. This section describes the elements and attributes included in the CvsMetadata.xml file.

Note: Modification of the CVS Metadata file affects all sites on a domain. This file must reside in the ARS directory and is distributed by the Master ARS.

For more information on retrieving point metadata information via script, see the PointMetadata Object.

See the following subsections for information about using the file:

See the following topics for information about elements and attributes comprising the file:

Structuring the CvsMetadata File Hierarchy

The basic hierarchical structure of the CvsMetadata.xml file is displayed below. The top-level, or root, element of the file is CvsMetadataDefinition.

The following sections describe the Elements and Attributes defined in a non-standard (enhanced) CygNet CvsMetadata file. Click on any link below to go to a description of that element.

<CvsMetadataDefinition>

<Colors>

<Color name="" value=""/>

</Colors>

<PointSchemes>

<PointScheme id="" desc="" blink="" oldsinglecolorblink="" enumooraction="">

</PointSchemes>

<AlarmPriorityCategories>

<AlarmPriorityCategory id="" name="" desc="" lower="" upper="" facinfovalue="" soundvalue=""/>

</AlarmPriorityCategories>

<PointStateDefinitions>

<PointStateDefinition id="" name="" desc="" displayorder="" token="" singlecolor="" fgcolor="" bgcolor="" alarmcondition=""/>

</PointStateDefinitions>

<StatusBits>

<StatusBitsForScheme pointschemes="">

<StatusBitDefinitions pointtypes="">

<StatusBitDefinition bitid="" desc="" displayorder="" calcorder="" calctype=""/>

</StatusBitDefinitions>

<StatusBitDefinitions pointtypes="">

<StatusBitDefinition bitid="" desc="" displayorder="" calcorder="" calctype="">

<CalcParameter1 desc=""/>

</StatusBitDefinition>

</StatusBitDefinitions>

</StatusBitsForScheme>

</StatusBits>

<PointStateInstances>

<PointStateInstancesForScheme pointschemes="">

<PointStateInstanceDefinitions pointtypes="">

<PointStateInstanceDefinition pointstatename="" precedence="" matchmethod="">

<StatusBit bitid=""/>

</PointStateInstanceDefinition>

</PointStateInstanceDefinitions>

</PointStateInstancesForScheme>

</PointStateInstances>

</CvsMetadataDefinition>

Updating the CvsMetadata.xml File

To apply a new CvsMetadata.xml file to a production system, perform the following steps:

  1. From your "license master" ARS, copy the existing CvsMetadata.xml file to a backup location.
  2. Overwrite the CvsMetadata.xml file in your "license master" ARS with the new version provided. There is no need to stop the ARS service.
  3. Stop and restart all CVS-based services (HSS, OPCIS, SVCMON, and UIS) and any PNT services.
  4. Restart all client instances of CygNet Studio and CygNet Vision.
  5. Repeat this process for any other CygNet domains in your enterprise.

Note: You may also need to use the Point Configuration Manager utility to change the point scheme. Contact CygNet Support for more information and technical assistance.

More:

ArrowCvsMetadataDefinition

ArrowCygNetStandardMetadata

ArrowColors

ArrowPointSchemes

ArrowAlarmPriorityCategories

ArrowPointStateDefinitions

ArrowStatusBits

ArrowPointStateInstances

Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.