Special Services

In this section:

The special services are:


Top of page

x
The Scheduler and Deferred Service

How to:

Reference:

x

You can configure the settings that are used to manage the Scheduler and deferred requests and reports from the Web Console Scheduler Configuration pane. The parameters are stored in the edaserve.cfg file. You can also view and configure the Scheduler Agents page.



x
Procedure: How to Display and Customize the Scheduler Agents Page
  1. From the menu bar, select Workspace.
  2. Right-click the Workspace folder, and select Scheduler Agents.

    or

    In the navigation pane, expand the Special Services and Listeners folder, right-click SCHEDULER, and select Scheduler Agents.

    The Scheduler Agents page opens.

  3. To customize the columns that appear on the page, click Choose Columns.

    Select the check boxes for the columns you want to appear, as shown in the following image.

  4. Click OK.
  5. To customize the states that appear on the page, click Choose States.

    All states appear by default. Deselect the check boxes for the states you want to remove, as shown in the following image.

  6. Click OK.
  7. To activate or deactivate a Scheduler agent, select the check box and click Activate Selected or Deactivate Selected.


x
Reference: Scheduler Agent Columns
You can add the following columns to the Scheduler Agents page.

General

ID

Identification number associated with the scheduler agent.

The current state of the scheduler agent (Starting, Scheduled, Running, Failed, Killed, Killing, Quiesced, Quiescing, Inactive, Reloading, or Done).

Application

Application name of the scheduled procedure.

Procedure

Name of the scheduled procedure.

User ID

User credentials used to run the scheduled procedure.

Schedule

Status

The current status for this procedure (Active or Inactive).

Schedule Type

The schedule type for this procedure (Run Once, Recurring, Multi-Day, Run when server starts, CMASAP, CMASAP Iterator, or CMASAP Iterator Group).

Start Date/Time

The initial start date and time for the schedule.

End Date/Time

The date and time on which this schedule expires.

Intraday Start

The start time of the intraday restriction interval.

Intraday End

The end time of the intraday restriction interval.

Interval

For recurring schedules, the number of minutes, hours, days, weeks, months, or years between runs.

Days of week

The days of the week on which the schedule will run.

Days of month

The days of the month on which the schedule will run.

E-Mail

E-Mail on Failure

The email address where confirmation will be sent on failure of each scheduled run.

E-Mail on start

The email address where confirmation will be sent on start of each scheduled run.

E-Mail on completion

The email address where confirmation will be sent on completion of each scheduled run.

Statistics

Last Run Time

The time of the last scheduled run.

Next Run Time

The time of the next scheduled run.

Tscomid

The identification number for the data service agent running the scheduled procedure.

Job ID

The job ID.

Parent Job ID

The parent job ID.



x
Reference: Scheduler Agent States

By default, the Scheduler Agents includes all states. You can removes the following states to limit what is displayed on the page.

Main states

SCHEDULED

Waiting for the next scheduled run time. When the next scheduled time arrives, the agent attempts to establish a connection with a tscom3 agent in order to execute the scheduled procedure. When a connection is successfully established, the agent enters the RUNNING state. The agent may transition into FAILED state if a problem occurs. The administrator may command the agent to transition into the QUIESCED state from this state by issuing a Quiesce Agent request.

INACTIVE

An idle state. The procedure has been marked inactive. No action is necessary.

DONE

An idle state. The agent will not run because the procedure is past its scheduled end time. The operation is complete, and no further action will be initiated by the agent.

RUNNING

A connection has been established with a tscom3 agent to execute the scheduled procedure, and the procedure has begun to execute. Attempting to kill this agent will result in killing the underlying tscom3 agent process, and will cause a transition into the KILLED state. A critical error, such as a lost or broken connection, will move the agent into FAILED state.

FAILED

A critical error had occurred while trying to connect to a tscom3 agent or while executing the scheduled procedure. Administrator action is required to move the agent out of this state. Removing a FAILED agent will force a rescan, and create a new agent for the procedure.

QUIESCED

The agent has been placed in this state by an administrator request to stop a SCHEDULED agent. No connection exists between this agent and a tscom3 agent. Without administrator action, the agent will remain in this state forever. To transition from this state the administrator must remove this agent. Removal will force a rescan, and create a new agent for the procedure.

KILLED

The agent has been placed in this state by an administrator request to kill a RUNNING agent. The underlying tscom3 process has been killed. No active connection exists between this scheduler agent and tscom3. Without administrator action, the agent will remain in this state forever. To transition from this state the administrator must remove this agent. This will force a rescan, and create a new agent for the procedure.

Transitional states

STARTING

The agent should successfully pass through this state into SCHEDULED, DONE, INACTIVE, or FAILED state with no intervention.

QUIESCING

The agent will transition from this state into QUIESCED without intervention.

KILLING

The agent should successfully pass through this into KILLED state with no intervention.

RELOADING

A RELOAD AGENT request was received to reload a QUIESCED, DONE, FAILED, KILLED, or INACTIVE agent. The agent should successfully pass through this state into SCHEDULED, DONE, INACTIVE, or FAILED state with no intervention.

RESTARTING

The scheduled agent has failed, but is automatically restarting because of the sched_restart_failed option. The agent will transition into the RUNNING state after the number of seconds set in the sched_restart_interval parameter.



x
Procedure: How to Set Scheduler and Deferred Management Properties
  1. From the menu bar, select Workspace.
  2. In the navigation pane, expand the Special Services and Listeners folder.
  3. Right-click SCHEDULER, and select Properties.

    The Scheduler Configuration page opens. The page has Scanning, Execution, Logging and Output, Notification, and DFM sections.

  4. To set properties for the Scheduler or for deferred execution of requests, enter values in the corresponding fields.
  5. Click Save and Restart Scheduler.


x
Reference: Scheduler Scanning Properties

The Scheduler Scanning properties are shown in the following image.

sched_scan_id

Determines what user ID the Scheduler uses to scan the application path for scheduled flows. It can be used to restrict the set of application directories scanned by the Scheduler to a subset of the APP PATH of the effective administrator. The default value is the effective administrator ID of the server.

sched_interval

Specifies the time interval in seconds used by the Scheduler. The Scheduler will wake-up and search for scheduled flows to run at this interval. The default value is 9999.

sched_autostart

If set to y, scanning for scheduled events is started when the DFM listener or a Scheduler service starts. If a service is not running, turning on sched_autostart will not make scanning available.

If set to n, a user may still start the scanning manually.

Depending on the number of files in the application path, sched_autostart may affect server performance.

The default value is n.



x
Reference: Scheduler Execution Properties

The Scheduler Execution properties are shown in the following image.

sched_run_id

Determines the user ID the a flow uses to run scheduled flows, either server_admin_id or user. The default value is server_admin_id.

Note: Flows submitted from the Data Management Console, the Web Console, or CMRUN are run under the userid that submits the specific flow.

sched_service

Defines the agent service that the Scheduler will use when running flows. If not set, the DEFAULT service will be used.

sched_restart_interval

Specifies the time interval in seconds between restart attempts for all restartable flows. The default value is 60 seconds.

sched_restart_failed

Determines whether scheduled agents will be restarted after they fail. The valid values are:

n - Failed agents will be restarted at most n times.

0 - Failed agents will not be restarted.

-1 - Failed agents will be restarted infinitely.

The default value is -1.

CMASAP_clear_interval

Specifies how often (in seconds) CMASAP agents are removed from the agents list. The default value is -1, meaning never.



x
Reference: Scheduler Logging and Output Properties

The Scheduler Logging and Output properties are shown in the following image.

sched_log_lines

Defines the maximum number of lines per request that the Scheduler will write to the log. When this number of lines is reached, logging stops. Exceeding this limit for one request does not affect logging for other requests.

When set to -1, the number of lines is unlimited. When set to 0, logging is disabled. The default value is -1.

sched_log_commit_interval

Specifies the maximum time interval in seconds that can elapse before log data is committed to the log. Used in conjunction with sched_log_commit_maxlines, these settings can fine-tune Scheduler logging behavior. The logging subsystem will commit data to the log whenever one of these maximums has been reached. Finding the best commit interval is a compromise among latency (the delay between the time a log message is received and when it is committed to the log database), reliability, and performance. Longer intervals enable greater I/O efficiency, but increase the potential amount of log information lost in a crash. The default value is 10.

sched_log_commit_maxlines

Specifies the maximum number of log lines to collect before committing them to the log. Used in conjunction with sched_log_commit_interval, these settings can fine-tune Scheduler logging behavior. The logging subsystem will commit data to the log whenever one of these maximums has been reached. Larger numbers enable greater I/O efficiency, but increase the potential amount of log information lost in a crash. The default value is 1000.

Merge Log and Formatted Output

Changes value of sched_log_output_destination keyword.

When checked, it specifies that only the job Log is stored in the Scheduler log (sched_log_output_destination=Log). The output is stored in dfm_dir location.

When unchecked, it specifies that the job Log and Output are stored in the Scheduler log (sched_log_output_destination=LogAndOutput).



x
Reference: Scheduler E-Mail Notification Properties

The Scheduler E-Mail Notification properties are shown in the following image.

On Start

Sends email when the procedure starts.

On Completion

Sends email when the procedure completes.

On Failure

Sends email if the procedure fails.

sched_email_address

Defines the list of email recipients. The list can contain one or multiple email addresses and/or user IDs. Multiple entries should be on separate lines.



x
Procedure: How to Start or Stop Scheduler Scanning Manually

If the Scheduler is active, you can start or stop scanning manually.

  1. Select Workspace from the menu bar.
  2. Open the Special Services and Listeners folder in the navigation pane.
  3. Right-click SCHEDULER and select Start Scanning or Stop Scanning.


x
Reference: Deferred Management Properties

The Scheduler Deferred Management (DFM) properties are shown in the following image.

dfm_dir

Defines the location where deferred requests and responses are stored. For related information, see Extensions for Deferred Files.

dfm_int_min

Defines the minimum time interval that the DFM listener sleeps between handling two requests.

dfm_int_max

Defines the maximum time interval that the DFM listener sleeps between handling two requests

dfm_maxage

Defines the maximum number of days that deferred reports are kept in the server after they are created.

dfm_maxoutput

Defines the maximum size of a deferred report expressed as the number of kilobytes [K] or megabytes [M] between 0 and 65535, where 0 means unlimited. Kilobytes is the default.

Reports that are over this limit are removed.

dfm_autostart

When set to y, the DFM listener is started when the server starts.



x
Procedure: How to View Deferred Process Statistics
  1. From the menu bar, select Workspace.
  2. In the navigation pane, expand the Special Services and Listeners folder.
  3. Right-click SCHEDULER, and select Statistics.

    The Statistics SCHEDULER page displays the following information in the DFM section:

    • DFM_DIR Available Disk Space (KB)
    • Number of Requests Done Since Startup
    • Number of Response Ready

    For more information, see Statistics for an Individual Special Service.



x
Reference: Extensions for Deferred Files
x

The following table lists possible extensions for the deferred files listed in the dfm_dir directory.

Extension

Description

REQ

Request file.

RQD

Data file. Contains user ID, optional flags, and so on.

RQP

Request is being executed.

RQF

Request is waiting to be executed.

DEL

Request is deleted.

RSP

Response file. Contains the whole report for one request.

RPF

Response is ready.

RPE

Response exceeds maximum limit.


iWay Software