connecting sap solution manager 7.x to the external job ... · connecting sap solution manager 7.x...

Connecting SAP Solution Manager 7.x to the External Job Management Systems Interface SAP SMSE 1.1. Version 1.1 2014-04-03

Connecting SAP Solution Manager 7.x to the External Job Management Systems

2

TABLE OF CONTENTS

INTRODUCTION ......................................................................................................................................... 3

1. REQUIREMENTS FOR AN EXTERNAL SCHEDULER ................................................................. 4 1.1. Functional Requirements............................................................................................................ 4 1.2. Technological Requirements ...................................................................................................... 4 1.3. Other Requirements .................................................................................................................... 4

2. USE CASE ................................................................................................................................... 5

3. SMSE OVERVIEW ........................................................................................................................ 6 3.1. Technology ................................................................................................................................... 6

3.2. SMSE Components ....................................................................................................................... 6

3.3. Implementation Concept................................................................................................................ 6

3.4. Authorization Concept ................................................................................................................... 7

3.5. Logging/Tracing Concept .............................................................................................................. 7

3.6. Testing Concept ............................................................................................................................ 7

4. SMSE OBJECTS .......................................................................................................................... 8

5. RELEASE INFORMATION FOR SMSE VERSION 1.0 - 2012. .................................................... 10

6 SMSE SPECIFICATION.............................................................................................................. 13 6.1 Registration API .......................................................................................................................... 13

6.1.1 Flow Diagram .............................................................................................................................. 13

6.1.2 RFC Destinations Management ................................................................................................... 13

6.1.3 Scheduler Connections Management .......................................................................................... 16

6.2 RFC Push Interface ..................................................................................................................... 18

6.2.1 Error Handling ............................................................................................................................. 18

6.2.2 Naming Conventions ................................................................................................................... 18

6.2.3 Handshake Functions.................................................................................................................. 19

6.2.4 Scheduling Functions .................................................................................................................. 22

6.2.4.1 Schedule Mode ........................................................................................................................... 24

6.2.4.2 Start Conditions .......................................................................................................................... 24

6.2.5 Event Support Functions ............................................................................................................. 28

6.2.6 Management/Monitoring Functions .............................................................................................. 32

6.2.7 Value Help Functions .................................................................................................................. 43

6.2.8 Additional functions ..................................................................................................................... 53

6.3 Notification API ........................................................................................................................... 57

7 EXAMPLE SCENARIO ............................................................................................................... 63

8. ADMINISTRATION TOOLS ........................................................................................................ 64 8.1 SMSE Administration Program ................................................................................................. 64 8.2 SMSE Test/Example Program ................................................................................................... 65


3

INTRODUCTION

This document deals with the connection of SAP Solution Manager 7.x to an external job management system, often called an external scheduler. External job management refers to software which allows jobs to be scheduled, run, and monitored from outside SAP NW. For this purpose, SAP has defined a new interface. This is called SMSE, which stands for Solution Manager Scheduling Enabler.


4

1. REQUIREMENTS FOR AN EXTERNAL SCHEDULER

Currently SAP Solution Manager is not able to automate functional requirements that are more complex in nature (see list below). However, such external jobs and the time/event relations can be defined in an External Scheduler. These definitions can then be exported and delivered as a template (or automation content) to customers enabling faster deployment of the application.

1.1. Functional Requirements

SAP applications should be able to perform following operations:

Scheduling jobs and job chains: o Scheduling with parameters using complex start conditions o Rescheduling o Changing jobs and job chains o Adding notes to job instances o Adding custom parameters to job instances

Monitoring jobs und job chains o Searching for jobs o Getting parameters o Getting output (job logs, spool lists, application logs, etc.) o Getting status o Getting operator messages

Managing jobs und job chains o Cancelling o Killing o Holding o Releasing o Subscribing/ unsubscribing for status/change notification

Triggering events o Raising o Clearing o Getting status o Creating/deleting event definitions

Getting list of o Applications o Isolation groups o Events instances/definitions and their parameters o Job instances/definitions and their parameters o SAP Systems/queues and their parameters o Start conditions and their parameters

Active notification from the external scheduler by: o Job status change o Job change

Showing URLs which were attached to a job or to a system

1.2. Technological Requirements

RFC or Web Services based communication interface between Solution Manager and External Scheduler

1.3. Other Requirements

Central logging and tracing.


5

2. USE CASE


6

3. SMSE OVERVIEW

3.1. Technology

The external scheduler is acting as an RFC-Server with a common interface for scheduling jobs. It is identified through an RFC-Destination, registered in the SMSE.

3.2. SMSE Components

SMSE consists of the following APIs:

Scheduling Interface –Interface for SAP Solution Manager to make the calls independent from the

scheduler and communication protocol, like an additional abstraction level.

Registration Interface – Interface to make the external scheduler available for SAP Solution

Manager.

Notification Interface - Interface between external Scheduler and SAP Solution Manager used for in time notifications.

Push Interface - Interface to forward SAP Solution Manager calls to an external scheduler.

3.3. Implementation Concept

HTTP/HTTPS

HTTP

R

HTTP/HTTPS

R

RR

R

R

R

R

R

SAP NW 7.X ABAP

R

R

RR

R

R

R

R

HTTPHTTP

HTTP/HTTPSHTTP/HTTPS

Solution Manager

SMSE

R

R

R

R

R

R

R

HTTP

Push Interface

Notification Interface

Registartion Interface

Scheduling Interface

Destinations

Permalink Adapter

Gateway

Solution Manager

SMSE

R

R

R

R

R

R

R

HTTP

Push Interface




Destinations

Permalink Adapter

Push Interface




Destinations

Permalink Adapter

Gateway

External Scheduler

Management Systems

WEBAS JAVA NW System BO SystemWEBAS JAVA NW System BO System

External Scheduler


7

Implementation of the Scheduling API is scheduler-independent, thus allowing applications to move or switch to another scheduler. The Scheduling API for SAP applications is ABAP OO based.

3.4. Authorization Concept

The scheduling Push Interface uses a special identification key. This key is provided during the registration, for the authorization.

The Scheduling API, Notification API and Registration API use standard SAP authorization objects.

3.5. Logging/Tracing Concept

Logging is done using the application log and tracing uses the check point group on the ABAP side.

3.6. Testing Concept

The testing is done via eCATT.

Register Identification Key

BAPI_EXT_SDL_REGISTER

Hand shake

Schedule Job

Shedule Job using Session ID

Scheduler Registration Interface Push Interface Solution Manager

Destintion Created

Get Scheduler Instance

Get Identification Key

Return Identification Key

Logon using Identification Key

Return Session ID

Return Scheduler Instance


8

4. SMSE OBJECTS

4.1. Isolation Groups With an isolation group, a user is limited to interacting with objects of the same isolation group.

4.2. Applications Applications are a way of grouping the different objects in the system into logical groups, according to the purpose that they serve.

4.3. Jobs, Job Definitions, Job Chains Job scheduling is a main purpose of SMSE. Jobs can be scheduled by users, as the result of a particular event or based on a business schedule. A job can be as short and simple as a line of ABAP code that runs on a single system, or as complex as a multi-day mass activity that runs across dozens of machines. Submitting a job definition allows users to specify values for the parameters when creating a job. The job definition approach means that users can have as many jobs running as they need, rather than having to create new jobs as business needs change. Job chains are job definitions of a specific type. They are made of one or more calls to job definitions, named jobs.

4.4. Queues, Systems Groups of jobs are managed using queues. Queues distribute jobs to systems, where the jobs actually run.

4.5. Event Definitions, Events SMSE supports event-driven process automation. This means that it is possible to start jobs (or job chains) using events, rather than just having them happen at a particular time. This event-driven nature makes it possible to create efficient processes that do not rely on time at all. When certain conditions are met, an event is raised. Events (like jobs) have a definition separate from the event itself. An event definition can have zero or more actual events associated with it. The definition stores information like the name and the trigger for the individual events.


9

Each time an event occurs, a new event is created (or raised). Each event can then be individually monitored and managed, and remains visible as historical data even after all tasks related to the event have completed.

4.6. Context Additional grouping possibility for job instances.


10

5. RELEASE INFORMATION FOR SMSE VERSION 1.0 - 2012.

The following tables give you an overview of functions modules.

5.1 Registration Interface:

Function module Feature

BAPI_EXT_SDL_CREATE_DEST Creating a new RFC destination

BAPI_EXT_SDL_CREATE_DEST_HTTP Creating a new HTTP destination

BAPI_EXT_SDL_READ_DEST Reading parameters of an RFC

destination

BAPI_EXT_SDL_READ_DEST_HTTP Reading parameters of an HTTP destination

BAPI_EXT_SDL_REGISTER Registering an external scheduler

BAPI_EXT_SDL_UNREGISTER Unregistering an external scheduler

BAPI_EXT_LOOP_BACK Checking connection

5.2 Push Interface

5.2.1 Handshake:


EXT_SDL_LOGON Logging on to the external scheduler and creating a new

session

EXT_SDL_LOGOFF Logging off from the external

scheduler

EXT_SDL_SESION_CHECK Checking, if the session is still active

5.2.2 Scheduling:


EXT_SDL_JOB_SCHEDULE Scheduling, changing, rescheduling or restarting a job


11

EXT_SDL_JOB_NOTE_ADD Attaching a note to a job

EXT_SDL_JOB_PARAMS_ADD Attaching dynamic parameters to

a job instance

5.2.3 Events:


EXT_SDL_CREATE_EVENT_DEF Creating new event definition

EXT_SDL_DELETE_EVENT_DEF Deleting an event definition

EXT_SDL_EVENT_CONTROL Raising/clearing events

EXT_SDL_EVENT_STATUS_GET Obtaining status of an event

EXT_SDL_GET_EVENTS Getting list of event instances

5.2.4 Managing/Monitoring:


EXT_SDL_JOB_CONTROL Holding, releasing, canceling or

killing a job

EXT_SDL_JOB_STATUS_GET Getting the job status

EXT_SDL_JOB_STATUS_NOTIFIC Subscribing/unsubscribing for a job status change notification

EXT_SDL_JOB_PARAMS_GET Getting parameters of a job

instance

EXT_SDL_JOB_DETAILS_GET Getting some details of a job (short form of

EXT_SDL_JOB_PARAMS_GET)

EXT_SDL_JOB_USER_GET Getting job owner (creator)

EXT_SDL_JOB_OUTPUT_INFO_GET Getting list of available job outputs

EXT_SDL_JOB_OUTPUT_GET Getting a particular job output (spool, log, etc.)

EXT_SDL_GET_JOBS Getting the list of jobs using one of the predefined filters

EXT_SDL_SELECT_JOBS Searching jobs

EXT_SDL_GET_OPERATOR_MESSAGES Getting operator messages

EXT_SDL_OPERATOR_MESSAGE_DET Getting details of an operator message

EXT_SDL_OPERATOR_MESSAGE_CONF Confirming an operator message


12

5.2.5 Value Helps:


EXT_SDL_GET_APPLICATIONS Getting list of applications

EXT_SDL_GET_EVENT_DEFS Getting list of event definitions

EXT_SDL_GET_ISOL_GROUPS Getting list of isolation groups

EXT_SDL_GET_JOB_DEFS Getting list of job definitions

EXT_SDL_GET_JOB_DEF_TYPES Getting list of available job definition types

EXT_SDL_GET_JOB_DEF_PARAMETERS Getting the list of parameters of

a job definition

EXT_SDL_GET_JOB_DEF_PAR_VALUES Value help for a particular parameter of a job definition

EXT_SDL_GET_JOB_FILTERS Getting list of predefined job filters

EXT_SDL_GET_QUEUES Getting list of queues

EXT_SDL_GET_SAP_SYSTEMS Getting list of defined SAP systems

EXT_SDL_GET_SAP_SYSTEM_DETAILS Getting details of a SAP System

EXT_SDL_GET_START_OPTIONS Getting list of start conditions

EXT_SDL_GET_START_OPT_VALUES Value help for a parameter of a start condition

5.2.6 Additional functions:


EXT_SDL_INFO_GET Getting information about an

external scheduler

EXT_SDL_CREATE_APPLICATION Defining a new application

EXT_SDL_DELETE_APPLICATION Deleting an application

EXT_SDL_PERMALINK_GET_URL Getting permalink to an object

5.3 Notification API:


BAPI_EXT_JOB_CHANGE_CALLBACK Notifying job change

BAPI_EXT_JOB_STATUS_CALLBACK Notifying job status change

BAPI_EXT_CHILD_JOB_CALLBACK Notifying child job create

5.4 URL Integration:


BAPI_EXT_NW_CALLBACKS_GET Getting a list of available callback variants


13

6 SMSE SPECIFICATION

6.1 Registration API

Before you call a function module of the registration interface for the first time, it is important that:

the external job management system logs onto the SAP AS ABAP system first, using an AS

ABAP user name and password.

the external job management system is authenticated by the CCMS external interface

administration using the function module BAPI_XMI_LOGON.

See XBP-specification for details.

6.1.1 Flow Diagram

The flow diagram shows how a connection is registered to an external scheduler in SMSE.

6.1.2 RFC Destinations Management


14

Function name BAPI_EXT_SDL_CREATE_DEST

Short description Creates a new RFC destination used for the communication between Solution Manager and the external scheduler.

Function Group SXBP_EXT_SDL_BAPI

RFC interface *"------------------------------------------------------

*" IMPORTING

*" VALUE(I_EXTERNAL_USER_NAME) TYPE XMILOGEUSR

*" VALUE(DESTINATION) TYPE RFCDEST

*" VALUE(METHOD) TYPE RFCREGID

*" VALUE(PROGRAM) TYPE RFCEXEC_EXT

*" VALUE(SERVER) TYPE RFCHOST_EXT

*" VALUE(DESCRIPTION) TYPE RFCDOC_D

*" VALUE(GWHOST) TYPE RFCGWHOST_EXT

*" VALUE(GWSERVICE) TYPE RFCGWSERV

*" VALUE(OVERWRITE) TYPE BOOLEAN

*" VALUE(RFCUNICODE) TYPE RFCUNICODE DEFAULT '1'

*" VALUE(TRACE) TYPE RFCTRACE DEFAULT SPACE

*" EXPORTING

*" VALUE(RETURN) TYPE BAPIRET2

Parameter (Input) I_EXTERNAL_USER_NAME - Name of user in external management tool

DESTINATION - Logical Destination

METHOD - Identification of a registered RFC server program

PROGRAM - Program Name (Complete Path)

SERVER - Name of Target Host

DESCRIPTION - Description of RFC connection

GWHOST - Gateway Host Name

GWSERVICE - Gateway service

OVERWRITE - Overwrite destination if exists

RFCUNICODE - Number of Bytes per Character (Unicode System)

TRACE - Trace

Parameter (Output) BAPIRET2 is the return structure used by BAPIs.

Remarks Required 'S_RFC_ADM'


15

Function name BAPI_EXT_SDL_READ_DEST

Short description Reads parameters of an RFC destination.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(DESTINATION) LIKE RFCDISPLAY-RFCDEST

*" EXPORTING


*" VALUE(METHOD) TYPE RFCREGID

*" VALUE(PROGRAM) TYPE RFCEXEC_EXT

*" VALUE(SERVER) TYPE RFCHOST_EXT


*" VALUE(GWHOST) TYPE RFCGWHOST_EXT

*" VALUE(GWSERVICE) TYPE RFCGWSERV

*" VALUE(RFCCONVERT) TYPE RFCCONVERT

*" VALUE(RFCCONVX) TYPE RFCCONVX

*" VALUE(RFCUNICODE) TYPE RFCUNICODE

*" VALUE(RFCBITMAP) TYPE RFCBITMAP

*"-----------------------------------------------------------

Parameter (Input) I_EXTERNAL_USER_NAME - Name of user in the external management tool

DESTINATION - Logical destination

Parameter (Output) BAPIRET2 - Return structure used by BAPIs

METHOD - Identification of a registered RFC server program

PROGRAM - Program name (complete path)

SERVER - Name of target host

DESCRIPTION - Description of RFC connection

GWHOST - Gateway host name

GWSERVICE - Gateway service

RFCUNICODE - Number of bytes per character (Unicode system)

RFCCONVERT - Conversion for non-compatible Codepage (SPACE, 'I', 'N')

RFCCONVX - Conversion bytes (If RFCCONV = 'I') in hex

RFCBITMAP - Bitmap for variable options in RFCOPT


16

6.1.3 Scheduler Connections Management

Function name BAPI_EXT_SDL_REGISTER

Short description Makes an external scheduler available for Solution Manager.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(DESTINATION) TYPE BTC_EXT_SDL_DEST

*" VALUE(DESCRIPTION) TYPE BTC_EXT_SDL_DESC

*" VALUE(VERSION) TYPE BTC_EXT_COMM_VERS

*" VALUE(IDENT_KEY) TYPE BTC_EXT_SDL_IDENT

*" VALUE(SET_AS_DEFAULT) TYPE BOOLEAN DEFAULT ABAP_TRUE

*" VALUE(SDL_TYPE) TYPE BTC_EXT_SDL_TYPE DEFAULT 'R'

*" EXPORTING

*" VALUE(SUPPORTED_VERSION) TYPE BTC_EXT_COMM_VERS


*"-----------------------------------------------------------



DESCRIPTION - Description of scheduler connection

VERSION - SMSE version, supported by scheduler

IDENT_KEY - Identification key

SET_AS_DEFAULT - Set connection as default

SDL_TYPE – Type of an external scheduler (R-Redwood, A- SAP, O-Other)

Parameter (Output) SUPPORTED_VERSION - SMSE Version which is supported by AS ABAP

BAPIRET2 - return structure used by BAPIs

Remarks

Function name BAPI_EXT_SDL_UNREGISTER

Short description Unregisters an external scheduler.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(REMOVE_DEST) TYPE BOOLEAN

*" EXPORTING


*"-----------------------------------------------------------



REMOVE_DEST - deletes RFC-Destination

Parameter (Output) BAPIRET2 - Return structure used by BAPIs


17

Function name BAPI_EXT_LOOP_BACK

Short description Checks connection to external scheduler. Returns no error if the connection is available and active.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(DESTINATION) TYPE BTC_EXT_SDL_DEST OPTIONAL

*" VALUE(ISOLATION_GROUP) TYPE BTC_EXT_ISOL_GROUP OPT.

*" EXPORTING

*" VALUE(RETURN) TYPE BAPIRET2*

"-----------------------------------------------------------



ISOLATION_GROUP - Isolation group

Parameter (Output) BAPIRET2 - return structure used by BAPIs


18

6.2 RFC Push Interface

Functional group SXBP_EXT_SDL.

6.2.1 Error Handling

Each XBP function module has a RET structure of type BTC_S_RETURN as export parameter. With the help of this structure messages are reported from the external scheduler to the caller.

Structure BTC_S_RETURN

Field name Type Short description

RC BTC_EXT_SDL_INT Return code: 0 – Successful 1-99 – Reserved for external scheduler 96 – Session expired 97 - Invalid session ID 98 – Invalid key >100 – Reserved for SAP

TEXT BTC_EXT_SDL_DESC Error text

6.2.2 Naming Conventions

It is aimed to have a standardized naming convention for function modules, and this is widely kept to. Thus, function modules for the SMSE Push Interface family have the prefix EXT_SDL, an

identification for the actual interface and arising from the target object and the intended action. For example: EXT_SDL_JOB_SCHEDULE EXT_SDL - prefix JOB – object SCHEDULE - action


19

6.2.3 Handshake Functions

The following picture shows the logon procedure.


20

Function name EXT_SDL_LOGON

Short description Logs on to the external scheduler and creates a new session.

Function Group SXBP_EXT_SDL

RFC interface *"-----------------------------------------------------------

*" VALUE(IDENT_KEY) TYPE BTC_EXT_SDL_IDENT

*" VALUE(ISOL_GROUP) TYPE BTC_EXT_ISOL_GROUP

*" VALUE(USER) TYPE BTC_EXT_SDL_USER

*" VALUE(CLIENT) TYPE MANDT

*" VALUE(LANGUAGE) TYPE LANGU

*" VALUE(TIMEZONE) TYPE TIMEZONE

*" VALUE(VERSION) TYPE BTC_EXT_COMM_VERS

*" VALUE(TIMEOUT) TYPE BTC_EXT_SDL_INT

*" EXPORTING

*" VALUE(RETURN) TYPE BTC_S_RETURN

*" VALUE(SESSION_ID) TYPE BTC_EXT_SDL_SESSION_ID

*"-----------------------------------------------------------

Parameter (Input) IDENT_KEY - Key of the external scheduler (provided by the registration)

ISOL_GROUP - Isolation group

USER - User name

CLIENT- User client

LANGUAGE - User language

TIMEZONE - User time zone

VERSION - Requested SMSE version

TIMEOUT - Session expiration time in seconds

Parameter (Output) RETURN - return structure for error handling

SESSION_ID - Session ID (used in all further calls)

Function name EXT_SDL_LOGOFF

Short description Logs off from the external scheduler.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" EXPORTING


*"-----------------------------------------------------------

Parameter (Input) SESSION_ID - Session ID



21

Function name EXT_SDL_SESSION_CHECK

Short description Checks if the session is still active.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" EXPORTING

*" VALUE(RETURN) TYPE BTC_S_RETURN "-----------------------------------------------------------

Parameter (Input) SESSION_ID - Session ID



22

6.2.4 Scheduling Functions


23

Function name EXT_SDL_JOB_SCHEDULE

Short description Schedules, changes, reschedules or restarts a job.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(SCHEDULE_MODE) TYPE BTC_EXT_JOB_SCHED_MODE

*" VALUE(JOBID) TYPE BTC_EXT_JOB_ID OPTIONAL

*" VALUE(DEFINITION_NAME) TYPE BTC_EXT_DEF_NAME OPTIONAL

*" VALUE(DEF_PARAMETERS) TYPE BTC_T_EXT_PAR OPTIONAL

*" VALUE(START_TYPE) TYPE BTC_EXT_JOB_START_TYPE OPT.

*" VALUE(START_OPTIONS) TYPE BTC_T_EXT_PAR OPTIONAL

*" VALUE(WAIT_EVENTS) TYPE BTC_T_EXT_WAIT_EVENT OPTIONAL

*" VALUE(RAISE_EVENTS) TYPE BTC_T_EXT_RAISE_EVENT .

*" VALUE(REMOVE_WAIT_EVENTS) TYPE BOOLEAN OPTIONAL

*" VALUE(REMOVE_RAISE_EVENTS) TYPE BOOLEAN OPTIONAL

*" VALUE(CALLBACK_VAR) TYPE BTC_EXT_SDL_NAME OPTIONAL

*" VALUE(QUEUE) TYPE BTC_EXT_SDL_QUEUE OPTIONAL

*" VALUE(NOTE) TYPE BTC_STRING OPTIONAL

*" VALUE(PRIORITY) TYPE BTC_EXT_JOB_PRIORITY OPTIONAL

*" VALUE(STATUS_NOTIFICATION) TYPE BOOLEAN OPTIONAL

*" VALUE(CHILD_CREATION_NOTIFICATION) TYPE BOOLEAN OPT.

*" VALUE(CHANGE_NOTIFICATION) TYPE BOOLEAN OPTIONAL

*" VALUE(CANCEL_ORIGINAL) TYPE BOOLEAN OPTIONAL

*" VALUE(HOLD_ON_SUBMIT) TYPE BOOLEAN OPTIONAL

*" VALUE(CONTEXT_ID) TYPE BTC_EXT_OBJ_ID OPTIONAL

*" VALUE(CONTEXT_CLOSE) TYPE BOOLEAN OPTIONAL

*" VALUE(API_CHANGES_ONLY) TYPE BOOLEAN OPTIONAL

*" EXPORTING


*" VALUE(NEWJOBID) TYPE BTC_EXT_JOB_ID

*"-----------------------------------------------------------

Parameter (Input) SESSION_ID – Session ID

SCHEDULE_MODE – Schedule mode (see p. 6.2.4.1. for details )

JOBID – ID of the old job (relevant for resubmit or restart mode)

DEFINITION_NAME – Name of a job definition

DEF_PARAMETERS – List of parameters of the job definition

START_TYPE – Start type (see p. 6.2.4.2. for details )

START_OPTIONS – Start options

WAIT_EVENTS – List of events for which jobs have to wait before start

RAISE_EVENTS – List of events which should be raised after the job end

REMOVE_WAIT_EVENTS – Removes wait events (relevant for change or

resubmit mode)

REMOVE_RAISE_EVENTS – Removes raise events (relevant for change or

resubmit)

CALLBACK_VAR – Callback variant (apart of URL integration, see p. 6.4 for

details)

QUEUE – Target queue

NOTE – Additional comment to a job

PRIORITY – Priority (0-99)

STATUS_NOTIFICATION – Activate status notification for the job


24

CHILD_CREATION_NOTIFICATION – Activate child creation notification for

the job

CHANGE_NOTIFICATION - Activate job change notification

CANCEL_ORIGINAL – Cancel original job (relevant for resubmit mode)

HOLD_ON_SUBMIT – Do not start the job when the start condition fulfils,

job should go to status “hold”

CONTEXT_ID – Context ID, uses for the job grouping

CONTEXT_CLOSE – Close context after the job is finished

API_CHANGES_ONLY – Forbid job changes in the scheduler

Parameter (Output) RETURN –return structure for error handling

NEWJOBID – ID of the new job

6.2.4.1 Schedule Mode

Definition of SCHEDULE_MODE

Value Description

S Normal schedule

R Resubmit

B Restart from the job beginning

E Restart from the error step

M Change job

T Simulate execution

6.2.4.2 Start Conditions

Following table summarizes the parameters of the supported start conditions:

Start type Parameter Parameter type

Man- dato- ry

Comments

I - Immediately

- - - Starts the job Immediately

O - Once DATETIMEZONE Date and Time X Schedules the job to start at given date and time

D - Daily DATETIMEZONE Date and Time X Starts date and time of the job

EVERY Number - Day interval: 0 – every Monday to Friday, >0 – any number of days

PRESUBMIT Number - Number of jobs to presubmit

ENDAFTER Number - Ends after given number of jobs

ENDDATE Date and Time - End date W – Weekly DATETIMEZONE Date and Time X Start date and

time of the job EVERY Number - Day interval: 0 –

every Monday to Friday, >0 – any


25

number of days PRESUBMIT Number - Number of jobs to

presubmit ENDAFTER Number - End after given

number of jobs ENDDATE Date and Time - End date SUNDAY Boolean - Schedules on the

given weekday MONDAY Boolean - TUESDAY Boolean - WEDNESDAY Boolean - THURSDAY Boolean - FRIDAY Boolean - SATURDAY Boolean -

M - Monthly DATETIMEZONE Date and Time X Start date and time of the job



ENDAFTER Number - End after given number of jobs

ENDDATE Date and Time - End date WEEKDAY Number - Weekday; 1 –

Sunday, 2 – Monday, …,7 - Saturday, 8 - Working Day

DAYORWEEKNUMBER Number - If weekday is set, then it denotes the weekday number, e.g. 4th Monday. Otherwise, it denotes the day of month, e.g. 4th day of the month

Y - Yearly DATETIMEZONE Date and Time X Start date and time of the job



ENDAFTER Number - End after given number of jobs

ENDDATE Date and Time - End date WEEKDAY Number - Weekday; 0 –

Sunday, 1 – Monday, …, 6 - Saturday

DAYORWEEKNUMBER Number - If weekday is set, then it denotes the weekday number, e.g. 4th Monday. Otherwise it denotes the day of


26

month, e.g. 4th day of the month

C - Dates DATETIMEZONE Date and Time X Start date and time of the job; can be repeated for every start date. Start time is always the same for all dates and is taken from the first entry

A - Advanced

DATETIMEZONE Date and Time X Start date and time of the job

TIMEWINDOW String Name of the Time window

SUBMITFRAME String Name of the submit frame

where

Date and Time is a string in format YYYYMMDDHHMMSS in UTC

Number is a string containing characters 0-9 only

Boolean is a string with the character ‘X’ representing TRUE, and ‘ ‘ (blank) representing FALSE

Function name EXT_SDL_JOB_NOTE_ADD

Short description Attaches a note to a job.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(JOBID) TYPE BTC_EXT_JOB_ID

*" VALUE(NOTE) TYPE BTC_STRING

*" EXPORTING

*" VALUE(RETURN) TYPE BTC_S_RETURN *"-----------------------------------------------------------


JOBID – Job ID

NOTE – Text of the note

Parameter (Output) RETURN – return structure for error handling


27

Function name EXT_SDL_JOB_PARAMS_ADD

Short description Attaching dynamic parameters to a job instance.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(JOB_PARAMETERS) TYPE BTC_T_EXT_PAR

*" EXPORTING



JOBID – Job ID

JOB_PARAMETERS – Table with parameters


Remarks Instance Parameters currently used by the Job Documentation :

Instance Paramater Description

JOBDOCID ID of the Job

Documentation

JOBDOCVERS Version of the Job

Documentation

JOBDOC_SOLMANSYSID System ID of SolMan

JOBDOC_SOLMANCLIENT Client of SolMan

JOBDOC_SMSY_LOGCMP Logical Component

JOBDOC_SMSY_SYSID Managed System Name

JOBDOC_SMSY_CLIENT Managed System Client

JOBDOC_SMSY_TYPE Managed System Type

JOBDOC_PROJECT_ID Solution Manager

Project ID

JOBDOC_SOLUTION_ID Solution Manager

Solution ID

JOBDOC_SOLUTION_GUID Solution Manager

Solution GUID

JOBDOC_BO_ID Solution Manager

Business Object ID


28

6.2.5 Event Support Functions

Function name EXT_SDL_CREATE_EVENT_DEF

Short description Creates new event definition.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(EVENT) TYPE BTC_EXT_SDL_EVENT

*" VALUE(APPLICATION_ID) TYPE BTC_EXT_SDL_APPL_ID


*" VALUE(KEEP_CLOSE) TYPE BOOLEAN

*" VALUE(COMMENT) TYPE BTC_EXT_SDL_COMMENT

*" EXPORTING



EVENT – Name of an event definition

APPLICATION_ID – ID of the application

DESCRIPTION - description

KEEP_CLOSE – not used

COMMENT – comment


Function name EXT_SLD_DELETE_EVENT_DEF

Short description Deletes an event definition.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(EVENT) TYPE BTC_EXT_SDL_EVENT

*" VALUE(FORCE) TYPE BOOLEAN

*" EXPORTING


*"-----------------------------------------------------------


EVENT – Name of an event definition

FORCE – Also delete if still used



29

Function name EXT_SDL_EVENT_CONTROL

Short description Raises/clears event.


RFC interface *"--------------------------------------------------------

---

*" IMPORTING


*" VALUE(MODE) TYPE BTC_EXT_EVENT_RAISE_MODE

*" VALUE(EVENT_NAME) TYPE BTC_EXT_SDL_EVENT

*" VALUE(PARAMETER) TYPE BTC_EXT_SDL_DESC OPTIONAL

*" EXPORTING


*"--------------------------------------------------------

---


MODE – Execution mode

EVENT_NAME – Name of the event definition

PARAMETER – Parameter of the event


Remarks Definition of MODE

Value Description

R Raise

C Clear


30

Function name EXT_SDL_EVENT_STATUS_GET

Short description Obtains the status of an event.


RFC interface *"--------------------------------------------------------

---

*" IMPORTING


*" VALUE(EVENT_NAME) TYPE BTC_EXT_SDL_EVENT

*" EXPORTING


*" VALUE(STATUS) TYPE BTC_EXT_EVENT_STATUS


*"--------------------------------------------------------

---


EVENT_NAME – Name of the event definition

Parameter (Output) RETURN –Return structure for error handling

STATUS – Status of the event

DESCRIPTION – Event parameter (user comment)

Remarks Definition of STATUS

Value Description

R Raised

C Cleared

Function name EXT_SDL_GET_EVENTS

Short description Gets a list of event instances.


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(EVENT_DEFNAME) TYPE BTC_EXT_SDL_EVENT

*" VALUE(CONTINUE) TYPE BOOLEAN

*" VALUE(PORTION) TYPE BTC_EXT_SDL_INT

*" EXPORTING


*" VALUE(EVENTS) TYPE BTC_T_EXT_EVENT

*" VALUE(MORE) TYPE BOOLEAN *"-----------------------------------------------------------


EVENT_DEFNAME – Name of event definition

CONTINUE – Continue reading

PORTION – Portion of reading

Parameter (Output) RETURN – Return structure for error handling

EVENTS - Table with even instances

MORE – More events available, (recall EXT_SDL_GET_EVENTS with

CONTINUE = ‘X’


31


32

6.2.6 Management/Monitoring Functions

Function name EXT_SDL_JOB_CONTROL

Short description Holds, releases, cancels or kills a job.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(MODE) TYPE BTC_EXT_JOB_CTRL_MODE

*" VALUE(ALL_OCCURRENCES) TYPE BOOLEAN

*" EXPORTING


*"-----------------------------------------------------------


JOBID – Job ID


ALL_OCCURRENCES – perform action with all jobs from the same group

(for example: “cancel” a periodic job)



Value Description

C Cancel

K Kill

R Release

H Hold


33

Function name EXT_SDL_JOB_STATUS_GET

Short description Gets the status of a job.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" EXPORTING


*" VALUE(STATUS) TYPE BTC_EXT_JOB_STATUS

*" VALUE(JOB_RC) TYPE BTC_EXT_SDL_INT

*" VALUE(CHILDREN_CNT) TYPE BTC_EXT_SDL_INT

*" VALUE(CONTEXT_CLOSED) TYPE BOOLEAN

*"-----------------------------------------------------------


JOBID – ID of a job

Parameter (Output) RETURN – Return structure for error handling

STATUS – Status of a job

JOB_RC – Return code

CHILDREN_CNT – Count of child jobs

CONTEXT_CLOSED – Context closed?

Remarks Job status:

Value Description

- New

P Chained

T Skipped

J Disabled

j Ignored

D Delayed

N Never

F Overdue

B QueueHeld

S Scheduled

o ConsoleRestart

H Held

V EventWait

I LockWait

Q Queued

q Dispatched

r Accepted

M Modified

R Running

a Assigned

O Console

W Waiting

G Killing

c Canceling

U Unknown

E Error

K Killed

A Canceled

C Completed


34

Function name EXT_SDL_JOB_STATUS_NOTIFIC

Short description Subscribes/unsubscribes for a job status change notification.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(MODE) TYPE BTC_EXT_STATUS_NOTIFIC

*" EXPORTING


*"-----------------------------------------------------------






Value Description

S Subscribe

U Unsubscribe

W Switch


35

Function name EXT_SDL_JOB_PARAMS_GET

Short description Gets parameters of a job instance.


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(GET_CHILDREN) TYPE BOOLEAN

*" VALUE(GET_PARAMETERS) TYPE BOOLEAN

*" VALUE(GET_STEPS_TREE) TYPE BOOLEAN

*" VALUE(GET_EVENTS) TYPE BOOLEAN

*" VALUE(GET_NOTES) TYPE BOOLEAN

*" VALUE(GET_START_OPTIONS) TYPE BOOLEAN

*" EXPORTING


*" VALUE(STEPS_TREE) TYPE BTC_XMLDATA

*" VALUE(DEF_NAME) TYPE BTC_EXT_DEF_NAME

*" VALUE(DEF_PARAMETERS) TYPE BTC_T_EXT_PAR

*" VALUE(JOB_PARAMETERS) TYPE BTC_T_EXT_PAR

*" VALUE(START_OPTIONS) TYPE BTC_T_EXT_PAR

*" VALUE(NOTES) TYPE BTC_T_EXT_JOB_NOTE

*" VALUE(WAIT_EVENTS) TYPE BTC_T_EXT_WAIT_EVENT

*" VALUE(RAISE_EVENTS) TYPE BTC_T_EXT_RAISE_EVENT


*" VALUE(QUEUE) TYPE BTC_EXT_SDL_QUEUE


*" VALUE(PRIORITY) TYPE BTC_EXT_JOB_PRIORITY

*" VALUE(JOB_RC) TYPE BTC_EXT_SDL_INT

*" VALUE(CHILDREN_CNT) TYPE BTC_EXT_SDL_INT

*" VALUE(CHILDREN) TYPE BTC_T_EXT_JOB

*" VALUE(STATUS_NOTIFIACTION) TYPE BOOLEAN

*" VALUE(CREATE_TIMESTAMP) TYPE BTC_EXT_PAR_VALUE

*" VALUE(PARENT_JOBID) TYPE BTC_EXT_JOB_ID

*" VALUE(CONTEXT_ID) TYPE BTC_EXT_OBJ_ID

*" VALUE(OPERATOR_MESSAGES_AVAILABLE) TYPE BOOLEAN

*" VALUE(OUTPUT_AVAILABLE) TYPE BOOLEAN

*" VALUE(EVENTS_AVAILABLE) TYPE BOOLEAN

*" VALUE(NOTES_AVAILABLE) TYPE BOOLEAN *"-----------------------------------------------------------



GET_CHILDREN – Return list of child jobs

GET_PARAMETERS – Return list of job parameters

GET_STEPS_TREE – Return step tree

GET_EVENTS – Return list of events

GET_NOTES – Return list of notes

GET_START_OPTIONS – Return start options?


STEPS_TREE – Tree of child jobs as XML

DEF_NAME – Job definition name

DEF_PARAMETERS – Job definition parameters (static parameters)

JOB_PARAMETERS – Job instance parameters (dynamic parameters)


36

START_OPTIONS – start condition options

NOTES – list of the attached notes

WAIT_EVENTS – list of wait events

RAISE_EVENTS – list of raise events

STATUS – status of a job

QUEUE – target queue

USER – job owner

PRIORITY - priority

JOB_RC – job return code

CHILDREN_CNT – count of child jobs

CHILDREN – list of child jobs

STATUS_NOTIFIACTION – is status notification enabled?

CREATE_TIMESTAMP- creation date

PARENT_JOBID – parent job id, if exists

CONTEXT_ID – context ID

OPERATOR_MESSAGES_AVAILABLE – is operator messages available?

OUTPUT_AVAILABLE – is job output available?

EVENTS_AVAILABLE – if events (raise or wait) available

NOTES_AVAILABLE – if notes available


37

Function name EXT_SDL_JOB_DETAILS_GET

Short description Getting some details of a job (short form of EXT_SDL_JOB_PARAMS_GET)


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" EXPORTING


*" VALUE(START_DATE) TYPE TIMESTAMP

*" VALUE(RUN_DATE) TYPE TIMESTAMP

*" VALUE(CREATION_DATE) TYPE TIMESTAMP

*" VALUE(MODIFICATION_DATE) TYPE TIMESTAMP

*" VALUE(MODIFICATION_USER) TYPE BTC_EXT_SDL_USER

*" VALUE(CREATION_USER) TYPE BTC_EXT_SDL_USER

*" VALUE(RUNTIME) TYPE BTC_EXT_SDL_INT

*" VALUE(RETURN_CODE) TYPE BTC_EXT_SDL_INT

*"-----------------------------------------------------------


JOBID –ID of a job


START_DATE – scheduled start date

RUN_DATE – execution date

CREATION_DATE – creation date

MODIFICATION_DATE – last modification date

MODIFICATION_USER – last modification user

CREATION_USER – job owner

RUNTIME – total time of execution

RETURN_CODE – job return code

Function name EXT_SDL_JOB_USER_GET

Short description Getting job owner (creator)


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" EXPORTING



*"-----------------------------------------------------------




USER – job owner


38

Function name EXT_SDL_JOB_OUTPUT_INFO_GET

Short description Getting list of available job outputs


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(CHILDREN_OUTPUT) TYPE BOOLEAN

*" EXPORTING


*" VALUE(OUTPUT_INFO) TYPE BTC_T_EXT_JOB_OUTPUT_INFO

*" VALUE(JOB_STATUS) TYPE BTC_EXT_JOB_STATUS

*"-----------------------------------------------------------



CHILDREN_OUTPUT – get also outputs of child jobs


OUTPUT_INFO – list of available job outputs

JOB_STATUS – status of a job


39

Function name EXT_SDL_JOB_OUTPUT_GET

Short description Getting content of a job output (spool, log, etc.)


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(DOC_ID) TYPE BTC_EXT_JOB_OUTPUT_ID

*" VALUE(MIME_TYPE) TYPE BTC_EXT_DOC_MIME_TYPE OPTIONAL



*" EXPORTING


*" VALUE(OUTPUT) TYPE BTC_BINDATA

*" VALUE(OUTPUT_MIME_TYPE) TYPE BTC_EXT_DOC_MIME_TYPE

*" VALUE(MORE) TYPE BOOLEAN

*"-----------------------------------------------------------

Parameter (Input) SESSION_ID – session ID


DOC_ID – ID of a job output

MIME_TYPE – MIME type of a job output (for example request text output

as PDF)

CONTINUE – continue

PORTION – portion in bytes


OUTPUT – job output as binary

OUTPUT_MIME_TYPE – job output mime type

MORE – is another portion available?


40

Function name EXT_SDL_GET_JOBS

Short description Getting list of jobs using one of the predefined filters


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(JOB_FILTER) TYPE BTC_EXT_SDL_JOB_FILTER

*" VALUE(SORT_MODE) TYPE BTC_EXT_SDL_JOB_SORT



*" EXPORTING


*" VALUE(JOBS) TYPE BTC_T_EXT_JOB


*"-----------------------------------------------------------


JOB_FILTER – name of a job filter

SORT_MODE – name of a job sorting

CONTINUE – continue reading?

PORTION – portion


JOBS - list of jobs



41

Function name EXT_SDL_SELECT_JOBS

Short description Searching for jobs


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(APPL_ID) TYPE BTC_EXT_SDL_APPL_ID

*" VALUE(SEARCH_STRING) TYPE STRING

*" VALUE(SDLSTART_FROM) TYPE BTCTIMESTAMP

*" VALUE(SDLSTART_TO) TYPE BTCTIMESTAMP

*" VALUE(QUEUE_MASK) TYPE BTC_EXT_SDL_QUEUE

*" VALUE(JOBDEF_TYPE) TYPE BTC_EXT_JOB_DEF_TYPE

*" VALUE(JOBDEF_MASK) TYPE BTC_EXT_DEF_NAME

*" VALUE(USER_MASK) TYPE BTC_EXT_SDL_USER

*" VALUE(JOBS_STATUSES) TYPE BTC_T_EXT_JOB_STATUS

*" VALUE(JOB_DEF_PARAMS) TYPE BTC_T_EXT_PAR

*" VALUE(JOB_INST_PARAMS) TYPE BTC_T_EXT_PAR

*" VALUE(ROOT_JOBS_ONLY) TYPE BOOLEAN

*" VALUE(EXCLUDE_MAINT_JOBS) TYPE BOOLEAN

*" VALUE(PARENT_JOBID) TYPE BTC_EXT_JOB_ID



*" VALUE(CONTEXT_ID) TYPE BTC_EXT_OBJ_ID

*" EXPORTING


*" VALUE(JOBS) TYPE BTC_T_EXT_JOB


*"-----------------------------------------------------------


APPL_ID – ID of an application

SEARCH_STRING – intellisearch string

SDLSTART_FROM – start date from

SDLSTART_TO – start date to

QUEUE_MASK - queue

JOBDEF_TYPE – job definition type

JOBDEF_MASK – job definition name

USER_MASK – creator

JOBS_STATUSES – table with job statuses (ignored if empty)

JOB_DEF_PARAMS – job definition parameters

JOB_INST_PARAMS – job instance parameters

ROOT_JOBS_ONLY – do not return children jobs

EXCLUDE_MAINT_JOBS - do not return maintenance jobs

PARENT_JOBID – parent job ID


PORTION – portion

CONTEXT_ID – ID of a context


JOBS – list of jobs



42

Function name EXT_SDL_GET_OPERATOR_MESSAGES

Short description Getting operator messages


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(APPL_ID) TYPE BTC_EXT_SDL_APPL_ID OPTIONAL

*" VALUE(OBJ_TYPE) TYPE BTC_EXT_OBJ_TYPE

*" VALUE(OBJ_ID) TYPE BTC_EXT_OBJ_ID

*" VALUE(SEARCH_STRING) TYPE STRING

*" VALUE(PERIOD_FROM) TYPE BTCTIMESTAMP

*" VALUE(PERIOD_TO) TYPE BTCTIMESTAMP



*" EXPORTING


*" VALUE(MESSAGES) TYPE BTC_T_EXT_OPERATOR_MESSAGE


*"-----------------------------------------------------------



OBJ_TYPE – type of an object

OBJ_ID – ID of an object

SEARCH_STRING - intellisearch string

PERIOD_FROM – interval begin

PERIOD_TO – interval end

CONTINUE - continue reading?

PORTION – portion


MESSAGES

MORE– is another portion available?


43

Function name EXT_SDL_OPERATOR_MESSAGE_DET

Short description Getting details of an operator message


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(MESSAGE_ID) TYPE BTC_EXT_OBJ_ID

*" EXPORTING


*" VALUE(LONG_TEXT) TYPE STRING

*" VALUE(MOD_TIMESTAMP) TYPE TIMESTAMP

*" VALUE(MOD_OBJ_TYPE) TYPE BTC_EXT_OBJ_TYPE

*" VALUE(MOD_OBJ_ID) TYPE BTC_EXT_OBJ_ID

*"-----------------------------------------------------------


MESSAGE_ID – ID of an operator message


LONG_TEXT – long text

MOD_TIMESTAMP – last change date

MOD_OBJ_TYPE – last change object type

MOD_OBJ_ID – last change object ID

Function name EXT_SDL_OPERATOR_MESSAGE_CONF

Short description Confirming an operator message


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(MESSAGE_ID) TYPE BTC_EXT_OBJ_ID

*" VALUE(REPLY) TYPE STRING

*" EXPORTING


*"-----------------------------------------------------------


MESSAGE_ID – ID of a message

REPLY – reply text


6.2.7 Value Help Functions


44

Figure 8: Reading using packages


45

Function name EXT_SDL_GET_APPLICATIONS

Short description Getting list of applications


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(APPL_MASK) TYPE BTC_EXT_SDL_APPLICATION



*" EXPORTING


*" VALUE(APPLICATIONS) TYPE BTC_T_EXT_APPLICATION


*"-----------------------------------------------------------



APPL_MASK – name of an application


PORTION – portion


APPLICATIONS – list of applications


Function name EXT_SDL_GET_EVENT_DEFS

Short description Getting list of event definitions


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(EVENT_MASK) TYPE BTC_EXT_SDL_EVENT



*" EXPORTING


*" VALUE(EVENTS) TYPE BTC_T_EXT_EVENT_DEF


*"-----------------------------------------------------------



EVENT_MASK – name of an event


PORTION – portion


EVENTS – list of event definitions



46

Function name EXT_SDL_GET_ISOL_GROUPS

Short description Getting list of isolation groups


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" EXPORTING


*" VALUE(ISOL_GROUPS) TYPE BTC_T_EXT_ISOL_GROUP

*"-----------------------------------------------------------

Parameter (Input) USER – user name


ISOL_GROUPS – list of isolation groups which are available for the

specified user

Function name EXT_SDL_GET_JOB_DEFS

Short description Getting list of job definitions


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(DEF_TYPE_MASK) TYPE BTC_EXT_JOB_DEF_TYPE

*" VALUE(DEF_NAME_MASK) TYPE BTC_EXT_DEF_NAME



*" EXPORTING


*" VALUE(DEFINITIONS) TYPE BTC_T_EXT_DEF


*"-----------------------------------------------------------



DEF_TYPE_MASK – type of a job definition

DEF_NAME_MASK – name of a job definition


PORTION – portion


DEFINITIONS – list of job definitions



47

Function name EXT_SDL_GET_JOB_DEF_TYPES

Short description Getting list of available job definition types


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(TYPE_MASK) TYPE BTC_EXT_JOB_DEF_TYPE



*" EXPORTING


*" VALUE(TYPES) TYPE BTC_T_EXT_JOB_DEF_TYPE


*"-----------------------------------------------------------


TYPE_MASK – name of a job definition type


PORTION – portion


TYPES – list of job definitions types



48

Function name EXT_SDL_GET_JOB_DEF_PARAMETERS

Short description Getting list of parameters of a job definition


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(DEFINITION_NAME) TYPE BTC_EXT_DEF_NAME

*" VALUE(GET_PARAMS) TYPE BOOLEAN DEFAULT ABAP_TRUE

*" VALUE(GET_PARAMS_DETAILS) TYPE BOOLEAN OPTIONAL

*" VALUE(GET_PARAMS_VALUE_HELP) TYPE BOOLEAN OPTIONAL

*" VALUE(GET_PARAMS_COMPLETE) TYPE BOOLEAN OPTIONAL

*" VALUE(CONSTRAINS) TYPE BTC_T_EXT_PAR OPTIONAL

*" EXPORTING


*" VALUE(PARAMETERS) TYPE BTC_T_EXT_PAR

*" VALUE(PARAMETERS_DETAILS) TYPE BTC_T_EXT_PAR_DETAILS

*" VALUE(PARAMETERS_VALUE_HELP) TYPE BTC_T_EXT_PAR_VALUES

*" VALUE(PARAMETERS_COMPLETE) TYPE BAE_T_DEF_PARAMETERS

*"-----------------------------------------------------------


DEFINITION_NAME – name of a job definition

GET_PARAMS – return list of parameters?

GET_PARAMS_DETAILS – return list of parameters details?

GET_PARAMS_VALUE_HELP – return value help?

GET_PARAMS_COMPLETE – return complete details of parameters?

CONSTRAINS – restrictions


PARAMETERS – list of parameters

PARAMETERS_DETAILS – list of properties

PARAMETERS_VALUE_HELP – value helps

PARAMETERS_COMPLETE – extended parameter details


49

Function name EXT_SDL_GET_JOB_DEF_PAR_VALUES

Short description Value help for a particular parameter of a job definition


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(DEFINITION_NAME) TYPE BTC_EXT_DEF_NAME

*" VALUE(PARAMETER_NAME) TYPE BTC_EXT_SDL_NAME


*" VALUE(CONTINUE) TYPE BOOLEAN OPTIONAL

*" VALUE(PORTION) TYPE BTC_EXT_SDL_INT OPTIONAL

*" EXPORTING


*" VALUE(VALUES) TYPE BTC_T_EXT_PAR


*"-----------------------------------------------------------


DEFINITION_NAME – name of a job definitions

PARAMETER_NAME – name of a parameter

CONSTRAINS – table with restrictions


PORTION – portion


VALUES – list of value (as name value combination)


Function name EXT_SDL_GET_JOB_FILTERS

Short description Getting list of predefined job filters


RFC interface *"-----------------------------------------------------------

*" IMPORTING




*" EXPORTING


*" VALUE(JOB_FILTERS) TYPE BTC_T_EXT_JOB_FILTER


*"-----------------------------------------------------------



PORTION – portion


JOB_FILTERS – list of available job filters



50

Function name EXT_SDL_GET_QUEUES

Short description Getting list of queues


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(APPL_ID) TYPE BTC_EXT_SDL_APPL_ID OPTIONAL

*" VALUE(SYSTEM_NAME) TYPE BTC_EXT_SDL_SYSTEM OPTIONAL

*" VALUE(QUEUE_MASK) TYPE BTC_EXT_SDL_QUEUE OPTIONAL



*" EXPORTING


*" VALUE(QUEUES) TYPE BTC_T_EXT_QUEUE


*"-----------------------------------------------------------



SYSTEM_NAME – name of a SAP System

QUEUE_MASK – name of a queue


PORTION – portion


QUEUES – list of queues



51

Function name EXT_SDL_GET_SAP_SYSTEMS

Short description Getting list of defined SAP Systems


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(SYSTEM_MASK) TYPE BTC_EXT_SDL_SYSTEM



*" EXPORTING


*" VALUE(SYSTEMS) TYPE BTC_T_EXT_SYSTEM


*"-----------------------------------------------------------



SYSTEM_MASK – name of a system


PORTION – portion


SYSTEMS – list of systems


Function name EXT_SDL_GET_SAP_SYSTEM_DETAILS

Short description Getting details of a SAP System


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(SYSTEM) TYPE BTC_EXT_SDL_SYSTEM

*" EXPORTING


*" VALUE(CONNECTIONS) TYPE BTC_T_EXT_SYSTEM_CON

*" VALUE(PARAMETERS) TYPE BTC_T_EXT_PAR

*"-----------------------------------------------------------


SYSTEM – name of a system


CONNECTIONS – list of available XBP connections

PARAMETERS – list of system parameters


52

Function name EXT_SDL_GET_START_OPTIONS

Short description Getting list of start conditions


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(START_TYPE) TYPE BTC_EXT_JOB_START_TYPE

*" VALUE(GET_OPTIONS) TYPE BOOLEAN DEFAULT ABAP_TRUE

*"VALUE(GET_OPTIONS_DETAILS) TYPE BOOLEAN DEFAULT ABAP_FALSE

*" EXPORTING


*" VALUE(START_OPTIONS) TYPE BTC_T_EXT_PAR

*" VALUE(START_OPTIONS_DETAILS) TYPE BTC_T_EXT_PAR_DETAILS

*"-----------------------------------------------------------


START_TYPE – start type

GET_OPTIONS – return list of available options?

GET_OPTIONS_DETAILS – return properties?


START_OPTIONS – start options

START_OPTIONS_DETAILS – properties

Function name EXT_SDL_GET_START_OPT_VALUES

Short description Value help for a parameter of a start condition


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(START_TYPE) TYPE BTC_EXT_JOB_START_TYPE

*" VALUE(OPTION_NAME) TYPE BTC_EXT_SDL_NAME


*" EXPORTING


*" VALUE(VALUES) TYPE BTC_T_EXT_PAR

*"-----------------------------------------------------------


START_TYPE – start type

OPTION_NAME – name of an option

CONSTRAINS – restrictions


VALUES – list of values


53

6.2.8 Additional functions

Function name EXT_SDL_INFO_GET

Short description Getting information about an external scheduler


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" EXPORTING


*" VALUE(NAME) TYPE BTC_EXT_SDL_NAME

*" VALUE(VERSION) TYPE BTC_EXT_SDL_NAME

*" VALUE(HOST) TYPE BTC_STRING

*" VALUE(URL) TYPE BTC_STRING

*" VALUE(SCHEDULER_INFO) TYPE BTC_XMLDATA

*"-----------------------------------------------------------



NAME – name of a scheduler

VERSION – max. supported SMSE version

HOST – host of a scheduler

URL – administration URL

SCHEDULER_INFO – additional parameters (xml)

Function name EXT_SDL_CREATE_APPLICATION

Short description Defining new application


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(NAME) TYPE BTC_EXT_SDL_APPLICATION

*" VALUE(PARENT_ID) TYPE BTC_EXT_SDL_APPL_ID


*" VALUE(COMMENT) TYPE BTC_EXT_SDL_COMMENT

*" EXPORTING


*" VALUE(ID) TYPE BTC_EXT_SDL_APPL_ID

*"-----------------------------------------------------------


NAME – name of an application

PARENT_ID – ID of a parent application

DESCRIPTION – small description

COMMENT – long description


ID – ID of a new application


54

Function name EXT_SDL_DELETE_APPLICATION

Short description Deleting an application


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(ID) TYPE BTC_EXT_SDL_APPL_ID

*" VALUE(FORCE) TYPE BOOLEAN

*" EXPORTING


*"-----------------------------------------------------------


ID – ID of an application

FORCE – also delete if still used



55

6.2.9 Permalinks Direct UI integration with the external scheduler: link from application to a particular object in the external scheduler UI.

Function name EXT_SDL_PERMALINK_GET_URL

Short description Generate direct URL to specified scheduler object based on particular action


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(OBJECT_TYPE) TYPE BTC_EXT_OBJ_TYPE

*" VALUE(OBJECT_ID) TYPE BTC_EXT_OBJ_ID

*" VALUE(ACTION) TYPE STRING

*" EXPORTING


*" VALUE(URL) TYPE STRING *"-----------------------------------------------------------


OBJECT_TYPE – type of an object

OBJECT_ID – id of an object, not used with the actions create and list

ACTION – requested action


URL – URL

The following standard objects are supported: Object type Comment

Job Job

JobChain Job chain

JobDefinition Definition of a job

JobDefinitionType Type of a JobDefinition

ProcessServer Process server (agent)

Queue Queue of jobs

SAPSystem Definition of a SAP System

TimeWindow Time window

SubmitFrame Submit frame

EventDefinition Definition of an event

Actions are object-dependent. The following standard actions are supported:

Action Comment Object type

show Display an object All objects

list Display a list of objects All objects

edit Edit an object Job

JobChain

JobDefinition

TimeWindow

SubmitFrame

EventDefinition

submit Submit an object JobDefinition

JobChain

EventDefinition

create Create an object JobChain


56

JobDefinition

TimeWindow

SubmitFrame

EventDefinition

diagram Display diagram of an object JobChain


57

6.3 Notification API

Functional group SXBP_EXT_SDL_BAPI, XMI logon is required.

Function name BAPI_EXT_JOB_STATUS_CALLBACK

Short description Notifying job status change


RFC interface *"-----------------------------------------------------------

*" IMPORTING





*" VALUE(START_DELAY) TYPE BTC_EXT_SDL_INT OPTIONAL

*" VALUE(EXEC_TIME) TYPE BTC_EXT_SDL_INT OPTIONAL

*" VALUE(ISOL_GROUP) TYPE BTC_EXT_SDL_NAME OPTIONAL

*" VALUE(CONTEXT_ID) TYPE BTC_EXT_OBJ_ID OPTIONAL

*" VALUE(CONTEXT_CLOSED) TYPE BOOLEAN OPTIONAL

*" VALUE(JOB_RC) TYPE BTC_EXT_SDL_INT OPTIONAL

*" VALUE(PARENT_JOBID) TYPE BTC_EXT_JOB_ID OPTIONAL

*" EXPORTING

*" VALUE(RETURN) TYPE BAPIRET2 *"-----------------------------------------------------------

Parameter (Input) I_EXTERNAL_USER_NAME - name of user in external management tool

DESTINATION – name of a destination

ISOL_GROUP – name of an isolation group


STATUS – status of a job

START_DELAY – start delay

EXEC_TIME – execution time (by final statuses)

CONTEXT_ID – ID of the context

CONTEXT_CLOSED – context closed?

JOB_RC – return code

PARENT_JOBID –parent job ID (if exists)



58

Function name BAPI_EXT_JOB_CHANGE_CALLBACK

Short description Notifying job change (except status change)


RFC interface *"-----------------------------------------------------------

*" IMPORTING



*" VALUE(ISOL_GROUP) TYPE BTC_EXT_SDL_NAME

*" VALUE(CHANGED_JOBS) TYPE BTC_T_EXT_JOB_CHANGE

*" EXPORTING


*"-----------------------------------------------------------

Parameter (Input) I_EXTERNAL_USER_NAME – name of user in external management tool



CHANGED_JOBS – list of changed jobs


Function name BAPI_EXT_CHILD_JOB_CALLBACK

Short description Notifying child job create


RFC interface *"-----------------------------------------------------------

*" IMPORTING




*" VALUE(CHILD_JOBID) TYPE BTC_EXT_JOB_ID

*" VALUE(ISOL_GROUP) TYPE BTC_EXT_SDL_NAME OPTIONAL

*" EXPORTING


*"-----------------------------------------------------------

Parameter (Input) I_EXTERNAL_USER_NAME - name of user in the external management tool


JOBID – ID of a parent job

CHILD_JOBID – ID of a child job




59

6.4 UI Callbacks Direct UI integration with the external scheduler: link from job or process server to application.

Function name BAPI_EXT_NW_CALLBACKS_GET

Short description Getting list of available callback variants


RFC interface *"-----------------------------------------------------------

*" IMPORTING


*" VALUE(VARIANT) TYPE BTC_EXT_SDL_NAME OPTIONAL

*" VALUE(LANGUAGE) TYPE SYLANGU DEFAULT SY-LANGU

*" EXPORTING

*" VALUE(T_CALLBACKS) TYPE BTC_T_EXT_CALLBACK


*"-----------------------------------------------------------


VARIANT – call-back variant name

LANGUAGE – language


T_CALLBACKS list of callbacks

The function module is to be called during start-up of an agent/process server which is communicating with

the solution manager. Depending on the CALLBACK_SCOPE (table T_CALLBACKS), the corresponding link

should be placed to the job (CALLBACK_SCOPE = J) or to the agent/process server (CALLBACK_SCOPE =

S). Nested table PARAMETERS_TABLE (table T_CALLBACKS) is used for the parameterization of callback-

variants. Depending on the PAR_SCOPE value, the parameters should be taken from the different sources and added as a URL-parameter with the same name:

PAR_SCOPE Source Comment

D JobDefinition Parameter should be taken from the job definition (IT_DEF_PARAMS of IF_BTC_EXT_SDL~ JOB_SCHEDULE). For example JOBNAME.

I JobRunTime Parameter should be taken from the job runtime (IT_PARAMS of IF_BTC_EXT_SDL~ JOB_PARAMS_ADD).

S SAPSystem Parameter should be taken from the system definition. For example SYSID.

X XBP Parameter should be taken from the XBP settings. For example XBP_VERSION.

L Logon Parameter should be taken from the user environment. For example USER or LANGUAGE.

Example of an ABAP implementation DATA: ls_callback TYPE btc_s_ext_callback,

lt_params TYPE btc_t_ext_par_mapping,

ls_param TYPE btc_s_ext_par_mapping.

IF iv_variant = 'BLA_BLA_BLA' OR iv_variant IS INITIAL.

ls_param-job_par_name = 'USER'.

ls_param-url_par_name = 'user'.

ls_param-par_scope = 'L'.

APPEND ls_param TO lt_params.


60

ls_callback-callback_variant = 'BLA_BLA_BLA'.

ls_callback-callback_text = 'Perforce open changes'.

ls_callback-callback_group = 'Perforce'.

ls_callback-callback_url =

'https://p4web.wdf.sap.corp/cgi-bin/list_open_cls.cgi'.

ls_callback-callback_scope = 'J'.

ls_callback-language = sy-langu.

ls_callback-parameters_table = lt_params.

APPEND ls_callback TO et_callbacks.

ENDIF.

IF iv_variant = 'BLA_BLA' OR iv_variant IS INITIAL.

CLEAR ls_callback.

ls_callback-callback_variant = 'BLA_BLA'.

ls_callback-callback_text = 'SAP'.

ls_callback-callback_group = 'Home pages'.

ls_callback-callback_url = 'http://www.sap.com'.

ls_callback-callback_scope = 'S'.



ls_callback-callback_variant = 'BLA_BLA'.

ls_callback-callback_text = 'Redwood'.

ls_callback-callback_group = 'Home pages'.

ls_callback-callback_url = 'http://www.redwood.com'.

ls_callback-callback_scope = 'S'.



ENDIF.

Result in Scheduler:


61

6.5 Web Services Interface 6.5.1 Registration

Instead of BAPI_EXT_SDL_CREATE_DEST and BAPI_EXT_SDL_READ_DEST the BAPI_EXT_SDL_CREATE_DEST_HTTP and BAPI_EXT_SDL_READ_DEST_HTTP should be used.

Function name BAPI_EXT_SDL_CREATE_DEST_HTTP

Short description Create new HTTP-Destination which should be used for the communication between Solution Manager and External Scheduler.


RFC interface *"------------------------------------------------------

*" IMPORTING


*" VALUE(DESTINATION) TYPE RFCDEST


*" VALUE(SERVER) LIKE RFCDISPLAY-RFCHOST DEFAULT SPACE

*" VALUE(PATH_PREFIX) TYPE STRING DEFAULT SPACE

*" VALUE(USER) LIKE RFCDISPLAY-RFCALIAS DEFAULT SPACE

*" VALUE(PASSWORD) LIKE RFCDISPLAY-RFCEXEC

*" VALUE(PROXY_HOST) LIKE RFCDISPLAY-

RFCGWHOST *" VALUE(PROXY_SERVICE) LIKE RFCDISPLAY-

RFCGWSERV *" VALUE(PROXY_USER) TYPE RFCDISPLAY-

PROXYUSER

*" VALUE(PROXY_PASSWORD) TYPE STRING DEFAULT SPACE

*" VALUE(LOGON_METHOD) TYPE RFCDISPLAZ-

RFCSLOGIN DEFAULT 'A'

*" VALUE(OVERWRITE) TYPE BOOLEAN OPTIONAL

*" EXPORTING



DESTINATION - logical Destination

DESCRIPTION - description of HTTP connection

SERVER - name of Target Host

PATH_PREFIX - prefix

USER - user

PASSWORD -password

PROXY_HOST - name of Proxy Host

PROXY_SERVICE - name of GW service

PROXY_USER - proxy server user

PROXY_PASSWORD - proxy server password

LOGON_METHOD - logon Procedure

OVERWRITE - overwrite destination if it exists



62

Function name BAPI_EXT_SDL_READ_DEST_HTTP

Short description Read parameters of a HTTP destination.


RFC interface *"------------------------------------------------------

*" IMPORTING


*" VALUE(DESTINATION) LIKE RFCDISPLAY-RFCDEST

*" EXPORTING



*" VALUE(SERVER) LIKE RFCDISPLAY-RFCHOST

*" VALUE(PATH_PREFIX) TYPE STRING

*" VALUE(USER) LIKE RFCDISPLAY-RFCALIAS

*" VALUE(PASSWORD) LIKE RFCDISPLAY-RFCEXEC

*" VALUE(PROXY_HOST) LIKE RFCDISPLAY-RFCGWHOST

*" VALUE(PROXY_SERVICE) LIKE RFCDISPLAY-RFCGWSERV

*" VALUE(PROXY_USER) TYPE RFCDISPLAY-PROXYUSER

*" VALUE(PROXY_PASSWORD) TYPE STRING

*" VALUE(LOGON_METHOD) TYPE RFCDISPLAZ-RFCSLOGIN

*"------------------------------------------------------


DESTINAMTION – name of a destination

Parameter (Output) BAPIRET2 - the return structure used by BAPIs.

DESCRIPTION - description of RFC connection

SERVER - name of Target Host

PATH_PREFIX - prefix

USER - explicit user ID

PASSWORD - password

PROXY_HOST –name of Proxy Host

PROXY_SERVICE – name of GW service

PROXY_USER - proxy server user

PROXY_PASSWORD – proxy server password

LOGON_METHOD – logon Procedure

Remarks Required 'S_RFC_ADM'

6.5.2 Push interface

Ext. scheduler should implement “SMSE.wsdl”.


63

7 EXAMPLE SCENARIO

Define simple job-chain using the SMSE interface.

Job R1 should start after job R2 and R3 but not before 17 PM

API calls diagram


64

8. ADMINISTRATION TOOLS

8.1 SMSE Administration Program

There is a special program for managing connections between an SAP ABAP System and the External

Scheduler available. This program is called “RSEXTSDL”. (Or Transaction "EXTSDL" since 7.00 SPS 15).

Using this program the administrator can:

enable or disable scheduler connection

change default connection

test connection

test RFC-destination

read Scheduler information


65

8.2 SMSE Test/Example Program

This test program can be used not only as the API test program but also as an example program, how to use

the Scheduling API. The program is called “RSEXTSDL_TEST”.

© 2014 SAP AG. All rights reserved.

SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP

BusinessObjects Explorer, StreamWork, SAP HANA, and other SAP

products and services mentioned herein as well as their respective

logos are trademarks or registered trademarks of SAP AG in Germany

and other countries.

Business Objects and the Business Objects logo, BusinessObjects,

Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and

other Business Objects products and services mentioned herein as

well as their respective logos are trademarks or registered trademarks

of Business Objects Software Ltd. Business Objects is an SAP

company.

Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL

Anywhere, and other Sybase products and services mentioned herein

as well as their respective logos are trademarks or registered

trademarks of Sybase Inc. Sybase is an SAP company.

Crossgate, m@gic EDDY, B2B 360°, and B2B 360° Services are

registered trademarks of Crossgate AG in Germany and other

countries. Crossgate is an SAP company.

All other product and service names mentioned are the trademarks of

their respective companies. Data contained in this document serves

informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials

are provided by SAP AG and its affiliated companies ("SAP Group")

for informational purposes only, without representation or warranty of

any kind, and SAP Group shall not be liable for errors or omissions

with respect to the materials. The only warranties for SAP Group

products and services are those that are set forth in the express

warranty statements accompanying such products and services, if

any. Nothing herein should be construed as constituting an additional

warranty.

www.sap.com

connecting sap solution manager 7.x to the external job ... · connecting sap solution manager 7.x...

Documents