How to publish status for use outside GroundWork

The Publish status tool enables GroundWork service information available outside of the GroundWork portal. This tool is intended to help make available selected service status information for use in custom dashboard applications (e.g., NOC, departmental status page). You can create data templates and associate them with exported data, allowing you to customize how the data from GroundWork gets displayed. The status is updated regularly on a configurable interval. It’s not real-time, but it’s never far behind.

Create clients

Client Information

A client in this context is simply a location where specific content can be accessed, along with a specification of what data to show, in what format, and with what template.

  1. To create a client, go to Configuration > BSM and SLAs > SLA Dashboards.
  2. Go to the Publish status tab.
  3. Select Create client.
    • After creating clients, use View clients tab to list existing clients. To make changes to a client click the corresponding edit icon (pencil). To permanently remove a client click the corresponding X icon.
  4. Enter the fields within the Client information form:
    • File: A unique name for the file that will hold the exported content. If you leave it blank, an MD5 sum will be generated and used. You may want something more descriptive, however.
    • Name: The HTML name of the content in the File. This is optional, but can be used to label the content.
    • Description: Can show text information in the HTML that is generated.

      client information
      • You can make the Name and Description appear or be hidden by adjusting the HTML template (see View Export Templates below). You can also adjust the relative position of the included fields.
      • In the following example, the Name field is set to Service Live Status, and first in the item order. The Description field is omitted from the template, so it is irrelevant what the content actually is in this case.

        client information example

Monitoring settings

Under Monitoring Settings, select the services to be published.

  1. Select a host from the drop-down menu.
  2. Based on the host selected, highlight the services for the host, using Shift for multiple services.
  3. Click Add selected.
  4. On the right, an additional configuration field can be opened for the added services.
    • The displayed name field is used to customize the name of the service displayed in the external view.
    • The Additional information field is used to display one text item per service, for example a maintenance note. This field, if supplied, generates an information button that shows this text when clicked. In the image above you can see the information symbol next the the E-Mail service which has data.

      monitoring settings

Monitoring options

In the Monitoring Options section, the export data format and location are specified.

  1. Under Export format you can choose one or more of the listed formats. 
  2. Each format used requires its own Export template. On this screen you can select only existing templates. See below to edit or create your own.
  3. Use Transfer method to choose between SSH, FTP and Local. 
    • If SSH is selected as the transfer method, the Host, Path, and User must be specified. An existing private and public key can be specified here. If the keys are omitted, the system automatically generates a new key pair with 2048 bits.
    • If FTP is selected, the HostPathUser and Password must be specified.
    • For Local, only the Path to where the files will be copied to the local file system needs to be specified.
  4. After saving the new configuration, the Publish status cronjob will run the client regularly (default is every 5 minutes) and transfers the data to the chosen location. The service status is thus regularly updated in the external location.

    monitoring options

Create export templates

  1. In the Create Export Template tab, you can create your own templates for any and all export formats. 
  2. In the Name field, provide the template name. This is the name you will see when selecting the Export Template for a client under Monitoring Options.
  3. In the View Export Templates tab, you can see the list of all defined templates you have defined, which can be edited or deleted.
  4. Each template is specific to an export type. You can select the Export type for a template.
    • For the HTML export type, there are several placeholders described on the template editing screen which can be used in the template code. CSS and JS are allowed in the Content field. This allows the template to be integrated with a central CSS file, and the placeholders can be used to give the displayed data more context (such as the time stamp of the cronjob, the service description data, etc).
  5. In the Description field, enter text to describe the template. This information is not available in the exported view of the service content, it is to help you keep track of the templates use. 
  6. The Content field contains all the generated code that will be present in the exported file.

    export templates

Related articles