Service Monitor

Detail Forms:

Service Audit

Service Instance Details

Error View

The Service Monitor form is used to run and monitor your company's service instances. You can use this form to schedule a service instance to run immediately without having to set up a schedule on the Service Schedule tab of the Service Instance form. The Service Monitor form can run the instance immediately, no matter what the service instance schedule reflects.

On the Service Monitor form you can:

The application includes a set of system-required service instances, some of which have a default schedule. However, you must check the Enabled box on the Service Schedule form in order to initiate each schedule.

In order to view the status of past and future service instances, you must first create and configure the instance on the Service Instance form.

See Also:

Service Monitor Field Descriptions

Find a Service Instance

Error View

Schedule Immediately

Stop Service

Configure Columns

Sorting Records

Download Records

 

Service Monitor Field Descriptions

Process Name

The Process Name is the template on which the service instance is based. Each template may contain several processes.

To display service instances with a specific Process Name, click the Filter button and select the Process Name from the drop-down list. Click Find. The appropriate services appear in the middle of the form.

The Process Name column in the middle of the form displays the Process Name for a specific service instance.

Instance Name

The Instance Name identifies the unique name of a service instance. A service instance is an activity in which one or several processes (i.e., services) are run with specific parameters. One service can run within different instances. For example, you can schedule a service to run with one set of parameters daily, and another set of parameters bi-weekly. This configuration would require two different Instance Names. The application includes a set of system required service instances.

Status

The status indicates the current status of the service.

Running - The service is currently running.

Success - The last service attempt was successful.

Error - The last service attempt was not successful.

Scheduled - The service instance is scheduled to run sometime in the future. You can schedule the service instance via the Service Instance form.

Stopped - The service was stopped. The service can be stopped via the Stop Service button.

Warning - The service was not enabled and exited without processing.

As Of Date

This field in the Filter section of the form shows the date and time when records shown on the form were retrieved from the database. To ensure you are displaying the most current information for your service instances, click Clear to update the As Of Date to the current date and time.

Last Run Start

Indicates when the instance started during its last scheduled run.

Last Run End

Indicates when the instance ended during its last scheduled run.

Last Run Duration

Indicates how long the instance lasted from start to end during its last scheduled run.

Last Run By

Indicates who scheduled the instance.

Next Scheduled Run

Indicates when the next instance is scheduled to run.

Timezone

Identifies the timezone by which the service runs.

Host

Location from which the service instance will run.

Port

Port number from which the service instance will run.

Enabled

When this box is checked, the service instance is available to run.

Error Log Count

Shows the number of Error Log records that occurred when the service instance ran. If there are any errors, this field will appear red with the number of errors. Otherwise the field will display zero (0) and no color. You can change this field’s color by modifying the Service Error Log Count context in the Color Policy.

To view the service’s errors, select the record in the Service Monitor form and click the Error View button.

 

Find a Service Instance

  1. Click Main Menu > Administration > Services > Service Monitor.

  2. If the record you are searching for is not visible on the form, you can use the filter fields to search for it. To display the fields, click the Filter button.

  3. To find services with a specified Process Name, select the Process Name from the drop-down list. You can also use the Instance Name, Status, and Enabled fields to narrow your search.

  4. Click Find.

    The service instances that match your criteria will appear in the middle of the form.

    Use the Schedule Immediately, Stop Service, Service Audit, and Service Instance Details buttons to run, stop, or view information about a selected service.

 

Schedule Immediately (Run a Service)

When you schedule an instance immediately, it is put in queue to run immediately regardless of its Service Schedule.

  1. Click Main Menu > Administration > Services > Service Monitor.

  2. Find and select the service instance you want to run.

  3. Click Schedule Immediately on the toolbar.

    A status message will appear on the form (Success, Running, or Error).

 

Stop Service

Services that are currently running can be stopped by pressing the Stop Service button on the Service Monitor form. Only one service can be stopped at a time.

  1. Click Main Menu > Administration > Services > Service Monitor.

  2. Select a service.

  3. Click Stop Service.

Note: When you click Stop Service, a request is made to stop the service. The Status column in Service Monitor will display Stopped and the Audit Type column on the Service Audit form will also display Stopped. However, if the service is in the process of executing a query when you click Stop Service, the service will finish executing the query before actually stopping.

 

Configure Columns

To rearrange the columns, drag a column to its new location.

When you Lock a column, the column moves to the left side of the grid. The locked columns will remain visible when you scroll the form with the horizontal scroll bar.

To Lock or Unlock a column, click the button on the right side of the column name and select the Lock or Unlock option.

To show or hide the available columns, click the button on the right side of the column name and select the Columns option. Check the box next to a column to show it. Uncheck the box to hide the column.

The available Columns will depend on which columns are enabled for the form in your Form Profile.

 

Sorting Records

To sort records by a particular column, click the column name or click the button on the right side of the column name and select Sort Ascending or Sort Descending from the pop-up menu.

The  icon in the column name indicates the data is sorted in ascending order (A - Z). The icon indicates the data is sorted in descending order (Z - A).

Note: Sorting will be disabled if the column is not selected as a Sortable Field in your Form Profile.

 

Download Records

To download the employee records on the Current Situation form, click the Download button. Your web browser will display a message asking if you want to open or save the .csv file. Open the file to view it immediately or click Save to save it to disk.