Viewing and Updating Documentation
Theme: Configure
Who Is It For? System Administrator, Automation Engineer
What Is It?
The Documentation panel in Daily Job Definition displays documentation for the job and frequency, including clickable hyperlinks in Read-only mode.
- Select the Full Screen icon (
) on the far right of the panel bar to enter Full Screen mode. Select it again to exit
- When properties are defined, a blue circular indicator (
) appears to the right of the panel name showing the number of defined properties
Adding or Updating Documentation
Documentation properties can be updated in Admin mode. For conceptual information, refer to Documentation in the Concepts online help.
Only users with appropriate permissions can access the Lock button and update job properties. For details, refer to Required Privileges in the Accessing Daily Job Definition topic.
Changes to job properties in Daily Job Definition take effect immediately. If the job has already run, changes take effect the next time the job runs.
To perform this procedure, complete the following steps:
- Select the Processes button at the top-right of the Operations Summary page
- Enable both the Date and Schedule toggle switches. Each switch appears green when enabled
- Select the desired date(s) to display the associated schedule(s)
- Select one or more schedule(s) in the list
- Select one job in the list. Your selection appears in the status bar as a breadcrumb trail
- Select the job record (e.g., 1 job(s)) in the status bar to display the Selection panel
- Select the Daily Job Definition button
at the top-left corner of the panel. The page opens in Read-only mode by default
- Select the Lock button
at the top-right corner to enter Admin mode. The button changes to a white unlocked lock on a green background
- Expand the Documentation panel
- Enter changes in the Job and/or Frequency frames. Hyperlinks may be included
- Select the Save button
:::
FAQs
Q: How many steps does the Viewing and Updating Documentation procedure involve?
The Viewing and Updating Documentation procedure involves 11 steps. Complete all steps in order and save your changes.
Q: What does Viewing and Updating Documentation cover?
This page covers Adding or Updating Documentation.
Glossary
Frequency: A set of rules that defines when a job or schedule is eligible to run, based on calendar rules, day-of-week settings, period offsets, and other timing criteria.
Resource: A numeric variable in OpCon representing a finite pool. Jobs can be configured to require a set number of resource units to run, limiting concurrent executions and preventing resource contention.
Privilege: A specific permission granted through an OpCon role that controls access to a feature, function, or object type. Privileges are organized into categories such as Function Privileges, Machine Privileges, Schedule Privileges, and Access Codes.
Schedule: A named container for jobs in OpCon, built for a specific date to create that day's automation. Schedules define build settings, frequencies, and the jobs that run within them.
Job: The fundamental unit of work in OpCon. A job defines what to run, on which machine, when to start, and what conditions must be met. Job results are tracked and can trigger events and notifications.