Configuring a Broker Service

A Broker Service is an application that runs continuously on a server. Services are customizable by choosing which program to run, any arguments passed via the command line to modify the behaviour of the application, and the configuration that the service uses to gather additional settings. Most services also require the use of rules for the processing of data.

Dependencies

Best Practices

When configuring a new service, it is best practice to clone the original service and modify the clone instead of using the original. Use a unique naming convention to ensure that any new service you create is distinguishable from the existing services.

Configuring a Broker Service

  1. Review the documentation for the Unified Assurance application for which you want to configure a service to understand what elements are required to configure and utilize the application.

  2. If the service requires configuration in the UI, navigate to the appropriate UIs and create the settings.

  3. If the service requires rules:

    1. From the main navigation menu, select Configuration, and then Rules.

    2. Either create new rules files or modify the default rules.

    The documentation for each application provides details on rules creation.

  4. From the main navigation menu, select Configuration, then Broker Control, and then Services and do one of the following:

    • Add a new service.

    • Clone and modify an existing service.

    • Modify the default service by editing any pre-configured service (least recommended).

    Ensure that the Status of the service is set to Enabled.

    The documentation for each application provides more information about the service settings.

  5. To immediately start the application, select the service in the list, then click Start.

    Check the service to make sure that a PID (Process ID) has been generated by the system and is in the Last PID column. If a PID is not generated, consult the log file for any error messages.

  6. If you want to validate whether a service is operating correctly, navigate to the Logs UI via the navigation bar and view the log file for the service.