Services - Install

Declaration

<AMSERVICES ACTIVITY="install" EXECUTABLE="text" DISPLAYNAME="text" 
USERNAME="text" PASSWORD="text (encrypted)" />

Description: Installs the specified service into the Service Control Manager (SCM) so that it can be started and stopped. This activity supports installation of a service onto the local machine or a remote machine.

Practical Usage

Used to install a service onto the local or remote system. Administrator privileges are usually required to perform this activity.

Service Parameters

Property Type Required Default Markup Description

Path to service executable

Text

Yes

(Empty)

 EXECUTABLE="c:\service.exe"

The path and file name of the service to install. Note that the executable file must be present on the target machine prior to installation. Additionally, when installing to a remote machine, the path to the service should be expressed in terms of the file's location on that machine. For example, the path should be entered like this: "c:\servicename.exe" and not like this: " font-style: normal;">\\computername\c$\servicename.exe".

Display name

Text

Yes

(Empty)

 DISPLAYNAME="My Service"

The name of the service as it should appear in the Service Control Manager (SCM).

Service account username

Text

Yes

(Empty)

 USERNAME="username"

The username that the service should use to log on. The service automatically inherits the rights of the user specified in this field.

Service account password

Text

Yes

(Empty)

 PASSWORD="password"

The password corresponding to the service account username.

Error severity

Text (options)

No

Normal

 ERROR="critical"

If the service generates errors, indicates how the errors should be written to the system event log. The available options are:

  • Normal (default) - Errors are logged as normal.

  • Ignore - Errors are ignored.

  • Critical - Errors are logged as critical.

  • Severe - Errors are logged as severe.

Service type

Text (options)

No

Own Process

 SERVICETYPE="shared_process"

The type of service to install. The available options are:

  • Runs in own process (default) - The service runs in it's own process space.

  • Shared process - The service runs in a shared process space.

  • Kernel driver - The service is a kernel driver.

  • File system - The service is a file system driver.

Run type

Text (options)

No

Automatic

 RUNTYPE="manual"

The service startup type. The available options are:

  • Automatic (default) -The Service is started automatically as part of the Windows boot process.

  • Manual - The Service can be started by another application or process that needs it, but is off by default. Once it is started, the service will remain on until it is manually stopped or the system is rebooted.

  • Disabled -The Service will not start unless this condition is changed.

  • Boot - Driver specific setting.

  • System - Driver specific setting.

Interactive Service

Yes/No

No

No

 INTERACT="YES"

If set to YES, specifies that the service should be able to interact with the desktop. This parameter is set to NO by default. Although typically services do not have a user interface, developers can add forms and other UI components. In such cases, this parameter should be set to YES.

Computer Parameters

Property

Type

Required

Default

Markup

Description

Local computer

 

 

 

 

If enabled, indicates that this activity will install a service on the local computer. This parameter is enabled by default. If this parameter is selected, the Another computer parameter becomes inactive. This is a visual mode parameter used during design time only, therefore, it contains no markups.

Another computer

 

 

 

 

If enabled, indicates that this activity will install a service on a remote computer. The parameters below become active if this parameter is enabled. This is a visual mode parameter used during design time only, therefore, it contains no markups.

Computer

Text

Yes

(Empty)

REMOTEMACHINE="MachineName"

The computer name of the remote machine in which to connect to.

Domain

Text

Yes

(Empty)

REMOTEDOMAIN="DomainName"

The domain that the remote machine belongs to.

Username

Text

Yes

(Empty)

REMOTEUSERNAME="Username"

A valid username used to log onto the remote machine. This user must have proper permissions to modify services on the remote machine.

Password

Text

Yes

(Empty)

REMOTEPASSWORD="password"

The password associated with the username entered above.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Descrition: Install service "c:\servicesname.exe" as "service name"

<AMSERVICES ACTIVITY="install" EXECUTABLE="c:\servicesname.exe" 
DISPLAYNAME="service name" USERNAME="username" 
PASSWORD="AM1H2tpzU1xiDLOlojMcSAm1fn5M3MxiXeEaME" />