Service Trigger

See Also

Introduction to Triggers, Available Triggers, Using AMTrigger, Setting a Service Watcher Trigger

 

Description

Launches task when the specified service starts, stops, pauses, resumes or stops responding. To indicate partial service names, use wildcard characters * and ?.

Practical Usage

Frequently used to monitor service applications for unexpected crashes.

Parameters

General Tab

Wait for service to

Specifies the service action to monitor. The available options are:

Service Name

Specifies the name of the service to watch. The provided combination list box accepts manual text entry or the service can be selected from the drop-down list of open services. Wildcard characters * and ? can be used to indicate partial service names. For example, entering e*.exe will watch for all processes starting with the letter e.

Behavior Tab

Trigger on startup if condition is true

If enabled, the system will act upon conditions that already exist upon startup of the current trigger. For example, if the Notepad window is already open on the desktop, a newly created Window trigger set to monitor for the existence of a Notepad window will trigger the task as a result. If disabled, the trigger will ignore the open Notepad window upon startup.

Trigger after the condition has been met 'X' times.

If enabled, specifies how many times the trigger condition must be met before the task is started (disabled by default). This parameter is available in all triggers except the Schedule Trigger.

AMTrigger Parameters

When this trigger is activated, it automatically passes the "AMTrigger" object to the task. AMTrigger can be used within a task to determine whether or not the task was started by a trigger, which trigger started the task, when the trigger was activated and other trigger related properties. For more details, see Using AMTrigger.

Common AMTrigger Fields

Every instance of AMTrigger populates a list of common fields which are described in the table below.

Name

Data Type

Return Value

AMTrigger.Trigger

String

Returns the name of the event or condition that triggered the task. Each event or condition contains a unique name. For this trigger, the value is always AMSERVICETRIGGER.

AMTrigger.TaskName

String

Returns the name of the managed task that the trigger was attached to. Useful to determine the responsible task when two managed tasks point to the same AML file.

AMTrigger.TriggerredDateTime

String

Returns the date and time when the trigger occurred.

AMTrigger.TriggeredOn

String

Returns the machine name where the trigger occurred.

AMTrigger.WasLocked

Boolean

If the workstation was locked when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.WasLoggedOff

Boolean

If the workstation was logged off when the trigger occurred, the value returned is 1. Otherwise, it will be 0.

AMTrigger.AML

String

Returns a verbose set of information about the triggered event or condition in AML (AutoMate Markup Language) format.

 

Specific AMTrigger Fields

The AMTrigger fields described in the table below are specific only to Service triggers.

Name

Data Type

Return Value

AMTrigger.Action

 

Text

Specifies the type of wait that the trigger used. The available returns are:

  • START: The trigger was set to wait for the service to be started.

  • STOP: The trigger was set to wait for the process to be stopped.

  • HUNG: The trigger was set to wait for the service to stop responding

  • RESUME: The trigger was set to wait for the service to be resumed (started after pause).

  • PAUSE: The trigger was set to wait for the service to be paused.

  • INSTALLED: The trigger was set to wait for the service to be installed.

  • REMOVED: The trigger was set to wait for the service to be removed.

AMTrigger.ServiceName

Text

Returns the short name of the service as shown in the service properties.

AMTrigger.ServiceDisplayName

Text

Returns the display name of the service as shown in the service properties.

AMTrigger.Filename

Text

Returns the path and filename of the service being watched.

 

NOTE: A full list of AMTrigger objects exclusive to each trigger can be viewed from the Expression Builder by expanding Objects -> Triggers and selecting the desired trigger.

See Also

Setting a Service Watcher Trigger

About Triggers

All Available Triggers

Using AMTrigger