Panel | ||||
---|---|---|---|---|
|
...
Note | ||
---|---|---|
| ||
These instructions assume the user has a working knowledge of SAP. |
The SAP task allows you to send commands to an SAP system and gather status information and output back from SAP. The SAP task uses Stonebranch's proprietary Universal Connector for SAP (USAP) to communicate with SAP. Universal Connector for SAP allows Universal Controller to connect to an SAP system and manage SAP background processing tasks.
Before You Begin
To run an SAP task, you must first complete the following:
- Identify the Utility Agent that has Universal Connector for SAP installed and licensed; either a Universal Agent for Linux/Unix or a Universal Agent for Windows that will interface with the SAP system.
- Define an SAP connection in the Controller database.
Built-In Variables
The following built-in variables can be used in an SAP task to pass data where appropriate:
...
Creating an SAP Task
...
Step 1
From the Automation Center navigation pane, select Tasks > SAP Tasks. The SAP Tasks list displays a list of all currently defined SAP tasks.
To the right of the list, SAP Task Details for a new SAP task displays.
...
Step 2
...
Enter/select Details for a new SAP task, using the field descriptions below as a guide.
- Required fields display an asterisk ( * ) after the field name.
- Default values for fields, if available, display automatically.
To display more of the Details fields on the screen, you can either:
- Use the scroll bar.
- Temporarily hide the list above the Details.
- Click the button above the list to display a pop-up version of the Details.
...
Step 3
...
Click the button. The task is added to the database, and all buttons and tabs in the Task Details are enabled.
Note | ||
---|---|---|
| ||
To open an existing record on the list, either:
|
...
SAP Task Details
The following SAP Task Details is for an existing SAP task.
Depending on the values that you enter / select for these fields, whether or not the SAP task has ever been launched, and whether you have Enhanced View or Legacy View selected, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the SAP Task Details.
SAP Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the SAP Task Details.
...
Field Name
...
Description
...
General
...
This section contains general information about the task.
...
Name
...
Version
...
Description
...
Member of Business Services
...
Resolve Name Immediately
...
Time Zone Preference
...
Hold on Start
...
Hold Reason
...
Virtual Resource Priority
...
Agent Details
...
This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.
...
Utility Agent Cluster Variable
...
Utility Credentials Variable
...
This section contains assorted detailed information about an SAP Task in enhanced view.
...
- Legacy View
- Enhanced View
...
Specifies whether to display the SAP tasking Legacy View or Enhanced View.
Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically.
...
Job class for the SAP Job. Options are:
- High Priority
- Middle Priority
- Low Priority
...
Panel | ||||||
---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Note | ||
---|---|---|
| ||
These instructions assume the user has a working knowledge of SAP. |
The SAP task allows you to send commands to an SAP system and gather status information and output back from SAP. The SAP task uses Stonebranch's proprietary Universal Connector for SAP (USAP) to communicate with SAP. Universal Connector for SAP allows Universal Controller to connect to an SAP system and manage SAP background processing tasks.
Before You Begin
To run an SAP task, you must first complete the following:
- Identify the Utility Agent that has Universal Connector for SAP installed and licensed; either a Universal Agent for Linux/Unix or a Universal Agent for Windows that will interface with the SAP system.
- Define an SAP connection in the Controller database.
Built-In Variables
The following built-in variables can be used in an SAP task to pass data where appropriate:
Anchor | ||||
---|---|---|---|---|
|
Creating an SAP Task
Step 1 | From the Automation Center navigation pane, select Tasks > SAP Tasks. The SAP Tasks list displays a list of all currently defined SAP tasks.
|
---|---|
Step 2 | Enter/select Details for a new SAP task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click the button. The task is added to the database, and all buttons and tabs in the Task Details are enabled. |
Note | ||
---|---|---|
| ||
To open an existing record on the list, either:
|
Anchor | ||||
---|---|---|---|---|
|
SAP Task Details
The following SAP Task Details is for an existing SAP task.
Depending on the values that you enter / select for these fields, whether or not the SAP task has ever been launched, and whether you have Enhanced View or Legacy View selected, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the SAP Task Details.
SAP Task Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in the SAP Task Details.
Field Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the task. | ||||||||||||
Name |
| ||||||||||||
Version |
| ||||||||||||
Description |
| ||||||||||||
Member of Business Services |
| ||||||||||||
Resolve Name Immediately |
| ||||||||||||
Time Zone Preference |
| ||||||||||||
Hold on Start |
| ||||||||||||
Hold Reason |
| ||||||||||||
Virtual Resource Priority |
| ||||||||||||
|
| ||||||||||||
Mutually Exclusive With Self |
| ||||||||||||
Simulate |
| ||||||||||||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Utility Agent Cluster Variable |
| ||||||||||||
|
| ||||||||||||
Utility Credentials Variable |
| ||||||||||||
| This section contains assorted detailed information about an SAP Task in 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 Name | User defined name of the SAP Job. | ||||||||||||
SAP Job Class | Job class for the SAP Job. Options are:
| ||||||||||||
SAP Target Server | SAP server on which the job should run. | ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
Recipient | Recipient address. | ||||||||||||
Report Status by Email | For Type = External Addresses only, options are:
| ||||||||||||
Report Send Status | For Type = External Addresses only, options are:
| ||||||||||||
Copy | If selected, recipient will receive the document as a copy. | ||||||||||||
Blind Copy | If selected, recipient will receive the document as a blind copy. | ||||||||||||
Express | If selected, document will be sent to the recipient as an express message. | ||||||||||||
No Forwarding | If selected, recipient cannot forward the document to other users. | ||||||||||||
SAP Connection |
| ||||||||||||
SAP Connection Variable |
| ||||||||||||
SAP Credentials |
| ||||||||||||
SAP Credentials Variable |
| ||||||||||||
Start Immediately | Specification for whether or not to start the job immediately. | ||||||||||||
Use Application RC | Specification for whether or not to use application RC. | ||||||||||||
Delete SAP Job on Completion | Specification for whether or not to delete the SAP Job on completion. | ||||||||||||
SAP Command Options |
| ||||||||||||
Runtime Directory |
| ||||||||||||
Environment Variables |
| ||||||||||||
SAP Print |
Parameters | This section contains assorted information about print parameters of an SAP Task in |
Enhanced View. | |
Print Job Log | Specification for whether or not to print the job log. |
Print Spooled Output | Specification for whether or not to print the spooled output. |
Print Application Log | Specification for whether or not to print the application log. |
Print Application RC | Specification for whether or not to print the application RC. |
SAP Wait Child Parameters |
This section contains assorted information about wait child parameters of an SAP Task in |
Enhanced View. | |||||||
Wait Child | Specification for whether or not to monitor child jobs. | ||||||
Max Child Depth | Specifies 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:
| ||||||
Spool List Child | Specification for whether or not to print the spool list for child jobs. | ||||||
Purge Child | Specification for whether or not to purge all child jobs from the SAP system. | ||||||
| This section contains assorted detailed information about an SAP Task in legacy 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 |
| ||||||||||||
SAP Connection Variable |
| ||||||||||||
SAP Language |
| ||||||||||||
SAP Credentials |
| ||||||||||||
SAP Credentials Variable |
| ||||||||||||
SAP Job Name |
| ||||||||||||
SAP Job ID |
| ||||||||||||
SAP Process Chain Log ID |
| ||||||||||||
SAP InfoPackage Request ID |
| ||||||||||||
Command Group | See Universal Connector Commands, below, for a description of all supported commands and their contingent fields (options). | ||||||||||||
|
| ||||||||||||
Runtime Directory |
| ||||||||||||
Environment Variables |
| ||||||||||||
Result Processing Details | This section contains assorted detailed information about result processing for this task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Output File (for Exit Code Processing) |
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Start Line |
| ||||||||||||
Number of Lines |
| ||||||||||||
Scan Text |
| ||||||||||||
| |||||||||||||
Retry Options | This section contains specifications for retrying the task. | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| ||||||||||||
Retry Indefinitely |
| ||||||||||||
Retry Interval (Seconds) |
| ||||||||||||
Suppress Intermediate Failures |
| ||||||||||||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Time Options | This section contains time-related specifications for the task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Critical Path Options | This section contains Critical Path-related specifications for the task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Self-Service Options | This section contains Self-Service specifications for the task. | ||||||||||||
Enforce Variables |
| ||||||||||||
Lock Variables |
| ||||||||||||
Statistics | This section contains time-related statistics for task instances of the task. | ||||||||||||
First Execution |
| ||||||||||||
Last Execution |
| ||||||||||||
Last Instance Duration |
| ||||||||||||
Lowest Instance Time |
| ||||||||||||
Average Instance Time |
| ||||||||||||
Highest Instance Time |
| ||||||||||||
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 |
| ||||||||||||
Launch |
| ||||||||||||
View Parents |
| ||||||||||||
Copy | Creates a copy of this task, which you are prompted to rename. | ||||||||||||
Delete |
| ||||||||||||
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 Steps | For Enhanced View only; Lists all Job Steps defined for this task. | ||||||||||||
Variables |
| ||||||||||||
Actions |
| ||||||||||||
Virtual Resources |
| ||||||||||||
Mutually Exclusive |
| ||||||||||||
| Lists all instances of the task. | ||||||||||||
Triggers |
| ||||||||||||
Notes |
| ||||||||||||
|
|
Anchor | ||||
---|---|---|---|---|
|
...
- Instances tab on the SAP Task Details for that task
- Activity Monitor
- Task Instances list
Anchor | ||||
---|---|---|---|---|
|
SAP Task Instance Details
...
The following SAP Task Instance Details contains information on the execution of the task shown in the SAP Task Details.
SAP Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in SAP Task Instance Details.
Field Name | Description |
---|---|
General | This section contains general information |
...
SAP Task Instance Details Field Descriptions
The following table describes the fields, buttons, and tabs that display in SAP Task Instance Details.
Field Name | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the task instance. | ||||||||||||
Anchor | Instance Name | Instance Name | Instance NameName 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. | ||||||||||||
| Specifies whether to display the SAP tasking Legacy View or Enhanced View. Enhanced View runs as Command Group Submit with both Start and Wait options enabled automatically. | ||||||||||||
SAP Job Name | User defined name of the SAP Job. | ||||||||||||
SAP Job Class | Job class for the SAP Job. Options are:
| ||||||||||||
SAP Target Server | SAP server on which the job should run. | ||||||||||||
Email Notification... | |||||||||||||
Include Page | IL:Email Notification Button - SAP Task | IL:Email Notification Button - SAP Task | Spool List Recipient... | Include Page | | IL:Spool List Recipient Button - SAP Task | IL:Spool List Recipient Button - SAP Task | SAP||||||
| Name of this task instance. | ||||||||||||
Instance Number |
| ||||||||||||
Description |
| ||||||||||||
Member of Business Services |
| ||||||||||||
Task |
| ||||||||||||
Source Version |
| ||||||||||||
Launch Source |
| ||||||||||||
Source Instance |
| ||||||||||||
Invoked by |
| ||||||||||||
|
| ||||||||||||
Calendar |
| ||||||||||||
Time Zone Preference |
| ||||||||||||
Virtual Resource Priority |
| ||||||||||||
|
| ||||||||||||
Mutually Exclusive With Self |
| ||||||||||||
Simulate |
| ||||||||||||
Status | This section contains information about the current status of the task instance. | ||||||||||||
Status |
| ||||||||||||
Exit Code |
| ||||||||||||
Status Description |
| ||||||||||||
Operational Memo |
| ||||||||||||
Evaluation Time |
| ||||||||||||
Critical |
| ||||||||||||
Critical Endpoint |
| ||||||||||||
Wait Until Time |
| ||||||||||||
Queued Time |
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
End Time |
| ||||||||||||
Duration |
| ||||||||||||
Process ID |
| ||||||||||||
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Utility Agent Cluster Variable |
| ||||||||||||
|
| ||||||||||||
Utility Credentials Variable |
| ||||||||||||
SAP Details (Enhanced View) | This section contains assorted detailed information about an SAP Task in 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 Name | User defined name of the SAP Job. | ||||||||||||
SAP Job Class | Job class for the SAP Job. Options are:
| ||||||||||||
SAP Target Server | SAP server on which the job should run. | ||||||||||||
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:
| ||||||||||||
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:
| ||||||||||||
Recipient | Recipient address. | ||||||||||||
Report Status by Email | For Type = External Addresses only, options are:
| ||||||||||||
Report Send Status | For Type = External Addresses only, options are:
| ||||||||||||
Copy | If selected, recipient will receive the document as a copy. | ||||||||||||
Blind Copy | If selected, recipient will receive the document as a blind copy. | ||||||||||||
Express | If selected, document will be sent to the recipient as an express message. | ||||||||||||
No Forwarding | If selected, recipient cannot forward the document to other users. | ||||||||||||
SAP Connection |
| ||||||||||||
SAP Connection Variable |
| ||||||||||||
SAP Credentials |
| ||||||||||||
SAP Credentials Variable |
| ||||||||||||
Start Immediately | Specification for whether or not to start the job immediately. | ||||||||||||
Use Application RC | Specification for whether or not to use application RC. | ||||||||||||
Delete SAP Job on Completion | Specification for whether or not to delete the SAP Job on completion. | ||||||||||||
SAP Command Options |
| ||||||||||||
Runtime Directory |
| ||||||||||||
Environment Variables |
| ||||||||||||
SAP Print Parameters (Enhanced View)Parameters | This section contains assorted information about print parameters of an SAP Task in enhanced viewEnhanced View. | ||||||||||||
Print Job Log | Specification for whether or not to print the job log. | ||||||||||||
Print Spooled Output | Specification for whether or not to print the spooled output. | ||||||||||||
Print Application Log | Specification for whether or not to print the application log. | ||||||||||||
Print Application RC | Specification for whether or not to print the application RC. | ||||||||||||
SAP Wait Child Parameters (Enhanced View) | This section contains assorted information about wait child parameters of an SAP Task in enhanced viewEnhanced View. | ||||||||||||
Wait Child | Specification for whether or not to monitor child jobs. | ||||||||||||
Max Child Depth | Specifies 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:
| ||||||||||||
Spool List Child | Specification for whether or not to print the spool list for child jobs. | ||||||||||||
Purge Child | Specification 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.information about the task instance in legacy 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 |
| ||||||||||||
SAP Connection Variable |
| ||||||||||||
SAP Language |
| ||||||||||||
SAP Credentials |
| ||||||||||||
SAP Credentials Variable |
| ||||||||||||
SAP Job Name |
| ||||||||||||
SAP Job ID |
| ||||||||||||
SAP Process Chain Log ID |
| ||||||||||||
SAP InfoPackage Request ID |
| ||||||||||||
Command Group | See Universal Connector Commands, below, for a description of all supported commands and their contingent fields (options). | ||||||||||||
|
| ||||||||||||
Runtime Directory |
| ||||||||||||
Environment Variables |
| ||||||||||||
Result Processing Details | This section contains assorted detailed information about result processing for this task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Output File (for Exit Code Processing) |
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Start Line |
| ||||||||||||
Number of Lines |
| ||||||||||||
Scan Text |
| ||||||||||||
|
| ||||||||||||
Retry Options | This section contains specifications for retrying the task. | ||||||||||||
|
| ||||||||||||
Retry Indefinitely |
| ||||||||||||
Retry Interval (Seconds) |
| ||||||||||||
Current Retry Count |
| ||||||||||||
Suppress Intermediate Failures |
| ||||||||||||
Next Retry Time |
| ||||||||||||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Time Options | This section contains time-related specifications for the task instance. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Critical Path Options | This section contains Critical Path-related specifications for the task. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
|
| ||||||||||||
Statistics | This section contains time-related statistics for the task instance. | ||||||||||||
|
| ||||||||||||
Lowest Estimated End Time |
| ||||||||||||
Average Estimated End Time |
| ||||||||||||
Highest Estimated End Time |
| ||||||||||||
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. | ||||||||||||
Buttons | This section identifies the buttons displayed above and below the Task Instance Details that let you perform various actions. | ||||||||||||
Update |
| ||||||||||||
Force Finish |
| ||||||||||||
Hold |
| ||||||||||||
Skip |
| ||||||||||||
Re-run |
| ||||||||||||
View Parent |
| ||||||||||||
|
| ||||||||||||
SAP | Displays an Action menu of SAP commands. | ||||||||||||
Delete |
| ||||||||||||
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 |
| ||||||||||||
Exclusive Requests |
| ||||||||||||
Output |
| ||||||||||||
Notes |
|
...
Command Name | Description | Options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Performs the following actions:
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Performs the following actions:
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Performs the following actions:
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Defines a new SAP job. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Modifies an SAP job that already exists in an SAP system. A USAP job definition file is used to specify the modifications. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Starts a currently defined SAP job. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Starts the specified process chain on the SAP system. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Starts the specified InfoPackage on the SAP system. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Reconnects to a started job and monitors it through completion. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Waits for a Process Chain to complete. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Waits for an InfoPackage to complete. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cancels a running SAP job. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Removes the specified process chain from the schedule. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deletes a variant from an SAP system. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Raises the specified SAP background processing event. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Displays the data specified in the Display Command field. The data is written to standard output. Display Command. The data is written to standard output. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Generates a USAP variant job definition file based on a model SAP variantjob. The generated definition file is written to standard output. Requires XBP interface 2.0 or greater. SAP ABAP Program Name. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Creates a new Criteria Manager profile. |
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. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Sets the criteria for a profile. |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Sets the Activates a 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Activates Deactivates 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Deactivates Deletes a criteria profile of the specified type. SAP Criteria Manager Profile Typefrom an SAP system. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 | For each field on the Refresh Parameter Name Options... dialog, you can select from a list of values that may have changed since the last time that a value was selected.
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 with Enhanced View enabled, you can add one or more Job Steps for each task, and define the values for those parameters, as described below.
Adding a Job Step
|
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. |
Job Step Details Field Descriptions
Field Name | Description |
---|---|
Type | Read only; Job step type. |
Program Name | Name of the ABAP program to be processed in the background. |
Variant Name | Variant to use to process the report. |
Execution Language | Specifies the language in which the system executes and prints the output. |
SAP User Name | User name in the SAP system. |
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 Copies | Number of printouts. |
Page Area | Specifies if everything should be printed or select pages. Options are:
|
Page From | If Page Area = Page, first page in the range of pages to be printed. |
Page To | If 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:
|
Use Temporary Variant | Specification 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. |
Options Fields
Four Job Step Details fields allow you to populate their drop-down lists with options retrieved from the SAP system:
- Program Name
- Variant Name
- Execution Language
- Output Device
To select the options for a field, click the refresh picker icon next to its drop-down list to display a Refresh Options... dialog. There is a different Refresh Options... dialog for each options field.
Most of the fields on a Refresh 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.
...
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.
Program Name
Variant Name
Execution Language
Output Device
Deleting a Job Step
...
Select a parameter from the drop-down list and enter a Parameter Value.
...
Step 6
...
To delete a single Job Step for a task, either:
- Right-click the step on the Job Step list and click Delete on the Action menu.
- Open the Job Step record and click the Delete button.
Running an SAP Task
You can run an SAP task:
...