HP OpenVMS System Services Reference Manual


Previous Contents Index

You must specify the following input value item code:

SJC$_CHARACTERISTIC_NAME

SJC$_DELETE_FORM

Deletes the definition of a form name. There must be no queues or jobs that reference the form.

You must specify the following input value item code:

SJC$_FORM_NAME

SJC$_DELETE_JOB

Deletes a job from the system job queue file. If the job is currently executing, it is aborted. If you specify the SJC$_QUEUE item code, the $SNDJBC service verifies that the selected job entry exists on the specified queue before deleting the job.

You must specify the following input value item code:

SJC$_ENTRY_NUMBER

You can specify the following input value item code:

SJC$_QUEUE

If you specify the SJC$_QUEUE item code, the $SNDJBC service verifies that the selected job entry exists on the specified queue before deleting the job.

SJC$_DELETE_QUEUE

Deletes a queue and all of the jobs in the queue. The queue must be stopped, and there must be no other queues or jobs that reference the queue.

You must specify the following input value item code:

SJC$_QUEUE

SJC$_DELETE_QUEUE_MANAGER

Removes all references to the specified queue manager from the shared master file. It also deletes the queue and journal files associated with the queue manager. A queue manager must be stopped to be deleted.

You must specify the following input value item code:

SJC$_QUEUE_MANAGER_NAME

SJC$_DISABLE_AUTOSTART

Disables autostart on a node. By default, SJC$_DISABLE_AUTOSTART affects the requesting node. To disable autostart on a node other than the node from which the $SNDJBC request is sent, use the SJC$_SCSNODE_NAME item code to specify the affected node.

Disabling autostart on a node forces the appropriate queue manager to perform these tasks:

You can specify the following input value item codes:

SJC$_QUEUE_MANAGER_NAME
SJC$_SCSNODE_NAME

For more information, see the HP OpenVMS System Manager's Manual.

SJC$_ENABLE_AUTOSTART

Notifies the appropriate queue manager process that a node has progressed sufficiently in its startup procedure that batch and print jobs should execute.

By default, SJC$_ENABLE_AUTOSTART affects the requesting node. To enable autostart on a node other than the node from which the $SNDJBC request is sent, use the SJC$_SCSNODE_NAME item code to specify the affected node. Once autostart is enabled, the queue manager starts all autostart-active queues on the appropriate node.

When a node reboots, autostart is disabled until the SJC$_ENABLE_AUTOSTART request is entered.

You can specify the following input value item codes:

SJC$_QUEUE_MANAGER_NAME
SJC$_SCSNODE_NAME

For more information, see the HP OpenVMS System Manager's Manual.

SJC$_ENTER_FILE

Creates a job containing one file and places the job in the specified queue. To create a job with more than one file, you must make a sequence of calls to the $SNDJBC service using the SJC$_CREATE_JOB, SJC$_ADD_FILE, and SJC$_CLOSE_JOB function codes.

You must specify the following input value item code:

SJC$_QUEUE

You must specify one of the following input value item codes:

SJC$_FILE_IDENTIFICATION
SJC$_FILE_SPECIFICATION

You can specify the following input value or Boolean item codes:
SJC$_ACCOUNT_NAME ---
SJC$_AFTER_TIME SJC$_NO_AFTER_TIME
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
SJC$_CLI SJC$_NO_CLI
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
SJC$_DELETE_FILE SJC$_NO_DELETE_FILE
SJC$_DOUBLE_SPACE SJC$_NO_DOUBLE_SPACE
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_COPIES ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_SETUP_MODULES SJC$_NO_FILE_SETUP_MODULES
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FIRST_PAGE SJC$_NO_FIRST_PAGE
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_HOLD SJC$_NO_HOLD
SJC$_JOB_COPIES ---
SJC$_JOB_DEFAULT_RETAIN ---
SJC$_JOB_ERROR_RETAIN ---
SJC$_JOB_NAME ---
SJC$_JOB_RETAIN ---
SJC$_JOB_RETAIN_TIME ---
SJC$_LAST_PAGE SJC$_NO_LAST_PAGE
SJC$_LOG_DELETE SJC$_NO_LOG_DELETE
SJC$_LOG_QUEUE ---
SJC$_LOG_SPECIFICATION SJC$_NO_LOG_SPECIFICATION
SJC$_LOG_SPOOL SJC$_NO_LOG_SPOOL
SJC$_LOWERCASE SJC$_NO_LOWERCASE
SJC$_NOTE SJC$_NO_NOTE
SJC$_NOTIFY SJC$_NO_NOTIFY
SJC$_OPERATOR_REQUEST SJC$_NO_OPERATOR_REQUEST
SJC$_PAGE_HEADER SJC$_NO_PAGE_HEADER
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PARAMETER_1 through 8 SJC$_NO_PARAMETERS
SJC$_PASSALL SJC$_NO_PASSALL
SJC$_PRIORITY ---
SJC$_RAD SJC$_NO_RAD
SJC$_RESTART SJC$_NO_RESTART
SJC$_UIC ---
SJC$_USERNAME ---
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

You can specify the following output value item codes:

SJC$_ENTRY_NUMBER_OUTPUT
SJC$_JOB_STATUS_OUTPUT

SJC$_MERGE_QUEUE

Requeues all jobs in the queue specified by the item code SJC$_QUEUE to the queue specified by the item code SJC$_DESTINATION_QUEUE. The execution of current jobs is unaffected.

You must specify the following input value item codes:

SJC$_DESTINATION_QUEUE
SJC$_QUEUE

SJC$_PAUSE_QUEUE

Pauses the execution of current jobs in the specified queue and prevents the starting of jobs in that queue.

You must specify the following input value item code:

SJC$_QUEUE

SJC$_RESET_QUEUE

Resets the specified queue by (1) terminating and deleting each executing job that is not restartable, (2) terminating and requeuing each executing job that is restartable, and (3) stopping the queue.

You must specify the following input value item code:

SJC$_QUEUE

SJC$_START_ACCOUNTING

This request performs two functions. If you specify the SJC$_ACCOUNTING_TYPES item code, the request enables recording of the specified types of accounting records; if you do not specify SJC$_ACCOUNTING_TYPES, the request starts the accounting manager and opens the system accounting file.

You can specify the following input value or Boolean item codes:

SJC$_ACCOUNTING_TYPES
SJC$_NEW_VERSION

SJC$_START_QUEUE

Permits the starting of jobs in the specified queue. If the queue was paused, current jobs are resumed.

You must specify the following input value item code:

SJC$_QUEUE

You can specify the following input value or Boolean item codes:
SJC$_ALIGNMENT_MASK ---
SJC$_ALIGNMENT_PAGES ---
SJC$_AUTOSTART_ON ---
SJC$_BASE_PRIORITY ---
SJC$_BATCH SJC$_NO_BATCH
SJC$_CHARACTERISTIC_NAME SJC$_NO_CHARACTERISTICS
SJC$_CHARACTERISTIC_NUMBER ---
SJC$_CLOSE_QUEUE ---
SJC$_CPU_DEFAULT SJC$_NO_CPU_DEFAULT
SJC$_CPU_LIMIT SJC$_NO_CPU_LIMIT
SJC$_DEFAULT_FORM_NAME ---
SJC$_DEFAULT_FORM_NUMBER ---
SJC$_DEVICE_NAME ---
SJC$_FILE_BURST SJC$_NO_FILE_BURST
SJC$_FILE_BURST_ONE ---
SJC$_FILE_FLAG SJC$_NO_FILE_FLAG
SJC$_FILE_FLAG_ONE ---
SJC$_FILE_TRAILER SJC$_NO_FILE_TRAILER
SJC$_FILE_TRAILER_ONE ---
SJC$_FORM_NAME ---
SJC$_FORM_NUMBER ---
SJC$_GENERIC_QUEUE SJC$_NO_GENERIC_QUEUE
SJC$_GENERIC_SELECTION SJC$_NO_GENERIC_SELECTION
SJC$_GENERIC_TARGET ---
SJC$_JOB_BURST SJC$_NO_JOB_BURST
SJC$_JOB_FLAG SJC$_NO_JOB_FLAG
SJC$_JOB_LIMIT ---
SJC$_JOB_RESET_MODULES SJC$_NO_JOB_RESET_MODULES
SJC$_JOB_SIZE_MAXIMUM SJC$_NO_JOB_SIZE_MAXIMUM
SJC$_JOB_SIZE_MINIMUM SJC$_NO_JOB_SIZE_MINIMUM
SJC$_JOB_SIZE_SCHEDULING SJC$_NO_JOB_SIZE_SCHEDULING
SJC$_JOB_TRAILER SJC$_NO_JOB_TRAILER
SJC$_LIBRARY_SPECIFICATION SJC$_NO_LIBRARY_SPECIFICATION
SJC$_NEXT_JOB ---
SJC$_OPEN_QUEUE ---
SJC$_OWNER_UIC ---
SJC$_PAGINATE SJC$_NO_PAGINATE
SJC$_PROCESSOR SJC$_NO_PROCESSOR
SJC$_PROTECTION ---
SJC$_QUEUE_DESCRIPTION SJC$_NO_QUEUE_DESCRIPTION
SJC$_RAD SJC$_NO_RAD
SJC$_RECORD_BLOCKING SJC$_NO_RECORD_BLOCKING
SJC$_RELATIVE_PAGE ---
SJC$_RETAIN_ALL_JOBS SJC$_NO_RETAIN_JOBS
SJC$_RETAIN_ERROR_JOBS ---
SJC$_SCSNODE_NAME ---
SJC$_SEARCH_STRING ---
SJC$_SWAP SJC$_NO_SWAP
SJC$_TERMINAL SJC$_NO_TERMINAL
SJC$_TOP_OF_FILE ---
SJC$_WSDEFAULT SJC$_NO_WSDEFAULT
SJC$_WSEXTENT SJC$_NO_WSEXTENT
SJC$_WSQUOTA SJC$_NO_WSQUOTA

SJC$_START_QUEUE_MANAGER

Starts the clusterwide queue manager for the batch and print queuing system. It also opens the queue database.

The SJC$_START_QUEUE_MANAGER request has the following five uses:

You can specify the following input value or Boolean item codes:

SJC$_ADD_QUEUE_MANAGER
SJC$_NEW_VERSION
SJC$_QUEUE_DIRECTORY
SJC$_QUEUE_MANAGER_NAME
SJC$_QUEUE_MANAGER_NODES

SJC$_STOP_ACCOUNTING

This request performs two functions. If you specify the SJC$_ACCOUNTING_TYPES item code, the request disables recording of the specified types of accounting records. If you do not specify SJC$_ACCOUNTING_TYPES, the request stops the accounting manager and closes the system accounting file.

You can specify the following input value item code:

SJC$_ACCOUNTING_TYPES

SJC$_STOP_ALL_QUEUES_ON_NODE

Stops all queues on a specific node. By default, all queues on the requesting node are stopped. To stop all queues on a node other than the node from which the $SNDJBC request is sent, use the SJC$_SCSNODE_NAME item code to specify the affected node.

Besides stopping all queues on a specific node, this request aborts each job that is currently executing. Aborted jobs that are restartable are requeued. Queues for which an autostart list has been specified fail over to the first available node in the list for which autostart is enabled.

You can specify the following input value item codes:

SJC$_QUEUE_MANAGER_NAME
SJC$_SCSNODE_NAME

SJC$_STOP_QUEUE

Prevents the starting of jobs in the specified queue. The execution of current jobs is unaffected.

You must specify the following input value item code:

SJC$_QUEUE

SJC$_STOP_QUEUE_MANAGER

Shuts down the appropriate queue manager. It disables autostart on all nodes; stops all queues; aborts each job that is currently executing, requeuing those jobs that are restartable; and closes the files of the queue database.

You can specify the following input value item code:

SJC$_QUEUE_MANAGER_NAME

SJC$_SYNCHRONIZE_JOB

Waits for the completion of a job, then sets the event flag, executes the completion AST if you specified astadr, and returns the completion status of the job to the I/O Status Block, provided you specified the iosb argument.

You must specify one of the following input value item codes:

SJC$_ENTRY_NUMBER
SJC$_QUEUE

If SJC$_QUEUE queue is specified, then you must also specify one of the following:

SJC$_ENTRY_NUMBER
SJC$_JOB_NAME

You can specify the following output value item code:

SJC$_JOB_COMPLETION_STATUS

SJC$_WRITE_ACCOUNTING

Writes an accounting record.

You must specify the following input value item code:

SJC$_ACCOUNTING_MESSAGE

Item Codes

SJC$_ACCOUNT_NAME

Input value item code that specifies the account name of the user on behalf of whom the request is made. The buffer must specify a string from 1 to 8 characters. By default, the account name for batch and print jobs is taken from the requesting process.

You need CMKRNL privilege to use this item code.

(Valid for SJC$_CREATE_JOB, SJC$_ENTER_FILE function codes)

SJC$_ACCOUNTING_MESSAGE

Input value item code. It causes the contents of the buffer to be placed in a "user message" accounting record. The buffer must specify a string from 1 to 255 characters.

(Valid for SJC$_WRITE_ACCOUNTING function code)

SJC$_ACCOUNTING_TYPES

Input value item code. It enables or disables accounting-record types. When an accounting-record type is enabled, the event designated by that type will be recorded in the accounting record. The buffer must contain a longword bit vector wherein each bit set specifies an accounting-record type. Undefined bits must be 0.

The $SJCDEF macro defines the symbolic names for the accounting-record types. Following is a list of each accounting-record type and the system event to which it corresponds:
Accounting-Record Type Corresponding System Event
SJC$V_ACCT_IMAGE Image terminations
SJC$V_ACCT_LOGIN_FAILURE Login failures
SJC$V_ACCT_MESSAGE User messages sent
SJC$V_ACCT_PRINT Print job terminations
SJC$V_ACCT_PROCESS Process terminations

The following accounting-record types, when enabled, provide additional information about image and process termination; specifically, they describe the type of image or process that has terminated:
Accounting-Record Type Type of Image or Process
SJC$V_ACCT_BATCH Batch process
SJC$V_ACCT_DETACHED Detached process
SJC$V_ACCT_INTERACTIVE Interactive process
SJC$V_ACCT_NETWORK Network process
SJC$V_ACCT_SUBPROCESS Subprocess

(Valid for SJC$_START_ACCOUNTING, SJC$_STOP_ACCOUNTING function codes)

SJC$_ADD_QUEUE_MANAGER

Boolean item code. It specifies that a new queue manager process should be defined in the master file. The operating system allows no more than five queue managers in a cluster.

(Valid for SJC$_START_QUEUE_MANAGER function code)

SJC$_AFTER_TIME

SJC$_NO_AFTER_TIME

The SJC$_AFTER_TIME item code is an input value item code. It specifies that the job can execute only if the system time is greater than or equal to the quadword time value contained in the buffer. The buffer must contain either an absolute time value or a delta time value; $SNDJBC converts delta time values to absolute time values by adding the current system time. The time value specified must be in the future, or it will be set to the current time.

The SJC$_NO_AFTER_TIME item code is a Boolean item code. It cancels the effect of a SJC$_AFTER_TIME item code previously specified for the job; the job can execute immediately. It is the default.

(Valid for SJC$_ALTER_JOB, SJC$_CREATE_JOB, SJC$_ENTER_FILE function codes)

SJC$_ALIGNMENT_MASK

Boolean item code. It is meaningful only for output execution queues and only when the SJC$_ALIGNMENT_PAGES item code is also specified. The SJC$_ALIGNMENT_MASK item code causes the data printed on form alignment pages to be masked: all alphabetic characters are replaced with the letter X and all numeric characters with the number 9.

(Valid for SJC$_START_QUEUE function code)

SJC$_ALIGNMENT_PAGES

Input value item code. It is meaningful only for output execution queues. It specifies that the queue be placed in form-alignment state and that a number of alignment pages be printed. The buffer must contain a longword value in the range 1 to 20; this value specifies how many alignment pages are to be printed.

(Valid for SJC$_START_QUEUE function code)

SJC$_AUTOSTART_ON

Input value item code. For a batch queue, it uses as its value a comma-separated list of the nodes on which the specified queue can be located. Each node name must be followed by a double colon (::).

For an output queue, it uses as its value a comma-separated list of the names of the nodes and devices to which the specified queue's output can be sent. Each node name must be followed by a double colon, and each device name can be followed by the optional colon [:].

By specifying this item code, you designate a queue as an autostart queue. If you specify more than one node name (within an OpenVMS Cluster environment), the queue can automatically fail over if the node on which the queue is running is removed from the cluster.

This item code cannot be used with the SJC$_SCSNODE_NAME and SJC$_DEVICE_NAME item codes.

For more information, see the HP OpenVMS System Manager's Manual.

(Valid for SJC$_CREATE_QUEUE, SJC$_START_QUEUE function codes)

SJC$_BASE_PRIORITY

Input value item code. It is meaningful only for execution queues. It specifies the base priority of batch processes initiated from a batch execution queue or of a symbiont process connected to an output execution queue. A symbiont process can control several queues; however, the base priority of the symbiont process is established by the first queue to which it is connected. The buffer must contain a longword value in the range 0 to 15; this value specifies the base priority.

By default, the base priority is the value of the system parameter DEFPRI.

(Valid for SJC$_ALTER_QUEUE, SJC$_CREATE_QUEUE, SJC$_START_QUEUE function codes)

SJC$_BATCH

SJC$_NO_BATCH

The SJC$_BATCH item code is a Boolean item code. It specifies that the queue is a batch execution queue or a generic batch queue, and thus can process only batch jobs.

The SJC$_BATCH, SJC$_PRINTER, SJC$_SERVER, and SJC$_TERMINAL item codes are mutually exclusive. If none of these item codes are specified, the default is SJC$_PRINTER.

The SJC$_NO_BATCH item code is a Boolean item code. It specifies that the queue is not a batch queue but rather an output execution or generic output queue, and thus can process only print jobs. It is the default.

For the SJC$_START_QUEUE function code, SJC$_BATCH and SJC$_NO_BATCH are supported for compatibility with VAX VMS Version 4.n, but might not be supported in the future.

(Valid for SJC$_CREATE_QUEUE, SJC$_START_QUEUE function codes)

SJC$_CHARACTERISTIC_NAME

SJC$_CHARACTERISTIC_NUMBER

SJC$_NO_CHARACTERISTICS

The SJC$_CHARACTERISTIC_NAME and SJC$_CHARACTERISTIC_NUMBER item codes are both input value item codes. Both specify characteristics for jobs or queues, and they can be used interchangeably. The characteristics are user defined.

The SJC$_DEFINE_CHARACTERISTIC and SJC$_DELETE_CHARACTERISTIC function codes include and delete, respectively, a specified characteristic from the system job queue file. A job cannot execute on an execution queue unless the queue possesses all the characteristics possessed by the job; the queue can possess additional characteristics and the job will still execute.


Previous Next Contents Index