CygNet Device Template Manager Utility
Important: The CygNet Device Template Manager utility enables device type-specific device template file validation but it does not automatically correct errors found in your device template file(s). If you are performing an upgrade, you must first use the CygNet Service Migration Utility Correct errors in template files option for your current version of CygNet to check your device template files at the service level and to automatically repair many device template file errors. Then you must run the CygNet Device Template Manager utility to locate any errors the CygNet Service Migration Utility did not catch and repair. See the CygNet Upgrade Procedure for more information.
The CygNet Device Template Manager utility (DtfMgr.exe) is useful for validating device template files (both .dtf and .xml) against the current validation rules of a specific EIE, loading valid device template files to a Device Definition Service (DDS), and comparing differences between device template files, among other things.
Deviations from a device template file's validation rules appear in the Results field of the CygNet Device Template Manager utility. These results help you to troubleshoot problems with your device template file. If you find that your device template file is invalid, open it in an XML editor and make the required changes. Once your device template file is in line with the appropriate device-specific validation rules, use the CygNet Device Template Manager utility to (re)load your valid device template file to the DDS.
The CygNet Device Template Manager utility is stored in the CygNet\Utilities directory (DtfMgr.exe) on the host server. To start the utility, use Windows Explorer to browse to the directory and double-click the program icon.
Note: You can also set up this utility to be installed and launched (started) via CygNet Client Installer so that the application can be version managed. See Version Management for instructions on how to do this.
For more information, see the subsections below:
For more information about device template file validation, see Validating Templates and template file subsections specific to your remote device types.
|
| Sample CygNet Device Template Manager Dialog Box |
To Validate an Unloaded Device Template File
- Go to the CygNet\Utilities directory on the host server and open the CygNet Device Template Manager utility (DtfMgr.exe).
- Make sure the DDS Service field is blank.
- In the Template File Name field, use the Browse button and/or wildcards to locate and select the device template file(s) you want to validate.
- Click Validate Template(s) to validate the device template file(s) displayed in the Template File Name field. The outcome of the validation appears in the Results pane.
- If your device template file(s) is not valid, locate the device template file(s) in your file system, open it in an XML editor, and make edits, then revalidate it to check your work. Issues are displayed one at a time, so you must rerun the CygNet Device Template Manager utility until all issues are repaired.
- Continue locating, selecting, and validating unloaded device template files to suit your needs.
- If you want to load a validated device template file(s) to a DDS, see To Load a Device Template File.
To Validate All Device Template Files in a DDS
Note: The following procedure is useful if you are performing a CygNet upgrade because CygNet device template file validation rules change from release to release. Validating all deployed device template files at once is more efficient than validating them one at a time. However, any issues found must be manually resolved one at a time before the device template file(s) can be reloaded into your DDS.
- Use Windows Explorer to browse to the CygNet\Utilities folder on the host server.
- Start the CygNet Device Template Manager utility by double-clicking the program executable (DtfMgr.exe).
- Browse to and select the relevant DDS.
- Leave the Template File Name field blank. If you mistakenly browse to and select a device template file for this field, it overrides template validation for the DDS selected above.
- Click Validate Template(s). Doing so identifies all invalid templates for the selected DDS.
- Take note of each invalid template. If all templates are valid, skip to step 4c below.
- Using CygNet Explorer, open the relevant DDS.
- Right-click in the DDS pane and select Device Definitions....
- Select an invalid template and click Extract from DDS.
- Do so for each invalid template noted above.
- Return to the CygNet Device Template Manager utility and use the Browse button beside Template File Name to select an extracted invalid template.
- Click Validate Template(s). Doing so displays issues with the extracted invalid template one at a time.
- For each issue that the CygNet Device Template Manager utility finds, manually edit and save the extracted device template file, then re-click Validate Template(s) in the CygNet Device Template Manager utility until no more issues are found for that template.
- Compare your valid extracted template to the latest CygNet version available to ensure that your template is current and has all of the available functionality offered by CygNet.
- When no issues remain for a template and you've compared your valid version to the latest CygNet version and made any desired updates, return to the CygNet Device Template Manager utility, enter the name of a valid extracted template in the Template File Name field, and click Load Template(s).
- Save the newly validated template to a location that identifies it as a valid and current template.
- Repeat steps a - e until all invalid templates are valid, current, and loaded into the relevant DDS.
- Click Close to exit the utility.
To Load a Device Template File
- Go to the CygNet\Utilities directory on the host server and open the CygNet Device Template Manager utility (DtfMgr.exe).
- In the DDS Service field, enter the name of the destination DDS.
- In the Template File Name field, use the Browse button and/or wildcards to locate and select the device template file(s) you want to (re)load.
- Click Load Template(s) to load the device template file(s) displayed in the Template File Name field. The load process in the CygNet Device Template Manager utility performs an EIE-specific validation and only loads the device template file(s) if it is valid.
Important: If two device template files have the same file name and you load the new valid version to your DDS, it overwrites the old valid version.
- Continue loading device template files to suit your needs.
To Compare Two Device Template Files
- On the CygNet Device Template Manager dialog box under Options, click Compare. This opens the Compare Templates dialog box.
- Select a device template file for the Template 1 field.
- Select a device template file for the Template 2 field.
- Click Compare. The Template Comparison dialog box opens.
- On the Template Comparison dialog box, differences between the selected device template files are indicated by node on a tree view under the Diff View page. Highlight the indicated node to display specific differences between these nodes in the two device template files.
- Attributes and child elements of the highlighted node display in the Attributes and Child Elements fields. Differing attributes and child elements and their values are highlighted. Select highlighted differences to display additional details in the More Information fields, including a description of the difference.
- Click the XML View page to see a read-only version of the device template file you selected for the Template 1 field.
CygNet Device Template Manager Utility Properties
The following table lists and describes the various properties of the CygNet Device Template Manager utility.
|
DDS Service
|
The name of the DDS affected by the validation and/or load. Carefully select the correct one.
|
|
Template File Name
|
The name of the device template file(s) you are validating and/or loading. File extension can be .dtf or .xml.
|
|
Results
|
This field displays the results of your validation and/or (re)load. Fails are clearly indicated, and notes provide information about the error(s).
|
|
Clear Results
|
Use this button to clear unwanted result information in the Results field.
|
|
Load Template(s)
|
Initiates the load of one or more device template files to the selected DDS.
Important: If two device template files have the same file name and you load the new valid version to your DDS, it overwrites the old valid version.
|
|
Validate Template(s)
|
Initiates the validation of one or more device template files.
|
|
View/Edit
|
Enables the viewing and editing of a single device template file selected in the Template File Name field.
It is useful for correcting invalid device template files on an ad hoc basis, then revalidating them in the CygNet Device Template Manager utility. If you use this button, the template opens in Notepad.
Wildcards are not allowed for this operation because the CygNet Device Template Manager utility must know the specific device template file in order to open it for viewing.
|
|
Synch Registry
|
The Synch Registry button enables you to synchronize the client-side DDS registry with a connected host DDS. All device template files in the DDS are synchronized.
Benefits include deleting all local device template file registry entries that no longer exist in the connected host DDS and ensuring that functionality between the client DDS and host DDS is consistent.
|
|
Options
|
Options include the following:
- Compare: Use the Compare option to compare two device template files. The feature helps you to focus on differences between device template files and to change them as needed. For more information, see To Compare Two Templates.
- Device Specific: The Device Specific option enables you to drill deeper into a specific remote device type device template file than standard validation does. Sets of information specific to the remote device type display, making troubleshooting simpler. This functionality varies by remote device type. For more information, see Device-Specific Options.
- Look for Potential Upper/Lower Case Errors: Use this option to validate your device template file by case. It helps focus your troubleshooting on incorrect case errors, a common and subtle problem in device template files. This option is not foolproof: you must still manually check that each potential case error is an actual error in your specific template.
|
|
Close
|
Click this button to exit the CygNet Device Template Manager utility.
|
Device-Specific Options
The following table lists and describes device-specific options found on the Options drop-down menu with their associated EIEs.
|
AutoCom EIE
EProd EIE
FB EFM3000 EIE
FlowAuto EIE
Lufkin MPC EIE
Lufkin SAM EIE
NuFlo EIE
Totalflow EIE
|
Item ID Map: Displays all Item IDs and their corresponding elements and data groups for a selected device template file.
|
|
Benchmark EIE
|
The following are all options for the device type selected:
- GMR Config Info: Displays all FMS Legacy config items and their corresponding parameters for a selected device template file.
- GMR Event Info: Displays all FMS Legacy event items and their corresponding parameters for a selected device template file.
- GMR History Info: Displays all FMS Legacy history items and their corresponding parameters for a selected device template file.
- Item ID Map: Displays all Item IDs and their corresponding elements and data groups for a selected device template file.
|
|
Eagle EIE
Modbus Realflo EIE
Thermo EIE
|
The following are all options for the device type selected:
- Cache Data Elements: Displays all when clause items for a selected device template file.
- FMS Alarm Info: Displays all FMS alarm items and their corresponding parameters for a selected device template file.
- FMS Config Info: Displays all FMS config items and their corresponding parameters for a selected device template file.
- FMS Event Info: Displays all FMS event items and their corresponding parameters for a selected device template file.
- FMS History Info: Displays all FMS history items and their corresponding parameters for a selected device template file.
- Item ID Map: Displays all Item IDs and their corresponding elements and data groups for a selected device template file.
|
|
FB Net EIE
|
The following are all options for the device type selected:
- GMR Config Info: Displays all FMS Legacy config items and their corresponding parameters for a selected device template file.
- GMR Event Info: Displays all FMS Legacy event items and their corresponding parameters for a selected device template file.
- GMR History Info: Displays all FMS Legacy history items and their corresponding parameters for a selected device template file.
|
|
Micro1C EIE
Modbus EFM EIE
Modbus Omni EIE
|
The following are all options for the device type selected:
- FMS Config Info: Displays all FMS config items and their corresponding parameters for a selected device template file.
- FMS Event Info: Displays all FMS event items and their corresponding parameters for a selected device template file.
- FMS History Info: Displays all FMS history items and their corresponding parameters for a selected device template file.
- Item ID Map: Displays all Item IDs and their corresponding elements and data groups for a selected device template file.
|
|
ProSoft EIE
|
The following are all options for the device type selected:
- Cache Data Elements: Displays all when clause items for a selected device template file.
- GMR Config Info: Displays all FMS Legacy config items and their corresponding parameters for a selected device template file.
- GMR Event Info: Displays all FMS Legacy event items and their corresponding parameters for a selected device template file.
- GMR History Info: Displays all FMS Legacy history items and their corresponding parameters for a selected device template file.
- Item ID Map: Displays all Item IDs and their corresponding elements and data groups for a selected device template file.
|
|
|
|
