The table below summarizes the XML service definition file tags. It should be noted that tags must appear in the same order as they are defined in the DTD. The tags in the table below are in DTD order. If you mis-order the tags, your service will not install.
|
Tag |
Required |
Data Type |
Valid Values |
Default Value |
Description |
|
Container Tag: Program |
|||||
|
Name |
Yes |
Text String |
A-Za-z0-9 |
N/A |
The short name of the service. |
|
DisplayName |
Yes |
Text String |
Free text |
N/A |
The display name of the service. |
|
DisplayNamePrefix |
No |
Text String |
Free Text |
N/A |
The prefix applied to the display name. |
|
Description |
No |
Text String |
Free text |
N/A |
Description of the service. |
|
WorkingDir |
Yes |
Text String |
Valid Windows Path |
N/A |
Full path to the working directory for the service. |
|
Executable |
Yes |
Text String |
Valid Windows Path + Executable Name + Extension |
N/A |
Full path to and name of the executable to be run including file extension. |
|
Parameters |
No |
Text String |
Free text |
N/A |
Arguments to be passed to the executable. |
|
Delay |
No |
Integer |
Greater than 0 |
3000 |
Number of milliseconds the service is likely to take to start. |
|
StartUpMode |
No |
Integer |
0-2 |
1 |
Service startup mode on system boot. 0 = Manual, 1 = Automatic, 2 = Disabled, 3 = Delayed Start |
|
ForceReplace |
No |
Boolean |
true or false |
false |
Force the reinstallation of the service if it already exists. Not configurable via the GUI. |
|
Container Tag: Options |
|||||
|
AffinityMask |
No |
Integer |
Greater than or equal to 0 |
0 |
Apply a processor affinity mask to the sub-process. 0 = SMP, 1 = CPU 1, 2 = CPU 2, 3 = CPU 1 + 2 etc.. More information. |
|
Priority |
No |
Integer |
0-5 |
0 |
Apply a scheduling priority to the sub-process (NT4 = 0-3, Win2K/XP = 0-5). 0 = Normal, 1 = Idle, 2 = High, 3 = Real Time, 4 = Below Normal, 5 = Above Normal. |
|
AppendLogs |
No |
Boolean |
true or false |
true |
Whether to append to or overwrite the debug log file. |
|
EventLogging |
No |
Boolean |
true or false |
true |
Stipulates whether the service logs to the Event Log. |
|
InteractWithDesktop |
No |
Boolean |
true or false |
false |
Allow the service to interact with the desktop. |
|
PreLaunchDelay |
No |
Integer |
Greater than or equal to 0 |
0 |
The number of milliseconds FireDaemon Pro will wait after the service has reached the running state prior to the sub-process being started. |
|
ConsoleApp |
No |
Boolean |
true or false |
false |
Whether the executable is console based or not. FireDaemon Pro will handle the CTRL_LOGOFF_EVENT and related events on behalf of the console application. |
|
CtrlC |
No |
Integer |
0-1 |
N/A |
What event will be sent to the Console Application during shutdown. 0 = Ctrl+Break, 1 = Ctrl+C |
|
UponExit |
No |
Integer |
0-3 |
1 |
FireDaemon Pro action upon sub-process exit. 0 = No Action, 1 = Restart, 2 = Terminate, 3 = Shutdown, |
|
UponFlap |
No |
Integer |
0-3 |
0 |
FireDaemon Pro flap detection setting. 0 = Disabled, 1 = Terminate the process, 2 = Terminate FireDaemon, 3 = Shutdown FireDaemon, 4 = Report the Termination, 5 = Reboot. |
|
FlapCount |
No |
Integer |
Greater than or equal to 0 |
5 |
The maximum number of times the process can be restarted before the flap action is taken. |
|
UponFail |
No |
Integer |
0-3 |
0 |
FireDaemon Pro fail detection setting. 0 = Disabled, 1 = Terminate the process, 2 = Terminate FireDaemon, 3 = Shutdown FireDaemon, 4 = Report the Termination, 5 = Reboot. |
|
FailCount |
No |
Integer |
Greater then or equal to 0 |
10 |
The maximum number of times the process can be restarted before the fail action is taken. |
|
ShutdownDelay |
No |
Integer |
Greater than or equal to 0 |
5000 |
Number of milliseconds FireDaemon Pro will wait after the sub-process has been issued the WM_CLOSE message before hard terminating it. Setting this value to 0 effectively disables graceful shutdown. |
|
ShowWindow |
No |
Integer |
0-3 |
0 |
How FireDaemon Pro initially displays interactive services. 0 = Normal, 1 = Hidden, 2 = Minimized, 3 = Maximized. |
|
JobType |
No |
Integer |
0-2 |
1 |
Optionally places the service sub-process in a Global or Local Job Group. 0 = No Job, 1 = Global Job, 2 = Local Job. |
|
LoadOrderGroup |
No |
Text String |
A-Za-z0-9 |
N/A |
Places the service in the named Load Order Group. |
|
Container Tag: Options / Dependencies |
|||||
|
GroupName |
No |
Text String |
Free text |
N/A |
Force the service to depend on the named Load Order Group. Multiple GroupName tags can be specified. |
|
ServiceName |
No |
Text String |
Free text |
N/A |
Force the services to depend on the named Service Name. Multiple ServiceName tags can be specified. |
|
Container Tag: Options / Logon |
|||||
|
AccountName |
No |
Text String |
Free text |
N/A |
Local or domain user account to run the service as. Format must be .\user for a local user or domain\user for a domain user. The user account must have Logon As A Service right granted. |
|
AccountPassword |
No |
Text String |
Free text |
N/A |
Local or domain user account password. |
|
Container Tag: Options / RedirectIO |
|||||
|
Stdout |
No |
Text String |
Valid Windows Path + File Name + Extension |
N/A |
Full path to and name of the file to log all Stdout to. |
|
Stderr |
No |
Text String |
Valid Windows Path + File Name + Extension |
N/A |
Full path to and name of the file to log all Stderr to. Specify ToStdout to force Stderr to be logged to Stdout. |
|
Container Tag: Debug |
|||||
|
DebugEnabled |
No |
Boolean |
true or false |
false |
Enable debug logging. |
|
DebugLocation |
No |
Text String |
Valid Windows Path and Log File Name |
N/A |
Full path and filename to log to. |
|
Container Tag: Environment |
|||||
|
Variable |
No |
Text String |
Free Text |
N/A |
Defines an environment variable to be exported to the sub-process. A valid environment variable name must be supplied as an attribute of the tag. |
|
Container Tag: SMF |
|||||
|
SMFEnabled |
No |
Boolean |
true or false |
true |
Enable or disable the Service Monitoring Facility (SMF). |
|
SMFFrequency |
No |
Integer |
Greater than 50 |
5000 |
Number of milliseconds between polls of the sub-process to see if it still running. |
|
Container Tag: Scheduling |
|||||
|
StartTime |
No |
Text String |
00:00:00 to 23:59:59 |
00:00:00 |
The time of the day after which the service may run. |
|
EndTime |
No |
Text String |
00:00:00 to 23:59:59 |
00:00:00 |
The time of the day after which the service may not run. |
|
StartDate |
No |
Text String |
YYYYMMDD |
Today’s date |
The first day on which the service may run. |
|
EndDate |
No |
Text String |
YYYYMMDD |
Today’s date |
The last day on which the service may run. |
|
RunDays |
No |
Integer |
0 to 127 |
127 |
Days of the week on which the service may run. Add the following values for each day to form the set: 1 = Sunday, 2 = Monday, 4 = Tuesday, 8 = Wednesday, 16 = Thursday, 32 = Friday, 64 = Saturday. |
|
MonthFrom |
No |
Integer |
0 to 31 |
0 |
The first day of the month on which the service may run. |
|
MonthTo |
No |
Integer |
0 to 31 |
0 |
The last day of the month on which the service may run. |
|
MonthDay |
No |
Integer |
0 to 31 |
0 |
The day of the month on which the service may run. |
|
RestartFreq |
No |
Integer |
0 to 9 |
0 |
The frequency of scheduled application restarts, if any. 0 = no scheduled restarts, 1 = every hour, 2 = every 2 hours, 3 = every 3 hours, 4 = every 4 hours, 5 = every 8 hours, 6 = every 12 hours, 7 = every 24 hours, 8 = once per week, 9 = once per month, 10 = every 30 minutes, 11 = at a specific time, 12 = user defined |
|
RestartEvery |
No |
Integer |
1 or more |
60 |
User defined restart interval in seconds. |
|
RestartDelay |
No |
Integer |
0 or more |
0 |
The restart delay in milliseconds. |
|
RestartTime |
No |
Text String |
00:00:00 to 23:59:59 |
00:00:00 |
The time of the day when the service is to be restarted. |
|
Container Tag: PreService |
|||||
|
PreWorkingDir |
Yes (but only if container tag specified) |
Text String |
Valid Windows Path |
N/A |
Full path to the working directory for the application. |
|
PreExecutable |
Yes (but only if container tag specified) |
Text String |
Valid Windows Path + Executable Name + Extension |
N/A |
Full path to and name of the executable to be run including file extension. |
|
PreParameters |
Yes (but only if container tag specified) |
Text String |
Free text |
N/A |
Arguments to be passed to the executable. Can include environment variables. |
|
PreDelay |
No |
Integer |
Greater than 0 |
3000 |
Number of milliseconds to wait for the execution of the executable to complete. |
|
Container Tag: PostService |
|||||
|
PostWorkingDir |
Yes (but only if container tag specified) |
Text String |
Valid Windows Path |
N/A |
Full path to the working directory for the application. |
|
PostExecutable |
Yes (but only if container tag specified) |
Text String |
Valid Windows Path + Executable Name + Extension |
N/A |
Full path to and name of the executable to be run including file extension. |
|
PostParameters |
Yes (but only if container tag specified) |
Text String |
Free text |
N/A |
Arguments to be passed to the executable. Can include environment variables. |
|
PostDelay |
No |
Integer |
Greater than 0 |
3000 |
Number of milliseconds to wait for the execution of the executable to complete. |
|
Container Tag: DlgResponder |
|||||
|
Enabled |
Yes (but only if container tag specified) |
Boolean |
true of false |
true |
Dialog checking is enabled |
|
CloseAll |
Yes (but only if container tag specified) |
Boolean |
true or false |
false |
Whether all dialogs are closed or closed just for this process |
|
IgnoreUnknowns |
Yes (but only if container tag specified) |
Boolean |
true or false |
false |
Whether unknown dialogs are closed by default |
|
LogFile |
Yes (but only if container tag specified) |
Text String |
Valid Windows Path and Filename |
N/A |
Full path and filename to Dialog Debug Log File |
|
Responses |
Yes (but only if container tag specified) |
Container |
N/A |
N/A |
Contains list of dialog responses |
|
Container Tag: PostService / Responses / Response |
|||||
|
TitleString |
Yes (but only if container tag specified) |
Text String |
Free text |
N/A |
Text to match against the dialog title |
|
ContentString |
Yes (but only if container tag specified) |
Text String |
Free text |
N/A |
Text to match against the dialog content |
|
Response |
Yes (but only if container tag specified) |
Text String |
Free text |
N/A |
Text to match against available buttons and "press" the button if matched |
|
Container Tag: Recovery |
|||||
|
FirstFailure |
Yes |
Integer |
0-3 |
0 |
Recovery trigger on first failure. 0 = Take no Action, 1 = Restart the Service, 2 = Restart the Computer, 3 = Run a Program |
|
SecondFailure |
Yes |
Integer |
0-3 |
0 |
Recovery trigger on second failure. 0 = Take no Action, 1 = Restart the Service, 2 = Restart the Computer, 3 = Run a Program |
|
Subsequent |
Yes |
Integer |
0-3 |
0 |
Recovery trigger on third and subsequent failure. 0 = Take no Action, 1 = Restart the Service, 2 = Restart the Computer, 3 = Run a Program |
|
ResetFailCountAfter |
Yes |
Integer |
>= 0 |
0 |
Resets the fail count after n-seconds |
|
RestartServiceDelay |
Yes |
Integer |
>= 0 |
0 |
Restart service delay in milliseconds |
|
RestartComputerDelay |
Yes |
Integer |
>= 0 |
0 |
Restart computer delay in milliseconds |
|
Program |
Yes |
Text String |
Valid Windows Path + Executable Name + Extension |
blank |
Full path to and name of the executable to be run including file extension |
|
CommandLineParams |
Yes |
Text String |
Free text |
blank |
Arguments to be passed to the executable |
|
AppendFailCount |
Yes |
Boolean |
true or false |
false |
Whether the fail count is appended to the command line parameters (/fail=%1%) |
|
EnableActionsForStopWithErrors |
Yes |
Boolean |
true or false |
false |
Whether recovery actions are triggered when services stop with errors |
|
SendMsg |
Yes |
Boolean |
true or false |
false |
Whether to send computers on the network a message if the machine is rebooted |
|
RebootMsg |
Yes |
Text String |
Free text |
blank |
The reboot message itself |