Skip to content

docs: correct job actions, Oracle client, installer log, and configuration - #100

Open
rweesner wants to merge 1 commit into
mainfrom
docs/job-actions-and-install-accuracy
Open

rweesner wants to merge 1 commit into
mainfrom
docs/job-actions-and-install-accuracy

Conversation

@rweesner

Copy link
Copy Markdown
Contributor

Corrects the job-action reference so it describes what the SQL Agent does for each job action, fixes the Oracle client prerequisite and the installer log name, and corrects the configuration, JORS, logging, environment-variable and multi-instance pages.

12 files, one commit.

Job actions

  • MySQL and Oracle run script files only. The page described both as running queries or scripts. The agent runs only the file in Script File Path for these two actions; statements entered in the job definition are not run. The page and a new FAQ now say so.
  • New section: how the agent runs every job action.
    • Which account the job runs as, and what the Password field holds when a Windows User ID is set.
    • <SmaEncrypt> values, and the fields they work in.
    • How each action uses environment variables.
    • That Encrypt Connection applies to MS SQL Script only.
    • Which client programs must be on the PATH.
  • New section: how the agent monitors an MS SQL Job. Covers monitor-only jobs, the monitor end time, the 10-second status check, retry behavior, and the exit codes 0–5.
  • Retry FAQ. Retry applies only to MS SQL Job, the 5-minute wait is fixed, and only an unavailable server is retried.
  • Use Script Exit Code FAQ. It no longer describes exit-code logic the agent does not have; the exit code is always the sqlcmd exit code.
  • MySQL port. The agent passes no port when none is given, so the client's default applies; the page no longer says the agent uses 3306.
  • MySQL environment variables are defined as @NAME user variables; the Oracle Connection ID is described as the agent uses it.

Installation

  • Oracle client. The prerequisites named SQLcl; the agent runs SQL*Plus (SqlPlus.exe). The page now lists the client program for each action and says each must be on the PATH.
  • Installer log. The log is SMA_OpCon_Agent_SQL_Install.log (new and upgrade pages).
  • Multiple instances. An instance name is optional. When the default ports are kept, the installer adds 100 × the instance number to them. Each instance's service is SMA_SQLAGENTNET<n>.

Configuration file

  • ShortServiceName is SMA_SQLAGENTNET. DisplayServiceName shows the shipped value and notes the name the installer registers.
  • UseSmoApi is picked up without a restart, and it is not in the shipped file.
  • Added the AllowedIPAddress_5 row and a note that the shipped file contains HungScript.
  • The folder is SQL Agent, with a space (also on the JORS and logging pages).
  • The allowed-address example uses 192.0.2.10, from a range reserved for documentation.

JORS, logging and scripts

  • JORS is part of the SQL Agent service, not a separate service.
  • Standard and error output are written to the same file.
  • Output is written under JobOutput\Archives\<date> while the job runs.
  • The log archive example uses the agent's log name.
  • Environment variables: jobs that run a command-line client get them, including DTExec. MS SQL Job and Other DB jobs do not. The agent sets one group or the other depending on the account the job runs as.

Standards

  • Landing page: added title, description and tags front matter. The link menu is unchanged.
  • "Dialog" is now "window", "OpCon client" is now "OpCon interface", and "executing user" is now "user running the job".
  • The two relative links without .md now use it.

Follow-ups for an owner

  1. Redirect for a renamed page. administration/manage-lsam was renamed to administration/manage-agent in June without a redirect, so the old URL no longer resolves. Adding one is a site configuration change.
  2. Right-click wording (7 uses). The standards ban "click" without an approved wording — open across all agent sites.
  3. HungScript. It is in the shipped file, but how the agent uses it is handled outside the agent's own code and is not documented here.
  4. Encrypt Connection on MS SQL Job. For this action the agent passes the option into the Windows-login setting rather than requesting encryption; the page now says the option applies to MS SQL Script only.

Verification

  • The site builds with no broken links or anchors.
  • No front-matter gaps; every relative link uses the .md form.

🤖 Generated with Claude Code

…ation

Job actions:
- MySQL and Oracle run script files only
- Shared behavior: run-as account, encrypted values, environment
  variables, Encrypt Connection, client programs
- MS SQL Job monitoring, retry and exit codes documented
- Retry, Use Script Exit Code and MySQL port FAQs corrected

Installation: SQL*Plus rather than SQLcl, client programs on the PATH,
installer log name, instance names optional and port offset.

Configuration, JORS, logging, scripts: service names, UseSmoApi reloads,
AllowedIPAddress_5, SQL Agent folder name, JORS part of the agent
service, environment-variable groups.

Standards: landing-page front matter (link menu unchanged), window and
interface wording, link extensions.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
@rweesner
rweesner requested a review from a team as a code owner September 25, 2026 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant