Configuring the CygNet Mobile Notification Plugin

Once the CygNet Mobile Notification Plugin is installed, configure the plugin to interact with your CygNet software installation and the CygNet Mobile Application Suite. After configuring the CygNet Mobile Notification Plugin, you can receive and acknowledge CygNet notifications over your mobile device using the CygNet Operator application.

Configuring CygNet Mobile Notification Plugin can occur using one of the following methods.

See Best Practice for Setting up Notification Record Types in the Notification section of the CygNet Help for more information about planning your GNS records and record types.

Add an Address to an Existing Event Record

To add a primary address record to an existing Group record, use the following procedure.

To Add a Primary Address to an Existing Event Record for the CygNet Mobile Notification Plugin

  1. In CygNet Explorer, open the General Notification Service (GNS) and double-click on the Event record to use. The Properties for Entry dialog box will appear.
    1. On the Addresses page, click New to access the Notification Address dialog box.
      1. In the Type field, use the drop-down menu to select Reference address.
      2. In the Address field, click ... to access the Select GNS ID dialog box. Select the primary address record to use (MOBILE_PRIMARY), and click OK.
      3. Optionally in the Description field, type descriptive text to help you identify the record in the future.
      4. Optionally click to select Propagate resend rules down, and optionally Report Alarm Clear. See Configuring an Address Record in the Notifications section of the CygNet Help for more information.
      5. Optionally click to select Ignore all previous resend rules.
      6. Select to require acknowledgment. Select the Acknowledgment Required check box and continue to the next step.
      7. Optionally select to resend notifications that are not cleared.
      8. Optionally schedule blackouts if required. See Configuring Blackouts in the Notifications section of the CygNet Help for more information.
      9. Click OK to close the Notification Address dialog box.
    2. In the Properties for Entry dialog box, click OK to save the new notification address for the Event record.

Add an Address to an Existing Group Record

To add a primary address record to an existing Group record, use the following procedure.

To Add a Primary Address to an Existing Group Record for the CygNet Mobile Notification Plugin

  1. In CygNet Explorer, open the General Notification Service (GNS) and double-click on the Group record to use. The Properties for Entry dialog box will appear.
    1. On the Addresses page, click New to access the Notification Address dialog box.
      1. In the Type field, use the drop-down menu to select Reference address.
      2. In the Address field, click ... to access the Select GNS ID dialog box. Select the primary address record to use (MOBILE_PRIMARY), and click OK.
      3. Optionally in the Description field, type descriptive text to help you identify the record in the future.
      4. Optionally click to select Propagate resend rules down, and optionally Report Alarm Clear. See Configuring an Address Record in the Notifications section of the CygNet Help for more information.
      5. Optionally click to select Ignore all previous resend rules.
      6. Select to require acknowledgment. Select the Acknowledgment Required check box and continue to the next step.
      7. Optionally select to resend notifications that are not cleared.
      8. Optionally schedule blackouts if required. See Configuring Blackouts in the Notifications section of the CygNet Help for more information.
      9. Click OK to close the Notification Address dialog box.
  2. In the Properties for Entry dialog box, click OK to save the new notification address for the Group record.

Create a New Address Record

To create a new address record, use the following procedure. You will be using the Notification Plugin Manager found in the General Notification Service (GNS) to aid in configuration.

To Create a New Address Record for the CygNet Mobile Notification Plugin

  1. In CygNet Explorer, open the General Notification Service (GNS) and right-click in the white space of the pane to access the context menu. Select View Notification Plugin Manager to access the Notification Plugin Manager dialog box.
  2. In the Edit... or Add... dialog box, specify the following values to configure the CygNet Mobile Notification Plugin settings.
    1. In the Address type field, type ZM.
    2. In the Notification name field, type CygNet Mobile Notification Plugin.
    3. In the Full notification file path field, the address is read-only to display the directory where the plugin assembly files are stored. It will be populated in part with values provided for the Relative notification file path value you enter in the next field, e.g. C:\CygNet\Services\GNS\Plugins\CygNetMobile\CygNetMobileGNSPlugin.dll.
    4. In the Relative notification file path field, define where the custom plugin assembly files are stored relative to the GNS (requires a dedicated directory for each plugin). Type in the location e.g. Plugins\CygNetMobile\CygNetMobileGNSPlugin.dll.
    5. In the Regular expression field, specify acceptable addresses. Enter your primary, and optionally secondary and tertiary, record addresses. Separate multiple values with a pipe, e.g. PrimaryAddress|SecondaryAddress|TertiaryAddress. Default value is .* or all valid addresses.
    6. In the Max parallel notifications field, type the number of push notifications to allow at the same time. Maximum value is 8; default value is 1.
    7. In the Notification time limit field, type the number of seconds to allow for the notification delivery. Value range is 60 seconds (1 minute) - 3600 seconds (1 hour). Default value is 600 seconds (10 minutes).
    8. Click Save to commit the settings and close the dialog.
  3. Validate the settings as follows.
    1. In the Notification Plugin Manager dialog box, click Validate plugins.
    2. If errors occur, resolve the issues. See Monitor Plugin Errors and Validation State, in the CygNet Notification Plugin Interface topic for more information.
    3. When the Plugins validated successfully message appears, click Close to exit the Notification Plugin Manager.
  4. Edit the CygNet Mobile Notification Plugin configuration file as follows.
    1. Open the CygNetMobileGNSPlugin.dll.config file using the text editor of your choice, such as Notepad++. The file is located in the \CygNet\Services\GNS\Plugins\CygNetMobile directory on the CygNet server.
    2. Change the URL value by locating the following line and modifying it to point to your mobile server location:

      <add key="BaseMobileRestUrl" value="https://localhost/" />

      Note: Use forward slashes (/) for the URL values, not backslashes.

    3. Change the GUID value (MobileNotificationGuid) as follows:
      1. Open the Web.config file. The file is located in the \\localhost\Weatherford\CygNetBridge\Website\CygNetBridge directory on the Web server.
      2. Copy the mobile notification GUID values (MobileNotificationGuid) from the Web.config file into the corresponding location in the CygNetMobileGNSPlugin.dll.config file.
    4. Save your changes and close the file.
  5. In CygNet Explorer, in the General Notification Service (GNS), add your desired mobile address records.
    1. If desired, add a Tertiary Notification Address record (GNS Id = MOBILE_TERTIARY). Otherwise skip to the next step and add a Secondary Address record.
      1. In the GNS pane, right-click in the white space to access the context menu and click New to access the New Entry dialog box.
      2. On the Notifications page, do the following.
        1. In the Record ID field, type MOBILE_TERTIARY.
        2. In the Description field, type Tertiary Notification Address.
        3. In the Type field, use the drop-down menu to select Address.
      3. On the Addresses page, click New to access the Notification Address dialog box and do the following.
        1. In the Type field, use the drop-down menu to select CygNet Mobile Notification Plugin.
        2. In the Address field, type Tertiary.
        3. In the Description field, type Tertiary Record.
        4. Select to require acknowledgment. Select the Acknowledgment Required check box and continue to the next step. Otherwise, skip to step H.
        5. If using acknowledgment required, in the Next GNS ID to notify field, click ... and select the GNS Id to use, and click OK.
        6. In the Retries if not acknowledged field, type 1.
        7. In the Minutes to wait between retries field, type 2.
        8. Optionally schedule blackouts if required. See Configuring Blackouts in the Notifications section of the CygNet Help for more information.
        9. Click OK to save the configuration settings.
      4. Click OK to close the property page.
    2. If desired, add a Secondary Notification Address record (GNS Id = MOBILE_SECONDARY). Otherwise skip to the next step and add a Primary Address record.
      1. In the GNS pane, right-click in the white space to access the context menu and click New to access the New Entry dialog box.
      2. On the Notifications page, do the following.
        1. In the Record ID field, type MOBILE_SECONDARY.
        2. In the Description field, type Secondary Notification Address.
        3. In the Type field, select Address.
      3. On the Addresses page, click New to access the Notification Address dialog box and do the following.
        1. In the Type field, use the drop-down menu to select CygNet Mobile Notification Plugin.
        2. In the Address field, type Secondary.
        3. In the Description field, type Secondary Record.
        4. If you are using a tertiary address, select the Acknowledgment Required check box and continue to the next step. Otherwise, skip to step H.
        5. If using acknowledgment required, in the Next GNS ID to notify field, click ... and select the Tertiary GNS Id (MOBILE_TERTIARY) and click OK.
        6. If using acknowledgment required, in the Retries if not acknowledged field, type 1.
        7. If using acknowledgment required, in the Minutes to wait between retries field, type 2.
        8. Optionally schedule blackouts if required. See Configuring Blackouts in the Notifications section of the CygNet Help for more information.
        9. Click OK to save the configuration settings.
      4. Click OK to close the property page.
    3. Add a Primary Notification Address record (GNS Id = MOBILE_PRIMARY).
      1. In the GNS pane, right-click in the white space to access the context menu and click New to access the New Entry dialog box.
      2. In the Notifications page, do the following.
        1. In the Record ID field, type MOBILE_PRIMARY.
        2. In the Description field, type Primary Notification Address.
        3. In the Type field, select Address.
      3. In the Addresses page, click New to access the Notification Address dialog box and do the following.
        1. In the Type field, use the drop-down menu to select CygNet Mobile Notification Plugin.
        2. In the Address field, type Primary.
        3. In the Description field, type Primary Record.
        4. If you are using a secondary address, select the Acknowledgment Required check box and continue to the next step. Otherwise, skip to step H.
        5. If using acknowledgment required, in the Next GNS ID to notify field, click ... and select the Secondary GNS Id (MOBILE_SECONDARY) and click OK.
        6. If using acknowledgment required, in the Retries if not acknowledged field, type 1.
        7. If using acknowledgment required, in the Minutes to wait between retries field, type 2.
        8. Optionally schedule blackouts if required. See Configuring Blackouts in the Notifications section of the CygNet Help for more information.
        9. Click OK to save the configuration settings.
      4. Click OK to close the property page.
  6. In CygNet Explorer, in the General Notification service (GNS), add a new notification Event record to contain the address to use for reporting alarms. See Configuring a GNS Record in the Notifications section of the CygNet Help for more information about the process.
    1. Right-click in the Database pane to access the context menu, and then click New to open the New Entry dialog box.
    2. On the Notifications page, enter MOBILE_PRIMARY_E as the Record ID name, and in the Details section select Event as the Type.
    3. On the Messages page, enter both Set and Clear messages as desired.
    4. On the Addresses page, click New to enter a notification Address for the new Event. Only create one address entry. Select Reference address as the Type, and enter MOBILE_PRIMARY as the Address value.
    5. Click OK to save the address, and then OK to save the new event notification entry.
  7. In CygNet Explorer, open the Point service (PNT), to configure point properties to report to the primary mobile GNS ID (MOBILE_PRIMARY_E). Notifications from these points will be sent to the mobile service, which will notify appropriate users based on their hierarchy assignments. See Editing Points and Point Configuration Manager Utility in the Points section of the main CygNet Help and more information about configuring point properties.
    1. In the PNT pane, double-click on the point you want to edit, or right-click on the point desired to access the context menu and then click Properties, to access the Properties for Point dialog box.
    2. Click Edit to access the editable fields to edit properties for the point.
    3. On the [point type] page (e.g. Analog, Digital), click the corresponding Report to GNS check box to configure each desired alarm. To specify the GNS ID value, type in MOBILE_PRIMARY_E, or click ... to select MOBILE_PRIMARY_E from the GNS IDs available in your service. This is the GNS ID you previously configured to have the MOBILE_PRIMARY address value.
    4. Click Save to save your changes and return to the service pane.

      Note: In the PNT Editor, when not in Edit mode, you can use the Previous and Next buttons to access additional points to perform more edits without returning to the service pane.

    5. Click Refresh to retrieve the new point information.

Back to top