Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxLevel2
maxlevel2

...

SAP Connection

Field Name

Description

General

This section contains general information about the task.

Name

Include Page
IL:Task Name
IL:Task Name

Version

Include Page
IL:Versions
IL:Versions

Description

Include Page
IL:Summary
IL:Summary

Member of Business Services

Include Page
IL:Member of Business Services
IL:Member of Business Services

Resolve Name Immediately

Include Page
IL:Resolve Name Immediately
IL:Resolve Name Immediately

Time Zone Preference

Include Page
IL:Time Zone Preference
IL:Time Zone Preference

Hold on Start

Include Page
IL:Hold on Start
IL:Hold on Start

Hold Reason

Include Page
IL:Hold Reason
IL:Hold Reason

Virtual Resource Priority

Include Page
IL:Virtual Resource Priority
IL:Virtual Resource Priority

Anchor
Hold Resources on Failure
Hold Resources on Failure
Hold Resources on Failure

Include Page
IL:Hold Resources on Failure
IL:Hold Resources on Failure

Mutually Exclusive With Self

Include Page
IL:Mutually Exclusive With Self
IL:Mutually Exclusive With Self

Simulate 
Include Page
IL:Simulate
IL:Simulate

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Anchor
Cluster
Cluster
Cluster

Include Page
IL:Cluster - Utility Agent
IL:Cluster - Utility Agent

Anchor
Utility Agent
Utility Agent
Utility Agent

Include Page
IL:Utility Agent - 6.8.0.0
IL:Utility Agent - 6.8.0.0

Anchor
Utility Agent Variable
Utility Agent Variable
Utility Agent Variable

Include Page
IL:Utility Agent Variable
IL:Utility Agent Variable

Anchor
Utility Agent Cluster
Utility Agent Cluster
Utility Agent Cluster

Include Page
IL:Utility Agent Cluster - no Broadcast
IL:Utility Agent Cluster - no Broadcast

Utility Agent Cluster Variable

Include Page
IL:Utility Agent Cluster Variable
IL:Utility Agent Cluster Variable

Anchor
Utility Credentials
Utility Credentials
Utility Credentials

Include Page
IL:Utility Credentials - 6.4.4.0
IL:Utility Credentials - 6.4.4.0

Utility Credentials Variable

Include Page
IL:Utility Credentials Variable
IL:Utility Credentials Variable

Anchor
Enhanced View
Enhanced View
SAP Details (Enhanced View)

This section contains assorted detailed information about an SAP Task in Enhanced View.

  • Legacy View
  • Enhanced View

Specifies whether to display the SAP task in Legacy View or Enhanced View.

Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically.

Note
The Enhanced SAP Task support both XBP 2.0 and XBP 3.0 options. Depending on the interface activated within the SAP system, certain options might not take effect.
See Standard Universal Connector for SAP Job Definition File Syntax to understand whether a field is a XBP 2.0 or XBP 3.0 exclusive option.


SAP Job NameUser defined name of the SAP Job.
SAP Job Class

Job class for the SAP Job. Options are:

  • High Priority
  • Middle Priority
  • Low Priority
SAP Target Server

SAP server on which the job should run.

Email Notification

 

Populate the drop-down list with options retrieved from the SAP system by clicking the refresh picker icon next to its drop-down list to display a Refresh SAP Target Server Options... dialog. 

The fields on the Refresh SAP Target Server Options... dialog are fields from the SAP Task Details, and the values for those fields in the dialog are, by default, the same as the values for the fields in the Details. You can keep the current values or change them from their drop-down lists.

Email Notification...

The Email Notification... button opens a dialog that allows you to set up email notifications.

Send Email

Specifies the circumstances in which to send the email notification. Options are:

  • Status Cancelled
  • Status Completed and Cancelled 
  • Never
Email Language

Specifies the language of the email.

Populate the drop-down list with options retrieved from the SAP system by clicking the refresh picker icon next to its drop-down list to display a Refresh Email Language Options... dialog. 

The fields on the Refresh Email Language Options... dialog are fields from the SAP Task Details, and the values for those fields in the dialog are, by default, the same as the values for the fields in the Details. You can keep the current values or change them from their drop-down lists.

Email Recipient

Specifies one or more email addresses.

The addresses must be separated by a semicolon.

Spool List Recipient...

The Spool List Recipient... button opens a dialog that allows you to set up a spool list recipient.

Type

Recipient type. Options are:

  • -- None --
  • SAP Username
  • External Addresses 
  • Shared Distribution List
  • Private Distribution List
  • Fax Number
  • Internet Address
  • X.400 Address
  • Remote Mail Address
Recipient

Recipient address.

Report Status by Email

For Type = External Addresses only, options are:

  • --System Default--
  • Always
  • Error
  • Never

Report Send Status

For Type = External Addresses only, options are:

  • --System Default--
  • Always
  • Error
  • Never
CopyIf selected, recipient will receive the document as a copy.
Blind CopyIf selected, recipient will receive the document as a blind copy.
ExpressIf selected, document will be sent to the recipient as an express message.
No ForwardingIf selected, recipient cannot forward the document to other users.
SAP Connection
Include Page
IL:SAP Connection field - 6.4.2
IL:SAP Connection field - 6.4.2

SAP Connection Variable

Include Page
IL:SAP Connection Variable
IL:SAP Connection Variable

SAP Credentials
Include Page
IL:SAP Credentials - 6.4.2.0
IL:SAP Credentials - 6.4.2.0
SAP Credentials Variable
Include Page
IL:Credentials Variable
IL:Credentials Variable
Start ImmediatelySpecification for whether or not to start the job immediately. 
Use Application RCSpecification for whether or not to use application RC.
Delete SAP Job on CompletionSpecification for whether or not to delete the SAP Job on completion.

SAP Command Options

Include Page
IL:SAP Command Options
IL:SAP Command Options

Runtime Directory

Include Page
IL:Runtime Directory
IL:Runtime Directory

Environment Variables

Include Page
IL:Environment Variables-Name and Value
IL:Environment Variables-Name and Value

SAP Print ParametersThis section contains assorted information about print parameters of an SAP Task in Enhanced View.
Print Job LogSpecification for whether or not to print the job log.
Print Spooled OutputSpecification for whether or not to print the spooled output.
Print Application LogSpecification for whether or not to print the application log.
Print Application RCSpecification for whether or not to print the application RC.
SAP Wait Child ParametersThis section contains assorted information about wait child parameters of an SAP Task in Enhanced View.
Wait ChildSpecification for whether or not to monitor child jobs. 
Max Child DepthSpecifies the maximum depth of child processes that Universal Connector will monitor. 
Job Log Child

Specifies whether or not to return job logs for child jobs. Options are:

  • Yes
  • No
  • Error
Spool List ChildSpecification for whether or not to print the spool list for child jobs.
Purge ChildSpecification for whether or not to purge all child jobs from the SAP system.

Anchor
Legacy View
Legacy View
SAP Details (Legacy View)

This section contains assorted detailed information about an SAP Task in legacy view.

  • Legacy View
  • Enhanced View

Specifies whether to display the SAP task in Legacy View or Enhanced View.

Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically.

SAP Connection

Include Page
IL:SAP Connection field - 6.4.2IL:SAP Connection field - 6.4.2
Note
The Enhanced SAP Task support both XBP 2.0 and XBP 3.0 options. Depending on the interface activated within the SAP system, certain options might not take effect.
See Standard Universal Connector for SAP Job Definition File Syntax to understand whether a field is a XBP 2.0 or XBP 3.0 exclusive option.


SAP Connection

Include Page
IL:SAP Connection field - 6.4.2
IL:SAP Connection field - 6.4.2

SAP Connection Variable

Include Page
IL:SAP Connection Variable
IL:SAP Connection Variable

SAP Language

Include Page
IL:SAPLang
IL:SAPLang

SAP Credentials

Include Page
IL:SAP Credentials - 6.4.2.0
IL:SAP Credentials - 6.4.2.0

SAP Credentials Variable

Include Page
IL:Credentials Variable
IL:Credentials Variable

SAP Job Name

Include Page
IL:SAP Job Name
IL:SAP Job Name

SAP Job ID

Include Page
IL:SAP Job ID field - 6.4.5.0
IL:SAP Job ID field - 6.4.5.0

SAP Process Chain Log ID

Include Page
IL:Process Chain Log ID
IL:Process Chain Log ID

SAP InfoPackage Request ID

Include Page
IL:InfoPackage Request ID
IL:InfoPackage Request ID

Command Group

See Universal Connector Commands, below, for a description of all supported commands and their contingent fields (options).

Anchor
SAP Command Options
SAP Command Options
SAP Command Options

Include Page
IL:SAP Command Options
IL:SAP Command Options

Runtime Directory

Include Page
IL:Runtime Directory
IL:Runtime Directory

Environment Variables

Include Page
IL:Environment Variables-Name and Value
IL:Environment Variables-Name and Value

Result Processing DetailsThis section contains assorted detailed information about result processing for this task.

Anchor
Exit Code Processing
Exit Code Processing
Exit Code Processing

Include Page
IL:Exit Code Processing
IL:Exit Code Processing

Anchor
Output Type
Output Type
Output Type

Include Page
IL:Output Type-Exit Code
IL:Output Type-Exit Code

Anchor
Scan Output For
Scan Output For
Scan Output For

Include Page
IL:Scan Output For
IL:Scan Output For

Output File (for Exit Code Processing)

Include Page
IL:Output File-Exit Code
IL:Output File-Exit Code

Anchor
Exit Codes
Exit Codes
Exit Codes

Include Page
IL:Exit Codes
IL:Exit Codes

Anchor
Automatic Output Retrieval
Automatic Output Retrieval
Automatic Output Retrieval

Include Page
IL:Automatic Output Retrieval - 6.4.2
IL:Automatic Output Retrieval - 6.4.2

Anchor
Wait For Output
Wait For Output
Wait For Output

Include Page
IL:Wait For Output
IL:Wait For Output

Anchor
Failure Only
Failure Only
Failure Only

Include Page
IL:Failure Only
IL:Failure Only

Start Line

Include Page
IL:Starting Line
IL:Starting Line

Number of Lines

Include Page
IL:Number of Lines
IL:Number of Lines

Scan Text

Include Page
IL:Scan Text-Automatic Output Retrieval
IL:Scan Text-Automatic Output Retrieval

Anchor
Output File - Automatic
Output File - Automatic
Output File (for Automatic Output Retrieval)

Include Page
IL:Output File-Auto Retrieve
IL:Output File-Auto Retrieve

Retry Options

This section contains specifications for retrying the task.

Anchor
Maximum Retries
Maximum Retries
Maximum Retries

Include Page
IL:Maximum Retries
IL:Maximum Retries

Retry Indefinitely

Include Page
IL:Retry Indefinitely
IL:Retry Indefinitely

Retry Interval (Seconds)

Include Page
IL:Retry Interval
IL:Retry Interval

Suppress Intermediate Failures

Include Page
IL:Suppress Intermediate Failures
IL:Suppress Intermediate Failures

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Anchor
Wait To Start
Wait To Start
Wait To Start

Include Page
IL:Wait To Start - 6.2.1.0
IL:Wait To Start - 6.2.1.0

Anchor
Wait Time
Wait Time
Wait Time

Include Page
IL:Wait Time - 6.2.1.0
IL:Wait Time - 6.2.1.0

Anchor
Wait Day Constraint
Wait Day Constraint
Wait Day Constraint

Include Page
IL:Wait Day Constraint
IL:Wait Day Constraint

Anchor
Wait Duration
Wait Duration
Wait Duration

Include Page
IL:Wait Duration
IL:Wait Duration

Anchor
Wait Duration In Seconds
Wait Duration In Seconds
Wait Duration In Seconds

Include Page
IL:Wait Duration In Seconds
IL:Wait Duration In Seconds

Anchor
Delay On Start
Delay On Start
Delay On Start

Include Page
IL:Delay On Start
IL:Delay On Start

Anchor
Delay Duration
Delay Duration
Delay Duration

Include Page
IL:Delay Duration
IL:Delay Duration

Anchor
Delay Duration In Seconds
Delay Duration In Seconds
Delay Duration In Seconds

Include Page
IL:Delay Duration In Seconds
IL:Delay Duration In Seconds

Anchor
Workflow Only
Workflow Only
Workflow Only

Include Page
IL:Workflow Only
IL:Workflow Only

Time Options

This section contains time-related specifications for the task.

Anchor
Late Start
Late Start
Late Start

Include Page
IL:Late Start
IL:Late Start

Anchor
Late Start Type
Late Start Type
Late Start Type

Include Page
IL:Late Start Type
IL:Late Start Type

Anchor
Late Start Time
Late Start Time
Late Start Time

Include Page
IL:Late Start Time
IL:Late Start Time

Anchor
Late Start Day Constraint
Late Start Day Constraint
Late Start Day Constraint

Include Page
IL:Late Start Day Constraint
IL:Late Start Day Constraint

Anchor
Late Start Nth Amount
Late Start Nth Amount
Late Start Nth Amount

Include Page
IL:Late Start Nth Amount
IL:Late Start Nth Amount

Anchor
Late Start Duration
Late Start Duration
Late Start Duration

Include Page
IL:Late Start Duration - NEW
IL:Late Start Duration - NEW

Anchor
Late Finish
Late Finish
Late Finish

Include Page
IL:Late Finish
IL:Late Finish

Anchor
Late Finish Type
Late Finish Type
Late Finish Type

Include Page
IL:Late Finish Type
IL:Late Finish Type

Anchor
Late Finish Offset Type
Late Finish Offset Type
Late Finish Offset Type

Include Page
IL:Late Finish Offset Type
IL:Late Finish Offset Type

Anchor
Late Finish Percentage Offset ( + )
Late Finish Percentage Offset ( + )
Late Finish Percentage Offset ( + )

Include Page
IL:Late Finish Percentage Offset ( + ) - 76
IL:Late Finish Percentage Offset ( + ) - 76

Anchor
Late Finish Duration Offset ( + )
Late Finish Duration Offset ( + )
Late Finish Duration Offset ( + )

Include Page
IL:Late Finish Duration Offset ( + )
IL:Late Finish Duration Offset ( + )

Anchor
Late Finish Duration Offset Unit
Late Finish Duration Offset Unit
Late Finish Duration Offset Unit

Include Page
IL:Late Finish Duration Offset Unit
IL:Late Finish Duration Offset Unit

Anchor
Late Finish Time
Late Finish Time
Late Finish Time

Include Page
IL:Late Finish Time
IL:Late Finish Time

Anchor
Late Finish Day Constraint
Late Finish Day Constraint
Late Finish Day Constraint

Include Page
IL:Late Finish Day Constraint
IL:Late Finish Day Constraint

Anchor
Late Finish Nth Amount
Late Finish Nth Amount
Late Finish Nth Amount

Include Page
IL:Late Finish Nth Amount
IL:Late Finish Nth Amount

Anchor
Late Finish Duration
Late Finish Duration
Late Finish Duration

Include Page
IL:Late Finish Duration - NEW
IL:Late Finish Duration - NEW

Anchor
Early Finish
Early Finish
Early Finish

Include Page
IL:Early Finish
IL:Early Finish

Anchor
Early Finish Type
Early Finish Type
Early Finish Type

Include Page
IL:Early Finish Type
IL:Early Finish Type

Anchor
Early Finish Offset Type
Early Finish Offset Type
Early Finish Offset Type

Include Page
IL:Early Finish Offset Type
IL:Early Finish Offset Type

Anchor
Early Finish Percentage Offset ( - )
Early Finish Percentage Offset ( - )
Early Finish Percentage Offset ( - )

Include Page
IL:Early Finish Percentage Offset ( - ) - 76
IL:Early Finish Percentage Offset ( - ) - 76

Anchor
Early Finish Duration Offset ( - )
Early Finish Duration Offset ( - )
Early Finish Duration Offset ( - )

Include Page
IL:Early Finish Duration Offset ( - )
IL:Early Finish Duration Offset ( - )

Anchor
Early Finish Duration Offset Unit
Early Finish Duration Offset Unit
Early Finish Duration Offset Unit

Include Page
IL:Early Finish Duration Offset Unit
IL:Early Finish Duration Offset Unit

Anchor
Early Finish Time
Early Finish Time
Early Finish Time

Include Page
IL:Early Finish Time
IL:Early Finish Time

Anchor
Early Finish Day Constraint
Early Finish Day Constraint
Early Finish Day Constraint

Include Page
IL:Early Finish Day Constraint
IL:Early Finish Day Constraint

Anchor
Early Finish Nth Amount
Early Finish Nth Amount
Early Finish Nth Amount

Include Page
IL:Early Finish Nth Amount
IL:Early Finish Nth Amount

Anchor
Early Finish Duration
Early Finish Duration
Early Finish Duration

Include Page
IL:Early Finish Duration - NEW
IL:Early Finish Duration - NEW

Anchor
User Estimated Duration
User Estimated Duration
User Estimated Duration

Include Page
IL:User Estimated Duration
IL:User Estimated Duration

Critical Path Options

This section contains Critical Path-related specifications for the task.

Anchor
CP Duration
CP Duration
CP Duration

Include Page
IL:CP Duration
IL:CP Duration

Anchor
CP Duration (Resolved)
CP Duration (Resolved)
CP Duration (Resolved)

Include Page
IL:CP Duration (Resolved)
IL:CP Duration (Resolved)

Anchor
CP Duration Unit
CP Duration Unit
CP Duration Unit

Include Page
IL:CP Duration Unit
IL:CP Duration Unit

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Anchor
Execution Restriction
Execution Restriction
Execution Restriction

Include Page
IL:Execution Restriction
IL:Execution Restriction

Anchor
Restriction Period
Restriction Period
Restriction Period

Include Page
IL:Restriction Period
IL:Restriction Period

Anchor
Before Date
Before Date
Before Date

Include Page
IL:Before Date
IL:Before Date

Anchor
Before Time
Before Time
Before Time

Include Page
IL:Before Time
IL:Before Time

Anchor
After Date
After Date
After Date

Include Page
IL:After Date
IL:After Date

Anchor
After Time
After Time
After Time

Include Page
IL:After Time
IL:After Time

Anchor
Date List
Date List
Date List

Include Page
IL:Date List
IL:Date List

Self-Service OptionsThis section contains Self-Service specifications for the task.
Enforce Variables 
Include Page
IL:Enforce Variables
IL:Enforce Variables
Lock Variables 
Include Page
IL:Lock Variables
IL:Lock Variables

Statistics

This section contains time-related statistics for task instances of the task.

First Execution

Include Page
IL:First Execution
IL:First Execution

Last Execution

Include Page
IL:Last Execution
IL:Last Execution

Last Instance Duration

Include Page
IL:Last Instance Duration
IL:Last Instance Duration

Lowest Instance Time

Include Page
IL:Lowest Instance Time
IL:Lowest Instance Time

Average Instance Time

Include Page
IL:Average Instance Time
IL:Average Instance Time

Highest Instance Time

Include Page
IL:Highest Instance Time
IL:Highest Instance Time

Number of Instances

Include Page
IL:Number of Instances
IL:Number of Instances

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Buttons

This section identifies the buttons displayed above and below the Task Details that let you perform various actions.

Save

Saves a new task record in the Controller database.

Save & New

Saves a new record in the Controller database and redisplays empty Details so that you can create another new record.

Save & View

Saves a new record in the Controller database and continues to display that record.

New

Displays empty (except for default values) Details for creating a new task.

Update

Include Page
IL:Update button
IL:Update button

Launch

Include Page
IL:Launch Task button
IL:Launch Task button

View Parents

Include Page
IL:View Parents button
IL:View Parents button

Copy

Creates a copy of this task, which you are prompted to rename.

Delete

Include Page
IL:Delete button
IL:Delete button

Note
titleNote

You cannot delete a task if it is either:

  • Specified in an enabled Trigger.
  • The only task specified in a disabled Trigger.


Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task.

Tabs

This section identifies the tabs across the top of the Task Details that provide access to additional information about the task instance.

Job StepsFor Enhanced View only; Lists all Job Steps defined for this task.

Variables

Include Page
IL:Variables tab
IL:Variables tab

Actions

Include Page
IL:Actions tab
IL:Actions tab

Virtual Resources

Include Page
IL:Task Virtual Resources tab - 6.7.0.0
IL:Task Virtual Resources tab - 6.7.0.0

Mutually Exclusive

Include Page
IL:Mutually Exclusive Tasks tab
IL:Mutually Exclusive Tasks tab

Anchor
Instances tab
Instances tab
Instances

Lists all instances of the task.

Triggers

Include Page
IL:Triggers tab
IL:Triggers tab

Notes

Include Page
IL:Notes tab
IL:Notes tab

Anchor
Versions tab
Versions tab
Versions

Include Page
IL:Versions tab
IL:Versions tab

...

Field Name

Description

General

This section contains general information about the task instance.

Anchor
Instance Name
Instance Name
Instance Name

Name of this task instance.

Instance Number

Include Page
IL:Instance Number
IL:Instance Number

Description

Include Page
IL:Summary
IL:Summary

Member of Business Services

Include Page
IL:Member of Business Services
IL:Member of Business Services

Task

Include Page
IL:Task
IL:Task

Source Version

Include Page
IL:Source Version
IL:Source Version

Launch Source

Include Page
IL:Launch Source 7.5
IL:Launch Source 7.5

Source Instance

Include Page
IL:Source Instance 7.5
IL:Source Instance 7.5

Invoked by

Include Page
IL:Invoked by
IL:Invoked by

Anchor
Execution User
Execution User
Execution User

Include Page
IL:Execution User
IL:Execution User

Calendar

Include Page
IL:Calendar in Task Instance
IL:Calendar in Task Instance

Time Zone Preference

Include Page
IL:Time Zone Preference
IL:Time Zone Preference

Virtual Resource Priority

Include Page
IL:Virtual Resource Priority
IL:Virtual Resource Priority

Anchor
Hold Resources on Failure
Hold Resources on Failure
Hold Resources on Failure

Include Page
IL:Hold Resources on Failure
IL:Hold Resources on Failure

Mutually Exclusive With Self

Include Page
IL:Mutually Exclusive With Self
IL:Mutually Exclusive With Self

Simulate 
Include Page
IL:Simulate
IL:Simulate

Status

This section contains information about the current status of the task instance.

Status

Include Page
IL:Status
IL:Status

Exit Code

Include Page
IL:Exit Code-Task Instance
IL:Exit Code-Task Instance

Status Description

Include Page
IL:Status Description
IL:Status Description

Operational Memo

Include Page
IL:Operational Memo
IL:Operational Memo

Evaluation Time

Include Page
IL:Evaluation Time
IL:Evaluation Time

Critical

Include Page
IL:Critical
IL:Critical

Critical Endpoint 

Include Page
IL:Critical Endpoint
IL:Critical Endpoint

Wait Until Time

Include Page
IL:Wait Until Time - Status
IL:Wait Until Time - Status

Queued Time

Include Page
IL:Queued Time
IL:Queued Time

Anchor
Trigger Time
Trigger Time
Trigger Time

Include Page
IL:Trigger Time
IL:Trigger Time

Anchor
Launch Time
Launch Time
Launch Time

Include Page
IL:Launch Time
IL:Launch Time

Anchor
Start Time
Start Time
Start Time

Include Page
IL:Start Time
IL:Start Time

End Time

Include Page
IL:End Time
IL:End Time

Duration

Include Page
IL:Duration
IL:Duration

Process ID

Include Page
IL:Process ID
IL:Process ID

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Anchor
Cluster
Cluster
Cluster

Include Page
IL:Cluster - Utility Agent
IL:Cluster - Utility Agent

Anchor
Utility Agent
Utility Agent
Utility Agent

Include Page
IL:Utility Agent - 6.8.0.0
IL:Utility Agent - 6.8.0.0

Anchor
Utility Agent Variable
Utility Agent Variable
Utility Agent Variable

Include Page
IL:Utility Agent Variable
IL:Utility Agent Variable

Anchor
Utility Agent Cluster
Utility Agent Cluster
Utility Agent Cluster

Include Page
IL:Utility Agent Cluster - no Broadcast
IL:Utility Agent Cluster - no Broadcast

Utility Agent Cluster Variable

Include Page
IL:Utility Agent Cluster Variable
IL:Utility Agent Cluster Variable

Anchor
Utility Credentials
Utility Credentials
Utility Credentials

Include Page
IL:Utility Credentials - 6.4.4.0
IL:Utility Credentials - 6.4.4.0

Utility Credentials Variable

Include Page
IL:Utility Credentials Variable
IL:Utility Credentials Variable

SAP Details (Enhanced View)

This section contains assorted detailed information about an SAP Task in Enhanced View.

  • Legacy View
  • Enhanced View

Specifies whether to display the SAP task in Legacy View or Enhanced View.

Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically. 

SAP Job ClassJob class for the SAP Job. Options
Note
SAP Job NameUser defined name of the SAP Job.
The Enhanced SAP Task support both XBP 2.0 and XBP 3.0 options. Depending on the interface activated within the SAP system, certain options might not take effect.
See Standard Universal Connector for SAP Job Definition File Syntax to understand whether a field is a XBP 2.0 or XBP 3.0 exclusive option.


SAP Job NameUser defined name of the SAP Job.
SAP Job Class

Job class for the SAP Job. Options are:

  • High Priority
  • Middle Priority
  • Low Priority
SAP Target Server

SAP server on which the job should run.

Populate the drop-down list with options retrieved from the SAP system by clicking the refresh picker icon next to its drop-down list to display a Refresh SAP Target Server Options... dialog. 

The fields on the Refresh SAP Target Server Options... dialog are fields from the SAP Task Details, and the values for those fields in the dialog are, by default, the same as the values for the fields in the Details. You can keep the current values or change them from their drop-down lists.

Email Notification...

The Email Notification... button opens a dialog that allows you to set up email notifications.

Send Email

Specifies the circumstances in which to send the email notification. Options are:

  • Status Cancelled
  • Status Completed and Cancelled 
  • Never
Email Language

Specifies the language of the email.

Populate the drop-down list with options retrieved from the SAP system by clicking the refresh picker icon next to its drop-down list to display a Refresh Email Language Options... dialog. 

The fields on the Refresh Email Language Options... dialog are fields from the SAP Task Details, and the values for those fields in the dialog are, by default, the same as the values for the fields in the Details. You can keep the current values or change them from their drop-down lists.

Email Recipient

Specifies one or more email addresses.

The addresses must be separated by a semicolon.

Spool List Recipient...

The Spool List Recipient... button opens a dialog that allows you to set up a spool list recipient.

Type

Recipient type. Options are:

  • -- None --
  • SAP Username
  • External Addresses 
  • Shared Distribution List
  • Private Distribution List
  • Fax Number
  • Internet Address
  • X.400 Address
  • Remote Mail Address
Recipient

Recipient address.

Report Status by Email

For Type = External Addresses only, options are:

  • --System Default--
  • Always
  • Error
  • Never

Report Send Status

For Type = External Addresses only, options are:

  • --System Default--
  • Always
  • Error
  • Never
CopyIf selected, recipient will receive the document as a copy.
Blind CopyIf selected, recipient will receive the document as a blind copy.
ExpressIf selected, document will be sent to the recipient as an express message.
No ForwardingIf selected, recipient cannot forward the document to other users.
SAP Connection
Include Page
IL:SAP Connection field - 6.4.2
IL:SAP Connection field - 6.4.2

SAP Connection Variable

Include Page
IL:SAP Connection Variable
IL:SAP Connection Variable

SAP Credentials
Include Page
IL:SAP Credentials - 6.4.2.0
IL:SAP Credentials - 6.4.2.0
SAP Credentials Variable
Include Page
IL:Credentials Variable
IL:Credentials Variable
Start ImmediatelySpecification for whether or not to start the job immediately. 
Use Application RCSpecification for whether or not to use application RC.
Delete SAP Job on CompletionSpecification for whether or not to delete the SAP Job on completion.

SAP Command Options

Include Page
IL:SAP Command Options
IL:SAP Command Options

Runtime Directory

Include Page
IL:Runtime Directory
IL:Runtime Directory

Environment Variables

Include Page
IL:Environment Variables-Name and Value
IL:Environment Variables-Name and Value

SAP Print ParametersThis section contains assorted information about print parameters of an SAP Task in Enhanced View.
Print Job LogSpecification for whether or not to print the job log.
Print Spooled OutputSpecification for whether or not to print the spooled output.
Print Application LogSpecification for whether or not to print the application log.
Print Application RCSpecification for whether or not to print the application RC.
SAP Wait Child ParametersThis section contains assorted information about wait child parameters of an SAP Task in Enhanced View.
Wait ChildSpecification for whether or not to monitor child jobs. 
Max Child DepthSpecifies the maximum depth of child processes that Universal Connector will monitor. 
Job Log Child

Specifies whether or not to return job logs for child jobs. Options are:

  • Yes
  • No
  • Error
Spool List ChildSpecification for whether or not to print the spool list for child jobs.
Purge ChildSpecification for whether or not to purge all child jobs from the SAP system.

SAP Details (Legacy View)

This section contains assorted detailed information about the task instance in legacy view.

  • Legacy View
  • Enhanced View

Specifies whether to display the SAP task in Legacy View or Enhanced View.Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically. task in Legacy View or Enhanced View.

Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically. 

Note
The Enhanced SAP Task support both XBP 2.0 and XBP 3.0 options. Depending on the interface activated within the SAP system, certain options might not take effect.
See Standard Universal Connector for SAP Job Definition File Syntax to understand whether a field is a XBP 2.0 or XBP 3.0 exclusive option.


SAP Connection

Include Page
IL:SAP Connection field - 6.4.2
IL:SAP Connection field - 6.4.2

SAP Connection Variable

Include Page
IL:SAP Connection Variable
IL:SAP Connection Variable

SAP Language

Include Page
IL:SAPLang
IL:SAPLang

SAP Credentials

Include Page
IL:SAP Credentials - 6.4.2.0
IL:SAP Credentials - 6.4.2.0

SAP Credentials Variable

Include Page
IL:Credentials Variable
IL:Credentials Variable

SAP Job Name

Include Page
IL:SAP Job Name
IL:SAP Job Name

SAP Job ID

Include Page
IL:SAP Job ID field - 6.4.5.0
IL:SAP Job ID field - 6.4.5.0

SAP Process Chain Log ID

Include Page
IL:Process Chain Log ID
IL:Process Chain Log ID

SAP InfoPackage Request ID

Include Page
IL:InfoPackage Request ID
IL:InfoPackage Request ID

Command Group

See Universal Connector Commands, below, for a description of all supported commands and their contingent fields (options).

Anchor
SAP Command Options
SAP Command Options
SAP Command Options

Include Page
IL:SAP Command Options
IL:SAP Command Options

Runtime Directory

Include Page
IL:Runtime Directory
IL:Runtime Directory

Environment Variables

Include Page
IL:Environment Variables-Name and Value
IL:Environment Variables-Name and Value

Result Processing DetailsThis section contains assorted detailed information about result processing for this task.

Anchor
Exit Code Processing
Exit Code Processing
Exit Code Processing

Include Page
IL:Exit Code Processing
IL:Exit Code Processing

Anchor
Output Type
Output Type
Output Type

Include Page
IL:Output Type-Exit Code
IL:Output Type-Exit Code

Anchor
Scan Output For
Scan Output For
Scan Output For

Include Page
IL:Scan Output For
IL:Scan Output For

Output File (for Exit Code Processing)

Include Page
IL:Output File-Exit Code
IL:Output File-Exit Code

Anchor
Exit Codes
Exit Codes
Exit Codes

Include Page
IL:Exit Codes
IL:Exit Codes

Anchor
Automatic Output Retrieval
Automatic Output Retrieval
Automatic Output Retrieval

Include Page
IL:Automatic Output Retrieval - 6.4.2
IL:Automatic Output Retrieval - 6.4.2

Anchor
Wait For Output
Wait For Output
Wait For Output

Include Page
IL:Wait For Output
IL:Wait For Output

Anchor
Failure Only
Failure Only
Failure Only

Include Page
IL:Failure Only
IL:Failure Only

Start Line

Include Page
IL:Starting Line
IL:Starting Line

Number of Lines

Include Page
IL:Number of Lines
IL:Number of Lines

Scan Text

Include Page
IL:Scan Text-Automatic Output Retrieval
IL:Scan Text-Automatic Output Retrieval

Anchor
Output File - Automatic
Output File - Automatic
Output File (for Automatic Output Retrieval)

Include Page
IL:Output File-Auto Retrieve
IL:Output File-Auto Retrieve

Retry Options

This section contains specifications for retrying the task.

Anchor
Maximum Retries
Maximum Retries
Maximum Retries

Include Page
IL:Maximum Retries
IL:Maximum Retries

Retry Indefinitely

Include Page
IL:Retry Indefinitely
IL:Retry Indefinitely

Retry Interval (Seconds)

Include Page
IL:Retry Interval
IL:Retry Interval

Current Retry Count

Include Page
IL:Current Retry Count
IL:Current Retry Count

Suppress Intermediate Failures

Include Page
IL:Suppress Intermediate Failures
IL:Suppress Intermediate Failures

Next Retry Time

Include Page
IL:Next Retry Time
IL:Next Retry Time

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Anchor
Wait To Start
Wait To Start
Wait To Start

Include Page
IL:Wait To Start - 6.2.1.0
IL:Wait To Start - 6.2.1.0

Anchor
Wait Time
Wait Time
Wait Time

Include Page
IL:Wait Time - 6.2.1.0
IL:Wait Time - 6.2.1.0

Anchor
Wait Day Constraint
Wait Day Constraint
Wait Day Constraint

Include Page
IL:Wait Day Constraint
IL:Wait Day Constraint

Anchor
Wait Duration
Wait Duration
Wait Duration

Include Page
IL:Wait Duration
IL:Wait Duration

Anchor
Wait Duration In Seconds
Wait Duration In Seconds
Wait Duration In Seconds

Include Page
IL:Wait Duration In Seconds
IL:Wait Duration In Seconds

Anchor
Delay On Start
Delay On Start
Delay On Start

Include Page
IL:Delay On Start
IL:Delay On Start

Anchor
Delay Duration
Delay Duration
Delay Duration

Include Page
IL:Delay Duration
IL:Delay Duration

Anchor
Delay Duration In Seconds
Delay Duration In Seconds
Delay Duration In Seconds

Include Page
IL:Delay Duration In Seconds
IL:Delay Duration In Seconds

Time Options

This section contains time-related specifications for the task instance.

Anchor
Late Start
Late Start
Late Start

Include Page
IL:Late Start
IL:Late Start

Anchor
Started Late
Started Late
Started Late

Include Page
IL:Started Late
IL:Started Late

Anchor
Late Start Type
Late Start Type
Late Start Type

Include Page
IL:Late Start Type
IL:Late Start Type

Anchor
Late Start Time
Late Start Time
Late Start Time

Include Page
IL:Late Start Time
IL:Late Start Time

Anchor
Late Start Day Constraint
Late Start Day Constraint
Late Start Day Constraint

Include Page
IL:Late Start Day Constraint
IL:Late Start Day Constraint

Anchor
Late Start Nth Amount
Late Start Nth Amount
Late Start Nth Amount

Include Page
IL:Late Start Nth Amount
IL:Late Start Nth Amount

Anchor
Late Start Duration
Late Start Duration
Late Start Duration

Include Page
IL:Late Start Duration - NEW
IL:Late Start Duration - NEW

Anchor
Computed Late Start Time
Computed Late Start Time
Computed Late Start Time

Include Page
IL:Computed Late Start Time
IL:Computed Late Start Time

Anchor
Late Finish
Late Finish
Late Finish

Include Page
IL:Late Finish
IL:Late Finish

Anchor
Finished Late
Finished Late
Finished Late

Include Page
IL:Finished Late
IL:Finished Late

Anchor
Late Finish Type
Late Finish Type
Late Finish Type

Include Page
IL:Late Finish Type
IL:Late Finish Type

Anchor
Late Finish Offset Type
Late Finish Offset Type
Late Finish Offset Type

Include Page
IL:Late Finish Offset Type
IL:Late Finish Offset Type

Anchor
Late Finish Percentage Offset ( + )
Late Finish Percentage Offset ( + )
Late Finish Percentage Offset ( + )

Include Page
IL:Late Finish Percentage Offset ( + ) - 76
IL:Late Finish Percentage Offset ( + ) - 76

Anchor
Late Finish Duration Offset ( + )
Late Finish Duration Offset ( + )
Late Finish Duration Offset ( + )

Include Page
IL:Late Finish Duration Offset ( + )
IL:Late Finish Duration Offset ( + )

Anchor
Late Finish Duration Offset Unit
Late Finish Duration Offset Unit
Late Finish Duration Offset Unit

Include Page
IL:Late Finish Duration Offset Unit
IL:Late Finish Duration Offset Unit

Anchor
Late Finish Time
Late Finish Time
Late Finish Time

Include Page
IL:Late Finish Time
IL:Late Finish Time

Anchor
Late Finish Day Constraint
Late Finish Day Constraint
Late Finish Day Constraint

Include Page
IL:Late Finish Day Constraint
IL:Late Finish Day Constraint

Anchor
Late Finish Nth Amount
Late Finish Nth Amount
Late Finish Nth Amount

Include Page
IL:Late Finish Nth Amount
IL:Late Finish Nth Amount

Anchor
Late Finish Duration
Late Finish Duration
Late Finish Duration

Include Page
IL:Late Finish Duration - NEW
IL:Late Finish Duration - NEW

Anchor
Computed Late Finish Time
Computed Late Finish Time
Computed Late Finish Time

Include Page
IL:Computed Late Finish Time
IL:Computed Late Finish Time

Anchor
Early Finish
Early Finish
Early Finish

Include Page
IL:Early Finish
IL:Early Finish

Anchor
Finished Early
Finished Early
Finished Early

Include Page
IL:Finished Early
IL:Finished Early

Anchor
Early Finish Type
Early Finish Type
Early Finish Type

Include Page
IL:Early Finish Type
IL:Early Finish Type

Anchor
Early Finish Offset Type
Early Finish Offset Type
Early Finish Offset Type

Include Page
IL:Early Finish Offset Type
IL:Early Finish Offset Type

Anchor
Early Finish Percentage Offset ( - )
Early Finish Percentage Offset ( - )
Early Finish Percentage Offset ( - )

Include Page
IL:Early Finish Percentage Offset ( - ) - 76
IL:Early Finish Percentage Offset ( - ) - 76

Anchor
Early Finish Duration Offset ( - )
Early Finish Duration Offset ( - )
Early Finish Duration Offset ( - )

Include Page
IL:Early Finish Duration Offset ( - )
IL:Early Finish Duration Offset ( - )

Anchor
Early Finish Duration Offset Unit
Early Finish Duration Offset Unit
Early Finish Duration Offset Unit

Include Page
IL:Early Finish Duration Offset Unit
IL:Early Finish Duration Offset Unit

Anchor
Early Finish Time
Early Finish Time
Early Finish Time

Include Page
IL:Early Finish Time
IL:Early Finish Time

Anchor
Early Finish Day Constraint
Early Finish Day Constraint
Early Finish Day Constraint

Include Page
IL:Early Finish Day Constraint
IL:Early Finish Day Constraint

Anchor
Early Finish Nth Amount
Early Finish Nth Amount
Early Finish Nth Amount

Include Page
IL:Early Finish Nth Amount
IL:Early Finish Nth Amount

Anchor
Early Finish Duration
Early Finish Duration
Early Finish Duration

Include Page
IL:Early Finish Duration - NEW
IL:Early Finish Duration - NEW

Anchor
Projected Late
Projected Late
Projected Late

Include Page
IL:Projected Late - 6.9.0.0
IL:Projected Late - 6.9.0.0

Critical Path Options

This section contains Critical Path-related specifications for the task.

Anchor
CP Duration
CP Duration
CP Duration

Include Page
IL:CP Duration
IL:CP Duration

Anchor
CP Duration (Resolved)
CP Duration (Resolved)
CP Duration (Resolved)

Include Page
IL:CP Duration (Resolved)
IL:CP Duration (Resolved)

Anchor
CP Duration Unit
CP Duration Unit
CP Duration Unit

Include Page
IL:CP Duration Unit
IL:CP Duration Unit

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Anchor
Execution Restriction
Execution Restriction
Execution Restriction

Include Page
IL:Execution Restriction
IL:Execution Restriction

Anchor
Restriction Period
Restriction Period
Restriction Period

Include Page
IL:Restriction Period
IL:Restriction Period

Anchor
Before Date
Before Date
Before Date

Include Page
IL:Before Date
IL:Before Date

Anchor
Before Time
Before Time
Before Time

Include Page
IL:Before Time
IL:Before Time

Anchor
After Date
After Date
After Date

Include Page
IL:After Date
IL:After Date

Anchor
After Time
After Time
After Time

Include Page
IL:After Time
IL:After Time

Anchor
Date List
Date List
Date List

Include Page
IL:Date List
IL:Date List

Statistics

This section contains time-related statistics for the task instance.

Anchor
User Estimated End Time
User Estimated End Time
User Estimated End Time

Include Page
IL:User Estimated End Time
IL:User Estimated End Time

Lowest Estimated End Time

Include Page
IL:Lowest Estimated End Time
IL:Lowest Estimated End Time

Average Estimated End Time

Include Page
IL:Average Estimated End Time
IL:Average Estimated End Time

Highest Estimated End Time

Include Page
IL:Highest Estimated End Time
IL:Highest Estimated End Time

Projected Start Time

Include Page
IL:Projected Start Time
IL:Projected Start Time

Projected End Time

System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration.

Metadata

This section contains Metadata information about this record.

UUID

Universally Unique Identifier of this record.

Updated By

Name of the user that last updated this record.

Updated

Date and time that this record was last updated.

Created By

Name of the user that created this record.

Created

Date and time that this record was created.

Status History

History of all statuses that the task instance has gone through.

Operational Memo History

History of all Operational Memos for the task.

Buttons

This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions.

Update

Include Page
IL:Update button
IL:Update button

Force Finish

Include Page
IL:Force Finish button
IL:Force Finish button

Hold

Include Page
IL:Hold button
IL:Hold button

Skip

Include Page
IL:Skip button
IL:Skip button

Re-run

Include Page
IL:Re-run button
IL:Re-run button

View Parent

Include Page
IL:View Parent button
IL:View Parent button

Anchor
Retrieve Output
Retrieve Output
Retrieve Output

Include Page
IL:Retrieve Output button
IL:Retrieve Output button

SAP

Displays an Action menu of SAP commands.

Delete

Include Page
IL:Delete button
IL:Delete button

Refresh

Refreshes any dynamic data displayed in the Details.

Close

For pop-up view only; closes the pop-up view of this task instance.

Tabs

This section identifies the tabs across the top of the Task Instance Details that provide access to additional information about the task instance.

Virtual Resources

Include Page
IL:Task Virtual Resources tab - 6.7.0.0
IL:Task Virtual Resources tab - 6.7.0.0

Exclusive Requests

Include Page
IL:Exclusive Requests tab
IL:Exclusive Requests tab

Output

Include Page
IL:Output tab
IL:Output tab

Notes

Include Page
IL:Notes tab
IL:Notes tab

...

Command Name

Description

Options

Anchor
Run Job command
Run Job command
Run

Performs the following actions:

  1. Defines a new SAP, job based on either a USAP Definition file or an SAP Model Job.
  2. Starts the defined job.
  3. Waits for the job to complete.
  4. Prints the job's joblog to standard error and the spoollists to standard output.
  5. Purges the job from the SAP system.
  • Definition or Model
    Include Page
    IL:Definition or Model
    IL:Definition or Model
  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Target Job Name
    Include Page
    IL:Target Job Name
    IL:Target Job Name
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Run Process Chain command
Run Process Chain command
Run Process Chain

Performs the following actions:

  1. Starts a process chain.
  2. Waits for the process chain to complete.
  3. Returns the process chain log.
  4. Returns process logs.
  5. Returns process spool lists.
  • Chain ID
    ID of the process chain to run.

Anchor
Run InfoPackage command
Run InfoPackage command
Run InfoPackage

Performs the following actions:

  1. Starts an InfoPackage.
  2. Wait for the InfoPackage request to complete.
  3. Returns status messages for the completed Infopackage request.
  • InfoPackage
    Name of the InfoPackage to run.
  • InfoPackage Job Name
    Include Page
    IL:InfoPackage Job Name
    IL:InfoPackage Job Name

Anchor
Submit Job command
Submit Job command
Submit

Defines a new SAP job.

  • Definition or Model
    Include Page
    IL:Definition or Model
    IL:Definition or Model
  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Target Job Name
    Include Page
    IL:Target Job Name
    IL:Target Job Name
  • Start
    Include Page
    IL:Start
    IL:Start
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC
  • SAP ABAP Program Name
    Include Page
    IL:SAP ABAP Program Name
    IL:SAP ABAP Program Name
  • SAP Variant Name
    Include Page
    IL:SAP Variant Name
    IL:SAP Variant Name
  • Target Variant Name
    Include Page
    IL:Target Variant Name
    IL:Target Variant Name

Anchor
Modify Job command
Modify Job command
Modify

Modifies an SAP job that already exists in an SAP system. A USAP job definition file is used to specify the modifications.

  • Script Library or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script
    IL:Script
  • Definition File
    Include Page
    IL:Definition File
    IL:Definition File
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Start Job command
Start Job command
Start

Starts a currently defined SAP job.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0
  • Start Immediately
    Include Page
    IL:Start Immediately
    IL:Start Immediately
  • SAP Target Server
    Include Page
    IL:SAP Target Server
    IL:SAP Target Server
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Start Process Chain command
Start Process Chain command
Start Process Chain

Starts the specified process chain on the SAP system.

  • Chain ID
    ID of process chain to start.
  • Restart
    Include Page
    IL:Restart Process Chain
    IL:Restart Process Chain
  • Log ID
    Include Page
    IL:Log ID
    IL:Log ID
  • Wait
    Include Page
    IL:Wait
    IL:Wait
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Start InfoPackage command
Start InfoPackage command
Start InfoPackage

Starts the specified InfoPackage on the SAP system.

  • InfoPackage
    Name of the InfoPackage to start.
  • InfoPackage Job Name
    Include Page
    IL:InfoPackage Job Name
    IL:InfoPackage Job Name
  • Wait
    Specifies whether the Controller should wait for the SAP InfoPackage to complete processing.

Anchor
Wait for Job command
Wait for Job command
Wait

Reconnects to a started job and monitors it through completion.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID
  • Print Job Log
    Include Page
    IL:Print Job Log
    IL:Print Job Log
  • Print Spooled Output
    Include Page
    IL:Print Spooled Output
    IL:Print Spooled Output
  • Print Application Log
    Include Page
    IL:Print Application Log
    IL:Print Application Log
  • Print Application RC
    Include Page
    IL:Print Application RC
    IL:Print Application RC
  • Use Application RC
    Include Page
    IL:Use Application RC
    IL:Use Application RC

Anchor
Wait for Process Chain command
Wait for Process Chain command
Wait Process Chain

Waits for a Process Chain to complete.

  • Chain ID
    ID of process chain to be monitored to completion.
  • Log ID
    Include Page
    IL:Process Chain Log ID
    IL:Process Chain Log ID

Anchor
Wait for InfoPackage command
Wait for InfoPackage command
Wait InfoPackage

Waits for an InfoPackage to complete.

  • Request ID
    Include Page
    IL:InfoPackage Request ID
    IL:InfoPackage Request ID

Anchor
Abort command
Abort command
Abort

Cancels a running SAP job.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Interrupt Process Chain command
Interrupt Process Chain command
Interrupt Process Chain

Removes the specified process chain from the schedule.

  • Chain ID
    ID of process chain that is to be interrupted.

Anchor
Purge Job command
Purge Job command
Purge Job

Deletes a defined SAP job, its joblog, and all of its spoollists. This command is not available on SAP 3.1 and SAP 4.0.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID
    IL:SAP Job ID

Anchor
Purge Variant command
Purge Variant command
Purge Variant

Deletes a variant from an SAP system.

  • SAP ABAP Program Name
    Name of the ABAP program for which the variant will be deleted.
  • SAP Variant Name
    Name of the variant to be deleted.

Anchor
Raise Event command
Raise Event command
Raise Event

Raises the specified SAP background processing event.

  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter

Anchor
Display command
Display command
Display

Displays the data specified in the Display Command field. The data is written to standard output.

  • Display Command
    Include Page
    IL:Display Command
    IL:Display Command

Anchor
Generate Variant Definition File command
Generate Variant Definition File command
Generate Variant Definition

Generates a USAP variant definition file based on a model SAP variant. The generated definition file is written to standard output. Requires XBP interface 2.0 or greater.

  • SAP ABAP Program Name
    Include Page
    IL:SAP ABAP Program Name
    IL:SAP ABAP Program Name
  • SAP Variant Name
    Include Page
    IL:SAP Variant Name
    IL:SAP Variant Name

Anchor
Generate Job Definition File command
Generate Job Definition File command
Generate Job Definition

Generates a USAP job definition file based on a model SAP job. The generated definition file is written to standard output.

  • SAP Job Name
    Include Page
    IL:SAP Job Name
    IL:SAP Job Name
  • SAP Job ID
    Include Page
    IL:SAP Job ID - 6.4.5.0
    IL:SAP Job ID - 6.4.5.0

Anchor
Create CM Profile command
Create CM Profile command
Create CM Profile

Creates a new Criteria Manager profile.

  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • SAP Criteria Manager XML File
    Include Page
    IL:SAP Criteria Manager XML File
    IL:SAP Criteria Manager XML File
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Set CM Criteria command
Set CM Criteria command
Set CM Criteria

Sets the criteria for a profile.

  • Script or File System
    Include Page
    IL:Library or File System - SAP
    IL:Library or File System - SAP
  • Script
    Include Page
    IL:Script - SAP
    IL:Script - SAP
  • SAP Criteria Manager XML File
    Include Page
    IL:SAP Criteria Manager XML File
    IL:SAP Criteria Manager XML File
  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Activate CM Profile command
Activate CM Profile command
Activate CM Profile

Activates a criteria profile of the specified type.

  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Deactivate CM Profile command
Deactivate CM Profile command
Deactivate CM Profile

Deactivates a criteria profile of the specified type.

  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Anchor
Delete CM Profile command
Delete CM Profile command
Delete CM Profile

Deletes a criteria profile from an SAP system.

  • SAP Criteria Manager Profile ID
    Include Page
    IL:SAP Criteria Manager Profile ID
    IL:SAP Criteria Manager Profile ID
  • SAP Criteria Manager Profile Type
    Include Page
    IL:SAP Criteria Manager Profile Type
    IL:SAP Criteria Manager Profile Type
  • Event Select State
    Include Page
    IL:SAP Event Select State
    IL:SAP Event Select State
  • SAP Event
    Include Page
    IL:SAP Event
    IL:SAP Event
  • SAP Event Parameter
    Include Page
    IL:SAP Event Parameter
    IL:SAP Event Parameter
  • Confirm Returned Events
    Include Page
    IL:SAP Confirm Returned Events
    IL:SAP Confirm Returned Events

Adding Job Steps

For an SAP Task in Enhanced View, you can add one or more Job Steps for each task, and define the values for those job steps, as described below.

Adding a Step

Note

The Controller searches Job Step definitions based on their order in the Job Steps list; the definition at the top of the list is searched first. To change the order of the definitions in the list, drag and drop them to any location.


Step 1

Open the SAP task to which you want to add the parameter.

Step 2

Click the Job Steps tab. The Job Steps list displays a list of all Job Steps for which values have been defined for this task.

Step 3

Click the  button to display Job Step Details.
 

 

Step 4

Enter/select Details for a new Job Step, using the field descriptions below as a guide.

Fields with the button are Options Fields that allow you to populate their drop-down lists with options retrieved from the SAP system.

Step 6

Click the button.

...

Field NameDescription
Type

Job step type. Options are

  • ABAP Program
  • External Command
  • External Program
NameName of the Job Step.
SAP User NameUser name in the SAP system.
Job Step Type = ABAP ProgramThis section contains assorted detailed information about an ABAP Program Job Step.
Variant NameVariant to use to process the report.
Execution LanguageSpecifies the language in which the system executes and prints the outputprints the output.
Use Temporary VariantSpecification for whether or not to use Temporary Variant.
Temporary Variant

If Use Temporary Variant is enabled, 

Allows you to enter temporary variants needed by the program to run.

To add a temporary variant, click the + icon and enter a Technical Name, Type, Lower Limit/Single Value, Upper Limit, Option and Sign. To delete a variant, select in the list of variables and click the - icon.

Print Parameters...

The Print Parameters... button opens a dialog that allows you to set up print parameters.

Output Device

Specifies the printer or fax machine.

Number of CopiesNumber of printouts.
Page Area

Specifies if everything should be printed or select pages. Options are:

  • Everything
  • Page
Page FromIf Page Area = Page, first page in the range of pages to be printed.
Page ToIf Page Area = Page, last page in the range of pages to be printed.
Print Time

Specifies when the spool request will be sent to the output device. Options are:

  • SAP Spool Only
  • Immediately
FormatPage format, depending on the output device, different formats with different maximum page lengths and widths can be specified.
Output Contents...

The Output Contents... button opens a dialog that allows you to set up the output contents.


Spool Request Maximum 255 Character WidthSpecification for a line break in spool after 255 characters.
Text OnlySpecification to print text output only.
Suppress Colors/Shading In PrintoutSpecifies if colors/shading are included in spool list.
Spool List With Structure InformationSpecifies if structure information is inserted into the print request.
No Frame CharactersSpecifies if no frame characters are printed.
Spool Request...

The Spool Request... button opens a dialog that allows you to set up the spool request.

Spool Request NameThe name of the spool request if not printed immediately.
TitleDescription text for the spool request, appears on the default cover page and is displayed in the output controller instead of the value of the Spool Request Name.
AuthorizationAuthorization for the spool request. This can be used to check whether or not a user is allowed to carry out certain actions on the spool request.
Cover Sheets...

SAP Cover SheetSpecifies whether a cover page containing details about the print request - such as recipient, department, and format - is to be sent with the with the spool request.
OS Cover SheetSpecifies whether the standard cover page of the operating system spooler is to be sent with the spool request.
Selection Cover Sheet

Specifies whether a cover page with the input values of the selection layout is printed.

ReceiversRecipient name for the SAP cover page.
DepartmentDepartment name for the SAP cover page.
Output Options...

Delete After PrintingIf yes, spool request is deleted immediately after printing, otherwise after the value of Spool Retention.
Spool Retention

This field specifies how many days a spool request stays in the spool system before it is deleted.

New Spool Request

Specifies whether the system creates a new spool request.

Print Priority

Specifies the priority to be passed on to the spool system of the operating system. A spool request with a higher priority is inserted into the spooler queue in front of a spool request with a lower priority.

Storage ModeSpecifies the archiving mode.
Object Type

If Storage Mode = Archive Only or Print And Archive,

Object type of the SAP object.

Document Type

If Storage Mode = Archive Only or Print And Archive,

Document type of the archiving object.

Information

If Storage Mode = Archive Only or Print And Archive,

Information abbreviation for the archiving request which can contain more information beside the name.

Text

If Storage Mode = Archive Only or Print And Archive,

Description text of the archiving request.

Use Temporary VariantSpecification for whether or not to use Temporary Variant.
Temporary Variant

If Use Temporary Variant is enabled, 

Allows you to enter temporary variants needed by the program to run.

To add a temporary variant, click the + icon and enter a Technical Name, Type, Lower Limit/Single Value, Upper Limit, Option and Sign. To delete a variant, select in the list of variables and click the - icon.

Job Step Type = External Command/ External ProgramThis section contains assorted detailed information about an External Command/ External Program Job Step.
ParametersParameter string to be passed to the external program or command when the step starts.
Target ServerName of the host system on which you want to process a background job.
OSJob Step Type = External Command, Operating system of the application server.
Job Waiting For External TerminationInforms SAP to wait for termination before returning.
Log Output Specifies how to write the standard job output.
Log ErrorsSpecifies how to write the standard error job output.
Activate Trace With Trace LevelSpecifies the trace level.

Options Fields

Four Some Job Step Details fields allow you to populate their drop-down lists with options retrieved from the SAP system:

  • Name - ABAP Program

  • Name - External Command

  • Variant Name
  • Execution Language
  • Output Device
  • Format
  • OS

...

When you click the Submit button on the Refresh Options... dialog for an options field, the drop-down list for that field is populated with values that are determined by the values that you submitted on the Refresh Options... dialog.

Name

...

- ABAP Program

Image Added

Name - External Command

Image Added

Variant Name

Execution Language

...