Run commands on legacy LSAM machines
- Synopsis
- Full Details
In briefThe legacy LSAM job types let a Continuum workflow run work on the UNIX, Windows, IBM i, SQL, SAP R/3 and CRM, SAP BW, z/OS, MCP and OS 2200 LSAM machines you already have, through a relay. You pick a job type, the machine and the batch user it runs as, where it takes one, and fill in the fields that type asks for; the relay builds what the agent needs, and the agent reports the outcome.
Use them when existing automation on an LSAM machine has to take part in a workflow.
- Fifteen job types take exit criteria; write them against the code the agent actually reports. On the six SQL types, on UNIX - Episys: Run JobFile and Find Report from RSJ Output, on Windows - WS_FTP Pro and on Windows - File Arrival, Continuum always evaluates the table itself. IBM i types have none: read the message ID in Termination, and use a message monitor to act on what a job raises. An SAP R/3 Job or SAP BW Process Chain has none either: its Termination is the agent's result text, and a failed one's Agent Message explains the code. A z/OS job is judged by its agent against its condition-code or return-code range and Step Control rows, or finishes once its command is issued, an MCP job by its agent against the fail codes you set, and an OS 2200 Job by its agent against its Completion Status rules; in each, Termination is the agent's text.
- Most values are checked when the job runs, not when you save it. A refused job fails before it reaches the machine, and the message names the field.
- A blank batch user means the agent's service account on Windows, MS SQL Script, MS SQL DTExec and Other DB, and the job description's default user on IBM i. UNIX, MS SQL Job, Oracle, MySQL and MCP jobs need one.
- Oracle, MySQL and Other DB need SQL*Plus, the mysql client, or the ODBC driver or OLE DB provider, on the SQL LSAM machine.
- Several features need a current relay — the IBM i lists, the MCP and OS 2200 preruns, the z/OS pre-runs, step control and restart options, the newer IBM i and SQL job types, and the advanced exit-criteria forms. A relay that cannot send what the job carries is refused it, and the job goes to Initialization Error.
- Never put a password in an Other DB connection string or a MySQL user variable; keep the login in the batch user.
- Kill on an SAP R/3 Job is refused until the agent's Allow Kill is turned on, and on an SAP BW Process Chain it is always refused.
- An SAP BW Process Chain name over 25 characters saves, and is refused when the job runs.
- A z/OS REXX Exec or Console Command restarts from the beginning only; a z/OS Batch Job or Started Task can restart on a range of steps. z/OS names are checked only when the job runs.
- Saving JCL needs z/OS JCL Edit and a z/OS user ID assigned to you.
- An MCP job restarts from the beginning only, and its values are checked only when it runs.
- An OS 2200 Job restarts from the beginning only and cannot be killed. Its values are checked when you save it, and again, once any property token is resolved, when it runs.
- An IBM i File Arrival job checks once unless a
$@RECHKFREQdynamic variable tells it to keep watching.
If you already run legacy LSAM agents, OpCon Continuum can drive them directly through the relay, so you don't need to rebuild that automation to start orchestrating it. These are the job types, by the kind of LSAM machine they run on:
- Windows LSAM: Windows Command runs a program; Windows - WS_FTP Pro runs a WS_FTP Pro file transfer; four Windows - Command: File … job types copy, move, rename or delete files without a command line; Windows - Corelation submits and monitors a Corelation batch job; two Windows - Fiserv DNA job types run a Fiserv DNA SQT job or a file load; Windows - File Arrival waits for a file; Windows - Embedded Script runs a script from the script library; Windows - Web Services runs a sequence of HTTP/REST calls.
- UNIX/Linux LSAM: UNIX Command runs a program; UNIX - File Arrival waits for a file; UNIX - Embedded Script runs a script from the script library; seven UNIX - Episys job types drive Episys batch processing through RSJ.
- SQL LSAM — listed as SQL - … in the Job Type list: MS SQL Script runs T-SQL; MS SQL Job and MS SQL DTExec start a SQL Server Agent job or an SSIS package; Oracle runs a SQL*Plus script; MySQL runs a MySQL script through the mysql client; Other DB runs SQL through an ODBC driver or OLE DB provider.
- IBM i LSAM: five IBM i job types run a batch job, an Operator Replay or Restricted Mode script or an FTP transfer, or wait for a file.
- SAP R/3 and CRM LSAM: SAP R/3 Job starts an existing SAP R/3 or CRM background job.
- SAP BW LSAM: SAP BW Process Chain starts an existing SAP BW process chain.
- z/OS LSAM: z/OS Batch Job submits a JCL member through JES, optionally once its datasets, a console message, a job or task, tape units or a REXX check are ready; z/OS Started Task starts a procedure such as a CICS region, z/OS REXX Exec runs a REXX exec, z/OS Console Command issues an operator command, and z/OS Tracked Job and z/OS Queued Job put a job the agent reports on its schedule.
- MCP LSAM: MCP Run runs a program, MCP Start starts a WFL job, MCP EAE/AB Suite runs an EAE/AB Suite report, and MCP Copy, MCP Change and MCP Remove copy, rename or remove a file or a whole directory on a Unisys MCP system.
- OS 2200 LSAM: OS 2200 Job starts an ECL runstream on a Unisys OS 2200 system, optionally once a prerun or its file dependencies are satisfied.
- Between machines: SMAFT File Transfer moves a file between any two of these machines, Windows, UNIX or z/OS.
The Common Settings tab covers what every legacy job shares: adding one, its settings, exit criteria, and the account it runs as. The other tabs cover each kind of machine: Windows, File Arrival, SQL, SAP R/3, SAP BW, z/OS, MCP, OS 2200, IBM i, and Between Machines for SMAFT File Transfer.
You're adopting OpCon Continuum but still have working automation on legacy LSAM machines. Rebuilding all of it before you can orchestrate anything would stall the whole move.
Use it when
- You're moving to OpCon Continuum but still have automation on legacy LSAM machines.
- A workflow needs to run a program on a UNIX/Linux or Windows LSAM machine.
- Common Settings
- Windows
- File Arrival
- SQL
- SAP R/3
- SAP BW
- z/OS
- MCP
- OS 2200
- IBM i
- Between Machines
Common Settings
What every legacy job shares, whatever machine it runs on.
- Add a Command
- Exit Criteria
- Connection
Add a Command
Add an LSAM command to a workflow
To add an LSAM command, complete the following steps:
- Go to Workflows and open the workflow you want to edit.
- Add a job: on an empty workflow select First Job, otherwise select New Job (Null) in the tool panel on the left of the editor.
- In the job editor, select the Job Definition tab.
- In the Job Type list, choose UNIX Command or Windows Command.
- Under Agent Assignment, pick the machine; under Job Parameters, set the program to run (see below).
- Select Save.
Settings
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The LSAM machine to run on. It must match the machine name registered with the relay, and name an agent of the job type's platform — a UNIX job aimed at a Windows agent is refused at dispatch with LSAM_AGENT_TYPE_MISMATCH. |
| Start Image | The program or script to run on the machine. On Windows, quote a path that contains spaces. |
| Parameters (Windows: Arguments) | Command-line arguments for the program, added after it with a space. On Windows Command the field is labelled Arguments. |
| Working Dir | Windows only: where the command runs on the machine. |
| Pre Run Image | An optional command run before the main one. A prerun that fails does not fail the job — it is re-attempted a few minutes later, as many times as it takes, which makes a prerun usable as a gate. See A prerun that fails is re-attempted. |
| Connection | The account the job runs as — a saved connection of the platform's batch-user type, picked from a list. On UNIX it is required, and so it is on the SQL MS SQL Job, Oracle and MySQL types and on the six MCP types. On Windows, and on MS SQL Script, MS SQL DTExec and Other DB, leaving it blank runs the job as the agent's own service account; on IBM i, under the job description's default user. See Batch users. |
| Environment Variables | Extra environment variables (Name = Value) for the job. Supported on both Windows and UNIX LSAM. |
| Exit Criteria | Conditions tested against the job's exit code — up to 20 of them, plus an Exit Criteria Result that says whether a match means Fail or Finish OK. Leave it empty to fail on any non-zero exit code. See Set exit criteria. |
A UNIX job's Start Image, Parameters, Pre Run Image and Environment Variables values are sent to the machine
unaltered, so /bin/sh -c "exit 3" runs what you wrote. Earlier builds converted ", &, <,
> and ' into their XML forms on the way, and a UNIX agent doesn't convert them back — the shell
was handed the converted text, and a command with a double quote in it ended with exit 127 and
quot: not found in the log. If you worked around that by avoiding quotes, you no longer need to.
Two character sequences can't be carried in a UNIX value and are refused at dispatch: </F> and
<F I=. The agent would read either as part of the message rather than as your text. Neither has a
use in a shell command; if you need those characters, put them in a script on the machine and run
that.
UNIX and Windows LSAM commands both support:
- Output Parsing: scan the job's output for text (Contains / Does Not Contain) and set an exit code when it matches, so a job that "succeeds" but logs an error can still be flagged failed. Up to five rules, and the first one to match decides the code.
- Custom Log File Path: a log file output parsing scans as well as the job's own output. Leave it blank and the rules read the job's standard output only.
On a UNIX job the agent runs the search through a shell as its own account, usually root, so a
search string that would not be safe to pass on is refused before the job runs — no `, $,
", \ or &, and no leading - or *. See
Output parsing on a UNIX job.
Windows LSAM commands also support Run In Command Shell: run the command inside a command shell instead of starting the program directly, and Process Priority — Normal (the default), High, Idle or Real-Time — for the program and its prerun. Keep Real-Time for a machine dedicated to the job. A priority other than Normal needs a current relay; on an older one the job goes to Initialization Error with RELAY_LSAM_FEATURE_UNSUPPORTED.
UNIX commands also support process priority (Nice Value) and signal/core-dump failure conditions (Signal Criteria, Core Dump Flag).
Exit Criteria
Set exit criteria
Leave Exit Criteria empty and the job fails on any non-zero exit code. Set them and you decide what the code means. The setting is offered on UNIX Command, UNIX - Embedded Script, UNIX - Episys: Run JobFile, UNIX - Episys: Find Report from RSJ Output, Windows Command, Windows - Embedded Script, Windows - Web Services, Windows - WS_FTP Pro, Windows - File Arrival, SQL - MS SQL Script, SQL - MS SQL Job, SQL - MS SQL DTExec, SQL - Oracle, SQL - Other DB and SQL - MySQL, and on no other LSAM job type.
There are two parts to get right, and the second is the one people miss:
- The rows. Up to 20, each an Operator and a Value. The operators are Equal To, Not Equal To, Less Than, Greater Than, Less Than or Equal To and Greater Than or Equal To, plus Range, which also takes an End Value and includes both ends. The rows are an OR — the code matches the table if it matches any row. End Value only appears on a Range row, so if you cannot see the field, check the operator.
- Exit Criteria Result. One setting for the whole table: does a match mean Fail (the default) or Finish OK? And whichever you pick, a code that matches nothing gets the opposite. There is no "no rule matched" middle.
So the same intent can be written two ways, and you should pick whichever is shorter to read:
| You want | Rows | Exit Criteria Result |
|---|---|---|
Fail on 5 and on anything above 100 | Equal To 5, Greater Than 100 | Fail |
Finish OK on 0, 3, and 10–20 — fail on everything else | Equal To 0, Equal To 3, Range 10–20 | Finish OK |
Two rules the editor enforces as you go: a range row must carry an End Value, and that End Value must be greater than or equal to its Value. Either mistake would make the row impossible to match — and because unmatched codes take the opposite outcome, it would quietly give the job the wrong verdict. The workflow refuses to commit and names the row: Range criterion #2 needs an End Value.
Write the criteria against the code the agent actually reports, which you can read as the job's Return Code on the Processes page. On UNIX in particular, a code of 128 or above arrives as a negative number unless the agent has been configured otherwise.
Finish OK, ranges, and rows past the fifth need a current relayThose three forms are enforced by OpCon Continuum after the agent reports, rather than by the agent
itself, and they depend on relay changes. A relay on an older build refuses the dispatch rather
than sending a table it cannot represent, so the job will not start until the relay is upgraded. Ask
your Administrator before building a workflow around them. Up to five plain conditions with the
default Fail work on any relay build, and so does any table on a UNIX - Episys: Run JobFile,
UNIX - Episys: Find Report from RSJ Output, Windows - WS_FTP Pro or Windows - File
Arrival job, which Continuum always evaluates itself.
When OpCon Continuum decides the outcome, it records
Finished OK (Exit Criteria) Return Code='3' in the job's history, which is worth knowing
because the agent's own log was given the default and will say the opposite. The job's termination
text keeps the exit code on these job types, so an
Exit Description event written for a particular code still fires.
Connection
Pick the account the job runs as
Most legacy job types have a Connection field: the SAP R/3, SAP BW, z/OS and OS 2200 types have none, and SMAFT File Transfer takes one for each end. Rather than typing a user name into the job, you pick a saved connection that holds the account — the Administrator defines it once and you reference it. Nothing sensitive lands in the workflow.
The picker offers only connections of your job's platform type, and you can search it by name. What a blank field means depends on the platform:
| Platform | Connection type | Blank means |
|---|---|---|
| Windows | Windows Batch User | The job runs as the agent's own service account. This is the only way to run as it: a Windows Batch User connection always names an account. |
| UNIX/Linux | UNIX Batch User | Not allowed — a UNIX job must name one. |
| IBM i | IBM i Batch User | The job runs under the job description's default user. |
| SQL | SQL Batch User | The job runs as the agent's own service account, with no impersonation. Not allowed on MS SQL Job, Oracle and MySQL. |
A Windows job used to accept only the literal Use Service Account, and UNIX and IBM i jobs carried
a user and group you typed in. Those fields are gone. If you are opening a UNIX or IBM i job you
built before the change, re-pick the account from the Connection field — the old typed-in value
is no longer read, and a UNIX job without a batch user fails when it runs.
If the account you need isn't in the list, ask your Administrator to define it — see Manage connections.
Windows
Transfer files with WS_FTP Pro
On a Windows LSAM machine that runs Ipswitch WS_FTP Pro, the Windows - WS_FTP Pro job type runs a file transfer using WS_FTP Pro's own site profiles. You pick the job type the same way as a Windows Command (choose Windows - WS_FTP Pro from the Job Type list), then fill in the transfer.
Before you start: the source and destination site profiles must already be set up in WS_FTP Pro on that machine. The job refers to them by name and stores no passwords or connection details; WS_FTP Pro supplies those from the profile.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The Windows LSAM machine to run on (must match the name registered with the relay). |
| Connection | The Windows Batch User connection the job runs as. Leave it blank to run as the agent's own service account. |
| Ws FTPPro Location | The folder containing wsftppro.exe on the machine. |
| Source Profile / Source File | The WS_FTP Pro site profile name for the source, and the file to transfer. |
| Destination Profile / Destination File | The site profile name for the destination, and the file to write. |
| File Transfer Options | Optional extra WS_FTP Pro command-line switches (for example, -binary -delete). |
| Exit Criteria / Exit Criteria Result | Optional. What the transfer's exit code means — up to 20 conditions, which Continuum always applies itself. Leave it empty to fail on any non-zero exit code. See Set exit criteria. A transfer the agent could not start at all stays Failed whatever the table says. |
All fields except the options are required, and saving is refused while one is empty. Profile
names can't contain a colon (:), and none of the text fields can contain a double quote (").
Those are not checked while you edit: a stray " or :, or a location that's too long, fails when
the job is dispatched, so double-check these before you run it.
Copy, move, rename, or delete files
For routine file housekeeping on a Windows LSAM machine you don't have to write an xcopy or del
command line by hand. Four Windows - Command: File … job types build it for you. Pick one the
same way as a Windows Command (from the Job Type list), then fill in the files:
| Job type | What it does | Key settings |
|---|---|---|
| File Copy | Copies files using xcopy | Source, Destination, Destination Type (file or directory), and toggles for verify (Verify Destination Files), short names (Use Short Name Format), and subdirectories (Copy Subdirectories). |
| File Move | Moves files, overwriting the destination | Source, Destination. |
| File Rename | Renames a single file (won't overwrite an existing name) | Path and Current File Name, New File Name. |
| File Delete | Deletes files or directories using del | File To Delete — a comma-separated list, wildcards allowed — plus optional Force Delete Read Only Files, Delete Specified Files from all Subdirectories, and per-attribute filters. |
All four run as whichever Windows Batch User connection you attach, or as the agent's own service account when you leave the field blank, and File Copy and File Delete each have an optional Other Options field for extra command switches. A path can contain spaces or unusual characters — the relay quotes it for you.
File Delete can also filter by file attribute — Read Only, Not Content Indexed, Archive, Hidden, System, and Reparse Point. Set a filter to Include to delete only files carrying that attribute, or Exclude to skip them; leave it unset to ignore the attribute.
As with WS_FTP Pro, saving is refused while a required field is empty, but the values themselves are
checked when the job runs. An invalid attribute filter or a command line that's too long fails at
dispatch, so double-check the paths before you run it. Options that would pause for a prompt
(such as del /P) are ignored, so an unattended job can't hang waiting for an answer.
Submit a Corelation batch job
On a Windows LSAM machine that has SMA's Corelation connector installed, the Windows - Corelation job type submits a Corelation batch job and waits for it to finish. Pick it the same way as a Windows Command — choose Windows - Corelation from the Job Type list — then fill in the job.
Before you start: the Corelation connector (SMARunCorelationJob.exe) and a configuration file
holding the Corelation connection details must already be in place in the connector folder on that
machine. The job runs as whichever Windows Batch User connection you attach, or as the agent's own service account when you leave the field blank.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The Windows LSAM machine to run on (must match the name registered with the relay). |
| Connection | The Windows Batch User connection the job runs as. Leave it blank to run as the agent's own service account. |
| Connector Location | The folder containing SMARunCorelationJob.exe. The job runs in this folder. |
| Corelation Job | The job to submit — its name, or its serial if you set Type to Job Serial. |
| Configuration File | Required. The connector configuration file holding the connection details. A new job starts with .\SMARunCorelationJob.ini stored; clear it and saving is refused with Required parameter 'configurationFile' is missing. |
| Batch Server | Optional. Blank uses the connector's default. |
| Use Least Busy Batch Queue | On for a new job: the job goes to the open queue with the least work. Turn it off to name a queue. |
| Batch Queue | Shown, and required, only while Use Least Busy Batch Queue is off: the queue to submit the job to. A job saved before the switch existed opens with it set from its queue — on for a blank or leastbusy queue, off for any other. |
| Format As | Whether runtime parameters are passed as Batch Options (the default) or Parameters. Property Owner is greyed out unless it is Batch Options. |
| Parameters | Runtime Name/Value pairs, up to 99. Neither part may contain a double quote or a pipe. |
| Include XMLIn Output / Show View Submit Response / Show Job List / Include Debug Messages | Log the request/response XML (on by default), the submit response, the job list, or verbose debug output. |
Turning on Include Job Details In Output retrieves the job's details only: the Corelation job is not run — use it to inspect a job rather than submit it.
Run a Fiserv DNA job
On a Windows LSAM machine that has SMA's DNA connector installed, two job types run a Fiserv DNA job and wait for it to finish. Pick one the same way as a Windows Command, from the Job Type list:
- Windows - Fiserv DNA runs a DNA SQT job: a DNA application (APPL), optionally scoped by cycle codes.
- Windows - Fiserv DNA (File Loader) loads a file into DNA. It always runs the
PS_FILELOADERapplication, so instead of cycle codes you give it the file's name and its control totals.
Before you start: the DNA connector (SMARunDNAJob.exe) and its configuration file must already
be in place in the connector folder on that machine, and the DNA/SQT (Oracle) credentials must
be set in the configuration file's [SQRT Parameters] section. The job carries no DNA credentials
of its own — the connector reads them from that file.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The Windows LSAM machine to run on (must match the name registered with the relay). |
| Connection | The Windows Batch User connection the job runs as. Leave it blank to run as the agent's own service account. |
| Connector Location | The folder containing SMARunDNAJob.exe; it's also the job's working directory. |
| Config File | Required. The connector configuration file (holds the DNA/SQT credentials). A new job starts with .\SMARunDNAJob.ini stored; clear it and saving is refused with Required parameter 'configFile' is missing. |
| Application Name / Application Number | The DNA application (APPL) to run; the name is required. A new File Loader job starts with PS_FILELOADER, the application for file loads, stored; on the SQT job there is no default, so enter one, or saving is refused with Required parameter 'applicationName' is missing. The number, if given, is used in preference to the name. |
| Effective Date / Effective Date Offset | Optional run date and a day offset; leave the date blank to let the connector derive it from DNA. |
| Cycle Codes | SQT job only — the cycle codes to run (for example EOM), or turn on Cycle Code Not Required to skip the connector's check. |
| File Name, File Batch Count, File Record Count, Credits, Debits, File Number | File Loader only — the file's name, batch count, record count, credits, debits, and file number. Each can be a literal value or the name of an OpCon property. |
| Parameters | Optional runtime parameters as Name/Value pairs (up to 99), each with optional date handling — an Action (Business date or Calendar date), an Offset in days, and (for a calendar date) a Date Format. |
All the text fields reject a double quote ("), and a cycle code or a parameter can't contain a
" or a pipe (|). Runtime-parameter date handling has to be consistent — set a date type before
an offset or a date format, and use a date format only with Calendar date. Saving is refused
while a required field is empty, but the rest is not checked while you edit: a stray " or |,
inconsistent date handling, more than 99 parameters or cycle codes, or a value that's too long fails
when the job is dispatched.
File Arrival
Wait for a file to arrive
Three job types do this — Windows - File Arrival on a Windows LSAM machine, UNIX - File Arrival on a UNIX/Linux one, and IBM i - File Arrival on an IBM i one (see Wait for a file on an IBM i machine, on the IBM i tab). Each waits for a file to appear and succeeds once a matching file has arrived and stopped changing, so you can put one ahead of the job that processes the file and know the file is really there before it runs. Pick either the same way as a Command job, from the Job Type list.
Unlike the other LSAM job types, File Arrival needs no connector and no command line — the LSAM agent watches for the file itself. You only describe what to watch for and when.
On a Windows LSAM machine
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The Windows LSAM machine to watch on; must match the name registered with the relay. |
| Connection | The Windows Batch User connection the job runs as. Leave it blank to run as the agent's own service account. |
| File Name | Full path and file name to watch for. Wildcards * and ? are allowed in the file-name part; the folder must already exist. UNC paths and %ENVVAR% references are fine. The path may be wrapped in double quotes, in whole or in part, as migrated jobs often store it, as long as it still reads as one path. This needs a current relay: an older one refuses any double quote. See Quotes in the file name. |
| Start Offset / End Offset | The watch window, each set as a Day Offset (whole days from the job's schedule date, -99 to 99) plus a 24-hour Time — so 08:00 on the schedule date is Day Offset 0, Time 08:00. The end can't be earlier than the start; to watch past midnight, move the end to the next day rather than back to an earlier time. Leave both at zero to check whether the file exists right now. This counts from the date the relay sends, so an out-of-date relay can shift the whole window by a day — see below. |
| File Size Stable Time | Seconds to wait before re-checking the file, to confirm it's fully written: the size and timestamps must be unchanged across the interval. Defaults to 5. |
| Include Subdirectories | Also watch subfolders of the given path. Off by default. |
| Exit Criteria / Exit Criteria Result | Optional. Decide what the watcher's exit code means — for example, finish OK on 1 when a missing file is not a failure. Continuum always evaluates the table. See Set exit criteria. |
The offsets used to be a single box taking the whole window in minutes, so 480 meant 08:00. Typing
480 into Day Offset does not give you 08:00: the box takes each digit as you type it, so it
keeps 48, a window 48 days out. 480 itself is outside -99 to 99, so the box refuses it and,
when you leave it, shows the day it kept. Check the day the box shows before you save.
Day Offset 0 is the job's schedule date, and the agent gets that date from the relay. An
out-of-date relay sends its own UTC date instead: if your agents sit west of UTC, an evening
dispatch carries tomorrow's date and the whole window lands a day late. The window you authored is
fine; the date it is counted from is not. See
The schedule date a legacy job is sent with.
The same date fills %SMA_MSLSAM_SCHEDULE_DATE%, so any path you build with it — including a path
you read exit criteria or failure criteria from — is off by the same day on an old relay.
If the file arrives and settles inside the window, the job finishes successfully. Otherwise it's
marked Failed, and the job's exit code tells you why — 1 means the window closed with no file,
2 means the folder doesn't exist. An exit-criteria table changes which codes finish OK.
Saving is refused while File Name is empty, but the rest is not checked while you edit. An
over-long file name, a stray ", an out-of-range offset, or an end offset earlier than the start
fails when the job is dispatched.
On a UNIX/Linux LSAM machine
UNIX - File Arrival is the same idea with UNIX path rules. The window is authored with the same Day Offset and Time pair, and the same relay-date caution above applies.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The UNIX/Linux LSAM machine to watch on; must match the name registered with the relay. |
| Connection | The UNIX Batch User connection the job runs as. Required — unlike Windows, there is no "run as the agent's own account" option — and it has to be able to read the file. |
| File Name | Absolute path of the file to watch for, up to 255 characters. Wildcards *, ? and [...] are allowed in the file-name part; matching is case-sensitive and files whose names start with a dot are skipped. The directory part is taken literally, must already exist, and must not contain spaces. |
| Start Offset / End Offset | As Windows. Leave both at zero to check whether a matching file exists right now. |
| File Size Stable Time | Seconds to wait before re-checking the file's size, to confirm it's fully written. Defaults to 5. |
| Include Subdirectories | Also search subdirectories of the given directory. Off by default. |
` $ " \ ; | & < > ( ) ' are refused anywhere in the path, and spaces are refused in the
directory part. Classic accepts them; Continuum doesn't, because an older UNIX agent hands the name
to a shell when it searches. If you need one of these characters in a watched path, this job type
can't do it. The refusal happens at dispatch, naming the field.
- Stability is judged on size alone. The Windows agent also waits for the timestamps to settle; the UNIX agent compares only the length. A file whose timestamps move but whose size holds will satisfy a UNIX watch.
- A file that keeps growing keeps the job waiting, even past the end of the window.
Its exit codes are 0 matched, 1 no match or unreadable, 2 directory doesn't exist, 3 the file
was last modified outside the window, and -1 the end offset was earlier than the start.
Hand the file on to the next job
Once the Windows or UNIX type matches, the path it matched is recorded on the job. It shows on the job's Summary → Completion as Arrived File, and five properties carry it into the events and notifications that job fires — the whole path, its directory, the file name, the file name without its extension, and the extension.
That is how a downstream job gets told which file turned up, rather than being handed the
pattern that found it. A $JOB:ADD or a notification fired from the File Arrival job can read
[[$ARRIVED SHORT FILE NAME]] and pass the real name along.
Windows - File Arrival takes an exit criteria (on the Common Settings
tab, under Exit Criteria) table, as in Classic; Continuum evaluates it, because the Windows agent
judges every file-watcher job by the default. UNIX - File Arrival offers none: its watcher's
exit code is the verdict, so only 0 succeeds.
SQL
- MS SQL Script
- MS SQL Job
- MS SQL DTExec
- Oracle
- Other DB
- MySQL
MS SQL Script
Run a T-SQL script on a SQL LSAM machine
On a SQL LSAM machine, the MS SQL Script job type runs T-SQL against SQL Server. Pick it the same way as the command job types, from the Job Type list, where it reads SQL - MS SQL Script — all six SQL types carry the SQL - prefix there.
You supply the script one of two ways, and Script Source picks which — the form then shows only that field:
- SQL statements (where a new job starts) — the T-SQL, typed into SQL Script Statements.
- Script file — the path to a
.sqlfile that already sits on the machine, in Script File Path. This is a path on that machine, not a script from the script library.
Switching Script Source clears the field it hides. A job saved before Script Source existed shows both fields; leaving both blank, or filling both in, saves cleanly and then fails when the job runs.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Server Name\Instance | The SQL Server host, or HOST\INSTANCE for a named instance. |
| Database Name | The database to start in. Blank uses the server's default for the login. |
| Connection | A SQL Batch User connection. Blank runs the job as the agent's own service account. |
| Windows Authentication | On, the job reaches SQL Server as the impersonated Windows account instead of with a SQL Server login and password. |
| Encrypt Connection | On by default. See the caution below. |
| Use Exit Code From Script Result | Makes the script's own result the job's exit code. Only works with SQL Script Statements — it does nothing with a script file, and is hidden while Script Source is Script file. |
| Redirect File Path | Writes the script's output to a file on the machine. |
| Other Options | Extra sqlcmd switches, passed through as typed. |
| Environment Variables | Name/value pairs for the script's process. A name with a blank value is not sent. |
This job type does have exit criteria, and OpCon Continuum always evaluates them itself — the SQL agent has no way to receive a criteria table, so it is the only legacy platform where that is true of every table. See Set exit criteria (on the Common Settings tab, under Exit Criteria).
Know which code you are writing conditions against. With Use Exit Code From Script Result off,
sqlcmd exits 0 on success and 1 on an error, which is the whole range available to a table.
Turning it on makes the script's own result the exit code, which is what makes criteria worth setting
on this type.
With it on, SQL Server has to present a certificate the machine trusts. Against a server that does not, the job dispatches cleanly and then fails reaching the database — so it looks like a job failure, not a setup problem. Either get a trusted certificate onto SQL Server or turn the setting off.
MS SQL Job
Start a SQL Server Agent job from a SQL LSAM machine
The MS SQL Job job type starts a SQL Server Agent job that already exists on a SQL Server
instance, and reports its outcome. Reach for it when the work is already defined in msdb — a
nightly ETL kick-off, a replication monitor, a maintenance plan — and you want Continuum to run it on
schedule rather than re-implementing it as a script. It comes from the same SQL LSAM plugin as
MS SQL Script.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Server Name\Instance | The SQL Server instance that owns the job — HOST\INSTANCE for a named instance, or HOST,1433 to name a port. |
| SQL Job Name | The SQL Server Agent job to start or monitor, up to 128 characters. |
| Connection | A SQL Batch User connection. Required here — unlike MS SQL Script, you cannot leave it blank. The account needs rights in msdb to see and start the job; for a job it does not own, that means SQLAgentOperatorRole. |
| Windows Authentication | On, the job reaches SQL Server as the batch user's Windows account instead of as a SQL login. |
| Monitor Only | Don't start the job — watch a run that is already in progress. |
| Monitoring End Time | When to stop watching, as a Day Offset and a Time from midnight of the schedule date. Day 0 / 00:00 watches until the job completes. |
| Connection Retry Attempts | How many times to retry the connection to SQL Server, 5 minutes apart. Up to 99. |
There is no database name, no script and no Encrypt Connection setting on this type: the agent
connects to SQL Server itself and drives the job directly rather than through sqlcmd.
The return codes are outcomes, not program exit codes: 0 Succeeded, 1 Failed, 2 Retry,
3 Cancelled, 4 In progress or a monitoring error, 5 Unknown, -1 a monitoring error before the
first status check. With no exit criteria (on the Common Settings tab, under Exit Criteria) only 0 finishes the job OK — so a
table is how you accept, say, 2 as a success. As with MS SQL Script, Continuum always evaluates the
table itself.
Reaching Monitoring End Time reports the job Finished OK with the SQL Server Agent job still
running, and does not stop it. "Finished OK" means stopped watching, not succeeded. An end time
already in the past starts the SQL job (unless Monitor Only is on), leaves it unmonitored and
reports Finished OK straight away — which is a fire-and-forget pattern, not a failure. Leave the end
time at day 0 / 00:00 if you want the real outcome.
Two things about Monitor Only to plan for: if the SQL Server Agent job is not running when
monitoring starts, you get the outcome of its previous run (5 if it has never run); and
cancelling the Continuum job stops the SQL Server Agent job even in Monitor Only, so a cancel
stops work this job did not start.
See MS SQL Job.
MS SQL DTExec
Run an SSIS package from a SQL LSAM machine
The MS SQL DTExec job type runs a SQL Server Integration Services (SSIS) package with DTExec on an existing SQL LSAM machine. Reach for it when the work is already built as a package — a load, an export, a clean-up — and you want Continuum to run it on schedule. It comes from the same SQL LSAM plugin as MS SQL Script and MS SQL Job.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Package Location | Required. SQL Server (msdb), File system, or SSIS catalog. A new job starts with SQL Server (msdb) stored. Set it first: it decides which fields below are shown. |
| Package Path | The package. In msdb, its package path — \Maintenance\Nightly; on the file system, the full path to the .dtsx file on the machine; in the catalog, \SSISDB\<folder>\<project>\<package>.dtsx. No double quotes, and no backslash at the end. |
| Configuration File | File system only. The full path to a .dtsConfig file on the machine, applied when the package runs. Type the path only — no quotes. Needs a current relay. See The configuration file. |
| Server Name\Instance | The SQL Server instance that holds the package, for msdb and the catalog. No spaces or double quotes. Hidden for the file system. |
| Connection | A SQL Batch User connection, or blank for the agent's service account. Hidden for the file system: those packages always run as the agent's service account. |
| Windows Authentication | On, DTExec reaches SQL Server as the batch user's Windows account instead of as a SQL login. The SSIS catalog always works this way. Hidden for the file system. |
| Other Options | Extra DTExec switches, appended as typed — /Rep EW, say. For a file-system package, put the configuration file in Configuration File instead of a /ConfigFile switch here; the job is refused if both name one. |
With a SQL login, DTExec is handed the login's password on its command line on the machine. Windows Authentication avoids that — and keep passwords out of Other Options for the same reason.
The return codes are DTExec's: 0 Success, 1 Failure, 3 Cancelled, 4 Package not found,
5 Package could not be loaded, 6 Syntax or internal error. With no
exit criteria (on the Common Settings tab, under Exit Criteria) only 0 finishes the job OK, and Continuum always evaluates the
table itself, as on the other SQL types. The job's output is DTExec's own, so it is the first place
to look when a package fails.
See MS SQL DTExec.
Oracle
Run an Oracle script from a SQL LSAM machine
The Oracle job type runs an Oracle SQL*Plus script on an existing SQL LSAM machine — an end-of-day extract or a balancing script you already run against Oracle. SQL*Plus has to be installed on that machine, and the script is always a file there: this type takes no inline SQL.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Connection | Required. A SQL Batch User connection holding the Oracle user name and password SQL*Plus signs on with. Oracle jobs use database authentication only. |
| Server Name | The Oracle database server's host name or IP address, such as dbhost.example.com. |
| Port | The listener port. Leave it empty for 1521. |
| Service Name | The Oracle service name, such as ORCLPDB1. |
| Script File Path | The full path to the script on the machine, such as C:\Scripts\nightly.sql. |
| Parameters | Values the script reads as &1, &2 and so on, separated by spaces. Quote a value with spaces in single quotes: 2026-10-14 'NORTH REGION'. |
| Redirect Result File Path | Send SQL*Plus output to this file on the machine instead of the job output. Overwritten each run. |
| Other Options | Extra SQL*Plus options, such as -S. |
The return code is 0 on success, the ORA error number on an Oracle error — 942 for
ORA-00942, 1017 for a bad user name or password — and 1 when the script file is missing. With
no exit criteria (on the Common Settings tab, under Exit Criteria) only 0 finishes OK, and Continuum evaluates the table
itself, as on the other SQL types.
The agent starts SQL*Plus from a Windows command line built from these fields, so characters the command line would act on are refused at dispatch — in the server name, the service name, the parameters, the two paths, the options, and the batch user's login and password. The message names the field, never the value. The full list is in What is refused at dispatch.
See Oracle.
Other DB
Run SQL through ODBC or OLE DB from a SQL LSAM machine
The Other DB job type runs SQL through an ODBC driver or OLE DB provider on an existing SQL LSAM machine — for a database none of the other SQL types reach. The driver or provider has to be installed on that machine.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Connection | A SQL Batch User connection, or blank to connect as the agent's service account. With Windows Authentication off it is the database login, for an ODBC connection string or a DSN. |
| Windows Authentication | On, the job connects as the batch user's Windows account. |
| Connection Option | ODBC connection string (the default), OLE DB connection string, or ODBC data source (DSN). It decides which of the next two fields is shown. |
| DSN Name | Shown for a DSN: the name of a system data source on the machine. |
| Connection String | Shown for a connection string, such as Driver={ODBC Driver 18 for SQL Server};Server=db01;Database=hr;. No login and no password — those come from the batch user. |
| Script Source | SQL statements (where a new job starts) or Script file. It decides which of the next two fields is shown. |
| SQL Statements or Script File Path | Exactly one: SQL typed into the job, or a .sql file on the machine. Switching Script Source clears the one it hides. |
| Substitution Variables | Each $(NAME) in the SQL is replaced with its value. Not environment variables — and the values show in the agent's log, so no secrets. |
| Redirect Result File Path | Send the results to a file on the machine instead of the job output. |
The connection string is stored with the job in plain text. A connection string that names a
password, secret, token or login key — PWD, UID, User ID and the like, even inside a quoted
value — is refused when the job runs. An OLE DB job cannot take a database login at all: with a
batch user, turn on Windows Authentication. See
The connection string must carry no login or secret.
The return code is 0 on success, -2146232009 on an ODBC error, the provider's own error code
on an OLE DB error, and -2146233079 when the script file is missing; the driver's message is in the
job output. A connection that does not open fails the job with no return code. The query has no
time limit on the agent — give the job a Max Run Time and a kill event if it could run away — and
only the first result set reaches the job output.
See Other DB.
MySQL
Run a MySQL script from a SQL LSAM machine
The MySQL job type runs a MySQL script file with the mysql command-line client on an
existing SQL LSAM machine — a nightly load into a MySQL reporting database, or a reconciliation
script you already run against MySQL. The mysql client has to be installed on that machine and on
its PATH, and the script is always a file there: this type takes no inline SQL.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SQL LSAM machine to run on. |
| Connection | Required. A SQL Batch User connection holding the MySQL user name and password the mysql client connects with. MySQL jobs use MySQL authentication only. |
| Server Name | The MySQL server's host name or IP address, such as dbhost.example.com. |
| Port | The server port. Leave it empty for 3306. |
| Database Name | The database the script runs against, such as sales. |
| Script File Path | The full path to the script on the machine, such as C:\Scripts\nightly.sql. A UNC path is fine. |
| User Variables | Name/value pairs set as MySQL user variables before the script runs: each becomes SET @name = value;, so the script reads @name. The value is a SQL expression — put text in single quotes, such as 'NORTH'. Function calls such as NOW() are not possible, and the values show in the agent's log, so no secrets. |
| Redirect Result File Path | Send the mysql client's results to this file on the machine instead of the job output. Error messages still reach the job output. Overwritten each run. |
| Other Options | Extra mysql command-line options, such as --table. |
The return code is 0 on success and 1 on any MySQL error, a failed login or connection, or a
missing script file — so exit criteria can tell success from failure, but not one error from
another; the mysql client's message is in the job output. A mysql client that is not installed, or
not on the PATH, also returns 1 — or 255 when the job sets user variables. With no
exit criteria (on the Common Settings tab, under Exit Criteria) only 0 finishes OK, and Continuum evaluates the table itself,
as on the other SQL types.
The agent starts the mysql client from a Windows command line built from these fields, so characters
the command line would act on are refused at dispatch — in the server and database names, the two
paths, the options, the user variables, and the batch user's login and password. Setting any user
variable narrows the Script File Path further: no & | ^ ( ) ;, and no folder, file or
server name in it that starts with a lowercase g. The message names the field, never the value.
The full list is in
What is refused at dispatch.
The script and Other Options reach the mysql client as written, and the client can run operating-system commands on the machine. The batch user's password is also on the client's command line while the job runs. Use a MySQL account with only the rights the script needs, and control who can edit the job and its script.
See MySQL.
SAP R/3
Start an SAP background job
The SAP R/3 Job type starts a background job that already exists in SAP R/3 or CRM — the nightly general-ledger posting you see in SM37, for example — on an SAP R/3 and CRM agent. You name the job; its steps and variants stay in SAP. The type is new and has not yet been verified against a real SAP system, so confirm availability with your Continuous contact first.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SAP R/3 and CRM agent to run on. |
| SAP Job Name | Required. The SAP job's name as shown in SM37, such as ZFIN_DAILY. Up to 32 characters, with no * or ?. |
| SAP Job Number | Required. The job number as shown in SM37, up to 8 digits. A shorter number is padded with leading zeros. |
| Start | A.S.A.P. (the default) waits for a free background work process; Immediately starts now, and fails the job if none is free. |
| Exec. Target | The SAP application server to run on, such as sapapp01_PRD_00. Leave it empty to let SAP choose. |
| Skip Spool Retrieval | Turn it on to skip retrieving the job's spool output after it ends. |
Search… beside SAP Job Name and Exec. Target picks the value from the SAP system rather than making you type it: a job you pick fills in SAP Job Name and SAP Job Number together. It is there only when the job's Agent Assignment is Specific Agent with a Primary Agent chosen, it asks that agent through its relay, and it needs Agents Execute granted under All workspaces. See Looking up the job and the server in SAP.
The SAP agent decides the outcome, so there are no exit criteria and no Connection: the agent
signs on to SAP with the SAP user configured on it. When the job ends, Termination shows the
agent's text, such as 0 - 12345601, and its leading code is the exit code — 0 finished, 1
failed in SAP, and a 700xx code means the agent could not run it (70006: the job was not found,
or is not Scheduled or Ready). To find SAP R/3 Jobs whose stored SAP job number SAP no longer
has before they fail this way, and correct them, use Check SAP Job Numbers in Workflows — see
Checking every stored SAP job number.
An SAP R/3 and CRM agent's Allow Kill is off by default, so Kill on one of these jobs is refused and the job keeps running. An administrator can turn it on — see Allow Kill.
The job needs a current relay, and its output can be listed only once it has finished — and not at all when the SAP job name contains a comma. A failed job can be restarted on one of the steps the agent reported — see Restart on a step. When some of the SAP job's child jobs fail, an operator can restart only those from the job's Child Processes table — see Restarting only the failed child processes. See SAP R/3 Job.
When a failed SAP R/3 Job ends, its Agent Message says what the exit code means — for 1,
The SAP job did not finish successfully: SAP reports it cancelled, or it no longer exists.
SAP BW
Start an SAP BW process chain
The SAP BW Process Chain type starts a process chain that already exists in SAP BW — a nightly data load you see in RSPC, for example — on an SAP BW agent. You name the chain; its processes stay in SAP. The type is new and has not yet been verified against a real SAP BW system, so confirm availability with your Continuous contact first.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The SAP BW agent to run on. |
| Process Chain Name | Required. The chain's technical name as shown in RSPC, such as ZPC_DAILY_LOAD. Up to 25 characters — the form accepts more, but a longer name, or one a property token resolves to, is refused when the job runs. |
Search… beside Process Chain Name picks the chain from the SAP system: enter a pattern such as
ZPC_*, search, and the chain you pick fills in the field. As on an SAP R/3 Job, it is there only
with a Specific Agent assignment and a Primary Agent chosen, and it needs Agents Execute
granted under All workspaces. See
Looking up the process chain in SAP.
The SAP BW agent decides the outcome, so there are no exit criteria and no Connection: the
agent signs on to SAP with the logon configured on it. When the chain ends, Termination shows
the agent's text — 0 - and the chain's log ID when it finished, 1 - and the log ID when it
did not, 1 - NOT FOUND when SAP has no chain by that name — and its leading code is the exit
code. A failed job's Agent Message says what the code means, such as The process chain did not
finish successfully.
Jobs on an SAP BW agent can never be killed. Let the chain end, or stop it in SAP.
The job needs a current relay, and its output — the process-chain log — can be listed only once it has finished. A failed job can be restarted on the chain's log ID, which the agent reports as its step, so SAP restarts that chain run — see Restart on a step. See SAP BW Process Chain.
z/OS
Submit a z/OS batch job
The z/OS Batch Job type has a z/OS agent submit a JCL member through JES — a nightly core posting job, for example — from the JCL library on the DD you name. The member and its JCL stay on the mainframe. The type is new and has not yet been verified against a real z/OS LSAM, so confirm availability with your Continuous contact first.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The z/OS agent to run on. |
| Member | The JCL member to submit, such as IVPJOB13. Leave it blank to use the start of the job's name, up to its first space, underscore or dot. |
| DD Name | The DD that holds the JCL library. Blank uses the agent's own default, usually XPSJCL. $DUMMY submits no JCL: the job completes once its dataset pre-runs are met, which makes it a file watcher. |
| User ID | The z/OS user the job is submitted as. Blank uses the agent's own authority. |
| Minimum Condition Code, Maximum Condition Code | The range, 0 to 4095, that every step's condition code must fall in for the job to succeed. Both default to 0. |
| JCL Substitutions | Symbolic and keyword substitutions, such as \\&HLQ=PROD.DATA\\, one line per group: up to 99 lines and 3400 characters. Sent exactly as typed. |
| Temporary Member, Override DD Name | A temporary member to submit instead, and the DD that holds it. |
| Pre-run System | The sysplex system that evaluates the job's pre-run conditions. Blank uses the agent's own system. |
| Submit From | Primary LSAM only (the default) or Any system in the sysplex. |
| Step Control | Up to 80 rows, each a step name, a condition-code range, an Action and an optional Message. The agent uses the first row that matches a step as it ends, so list them by priority. |
| Dataset Pre-run | Up to 80 rows, each a Dataset Name, how many Generations, a Condition (Exists, Created, Updated, Deleted, Referenced, Cataloged or Uncataloged), When (Continuous Monitoring or While/As Scheduled Only) and an optional Job Name. The agent submits the job only once every row is met. An Exists row needs a fully qualified name. |
| Message Pre-run, Job/Task Pre-run, Tape Pre-run, REXX Pre-run | Optional holds that follow Dataset Pre-run: console messages the agent must see, jobs or started tasks that must be running or not, enough free tape units, or a REXX procedure that must return 0. Every pre-run the job has must be met before it runs. See Message, Job/Task, Tape and REXX Pre-run. |
| Restart | Three optional settings for the agent's restart processing: Duplicate Dataset Action — Normal and — Restart (None, Scratch or Reuse) and GDG Regression (None, Absolute, Relative or Catalog Resync). Blank leaves the agent's own default. |
Member, DD and user names are 1 to 8 characters — letters, digits, @, # or $, not starting with
a digit — and are upper-cased for you. A name that breaks the rule saves, and is refused when the job
runs, naming the field.
The z/OS agent decides the outcome: the job fails when a step ends outside the condition-code range, or abends, unless a Step Control row says otherwise. There are no exit criteria and no Connection. When the job ends, Termination shows the agent's text, and while it runs the agent's User Message, Step Completion and Trigger Messages appear under Agent Feedback, where an LSAM Feedback event can watch them.
While the agent waits on the pre-runs, the job reads Pre-run Active. Pre-runs, Step Control rows and the Restart options need a current relay: a relay that has not reported it can send them is refused the job, which goes to Initialization Error rather than submitting its JCL without them.
Restart a failed z/OS Batch Job on a step, or a range of steps. In the Restart dialog pick
a Start Step from the steps the agent reported, and optionally an End Step at or after it;
To the end of the job is the default. A $JOB:RESTART event names the range as STEP2|STEP4.
See Restarting it and
Restart on a step.
The job needs a current relay. See z/OS Batch Job and Dataset Pre-run.
Start a started task, run a REXX exec or issue a console command
Three more job types run on the same z/OS agents. Each shares the z/OS Batch Job's Pre-run System, Submit From, Dataset Pre-run, Message Pre-run, Job/Task Pre-run, Tape Pre-run and REXX Pre-run fields, and none has exit criteria or a Batch User: the agent decides the outcome. They are new and have not yet been verified against a real z/OS LSAM, so confirm availability with your Continuous contact first.
| Job type | Its own fields | How it ends |
|---|---|---|
| z/OS Started Task | Started Task Name (the PROCLIB procedure, such as CICSPROD), Execution Parameters, Minimum and Maximum Condition Code, Step Control | Stays Running until the task ends; fails on a step outside the condition-code range, or an abend. Can be restarted on a step, like a z/OS Batch Job. |
| z/OS REXX Exec | Exec Name (such as RXDAILY), DD Name (blank uses the agent's default, usually SYSEXEC), Execution Parameters, Minimum and Maximum Return Code | Fails when the exec's return code is outside the range. Restarts from the beginning only. |
| z/OS Console Command | Operator Command (required, such as D A,L), Host Job Name | Finishes once the agent has issued the command; there is no completion code. Restarts from the beginning only. |
A blank name field uses the start of the job's name, as Member does. Execution Parameters and Operator Command are sent exactly as typed, up to 256 characters once property tokens are resolved. See Started Task, REXX and Command.
Track or queue a job the agent reports
A z/OS Tracked Job or z/OS Queued Job gives a job the z/OS agent reports a place on its workflow. Use a Tracked Job for a job submitted on the mainframe outside OpCon, and a Queued Job for one the agent intercepts and holds until OpCon releases it. They are new and have not yet been verified against a real z/OS LSAM, so confirm availability with your Continuous contact first.
- Add the job to the workflow with the job name the agent will report, and choose z/OS Tracked Job or z/OS Queued Job.
- Assign it a z/OS agent. When the agent reports the job, the job is assigned to the agent that reported it.
- Set its Restart options if the job needs them; it has no other fields, and no JCL.
- Give it the dependencies it needs. A queued job waits for them; a tracked job has already started when it is reported, so it does not.
- Deploy the workflow. The agent's report is refused unless the workflow is already built for that day, with one instance.
When the agent reports it, the job appears in the workflow instance — a tracked job as Wait to Start (Forced), a queued job waiting for its dependencies — and finishes with the condition code the agent reports. The job runs only from the agent's report: started any other way — built with the workflow and released before the agent reports it, say — it fails without anything being sent to the agent. See z/OS Tracked Job and z/OS Queued Job.
View and edit a job's JCL
- Open the JCL dialog with View / edit JCL — on the Job Definition tab of a z/OS Batch Job or z/OS REXX Exec assigned to a Specific Agent, from JCL on a daily job's detail card, or from the ⋮ menu of the job's node on the workflow diagram.
- Check Member, View DD and Save DD, which are filled in from the job — for a z/OS Batch
Job, Save DD defaults to
TEMPJCL. - Select Load to read the member, and edit it. Every line must fit in 80 columns.
- Select Save. The dialog says which z/OS user ID the save runs as.
Verify: the dialog shows the agent's Saved reply. If it says The save may or may not have been applied, Load the member again before you save a second time.
Loading needs Agents Execute under All workspaces and an agent with a JORS Port. Saving also needs z/OS JCL Edit and a z/OS user ID an administrator has assigned you. See Viewing and editing JCL.
MCP
Run an MCP program or start a WFL job
Two job types run work on a Unisys MCP agent, under an MCP usercode. MCP Run runs a
program, such as (PRODUSER)OBJECT/PAYCALC ON DISK; MCP Start starts a WFL job, such as
WFL/PAYROLL/DAILY ON PACK, and can keep a job summary. The types are new and have not yet been
verified against a real MCP LSAM, so confirm availability with your Continuous contact first.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The MCP agent to run on. An MCP agent's name ends with a period, such as MCPPROD.. |
| Connection | Required: an MCP Batch User connection, which holds the usercode the job runs under. |
| Access Code | The usercode's access code, if it has one. |
| File Title | Required: the program or WFL job, as an MCP file title. Up to 96 characters, no lower-case letters. |
| Arguments | Parameters for the program or WFL job, such as ("STRING PARAM",5,TRUE). Quotes are sent as typed. |
| Task Attributes | Up to 10, one per row, such as PRIORITY=50. |
| File Attributes | MCP Run only: up to 10 file attribute equations, one per row. |
| End-of-Task Notice | Asks the agent for an end-of-task notice when the job ends. |
| Template Display File | The display template file the agent uses for this job. |
| Job Summary User, Job Summary Family, Job Summary Directory or File | MCP Start only: where the job summary is kept. The user is a second MCP Batch User, required when either of the other two is set, and a family needs a directory or file. |
| Fail Code 1–3, Fail Reset 1–2 | Console words that mean the job failed, or cancel a fail-code match, such as DS*. A * at the end matches any ending. |
The MCP agent decides the outcome, by matching your fail codes against the MCP console display.
There are no exit criteria. When the job ends, Termination shows the agent's text, such as
12345COMPLETED, whose leading digits are the mix number, not an exit code.
Values are checked when the job runs, after any property token is resolved, and a value over its limit is refused rather than cut short. An MCP job restarts from the beginning only, and it needs a current relay. See MCP Run and MCP Start.
Run a prerun first. Every MCP job type has a Prerun section. Choose a Prerun Type — Run, Start, EAE/AB Suite, Copy, Change or Remove — and fill in the prerun fields titled with that type, such as Prerun File Title (Run, Start); the others are ignored. The agent runs the prerun before the job, under the job's own batch user and fail codes. A prerun that fails does not fail the job: it moves to Pre-run Failed and is tried again, prerun first, about three minutes later. No prerun field is marked required in the form, so a missing one is reported when the job runs, naming the field and the Prerun Type. A relay that has not reported it can send the prerun is refused the job, which goes to Initialization Error, so upgrade the relays first. See Prerun.
Run an EAE/AB Suite report
MCP EAE/AB Suite runs an EAE/AB Suite report on an MCP agent. It takes the same settings as MCP Run — Connection, Access Code, Task Attributes, File Attributes, End-of-Task Notice, Template Display File, fail codes and fail resets — except File Title and Arguments, which three required fields of its own replace:
| Setting | Notes |
|---|---|
| Report Name | The report to run, such as PAYROLLRPT. Up to 256 characters. |
| Accept File | The file the agent creates to hold the report's parameters, such as PAYROLLACC. Up to 256 characters. The agent keeps it in *SMA/LINC17/FILES/= afterwards; schedule SMA/WFL/CLEANUP/LINC17/FILES to clear that directory. |
| Parameters | Every parameter the report needs, such as PAYROLL 20261024 ALL, sent as typed. Up to 256 characters. |
The agent decides the outcome from your fail codes, as for the other MCP types. See MCP EAE/AB Suite.
Copy, rename or remove MCP files
MCP Copy copies a file or a whole directory, such as (PRODUSER)PAYROLL/=, between disk packs
and tapes, optionally to another MCP host over BNA. MCP Change renames one, and MCP Remove
removes one. Each takes Connection, Access Code, fail codes and fail resets as MCP Run
does, but no task or file attributes, end-of-task notice or template display file:
| Setting | Notes |
|---|---|
| Source File or Directory | Required, on all three: the file or directory, as an MCP file title. Up to 256 characters. |
| From | Required, on all three: the disk family or tape it is on, such as DISK. Up to 40 characters. |
| Source Kind, Destination Kind | MCP Copy only: Tape or Pack (disk). Left unset, each is sent as Tape. |
| Destination File or Directory, To | Required on MCP Copy: where to copy to, and the disk family or tape it is on. Up to 256 and 40 characters. |
| BNA Hostname | MCP Copy only: the MCP host to copy to over BNA. Leave it blank for a copy on this host. |
| Copy & Compare | MCP Copy only: compares the copy with the source after copying. |
| New File or Directory | Required on MCP Change: the new name, as an MCP file title. Up to 256 characters. |
By default the agent fails an MCP Remove job when there is nothing to remove. These three types need a relay that knows them: an older one refuses them with Unsupported MCP task type … (RC_MCP_UNSUPPORTED_TASK_TYPE). See MCP Copy, MCP Change and MCP Remove.
OS 2200
Start an OS 2200 runstream
OS 2200 Job starts an ECL runstream on a Unisys OS 2200 agent. The type is new and has not yet been verified against a real OS 2200 LSAM, so confirm availability with your Continuous contact first.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The OS 2200 agent to run on. |
| Qualifier, File Name | Required: the file that holds the runstream, with its read and write keys if it has any. Up to 12 and 20 characters. |
| Element | The element (and version) to start. Leave it blank to start the file itself. |
| Priority, Options, Condition Word (Octal) | The rest of the Start Command section. Enter the condition word's octal value as written. |
| Run ID, Account, User ID, Project, Maximum Pages, Maximum Cards | The Run Card Control section. User ID -SECURITY- uses the LSAM's security user. |
| Completion Status | Up to 4 rules, each a Finish, a Word Part, a Condition and a Value, joined to the row before by And or Or. Enter each Value in decimal, as the decimal equivalent of the octal status value; the form shows its octal form beneath. A new job starts with one row: Bad Fin when S2 is not equal to 0. |
| Anything Else | Good Fin or Bad Fin: how the run finishes when no Completion Status row matches. |
| LSAM Resolved Dependency | None, Prerun or File Dependencies: something the agent checks before it starts the job. Prerun shows a second set of the fields above, each titled Prerun …, for a runstream the agent starts first; the job starts once it finishes with Good Fin. File Dependencies takes up to eight files, each a Qualifier, a File Name and a Type such as Exists or Created — and a Size for a Size row; the job starts once every file meets its condition. |
| Tokens | Runstream tokens, one per row, as ?NAME?=value, at most 251 characters together. |
A prerun or file check that is not met does not fail the job. It moves to Pre-run Failed and is tried again, check first, about three minutes later. A relay that has not reported it can send them is refused the job, which goes to Initialization Error, so upgrade the relays first. See LSAM Resolved Dependencies.
The OS 2200 agent decides the outcome from your Completion Status rules. There are no exit criteria and no batch user. When the job ends, Termination shows the agent's text.
Save checks every value. The editor refuses to save the job, or the workflow, while a value breaks its rule, and the message names the field, such as Qualifier is required. A value that holds a property token is checked when the job runs, once the token is resolved, and a value over its limit is refused rather than cut short. An OS 2200 Job restarts from the beginning only, cannot be killed, and needs a current relay. See OS 2200 Job.
IBM i
Run work on an IBM i machine
The IBM i job types are registered and run through the relay, but their end-to-end path has not been verified on a real IBM i system yet. Confirm availability with your Continuous contact before you plan work around them.
Five job types run work on an existing IBM i LSAM machine:
| Job type | Use it to | You give it |
|---|---|---|
| IBM i Command | Submit a batch job | The Call — the CL command or program |
| IBM i - Operator Replay | Run an Operator Replay script | The Script Name |
| IBM i - Restricted Mode | Run a Restricted Mode script | The Script Name |
| IBM i - FTP | Send, receive or delete files on an FTP server | An Action (PUT, MPUT, GET, MGET, DEL or MDEL), the Remote System and Remote Library or Directory, and the file fields that action uses |
| IBM i - File Arrival | Wait for a DB2 file or an IFS file to arrive | The File Name, and optionally a creation window and checks — see below |
The first four share the batch user, the prerun and the IBM i batch environment fields — job description, libraries, queues and message logging — and a new job starts with values that reproduce what the job description already does. The form groups the fields in collapsible sections, with Additional Information closed until you open it, and the library, queue and job date fields suggest values you can pick or type over — see How the form is laid out. None of them has exit criteria: IBM i reports no exit code to test. Instead, three of them take lists that let the agent act on what happens while the job runs:
- Message Monitor — IBM i messages to watch for, by Message ID or by severity, and what to do: reply, send an OpCon event, or both, and optionally end the job.
- Spool Files — spooled files to print, hold or save, named with either a User or an Output Queue and its library.
- Dynamic Variables — IBM i LSAM variables set before the job starts. A value can hold
[[property]]tokens.
IBM i - Restricted Mode takes dynamic variables only. Each list holds up to 99 rows. The form does not check the rows; the relay does, when the job runs, and a bad row fails the job naming the list, the row and the column.
A relay that has not reported it can send an IBM i job's lists — any relay older than this release — is refused the job, which goes to Initialization Error with RELAY_LSAM_FEATURE_UNSUPPORTED rather than running without them. Ask your Administrator to confirm the relay is current first.
On an FTP job, a field the Action does not use is greyed out, and changing the Action clears it — see IBM i - FTP for which actions use which fields. No password is sent from Continuum: the IBM i LSAM supplies the FTP user's password itself.
A Call such as CALL PGM(NIGHTLY) PARM('A&B'), or an FTP Remote System written as an IP address
in single quotes, now reaches the machine as written. Earlier builds converted ', &, <, >
and " into their XML forms on the way. As on UNIX, the text </F> or <F I= in a value is refused
when the job runs. This needs a current relay — see
IBM i values reach the agent as you typed them.
Read the outcome from Termination. An IBM i job ends with the message ID its agent reported —
for example SMA0036 when it finished OK, or SMA0037 when it failed — and that is what the job's
Termination row shows and an Exit Description event compares. The event's value is a
number, so use Contains with the digits you want — 37 for SMA0037 — bearing in mind it
matches any other message ID holding them. See
The message ID is the job's Exit Description.
Wait for a file on an IBM i machine
IBM i - File Arrival holds the workflow until a file turns up on the IBM i machine — a nightly
transaction file in PAYLIB/DAILYTRN, say — so the job that loads it runs only once it is there.
The IBM i LSAM does the watching; there is no Call.
| Setting | Notes |
|---|---|
| Machine (from Agent Assignment) | The IBM i LSAM machine to watch on. |
| File Name | Required. A DB2 file as LIBRARY/FILE or LIBRARY/FILE(MEMBER), or an IFS path starting with /. * and ? may be used in the file-name part. No tab or line break inside the name. |
| Creation Window Start / Creation Window End | A Day Offset and a Time from midnight of the job's schedule date — the earliest and latest creation time a matching file may have. Zero means no limit. |
| File Size Stable Duration (seconds) | How long the size must hold still before the file counts as arrived. Defaults to 5. |
| Failure Condition | Fail on error (the default), Always succeed, Fail on error, except when the end time is reached, or Fail if the file contains zero records or zero bytes. |
| Check Lock on DB2 File | Fail with CKF0003 if the DB2 file is locked. |
| Check Read Authority, Check Write Authority, Check Execute Authority | Check that the Connection's user profile has that authority to the file. Each needs a connection. |
| File Name Variable, Record Count Variable | IBM i LSAM dynamic variables that receive the found file's name, and its record count (DB2) or byte count (IFS). |
| Connection | Only for the authority checks. Leave it empty otherwise. |
Without a re-check interval the agent looks for the file once. To keep watching, add a
$@RECHKFREQ dynamic variable with the seconds between checks, and set the window end — or
$@JOBENDTIME — for when to stop.
It also takes the job queue, output queue and message-logging fields, a message monitor and dynamic variables, but no prerun, no library or job description fields and no spool-file list. Like every IBM i job type it has no exit criteria: the agent's completion code and the Failure Condition decide the outcome. See IBM i - File Arrival.
See IBM i LSAM for every field and rule.
Between Machines
Transfer a file between two LSAM machines
The SMAFT File Transfer job type moves a file from one legacy machine to another — Windows to UNIX, UNIX to Windows, or either to itself — using SMA's own file-transfer protocol. Choose it from the Job Type list: SMAFT File Transfer.
A SQL machine can never take part in a file transfer, so it does not appear in this job type's
machine pickers. A z/OS machine can take part, with three differences: Start Transfer On is
locked to Destination, TLS Security cannot be Required, and the z/OS end shows z/OS: no connection (sent as N/A) in place of
the batch user picker. EBCDIC is offered as a data type on the z/OS end only.
It works differently from every other job type here in one respect: you don't choose the machine it runs on. You name both ends, and Start Transfer On decides which of the two does the work.
| Setting | Notes |
|---|---|
| Source Machine / Destination Machine | The two ends. Each list offers only machines whose FT Role permits that direction, so a machine missing from a list has a role that excludes it — including the default, None, which an administrator has to change before the machine takes part in any transfer. |
| Source File / Destination File | Full path and file name at each end. Wildcards * and ? are allowed and transfer more than one file. No double quotes. |
| Source User / Destination User | The batch-user connection for that end, filtered to that machine's platform. A Windows end may be left blank to run as the agent's service account; a UNIX end must have one. |
| Source Data Type / Destination Data Type | Text, ASCII, or Binary (plus EBCDIC on a z/OS end). Text and ASCII translate line endings between platforms; Binary copies bytes unchanged and must be set on both ends. Text (the default) is accepted whichever platform runs the job — a transfer failing on an Unsupported Data Type from a UNIX end means the platform predates that fix, not that the setting is wrong. |
| Start Transfer On | Destination (the default) means the destination pulls from the source. Source means the source pushes — and that needs full file-transfer support on both machines. |
| If File Exists | What to do when the destination file is already there: don't overwrite (the default), overwrite, back up then overwrite, append, or back up then append. |
| Delete Source File | Delete the source after a successful transfer: No (the default), Required or Preferred. Anything but No needs both machines to be Windows, and is refused when the job runs otherwise. |
| Maximum Transfer Rate | A bandwidth cap chosen from fixed steps in kbit/s, not a number you type. >2048 (the default) means uncapped. |
| Compression / Encryption / TLS Security | Each is Required, Preferred, or None. Fail If Preferred Settings Not Satisfied decides whether a silent downgrade from Preferred fails the job. |
Before you start: both machines need a file-transfer endpoint — an address, a port, and a role — set by an administrator. A Universal Agent has none and can never take part. Ask your administrator to give each machine an endpoint before you build the job.
As you fill the two machines in, the editor shows where the job will run, for example Runs on: PAYROLL-WIN (pull — the destination connects to the source and pulls the file).
Agent Assignment is read-only for this job type, and offers no pool and no legacy agent group —
change Start Transfer On or either machine and the assignment follows. Four mistakes are caught
while you edit rather than at dispatch: a missing machine, Binary on only one end, the same file on
the same machine at both ends, and a stale machine assignment.
If the machine at the other end is offline, marked out of service, or unreachable, the job holds until it comes back — and force-start will not push it through, just as it will not send any job to an agent that cannot take it. There is no file-transfer server at the far end to connect to, so forcing would only turn a wait into a failure.
There is also no exit-criteria setting: whatever the file-transfer agent reports is the job's outcome. So check the destination file, not just the job status — particularly on a wildcard transfer, where a partial match still completes. For the full parameter reference and the rules that fail a dispatch, see SMAFT File Transfer job.
- These run through the relay on your existing LSAM machines, not the Universal Agent. If a command finds no agent to run on, it's usually relay or machine connectivity; check with your administrator.
- On Windows LSAM, a job runs as the batch user you attach, or as the agent's own service account when you attach none. Per-job environment variables are supported. The Windows Command job runs a program that already exists on the machine; to carry the script in the job instead, use Windows - Embedded Script.
Related topics
- Legacy LSAM connectors (UNIX/Linux, Windows, IBM i, SQL, SAP R/3, SAP BW, z/OS, MCP and OS 2200) — full configuration reference and troubleshooting
- SMAFT File Transfer job — the cross-machine transfer job type in full
- Prepare agents for connectors (Administrator)
- Respond to a failed connector job (Operator)