SAP Job Interception Configuration
When a job is found in the SAP System it is checked against the XBP interception rules defining the action to take on the job.
tip
You can check all job control rules that use a specific default queue across all SAP systems in the Related Objects list of the queue in question.
note
When you want to retrieve spool files, you should ensure that you have not disabled or restricted spool retrieval with the process server parameter SAP_MaxSpoolSize.
Setting up connection information
See the Connection Details for the ABAP Stack section of the documentation for details on how to set up a connection to the ABAP stack.
Setting up the job handling information
Tab | Field | Description |
---|---|---|
XBP Job Control Rules | Job Handling | Reports the setting of the Job Handling field on the SAP System tab. |
XBP Job Control Rules | Enabled | Allows you to disable rules, preserving the settings for future use. |
XBP Job Control Rules | Description | The description to use for this rule. Limited to 255 characters, any printable UTF-8 character combination is allowed, your browser might not be able to render all characters. If the description is not set, the rules are named <Action>/<Client Number Mask>/<Username Mask>/<Job Name Mask> , please see the list below for available actions. |
XBP Job Control Rules | Processing order | Order in which to process this rule. Rules are processed in ascending order according to the integer you specify here, the first rule that matches wins. The rule with the lowest processing order is processed first. |
XBP Job Control Rules | Action | Defines how to handle the job. Please see the list below for available actions. |
XBP Job Control Rules | Client Number Mask | SAP client pattern that is used to match jobs. Limited to 3 characters, accepts ? and * wildcards, see below. |
XBP Job Control Rules | Job Name Mask | Job name pattern that is used to match jobs. Limited to 255 characters, accepts ? and * wildcards, see below. |
XBP Job Control Rules | Username Mask | User name pattern that is used to match jobs. Limited to 255 characters, accepts ? and * wildcards, see below. |
XBP Job Control Rules | Job class (A, B, C) | The SAP job class. |
XBP Job Control Rules | Default Queue | Queue the job should be put on. This field allows you to choose a queue from the list of queues. |
XBP Job Control Rules | Ccms Process Definition | The process definition to use as SAP_CcmsJob alternative. |
XBP Job Control Rules | Target Server | Force the SAP job to run on a specific SAP application server. This field allows you to select an application server from the list of application servers. |
XBP Job Control Rules | Target Server Group | Force the SAP job to run in a specific. This filed allows you to select a target server group from all target server groups on the SAP system. |
XBP Job Control Rules | Priority | Priority of the process in Redwood Server. |
XBP Job Control Rules | Retrieve Job log | Should the log of the job be retrieved? |
XBP Job Control Rules | Retrieve Spool | Should the output file of the job be retrieved? |
XBP Job Control Rules | Retrieve Application Log | Should the application log file be retrieved? |
XBP Job Control Rules | Ignore Application Return Code | Ignore the return code as returned by the SAP system. |
XBP Job Control Rules | Applies to jobs in SAP status | You may restrict this rule to jobs with a specific status in SAP, see the details below. |
The following wildcards are supported in masks:
- * to match any string, for example
PROCESS_*
would matchPROCESS_ABAP
andPROCESS_OR
but notBI_PROCESS_TRIGGER
. - ? to match a single character, for example
RSUSR?00
would matchRSUSR200
andRSUSR400
.
note
Due to limitations in SAP BI, you should not intercept processes starting with BI_PROCESS
, the only exception is BI_PROCESS_TRIGGER
.
note
Jobs that do not match any of the defined rules are skipped, but not confirmed in SAP, so they are checked at the next synchronization round.
Actions
The following actions are available:
Action | Description | Interception |
---|---|---|
Monitor | A reference to the job is created in Redwood Server. The status of the SAP job can be monitored in the job monitor of Redwood Server. | N/A |
Hold | A reference to the job is created in Redwood Server. If the SAP job is found to be in a Released state in SAP (which means waiting to start at a certain point in time), it is dereleased (put back in status Scheduled in SAP) and submitted on hold in Redwood Server. | Redwood Interception |
Ignore | Jobs that match this rule are confirmed in SAP, so they are not checked again, and ignored (no reference to the job is created in Redwood Server). | N/A |
Schedule | A reference to the job is created in Redwood Server. If the SAP job is found to be in a Released state in SAP (which means waiting to start at a certain point in time), it is dereleased (put back in status Scheduled in SAP). The job is scheduled to start in Redwood Server at the time it was intended to be in SAP. | Redwood Interception |
Start Immediately | A reference to the job is created in Redwood Server. If the SAP job is found to be in a Released state in SAP (which means waiting to start at a certain point in time), it is dereleased (put back in status Scheduled in SAP) and Redwood Server attempts to start the job as soon as possible. | Redwood Interception |
Schedule Intercepted | Jobs that have been intercepted by the SAP system are scheduled in Redwood Server. | SAP Interception |
Status
You can restrict job control rules to SAP jobs with the following statuses:
- Scheduled (
P
) - Released (
S
) - Ready (
Y
) - Active (
R
) - Finished (
F
) - Canceled / Error (
A
)
Custom CCMS Definition
You duplicate the SAP_CcmsJob process definition and customize the new definition to suit your needs. Note that you should not delete the SAP Job Name and SAP Job Count parameters, these are required.
You add additional parameters, control how the process files are retrieved and in which format, and/or add RedwoodScript actions to the definition.
Retrieving Spool Output, Logs, and Application Logs in Other Formats
The FL_SHOWSPOOL
, FL_SHOWLOG
, and FL_SHOWAPPLLOG
parameters override the standard SHOWSPOOL
, SHOWLOG
, and SHOWAPPLLOG
parameters, respectively. The EnableFLParameters registry entry allows you to enable or disable these parameters (defaults to true
, enabled ). The available formats depend on the version of the target AS ABAP; see Spool Output for more information.