Notes > Notes Overview > Installing the Note Service

Installing the Note Service

The following procedure explains how to install and add a single new Note Service to an existing system. If you are upgrading an existing CygNet system and do not already have a Note Service installed on your host, you must manually install and add a Note Service in order for it to become available. If you do not already have a Note Service installed, performing an upgrade does not automatically install a Note Service, even though its files are included in the upgrade source files. Once you've manually installed and added a Note Service to your existing system, future system upgrades will upgrade your Note Service.

While this procedure focuses on how to install a single instance of a Note Service, you can install and add multiple new Note Services. Merely repeat the steps below for each instance of a new Note Service. You can associate as many current value services (i.e., UIS, SVCMON, HSS, and/or OPCIS) as you like with a single Note Service. However, each associated current value service can only be associated with a single Note Service. For instance, Note Service A can contain notes referencing data from both UIS A and UIS B. However, UIS A can only be associated with Note Service A and UIS B can only be associated with Note Service A.

Although a Note Service can be installed along with other CygNet Software components during a fresh installation, the procedure below does not apply to such a scenario.

For a fresh CygNet installation, a Note Service is selected by default in the CygNetSCADAServicesSetup.exe. See the CygNet Quick Start document or contact CygNet Support to access resources to assist with initial CygNet Software installation.

To Install a Service

  1. Using Windows Explorer, open your CygNet\Services directory and create a Note folder there. (Optionally, create two new folders on different drives: one for executables and one for data.)
  2. Copy the following source files to your new Services\Note folder: Note.cfg, Note.ddl, and Note.exe.
  3. Edit the Note.cfg file in one of the following two ways:
  1. Add the new Note Service to the relevant Address Resolution Service (ARS).
  1. Using CygNet Explorer, open the ARS, right-click in its service pane, and click New.
  2. In the New Service dialog box, select the Service Type. It is NOTE.
  3. Type the Site and Service names.
  4. Type a Description for the service and click OK.
  1. Add the new Note Service to the Remote Service Manager (RSM).
  1. Using CygNet Explorer, open the RSM, right-click in its service pane, and click New.
  2. In the New RSM Entry dialog box, select the new Note Service and confirm or alter its default settings.
  3. Optional: If the Note Service executable and data folders are not under the same Services folder, type their directory paths in the Executable and Data fields respectively.
  4. Optional: Click Automatic Service Recovery… and configure recovery settings.
  5. Click OK to save RSM settings.
  1. Once the service is added to the RSM, right-click its entry in the RSM and click Start.
  2. Add security settings for the new Note Service. See Security – Implementing Security and Note Service (NOTE) Security for more information about adding Applications, Permissions, and Events to the Note Service.
  1. Make sure your ACS is running. Using CygNet Explorer, click Access Control Service (ACS) in the service hierarchy.
  2. Right-click in the service pane and click Apps List.
  3. Click New in the Applications List dialog box.
  4. On the Events and Permissions page, add a NOTE application and create two new events, ACCESS and ODBC:  
  1. In the Application field, type NOTE.
  2. In the Description field, type a description, such as "Note Service".
  3. Click New in the Events area.
  4. In the Event field, type ACCESS.
  5. In the corresponding Description field, type Access. Click OK.
  6. Repeat step iii. through v. for ODBC.
  1. In the same dialog box, select each new event from the Events drop-down menu and add its permissions:
  1. In the Permissions area, click New.
  2. Select the Type, Group, and Access Level for each event using information from the following table as a guide. Your site can require different security settings:

Event Type Group Access Level

ACCESS

CG - CygNet Group

ADMINS

2 - Update

ODBC

CG - CygNet Group

ADMINS

1 - Read

  1. Click OK to save the Application.
  2. Click Close to close the Applications List dialog box.
  1. Associate relevant current value services (i.e., UIS, SVCMON, HSS, and/or OPCIS) with the new Note Service.

  1. Using Windows Explorer, open your CygNet\Services directory and locate the relevant current value service folder.
  2. Open the current value service folder, and open the configuration file found there.
  3. Go to the Associated Services section of the .cfg file and either uncomment the NOTE entry or add a NOTE entry in the same format as other associated services.
  4. Save and close the .cfg file.
  5. In CygNet Explorer, go to the RSM, right-click the relevant current value service in the service pane, and select Restart. This completes the association process.
  6. Repeat steps a. - e. for each associated current value service.

  1. Now that your Note Service is installed, you can configure and customize it for your system. See Note Service and Using Notes for more information.
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.