Alarm: Command line interface

Introduction

The command line interface is an alternative to the graphical interface to this program. It allows you to manipulate the program either directly from a command prompt or from the Job Scheduler program.

Using this interface you can automatically print the Alarm List with a fixed interval or activated on an event in the IGSS system.

Procedure

Click here $images\CHICLET.gif$ to learn how to use the command line interface either with the Job Scheduler program or the Windows command prompt.

Syntax conventions

The following symbols are used:

Symbol	Description
Bold	Required parameter.
<placeholder>	Placeholder for a variable parameter.
\| (pipe symbol)	Separates required parameters. You must use at least one of these parameters in the syntax and you may use two or more of them. NOTE: To separate these parameters, put a space between them.
[parameter]	Optional parameter that you may include in the command line.

Syntax

Use the following syntax (separate parameters with a space):

Alm -f<filter name> [-ds<start date>] [-ts<start time>] [-de<end date>] [-te<end time>] [-all]
[-note] [-page]

You must check the Prompt for period box in the Defining Filters for Alarm List dialog when you create a filter that you will access from the command line. If disabled, Alarm will use the default period.
The last three command line parameters are equivalent to the three check boxes in the print dialogue of the alarm program.

Parameter	Description
-f<filter name>	Name of the filter to use. If the name contains spaces, enclose the name in quotation marks (""). You can also use the root filters: "Active Alarms" and "Alarm Log".
-ds<start date>	Start date in the format yyyy/mm/dd or as an offset defined with the $ parameter (offset in days).
-ts<start time>	Start time in the format hh:mm:ss or as an offset defined with the $ parameter (offset in seconds).
-de<end date>	End date in the format yyyy/mm/dd or as an offset defined with the $ parameter (offset in days).
-te<end time>	End time in the format hh:mm:ss or as an offset defined with the $ parameter (offset in seconds).
-all	All columns are printed (otherwise the columns exceeding one page are not printed)
-note	Includes alarm notes on the printout.
-page	Inserts page breaks after alarm notes.
-landscape	Landscape makes alarm print in landscape mode

Job Scheduler example

This example prints the alarms matching the Analog Alarms filter. The start date is set to the previous day ($date-1) and end date is set to today $(date). Start time (-ts) and end time (-te) are both set to 7:00 a.m. All columns are printed and alarm notes are included.

Program path:

"[IGSS InstallPath]\Gss\Alm.exe"

Parameters:

-f"Analog Alarms" -ds$(date-1) -ts07:00:00 -de$(date) -te07:00:00 -all –note

Working folder:

Command prompt example

This command line prints all alarms matching the Purification filter from the previous day. The printout shows all columns and includes alarm notes.

Alm -fPurification -ds$-1 -ts00:00:00 -de$ -te00:00:00 -all -note