JAMS Reference Manual
Contents Index JAMS Home Support

JAMS Reference Manual


Previous Contents Index


JAMS_SCHEDULE_INIT

The JAMS_SCHEDULE_INIT routine is used to create and initialize a simulated job schedule.

Format

JAMS_SCHEDULE_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 schedule 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_SCHEDULE_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 simulated schedule. 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. When the initial schedule is created, only Jobs which match this selection specification will be included. If this item is omitted, all Jobs are included.

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_CURRENT Use the Jobs which are currently scheduled as the basis for the simulation. If this option is used, you should not include start and end dates in the item list.
JAMS_M_INCLUDE_PLANNED If this option is used, Setups which are not automatically submitted will be included in the simulated schedule (provided that they match other selection criteria).
JAMS_M_INCLUDE_REPEATING If this option is used, Setups which are automatically resubmitted will have all occurrences shown in the simulated schedule.
JAMS_M_INCLUDE_TRIGGERED If this option is used, the simulation will include jobs submitted by the simulated firing of Trigger definitions.

JAMS_K_SETUP_NAME

The JAMS_K_SETUP_NAME item code is used to pass a Setup Name selection specification. Wildcard characters are allowed. When the initial schedule is created, only Setups which match this selection specification will be included. If this item is omitted, all Setups are included.

JAMS_K_START_DATE

The JAMS_K_START_DATE item code is used to pass the date and time of the start of the simulated schedule. 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. When the initial schedule is created, only Jobs and Setups in a System which matches this selection specification will be included.


Description

The JAMS_SCHEDULE_INIT routine is the first step in creating a simulated schedule. This simulated schedule can be used for reporting or capacity planning purposes. After successfully calling JAMS_SCHEDULE_INIT, you can call JAMS_SCHEDULE_SORT to sort the jobs in the simulated schedule. You call JAMS_SCHEDULE_GET_JOB to return a Job Context which can then be passed to JAMS_GET_DATA to get data from the context.

JAMS2100.COB is an example of using the JAMS_SCHEDULE_INIT routine. JAMS2100.COB can be found in SYS$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.