SAP Task
Overview
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.  |
|---|---|
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:
Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)
Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.
Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).
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 | |
Hold Resources on Failure | |
Mutually Exclusive With Self | |
Simulate | |
Override Previous Instance Wait | |
Agent Details | This section contains assorted detailed information about the Agent / Agent Cluster selected for this task. |
Cluster | |
Utility Agent | |
Utility Agent Variable | |
Utility Agent Cluster | |
Utility Agent Cluster Variable | |
Utility Credentials | |
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. 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 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. 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:
|
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. |
SAP Details (Legacy View) | 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. 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 | |
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). |
SAP Command Options | |
Runtime Directory | |
Environment Variables | |
Result Processing Details | This section contains assorted detailed information about result processing for this task. |
Exit Code Processing | |
Output Type | |
Scan Output For | |
Output File (for Exit Code Processing) | |
Exit Codes | |
Automatic Output Retrieval | |
Wait For Output | |
Failure Only | |
Start Line | |
Number of Lines | |
Scan Text | |
Output File (for Automatic Output Retrieval) | |
Retry Options | This section contains specifications for retrying the task. |
Maximum Retries | |
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. |
Wait To Start | |
Wait Time | |
Wait Day Constraint | |
Wait Duration | |
Wait Duration In Seconds | |
Delay On Start | |