JAMS Reference Manual
Contents Index JAMS Home Support

JAMS Reference Manual


Previous Contents Index


JAMS_HISTORY_INIT

The JAMS_HISTORY_INIT routine is used to search the JAMS history database.

Format

JAMS_HISTORY_INIT context, item-list


RETURNS

VMS usage: cond_value
type: longword (unsigned)
access: write only
mechanism: by value

ARGUMENTS

context


VMS usage: context
type: pointer
access: write only
mechanism: by reference

This argument is a pointer which will be used to return the history context which is created and initialized by this routine.

item-list


VMS usage: item_list_3
type: longword (unsigned)
access: read only
mechanism: by reference

This argument is a pointer to an item list. An item list is an array of item descriptors, each of which specifies one input or output data item.

The item list is terminated by an item descriptor with a value of zero in the item code and buffer length fields.

The following item codes are supported by the JAMS_HISTORY_INIT routine:

JAMS_K_END_DATE

The JAMS_K_END_DATE item code is used to pass the date and time of the end of the time range from which history will be returned. The date and time must be passed as a standard VMS quadword date.

JAMS_K_JOB_NAME

The JAMS_K_JOB_NAME item code is used to pass a Job Name selection specification. Wildcard characters are allowed. Only history of Jobs which match this selection specification will be included. Omitted this item is the same as specifying an asterisk.

JAMS_K_OPTIONS

The JAMS_K_OPTIONS item code is used to pass a longword which specifies the options which should be activated during this call. Each bit in the longword corresponds to one option. You can initialize this longword by ORing (or adding) together one or more of the following symbols.
Symbol Function
JAMS_M_SUBMITTED Include jobs which were submitted in the specified time range.
JAMS_M_COMPLETED Include jobs which completed in the specified time range.
JAMS_M_STARTED Include jobs which started in the specified time range.

JAMS_K_SETUP_NAME

The JAMS_K_SETUP_NAME item code is used to pass a Setup Name selection specification. Wildcard characters are allowed. Only history of Setups which match this selection specification will be included. A history record of a Job which was not submitted via a Setup will only match an asterisk. Omitted this item is the same as specifying an asterisk.

JAMS_K_SEVERITY

The JAMS_K_SEVERITY item code is used to pass a longword which specifies the final status severities which should be returned. Only history records from job which termination with a severity which matches one of the specified severities will be returned. You can initialize this longword by ORing (or adding) together one or more of the following symbols.

JAMS_M_SUCCESS
JAMS_M_INFO
JAMS_M_WARNING
JAMS_M_ERROR
JAMS_M_FATAL

JAMS_K_START_DATE

The JAMS_K_START_DATE item code is used to pass the date and time of the start of the time range from which history will be returned. The date and time must be passed as a standard VMS quadword date.

JAMS_K_SYSTEM_ID

The JAMS_K_SYSTEM_ID item code is used to pass a System I.D. selection specification. Wildcard characters are allowed. Only history from Jobs and Setups in a System which matches this selection specification will be included.


Description

The JAMS_HISTORY_INIT routine is the first step in searching the JAMS job execution history information. After successfully calling JAMS_HISTORY_INIT, you call JAMS_HISTORY_GET to return a History Context which can then be passed to JAMS_GET_DATA to get data from the context.

JAMS3000.COB is an example of using the JAMS_HISTORY_INIT routine. JAMS3000.COB can be found in JAMS_EXAMPLES.


Return Values

JAMS_INVIL Invalid item list.
SS$_NOPRIV Insufficient privileges


Previous Next Contents Index
JAMS Copyright © 2000, MVP Systems, Inc. All rights reserved.