| Contents | Index | JAMS Home | Support |
|
||||
|
| Previous | Contents | Index |
The JAMS_GET_DATA routine is used to obtain data associated with a context.
JAMS_GET_DATA context,
data-ident1, return-desc1,
[data-ident2, return-desc2]...
VMS usage: cond_value type: longword (unsigned) access: write only mechanism: by value
context
VMS usage: context type: longword (unsigned) access: read only mechanism: by value
This is a context variable which was passed, or returned to your routine by JAMS. The JAMS_GET_DATA routine can be called only with a context which has been:
- passed to your code via a JAMS calluser routine,
- returned to your code via a call to JAMS_SCHEDULE_GET_JOB,
- returned to your code via a call to JAMS_SCHEDULE_GET_DEPEND.
- returned to your code via a call to JAMS_HISTORY_GET.
data-identN
VMS usage: longword type: longword access: read only mechanism: by value
The data-ident parameter identifies a data element which you want JAMS_GET_DATA to return to you.return-descN
VMS usage: various type: various access: write only mechanism: by descriptor
The return-desc parameter is a descriptor which points to the location of the variable which is to receive the requested data element.
When calling JAMS_GET_DATA you pass one or more pairs of data-ident and return-desc parameters.The data identifiers supported vary based on the type of context. JAMS can call your code with the following context types:
JAMS_K_SCHSTART JAMS_SCHEDULE process is starting up. JAMS_K_SCHSTOP JAMS_SCHEDULE process is stopping. JAMS_K_JOBSTART A Job is starting to execute. JAMS_K_JOBEND A Job has completed. n/a A context returned from JAMS_SCHEDULE_GET_JOB. n/a A context returned from JAMS_SCHEDULE_GET_DEPEND. n/a A context returned from JAMS_HISTORY_GET. The following data identifiers are supported by the JAMS_GET_DATA routine when the context type is JAMS_K_JOBSTART:
JAMS_K_CHECKPOINT_DATA
JAMS_K_CPU_RATING
JAMS_K_DESC_LN1
JAMS_K_DESC_LN2
JAMS_K_ENTRY
JAMS_K_FINAL_STATUS
JAMS_K_JOB_DESC_LN1
JAMS_K_JOB_DESC_LN2
JAMS_K_JOB_NAME
JAMS_K_LOG_FILENAME
JAMS_K_MAIL_ADR
JAMS_K_NAME
JAMS_K_NODENAME
JAMS_K_OPER_CLASSES
JAMS_K_PID
JAMS_K_PRINT_DIR
JAMS_K_QUEUE_NAME
JAMS_K_REPLY_USERS
JAMS_K_RESTART_COUNT
JAMS_K_RON
JAMS_K_RUN_UNDER
JAMS_K_SETUP_DESC_LN1
JAMS_K_SETUP_DESC_LN2
JAMS_K_SETUP_NAME
JAMS_K_START_TIME
JAMS_K_SUBMITTED_BY
JAMS_K_SUBMIT_TIME
JAMS_K_SYSTEM_DESC
JAMS_K_SYSTEM_IDThe following data identifiers are supported by the JAMS_GET_DATA routine when the context type is JAMS_K_JOBEND:
JAMS_K_BIOCNT
JAMS_K_CHECKPOINT_DATA
JAMS_K_CPUTIM
JAMS_K_CPU_RATING
JAMS_K_DESC_LN1
JAMS_K_DESC_LN2
JAMS_K_DIOCNT
JAMS_K_END_TIME
JAMS_K_ENTRY
JAMS_K_FINAL_STATUS
JAMS_K_JOB_DESC_LN1
JAMS_K_JOB_DESC_LN2
JAMS_K_JOB_NAME
JAMS_K_LOG_FILENAME
JAMS_K_MAIL_ADR
JAMS_K_NAME
JAMS_K_NODENAME
JAMS_K_OPER_CLASSES
JAMS_K_PAGEFLTS
JAMS_K_PGFLPEAK
JAMS_K_PID
JAMS_K_PRINT_DIR
JAMS_K_QUEUE_NAME
JAMS_K_REPLY_USERS
JAMS_K_RESTART_COUNT
JAMS_K_RON
JAMS_K_RUN_UNDER
JAMS_K_SETUP_DESC_LN1
JAMS_K_SETUP_DESC_LN2
JAMS_K_SETUP_NAME
JAMS_K_START_TIME
JAMS_K_SUBMITTED_BY
JAMS_K_SUBMIT_TIME
JAMS_K_SYSTEM_DESC
JAMS_K_SYSTEM_ID
JAMS_K_VOLUMES
JAMS_K_WSPEAKThe following data identifiers are supported by the JAMS_GET_DATA routine when the context was returned by a call to JAMS_SCHEDULE_GET_JOB:
JAMS_K_AUTOSUBMIT
JAMS_K_AVG_BIOCNT
JAMS_K_AVG_CPUTIM
JAMS_K_AVG_DIOCNT
JAMS_K_AVG_PAGEFLTS
JAMS_K_AVG_PGFLPEAK
JAMS_K_AVG_WSPEAK
JAMS_K_DESC_LN1
JAMS_K_DESC_LN2
JAMS_K_END_TIME
JAMS_K_ESTIMATED_TIME
JAMS_K_JOB_DESC_LN1
JAMS_K_JOB_DESC_LN2
JAMS_K_JOB_NAME
JAMS_K_LAST_AUTOSUBMIT
JAMS_K_LAST_ERROR
JAMS_K_LAST_FATAL
JAMS_K_LAST_INFO
JAMS_K_LAST_SUCCESS
JAMS_K_LAST_WARNING
JAMS_K_MAIL_ADR
JAMS_K_MAX_BIOCNT
JAMS_K_MAX_CPUTIM
JAMS_K_MAX_DIOCNT
JAMS_K_MAX_PAGEFLTS
JAMS_K_MAX_PGFLPEAK
JAMS_K_MAX_WSPEAK
JAMS_K_MIN_BIOCNT
JAMS_K_MIN_CPUTIM
JAMS_K_MIN_DIOCNT
JAMS_K_MIN_PAGEFLTS
JAMS_K_MIN_PGFLPEAK
JAMS_K_MIN_WSPEAK
JAMS_K_NAME
JAMS_K_NONWORKDAY_OPTION
JAMS_K_NOTIFY_SEVERITY
JAMS_K_OPER_CLASSES
JAMS_K_RECOVERY_SEVERITY
JAMS_K_REPLY_USERS
JAMS_K_RESTARTABLE
JAMS_K_RESUBMIT_BASE
JAMS_K_RESUBMIT_DELAY
JAMS_K_RESUBMIT_END
JAMS_K_SCHEDULE_TYPE
JAMS_K_SCHED_DATE
JAMS_K_SCHED_EXCEPT
JAMS_K_SCHED_TIME
JAMS_K_SETUP_DESC_LN1
JAMS_K_SETUP_DESC_LN2
JAMS_K_SETUP_NAME
JAMS_K_SUBMIT_FROM
JAMS_K_SUBMIT_HOLD
JAMS_K_SUBMIT_TO
JAMS_K_SYSTEM_DESC
JAMS_K_SYSTEM_IDJAMS_SCHEDULE_GET_DEPEND Context
The following data identifiers are supported by the JAMS_GET_DATA routine when the context was returned by a call to JAMS_SCHEDULE_GET_DEPEND:
JAMS_K_AVG_BIOCNT
JAMS_K_AVG_CPUTIM
JAMS_K_AVG_DIOCNT
JAMS_K_AVG_PAGEFLTS
JAMS_K_AVG_PGFLPEAK
JAMS_K_AVG_WSPEAK
JAMS_K_DEPENDENCY
JAMS_K_DESC_LN1
JAMS_K_DESC_LN2
JAMS_K_JOB_DESC_LN1
JAMS_K_JOB_DESC_LN2
JAMS_K_JOB_NAME
JAMS_K_LAST_ERROR
JAMS_K_LAST_FATAL
JAMS_K_LAST_INFO
JAMS_K_LAST_SUCCESS
JAMS_K_LAST_WARNING
JAMS_K_MAX_BIOCNT
JAMS_K_MAX_CPUTIM
JAMS_K_MAX_DIOCNT
JAMS_K_MAX_PAGEFLTS
JAMS_K_MAX_PGFLPEAK
JAMS_K_MAX_WSPEAK
JAMS_K_MIN_BIOCNT
JAMS_K_MIN_CPUTIM
JAMS_K_MIN_DIOCNT
JAMS_K_MIN_PAGEFLTS
JAMS_K_MIN_PGFLPEAK
JAMS_K_MIN_WSPEAK
JAMS_K_NAME
JAMS_K_NOTIFY_SEVERITY
JAMS_K_RECOVERY_SEVERITY
JAMS_K_RESTARTABLE
JAMS_K_SATISFIED
JAMS_K_SATISFIED_TIME
JAMS_K_SINCE_DESC_LN1
JAMS_K_SINCE_DESC_LN2
JAMS_K_SINCE_NAME
JAMS_K_SINCE_TIME
JAMS_K_SUBMIT_FROM
JAMS_K_SUBMIT_HOLD
JAMS_K_SUBMIT_TO
JAMS_K_SYSTEM_IDThe following data identifiers are supported by the JAMS_GET_DATA routine when the context was returned by a call to JAMS_HISTORY_GET:
JAMS_K_AUTOSUBMIT
JAMS_K_AVG_BIOCNT
JAMS_K_AVG_CPUTIM
JAMS_K_AVG_DIOCNT
JAMS_K_AVG_PAGEFLTS
JAMS_K_AVG_PGFLPEAK
JAMS_K_AVG_WSPEAK
JAMS_K_BIOCNT
JAMS_K_CHECKPOINT_DATA
JAMS_K_CPUTIM
JAMS_K_CPU_RATING
JAMS_K_DESC_LN1
JAMS_K_DESC_LN2
JAMS_K_DIOCNT
JAMS_K_END_TIME
JAMS_K_ENTRY
JAMS_K_FINAL_STATUS
JAMS_K_JOB_DESC_LN1
JAMS_K_JOB_DESC_LN2
JAMS_K_JOB_NAME
JAMS_K_LAST_AUTOSUBMIT
JAMS_K_LAST_ERROR
JAMS_K_LAST_FATAL
JAMS_K_LAST_INFO
JAMS_K_LAST_SUCCESS
JAMS_K_LAST_WARNING
JAMS_K_LOG_FILENAME
JAMS_K_MAIL_ADR
JAMS_K_MAX_BIOCNT
JAMS_K_MAX_CPUTIM
JAMS_K_MAX_DIOCNT
JAMS_K_MAX_PAGEFLTS
JAMS_K_MAX_PGFLPEAK
JAMS_K_MAX_WSPEAK
JAMS_K_MIN_BIOCNT
JAMS_K_MIN_CPUTIM
JAMS_K_MIN_DIOCNT
JAMS_K_MIN_PAGEFLTS
JAMS_K_MIN_PGFLPEAK
JAMS_K_MIN_WSPEAK
JAMS_K_NAME
JAMS_K_NODENAME
JAMS_K_NONWORKDAY_OPTION
JAMS_K_NOTIFY_SEVERITY
JAMS_K_OPER_CLASSES
JAMS_K_OVERRIDE_NAME
JAMS_K_PAGEFLTS
JAMS_K_PGFLPEAK
JAMS_K_PID
JAMS_K_QUEUE_NAME
JAMS_K_RECOVERY_SEVERITY
JAMS_K_REPLY_USERS
JAMS_K_RESTARTABLE
JAMS_K_RESTART_COUNT
JAMS_K_RESTART_NUMBER
JAMS_K_RESUBMIT_BASE
JAMS_K_RESUBMIT_DELAY
JAMS_K_RESUBMIT_END
JAMS_K_RON
JAMS_K_RUN_UNDER
JAMS_K_SCHED_DATE
JAMS_K_SCHED_EXCEPT
JAMS_K_SETUP_DESC_LN1
JAMS_K_SETUP_DESC_LN2
JAMS_K_SETUP_NAME
JAMS_K_START_TIME
JAMS_K_SUBMITTED_BY
JAMS_K_SUBMIT_FROM
JAMS_K_SUBMIT_HOLD
JAMS_K_SUBMIT_TIME
JAMS_K_SUBMIT_TO
JAMS_K_SYSTEM_DESC
JAMS_K_SYSTEM_ID
JAMS_K_WSPEAKReturns the Autosubmit flag of a Setup definition. This flag will be "Y" or "N". The return descriptor must point to a character string variable.
Returns the average number of buffered I/O's performed by the job. The return descriptor must point to an integer variable.
Returns the average amount of CPU time, in 10 millisecond units, used by the job. The return descriptor must point to an integer variable.
Returns the average number of direct I/Os performed by the job. The return descriptor must point to an integer variable.
Returns the average number of page faults which incurred by the job. The return descriptor must point to an integer variable.
Returns the average peak page file usage of the job. The return descriptor must point to an integer variable.
Returns the average peak working set of the job. The return descriptor must point to an integer variable.
Returns the number of buffered I/O's performed by the job. The return descriptor must point to an integer variable.
Returns the last value of the job's checkpoint data. Only the first 39 bytes of the checkpoint data can be returned. The return descriptor must point to a character string variable.
Returns the amount of CPU time, in 10 millisecond units, used by the job. The return descriptor must point to an integer variable.
Returns the value of the JAMS_CPU_RATING logical name for the node on which the job executed. The return descriptor must point to a F-float floating point variable.
Returns a text representation, or description, of the the dependency. The return descriptor must point to a character string variable.
JAMS_K_DESC_LN1, JAMS_K_DESC_LN2
Returns line one or line two of the description of the job. If the job was submitted via a Setup definition, the description is from the Setup definition otherwise the description is from the Job definition. If the context is from a call to JAMS_SCHEDULE_GET_DEPEND then this item code returns line one or line two of the description of the Job or Variable involved in the dependency. The description may be up to 50 characters in length. The return descriptor must point to a character string variable.
Returns the number of direct I/Os performed by the job. The return descriptor must point to an integer variable.
Returns the actual or estimated completion time of the job as a VMS quadword date and time. If the context is from a call to JAMS_SCHEDULE_GET_JOB then this time is estimated based upon the estimated start time and the Job's (or Setup's) average elapsed time. The return descriptor must point to an 8 byte variable.
Returns the VMS queue entry number of the job. The return descriptor must point to an integer variable.
Returns the estimated start time of the job as a VMS quadword date and time. This estimate is based upon the scheduled time and the time when all dependencies are satisfied. The return descriptor must point to an 8 byte variable.
Returns the final status of the job. The return descriptor must point to an integer variable.
JAMS_K_JOB_DESC_LN1, JAMS_K_JOB_DESC_LN2
Returns line one or line two of the description of the job. This description comes from the Job definition. The description may be up to 50 characters in length. The return descriptor must point to a character string variable.
Returns the name of the job as specified in the Job Definition. A job name may be up to 39 characters in length. The return descriptor must point to a character string variable.
Returns the date and time of the most recent automatic submit of this Setup. This date is updated only when a Setup is automatically submitted by the JAMS_AUTOSUBMIT Job. The return descriptor must point to an 8 byte variable.
Returns the date and time of the most recent error completion of this Job or Setup. The return descriptor must point to an 8 byte variable.
Returns the date and time of the most recent fatal completion of this Job or Setup. The return descriptor must point to an 8 byte variable.
Returns the date and time of the most recent informational completion of this Job or Setup. The return descriptor must point to an 8 byte variable.
Returns the date and time of the most recent successful completion of this Job or Setup. The return descriptor must point to an 8 byte variable.
Returns the date and time of the most recent warning completion of this Job or Setup. The return descriptor must point to an 8 byte variable.
Returns the full file specification, including version number, of the Job's .LOG file. The log file name is available only if the Job actually started and got as far as running JAMS_REGISTRAR.EXE in the SYLOGIN command file.
Returns the VMS mail addresses specified in the job's System I.D. or, if the job is unregistered, in the JAMS configuration. The list of addresses may be up to 256 characters in length. The return descriptor must point to a character string variable.
Returns the maximum number of buffered I/O's performed by the job. The return descriptor must point to an integer variable.
Returns the maximum amount of CPU time, in 10 millisecond units, used by the job. The return descriptor must point to an integer variable.
Returns the maximum number of direct I/Os performed by the job. The return descriptor must point to an integer variable.
Returns the maximum number of page faults which incurred by the job. The return descriptor must point to an integer variable.
Returns the maximum peak page file usage of the job. The return descriptor must point to an integer variable.
Returns the maximum peak working set of the job. The return descriptor must point to an integer variable.
Returns the minimum number of buffered I/O's performed by the job. The return descriptor must point to an integer variable.
Returns the minimum amount of CPU time, in 10 millisecond units, used by the job. The return descriptor must point to an integer variable.
Returns the minimum number of direct I/Os performed by the job. The return descriptor must point to an integer variable.
Returns the minimum number of page faults which incurred by the job. The return descriptor must point to an integer variable.
Returns the minimum peak page file usage of the job. The return descriptor must point to an integer variable.
Returns the minimum peak working set of the job. The return descriptor must point to an integer variable.
Returns the name of the job. If the job was submitted via a Setup Definition, the name of the Setup is returned, otherwise, the name of the job is returned. A job name may be up to 39 characters in length. The return descriptor must point to a character string variable. If the context is from a call to JAMS_SCHEDULE_GET_DEPEND then this item code returns the name of the Job or Variable involved in the dependency.
Returns the node name on which the job executed. The node name may be up to 64 characters long. The return descriptor must point to a character string variable.
Returns the Non-workday flag of a Setup definition. This flag will be "S", "I" or "D". The return descriptor must point to a character string variable.
Returns the Notify Severity flag of a Job definition. This flag will be "S", "I", "W", "E" or "F". The return descriptor must point to a character string variable.
Returns the Operator classes specified in the job's System I.D. or, if the job is unregistered, in the JAMS configuration. The list of classes may be up to 256 characters in length. The return descriptor must point to a character string variable.
Returns the override name given to a Job. This is the name supplied by the/NAME= qualifier of the SUBMIT command. The return descriptor must point to a character string variable.
Returns the number of page faults which occurred during the execution of the job. The return descriptor must point to an integer variable.
Returns the peak page file usage of the job. The return descriptor must point to an integer variable.
Returns the VMS process ID of the job's process. The return descriptor must point to an integer variable.
Returns the Report Location as specified in the System Definition. The return descriptor must point to a string variable.
Returns the name of the VMS queue in which the job executed. The return descriptor must point to a string variable.
Returns the Recovery Severity flag of a Job definition. This flag will be "S", "I", "W", "E" or "F". The return descriptor must point to a character string variable.
Returns the VMS Reply username list specified in the job's System I.D. or, if the job is unregistered, in the JAMS configuration. The list of usernames may be up to 256 characters in length. The return descriptor must point to a character string variable.
Returns the Restartable flag of a Job definition. This flag will be "Y" or "N". The return descriptor must point to a character string variable.
Returns the number of times that this job restarted. The return descriptor must point to an integer variable.
Returns the number of this restart. The return descriptor must point to an integer variable.
Returns the Re-submit from flag of a Setup definition. This flag will be "S", "E" or "T". The return descriptor must point to a character string variable.
Returns the Re-submit delay for a Setup Definition. The return descriptor must point to an integer variable.
Returns the time of day when Re-submits should stop for a Setup Definition. The time of day is expressed as the number of seconds since midnight. A negative number represents a missing time. The return descriptor must point to an integer variable.
Returns the JAMS run occurrence number (RON) of this job. Each job is assigned a unique RON which will never repeat. The return descriptor must point to an integer variable.
Returns the VMS username under which this job ran. The return descriptor must point to a character string variable.
Returns an integer which will have the value 1 if the dependency was satisfied in the simulation or zero is the dependency was not satisfied. The return descriptor must point to an integer variable.
Returns a VMS quadword date and time which represents the date and time when the dependency was satisfied. Zero is returned if the dependency was not satisfied. The return descriptor must point to an 8 byte variable.
Returns a numeric code which represents what type of scheduled Job this is. Possible values are:
Symbol Description JAMS_K_PRECHECK The Job was submitted as a pre-check for another job in the schedule. JAMS_K_RECOVERY The Job was submitted as a recovery job for another job in the schedule. JAMS_K_REPEATED The Job was submitted as the result of the completion of a Setup which is resubmitted periodically. JAMS_K_SCHEDULED The Job is an normal scheduled Job. JAMS_K_TRIGGERED The Job was submitted as the result of a Trigger firing during the simulation. The return descriptor must point to an integer variable.
Returns the the text of a Setup Definitions Scheduled Date. The return descriptor must point to a character string variable.
Returns the the text of a Setup Definitions Except for Date. The return descriptor must point to a character string variable.
Returns the scheduled time of the job as a VMS quadword date and time. The return descriptor must point to an 8 byte variable.
JAMS_K_SETUP_DESC_LN1, JAMS_K_SETUP_DESC_LN2
If this job was submitted via a Setup definition, returns line one or line two of the Setup description , otherwise returns spaces. A description may be up to 50 characters in length. The return descriptor must point to a character string variable.
If this job was submitted via a Setup definition, returns the name of the Setup, otherwise returns spaces. A Setup name may be up to 39 characters in length. The return descriptor must point to a character string variable.
JAMS_K_SINCE_DESC_LN1, JAMS_K_SINCE_DESC_LN2
Returns line one or line two of the description of the Since Job. The description may be up to 50 characters in length. The return descriptor must point to a character string variable.
Returns the name of the Since Job. The name may be up to 39 characters in length. The return descriptor must point to a character string variable.
Returns a VMS quadword date and time which represents the date and time after which the dependency had to be satisfied. For example, if a dependency says "JOBA must have completed since the last time that JOBB completed with a status of I or better", then the date and time returned by this item code will be the last time that JOBB completed with a status of I or better. The return descriptor must point to an 8 byte variable.
Returns the starting time of the job as a VMS quadword date and time. The return descriptor must point to an 8 byte variable.
Returns the VMS username which submitted this job. The return descriptor must point to a character string variable.
Returns the time of day which starts this Job or Setups Submit range. The time of day is expressed as the number of seconds since midnight. A negative number represents a missing time. The return descriptor must point to an integer variable.
Returns the Submit on Hold flag of a Job or Setup definition. This flag will be "Y" or "N". The return descriptor must point to a character string variable.
Returns the submit time of the job as a VMS quadword date and time. The return descriptor must point to an 8 byte variable.
Returns the time of day which ends this Job or Setups Submit range. The time of day is expressed as the number of seconds since midnight. A negative number represents a missing time. The return descriptor must point to an integer variable.
Returns the description of this Job's System. A description can be up to 50 characters long. The return descriptor must point to a character string variable.
Returns the System I.D. of this Job. A System I.D. can be up to 12 characters long. The return descriptor must point to a character string variable.
Returns number of volumes mounted by this job. The return descriptor must point to an integer variable.
Returns the peak working set of the job. The return descriptor must point to an integer variable.
JAMS_INVCTX Invalid context passed in. JAMS_INVDATAID Invalid data identifier. JAMS_INVRETDSC Invalid return descriptor.
| Previous | Next | Contents | Index |
 | Copyright © 2000, MVP Systems, Inc. All rights reserved. |