JAMS Reference Manual
Contents Index JAMS Home Support

JAMS Reference Manual
Previous Contents Index

DEFINE SETUP

Creates or replaces a Setup Definition.

Format

DEFINE SETUP setup-name

Parameters

setup-name

The Setup Name of the Setup which you want to create or replace.

Description

The DEFINE SETUP command is used to create or replace an entire Setup Definition. The DEFINE SETUP command marks the beginning of a Setup Definition. The JAMS> prompt changes to SETUP_DEF> until the Setup Definition is complete.

Usually, the DEFINE SETUP command is part of a JAMS command procedure which contains the entire definition. You can use the EXTRACT SETUP command to create a complete DEFINE SETUP command procedure.

restrictions

You must be authorized to create or replace the Setup Definition. Additional security checks are made based upon the contents of the Setup Definition.
related commands

Qualifiers

/REPLACE

This qualifier is used to specify whether you want to create or replace the Definition. If you omit this qualifier, the Definition will be created if it does not exist and replaced if it does exist. If you specify /REPLACE, an error will be returned if the definition does not exist and no changes will be made. If you specify /NOREPLACE, an error will be returned if the definition exists and no changes will be made.

Syntax Diagram

The complete syntax for a Setup definition is:
DEFINE SETUP setup-name
  • DESCRIPTION quoted-string [, quoted-string]

  • SYSTEM system-id

  • PRIORITY MODIFIER integer

  • [NO] SUBMIT ON HOLD

  • SUPPRESS MENU

  • NOTIFY SUBMITTER

  • SCHEDULE WINDOW named-time
  • SCHEDULE RANGE time TO time

  • MISSED ACTION
    • ABORT
    • CONTINUE
    • NONE
    • RESCHEDULE
    • RESTART

  • NOTIFY MISSED

  • DEFAULT SUBMIT DATE date-specification

  • DEFAULT SUBMIT TIME time

  • SCHEDULED DATE date-specification

  • EXCEPT FOR date-specification

  • SCHEDULED TIME time

  • RESUBMIT EVERY delta-time UNTIL end-time
    • BASED ON
      • SCHEDULED
      • START
      • END
      TIME

  • [NO] AUTO SUBMIT

  • NONWORKDAYS
    • IGNORE
    • DEFER
    • SCHEDULE

  • dependency-specification...

  • PRECHECK JOB job-name

  • PRECHECK INTERVAL delta-time

  • RETAIN
    • ALWAYS
    • NEVER
    • ERROR
    • FOR delta-time

  • RECOVERY SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

  • RECOVERY JOB job-name

  • RECOVERY INSTRUCTIONS
  • recovery instructions
  • END_RECOVERY

  • MAIL NOTIFICATION quoted-string

  • REPLY NOTIFICATION quoted-string

  • OPERATOR NOTIFICATION quoted-string

  • NOTIFICATION JOB job-name

  • NOTIFY SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL
    • NEVER

  • LOG FILE file-specification

  • [NO] KEEP LOGS

  • [NO] PRINT LOGS

  • [NO] TIMESTAMP LOGS

  • STALLED TIME delta-time

  • RUNAWAY ELAPSED TIME delta-time

  • RUNAWAY ELAPSED PERCENT integer

  • SHORT ELAPSED TIME delta-time

  • SHORT ELAPSED PERCENT integer

  • SHORT SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

  • ACL (acl)

  • resource-requirement...

  • job-specification...

END_SETUP

The syntax for a job specification is:

JOB job-name
  • NAME override-job-name

  • DESCRIPTION quoted-string [, quoted-string]

  • STEP step-number

  • [NO] WAIT

  • CONTINUE

  • MINIMUM SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

  • AGENT NODE agent-name

  • BATCH QUEUE queue-name

  • PRIORITY MODIFIER integer

  • USERNAME username

  • [NO] SUBMIT ON HOLD

  • SCHEDULE WINDOW named-time
  • SCHEDULE RANGE time TO time

  • MISSED ACTION
    • ABORT
    • CONTINUE
    • NONE
    • RESCHEDULE
    • RESTART

  • NOTIFY MISSED

  • SCHEDULED DATE date-specification

  • EXCEPT FOR date-specification

  • NONWORKDAYS
    • IGNORE
    • SCHEDULE

  • parameter-specification...

  • report-specification...

  • PRECHECK JOB job-name

  • PRECHECK INTERVAL delta-time

  • RECOVERY SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

  • RECOVERY JOB job-name

  • MAIL NOTIFICATION quoted-string

  • REPLY NOTIFICATION quoted-string

  • OPERATOR NOTIFICATION quoted-string

  • NOTIFICATION JOB job-name

  • NOTIFY SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL
    • NEVER

  • STALLED TIME delta-time

  • RUNAWAY ELAPSED TIME delta-time

  • RUNAWAY ELAPSED PERCENT integer

  • RUNAWAY CPU TIME delta-time

  • RUNAWAY CPU PERCENT integer

  • SHORT ELAPSED TIME delta-time

  • SHORT ELAPSED PERCENT integer

  • SHORT CPU TIME delta-time

  • SHORT CPU PERCENT integer

  • SHORT SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

END_JOB

The syntax for a parameter specification is:

PARAMETER parameter-name
  • PROMPT quoted-string

  • GLOBAL parameter-name

  • DEFAULT VARIABLE variable-name

  • DEFAULT VALUE quoted-string

  • [NO] REQUIRED

  • [NO] MUST_FILL

  • [NO] ALLOW_ENTRY

  • [NO] UPPERCASE

  • [NO] HIDE

END_PARAMETER

The syntax for a report specification is:

REPORT report-id
  • QUEUE queue-name

  • FORM form-name

  • COPIES integer

  • RETENTION integer

  • QUALIFIERS quoted-string

END_REPORT

The syntax for a job dependency is:

DEPENDS ON JOB [node::]job-name
  • SEVERITY
    • SUCCESS
    • INFORMATIONAL
    • WARNING
    • ERROR
    • FATAL

  • SINCE JOB job-name
    • SEVERITY
      • SUCCESS
      • INFORMATIONAL
      • WARNING
      • ERROR
      • FATAL
  • [NO] SINCE JOB

  • WITHIN [integer DAYS [AND]] [integer HOURS]

  • WAIT IF QUEUED

END_DEPEND

The syntax for a variable dependency is:

DEPENDS ON VARIABLE variable-id
  • CHANGED
  • TRUE
  • FALSE
  • = value
  • < value
  • > value
  • <= value
  • >= value
  • <> value

END_DEPEND

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