Show TOC

Background documentationDefault SAP Job Definitions Locate this document in the navigation structure

 

SAP-specific job definitions can be recognized by their prefix SAP_ and their job definition type which is SAPR3 for most, the only exceptions are for Java Scheduler job definitions that have the JXBP job definition type. Some parameters have both long and short versions of their values. The long values are used in drop-down menus in the submit wizard. The long versions are more verbose than the short ones, however, the short version must be used in job chains, so both are listed here.

The following SAP job definitions are available:

  • SAP_AbapRun

  • SAP_AbapRunPrint

  • SAP_AbapRunPrintExt

  • SAP_BW_GenerateInfoPackageGroup

  • SAP_BW_ImportInfoPackageGroups

  • SAP_BW_ImportInfoPackages

  • SAP_BW_ImportProcessChainDefinition

  • SAP_BW_ImportProcessChains

  • SAP_BW_InfopackageRun

  • SAP_BW_MaintainProcessChainDefinition

  • SAP_BW_Process

  • SAP_BW_ProcessChain

  • SAP_BW_ProcessChainRun

  • SAP_BW_RestartProcess

  • SAP_BW_RestartProcessChain

  • SAP_CcmsJob

  • SAP_CcmsJobCheckStatus

  • SAP_CcmsJobGetApplicationLog

  • SAP_CcmsJobGetApplicationLogHandles

  • SAP_CcmsJobGetLog

  • SAP_CcmsJobGetSpoollist

  • SAP_CcmsJobGetStatistics

  • SAP_CcmsJobGetStatus

  • SAP_CcmsJobModifyHeader

  • SAP_ClosingCockpit_AbapRun

  • SAP_ClosingCockpit_ManualTask

  • SAP_CopyVariant

  • SAP_DeleteCcmsMonitors

  • SAP_DeleteVariant

  • SAP_ExternalCommandRun

  • SAP_ExternalProgramRun

  • SAP_GenerateCcmsJobDefinition

  • SAP_GetBatchResources

  • SAP_GetEventHistory

  • SAP_GetInstalledComponents

  • SAP_GetXmiLog

  • SAP_ImportAbapParameterDefinition

  • SAP_ImportAbapPrograms

  • SAP_ImportApplicationServers

  • SAP_ImportArchiveObjects

  • SAP_ImportBatchEvents

  • SAP_ImportCalendars

  • SAP_ImportCcmsJobs

  • SAP_ImportCcmsMonitors

  • SAP_ImportExternalCommands

  • SAP_ImportOutputDevices

  • SAP_ImportRecipients

  • SAP_ImportVariantDefinition

  • SAP_ImportVariants

  • SAP_Info

  • SAP_InterceptedJob

  • SAP_JXBP_GenerateJobDefinition

  • SAP_JXBP_ImportJobDefinitions

  • SAP_MA_CopyParameters

  • SAP_MA_CreateParameters

  • SAP_MA_DeleteDunningProposal

  • SAP_MA_ImportMassActivities

  • SAP_MA_ImportMassActivity

  • SAP_MA_MassActivityRun

  • SAP_MA_MassActivityTemplateRun

  • SAP_MA_ResumeMassActivity

  • SAP_MA_ShowMassActivity

  • SAP_MA_StopMassActivity

  • SAP_MaintainXbpOptions

  • SAP_PI_GetChannelStatus

  • SAP_PI_ImportChannels

  • SAP_PI_StartChannel

  • SAP_PI_StopChannel

  • SAP_RaiseEvent

  • SAP_ReleaseInterceptedJobs

  • SAP_ReloadApplicationLinks

  • SAP_RunTemplateJob

  • SAP_SetXmiAuditLevel

  • SAP_SolutionManager_AbapRun

  • SAP_StoreVariant

  • SAP_SynchronizeEventHistoryCriteria

  • SAP_SynchronizeInterceptionCriteria

  • SAP_SynchronizeTerminatedCcmsJobs

SAP_AbapRun

This job definition is used to run ABAP's via the XBP interface in SAP Systems.

This job definition works with every version of the XBP interface, yet it offers a limited set of print and archive parameters (only those that are available in XBP 1.0) if you do not load the Redwood Transport files.

Parameters

Name

Description

Data Type

Default Expression

Default List of Values

ABAP_PROGRAM_NAME

ABAP program

String

ABAP_VARIANT_NAME

ABAP variant

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

ARCHIVE_INFO

Archive info

String

ARCHIVE_OBJECT

Document type

String

ARCHIVE_SAPOBJECT

Archive SAP object

String

CLIENT

SAP client

String

DELETE_JOB

Delete job when finished?

String

N

Y,N

JOBCLASS

SAP job class

String

C

A,B,C

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

LANGUAGE

SAP language for the step

String

PRINT_ARCMODE

Print/Archive mode

String

1 (Print only)

1 (Print only) 2 (Archive only) 3 (Print and Archive)

PRINT_BANNERPAGE

Selection cover sheet?

String

N

Y,N

PRINT_COPIES

# of copies

String

1

PRINT_DESTIN

Printer

String

PRINT_EXPIRATION

Expiration in days

String

8

0 (Do not Delete)1-8 days

PRINT_IMMEDIATE

Print immediately?

String

N

Y,N

PRINT_NUMCOLUMNS

Print columns per page

String

PRINT_NUMLINES

Print lines per page

String

PRINT_RECIPIENT

Spool list recipient

String

PRINT_RELEASE

Release print job?

String

N

Y,N

PRINT_SAPBANNER

SAP cover page?

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_SHOWPASSWD

Authority for printing

String

SAP_SYSTEMS

SAP System

String

SAP_USER_NAME

SAP user name

String

SHOWLOG

Retrieve joblog?

String

Y

Y,N

SHOWSPOOL

Retrieve spoollist?

String

Y

Y,N

TARGET_GROUP

SAP target server group name

String

TARGET_SERVER

SAP target server name

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

If you set Print/Archive mode to Archive only or Print and Archive, the following additional Archive parameters must be filled:

  • Archive SAP object - Referred to as Obj.type in SAPGUI

  • Archive object - Referred to as Doc.type in SAPGUI

  • Archive info - Referred to as Information in SAPGUI

  • Archive text information field - Referred to as Text in SAPGUI

Note Note

If you need to use the optional Archive text information field parameter, known as Text in SAPGUI, you will have to use the job definition SAP_AbapRunPrint or SAP_AbapRunPrintExt.

End of the note.
Advanced

By adding the following two parameters, you can make jobs wait on events in SAP:

Parameter

Description

Direction

Data Type

STARTCOND_EVENTID

batch event id

In

String

STARTCOND_EVENTPARM

parameter of the event id

In

String

Note that you have to duplicate the job definition and modify the duplicate.

More Information

Handling ABAP programs

SAP_AbapRunPrint

This job definition is used to run ABAP's via the XBP interface in SAP Systems.

This job definition makes use of the extended capabilities of the XBP 2.0 interface, which provides an extended set of print and archive parameters.

This job definition works on every version of the XBP interface, yet on versions below 2.0 the new functionality is disabled if you do not have the transport files installed.

Parameters

Name

Description

Data Type

Default Expression

Default List of Values

ABAP_PROGRAM_NAME

ABAP program

String

ABAP_VARIANT_NAME

ABAP variant

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

ARCHIVE_ARCTEXT

Archive text information field

String

ARCHIVE_AR_OBJECT

Document type

String

ARCHIVE_INFO

Archive info

String

ARCHIVE_SAP_OBJECT

Archive SAP object

String

CLIENT

SAP client

String

DELETE_JOB

Delete job when finished?

String

N

Y, N

JOBCLASS

SAP job class

String

C

A, B, C

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

LANGUAGE

SAP language for the step

String

PRINT_ARMOD

Print/Archive mode

String

1

PRINT_FOOTL

Print a footer?

String

N

Y, N

PRINT_LICT

Print lines per page

String

PRINT_LISZ

Print columns per page

String

PRINT_PAART

Print format

String

PRINT_PDEST

Printer

String

PRINT_PEXPI

Expiration in days

String

8

0 (Do not Delete)1-8 days

PRINT_PLIST

Spoollist name

String

PRINT_PRABT

Department on cover page

String

PRINT_PRBER

Authority for printing

String

PRINT_PRBIG

Selection cover sheet?

String

N

Y, N

PRINT_PRCOP

# of copies

String

1 (Print only)

1 (Print only) 2 (Archive only) 3 (Print and Archive)

PRINT_PRDSN

Spool dataset name

String

PRINT_PRIMM

Print immediately?

String

N

Y, N

PRINT_PRNEW

New spool?

String

Y

Y, N

PRINT_PRREC

Spool list recipient

String

PRINT_PRREL

Release print job?

String

N

Y, N

PRINT_PRSAP

SAP cover page?

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PRTXT

Cover sheet title

String

PRINT_PRUNX

OS cover sheet?

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PTYPE

Spool type

String

SAP_SYSTEMS

SAP System

String

SAP_USER_NAME

SAP user name

String

SHOWLOG

Retrieve joblog?

String

Y

Y, N

SHOWSPOOL

Retrieve spoollist?

String

Y

Y, N

TARGET_GROUP

SAP target server group name

String

TARGET_SERVER

SAP target server name

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

If you set Print/Archive mode to Archive only or Print and Archive, the following Archive parameters should be filled:

  • Archive SAP object - Referred to as Obj.type in SAPGUI

  • Archive object - Referred to as Doc.type in SAPGUI

  • Archive Info - Referred to as Information in SAPGUI

Advanced

By adding the following two parameters, you can make jobs wait on events in SAP:

Parameter

Description

Direction

Data Type

STARTCOND_EVENTID

batch event id

In

String

STARTCOND_EVENTPARM

parameter of the event id

In

String

Note that you have to duplicate the job definition and modify the duplicate.

More Information

Handling ABAP programs

SAP_AbapRunPrintExt

This job definition is used to run ABAP's via the XBP interface in SAP Systems.

This job definition makes use of the extended capabilities of the XBP 3.0 interface to set the spool list recipient and retrieve application log and batch statistics of the SAP job.

This job definition works on every version of the XBP interface, yet on versions below 3.0 the new functionality is disabled if you do not have the transport files installed.

Parameters

Name

Description

Data Type

Default Expression

Default List of Values

ABAP_PROGRAM_NAME

ABAP program

String

ABAP_VARIANT_NAME

ABAP variant

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

ARCHIVE_ARCTEXT

Archive text information field

String

ARCHIVE_AR_OBJECT

Document type

String

ARCHIVE_INFO

Archive info

String

ARCHIVE_SAP_OBJECT

Archive SAP object

String

CLIENT

SAP client

String

DELETE_JOB

Delete job when finished?

String

N

JOBCLASS

SAP job class

String

C

A, B, C

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

LANGUAGE

SAP language for the step

String

PRINT_ARMOD

Print/Archive mode

String

1 (Print only)

1 (Print only) 2 (Archive only) 3 (Print and Archive)

PRINT_FOOTL

Print a footer?

String

N

Y, N

PRINT_LICT

Print lines per page

String

PRINT_LISZ

Print columns per page

String

PRINT_PAART

Print format

String

PRINT_PDEST

Printer

String

PRINT_PEXPI

Expiration in days

String

8

0 (Do not Delete)1-8 days

PRINT_PLIST

Spoollist name

String

PRINT_PRABT

Department on cover page

String

PRINT_PRBER

Authority for printing

String

PRINT_PRBIG

Selection cover sheet?

String

N

Y, N

PRINT_PRCOP

# of copies

String

1

PRINT_PRDSN

Spool dataset name

String

PRINT_PRIMM

Print immediately?

String

N

Y, N

PRINT_PRNEW

New spool?

String

Y

PRINT_PRREC

Spool list recipient

String

PRINT_PRREL

Release print job?

String

N

Y, N

PRINT_PRSAP

SAP cover page?

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PRTXT

Cover sheet title

String

PRINT_PRUNX

OS cover sheet?

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PTYPE

Spool type

String

REC_BLIND_COPY

Recipient blind copy flag

String

N

Y, N

REC_COPY

Recipient copy flag

String

N

Y, N

REC_DELIVER

Report send status

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

REC_EXPRESS

Recipient express flag

String

N

Y, N

REC_MAILSTATUS

Report status by e-mail

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

REC_NO_FORWARDING

Recipient no forwarding flag

String

N

Y, N

REC_NO_PRINT

Recipient no print flag

String

N

Y, N

REC_RECIPIENT

Spool list recipient

String

REC_TYPE

Recipient type

String

U (Internet User)

U (Internet User) B (SAP user) O (SAP-Office user) P (Personel distribution list) C (Shared distribution list) F (Fax number)

SAP_SYSTEMS

SAP System

String

SAP_USER_NAME

SAP user name

String

SHOWAPPLLOG

Retrieve application logs?

String

Y

Y, N

SHOWLOG

Retrieve joblog?

String

Y

Y, N

SHOWSPOOL

Retrieve spoollist?

String

Y

Y, N

SHOWSTAT

Retrieve job statistics?

String

Y

Y, N

TARGET_GROUP

SAP target server group name

String

TARGET_SERVER

SAP target server name

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

If you set Print/Archive mode to Archive only or Print and Archive, the following Archive parameters should be filled:

  • Archive SAP object - Referred to as Obj.type in SAPGUI

  • Archive object - Referred to as Doc.type in SAPGUI

  • Archive Info - Referred to as Information in SAPGUI

Advanced

By adding the following two parameters, you can make jobs wait on events in SAP:

Parameter

Description

Direction

Data Type

STARTCOND_EVENTID

batch event id

In

String

STARTCOND_EVENTPARM

parameter of the event id

In

String

Note that you have to duplicate the job definition and modify the duplicate.

More Information

Handling ABAP programs

SAP_BW_GenerateInfoPackageGroup

Generate an Infopackage group in an SAP System.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

INFOPACKAGEGROUP_NAME

SAP BW InfoPackage group

In

String

JOBDEF_NAME

Name for the generated job definition

In

String

OVERWRITE

Overwrite existing job definitions?

In

String

Y

APPLICATION

Application

In

String

SHOWLOG

Retrieve joblog?

In

String

Y
SAP_BW_ImportInfoPackageGroups

Import InfoPackage groups from an SAP System.

Parameter

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String
SAP_BW_ImportInfoPackages

Import InfoPackages.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

INFOPACKAGE_NAME

Technical name of the SAP BW InfoPackage

In

String

MAX_COUNT

Max. count

In

Number

DROP_OLD_SELECTION

Drop old selection?

In

String

Y

IPAK_INFOSOURCE

Info source of the SAP BW InfoPackage

In

String

IPAK_SOURCESYSTEM

Source system of the SAP BW InfoPackage

In

String

IPAK_DATASOURCE

Datasource of the SAP BW InfoPackage

In

String

SAP_BW_ImportProcessChainDefinition

Import the definition of a Process Chain.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

PCHAIN_NAME

Technical name of the SAP BW Process Chain

In

String

DROP_OLD_SELECTION

Drop old selection?

In

String

Y
More Information

Importing and Running Process Chains

SAP_BW_ImportProcessChains

Import process chains.

Parameters

Name

Description

Direction

Data Type

Default Expression

DROP_OLD_SELECTION

Drop old matching values?

In

String

Y

IMPORT_CHAIN_DEFINITION

Import process chain definition?

In

String

MAX_COUNT

Max. count

In

Number

PCHAIN_NAME

Technical name of the SAP BW Process Chain

In

String

PCHAIN_TEXT

Description of the SAP BW process chain

In

String

SAP_SYSTEMS

SAP System

In

String

More Information

Importing and Running Process Chains

SAP_BW_InfopackageRun

This job definition is used to run Infopackages in SAP BW.

Parameters

Name

Description

Data Type

Direction

Default Expression

JOBNAME

SAP BW job name

In

String

NAME

Technical name of the SAP BW InfoPackage

In

String

REQUESTID

Request ID of an SAP BW InfoPackage run

Out

String

SAP_SYSTEMS

SAP System

In

String

SHOWLOG

Retrieve joblog?

In

String

Y
SAP_BW_MaintainProcessChainDefinition

Maintain the definition of a Process Chain.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

PCHAIN_NAME

Technical name of the SAP BW Process Chain

In

String

BW_PROCESS_TYPE

Type of the SAP BW process

In

String

BW_PROCESS_VARIANT

Variant (name) of the SAP BW process

In

String

BW_MAX_RESTARTS

Number of automatic restarts on error

In

Number

BW_RESTART_DELAY

Delay needed to restart.

In

Number

10

BW_RESTART_DELAY_TIME_UNIT

Unit of the delay (seconds or minutes)

In

String

M(Minutes)

M (Minutes) S (Seconds)

BW_RESTART_UNCHECKED

Restart unchecked

In

String

BW_ERROR_PROCESS_TYPE

Type of the SAP BW process to restart on error

In

String

BW_ERROR_PROCESS_VARIANT

Variant (name) of the SAP BW process to restart on error

In

String

SAP_BW_Process

This job definition represents a process of a BW Process Chain. It is not supposed to be scheduled by the user.

Parameters

Name

Description

Data Type

Default Expression

ID

SAP BW process id

String

JOBCOUNT

SAP BW process batch job count

String

LOGID

SAP BW process chain logid

String

NAME

SAP BW process name

String

SHOWLOG

Retrieve joblog?

String

Y

TYPE

SAP BW process type

String

SAP_BW_ProcessChain

This job definition represents an SAP BW Process Chain. It is not supposed to be scheduled by the user.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

NAME

Technical name of the SAP BW Process Chain

In

String

LOGID

SAP BW process chain LogID

In/Out

String

SYNCHRONOUS

Synchronous run?

In

String

N

SIMULATE

Simulate run?

In

String

N

NOPLAN

No plan?

In

String

N

SHOWLOG

Retrieve joblog?

In

String

Y
SAP_BW_RestartProcess

This job restarts an instance of a process of an SAP BW Process Chain. You do not have to submit this job definition, when a job of a process chain fails, the parent job of the job chain will have an operator message with which you can restart the process chain or one or more of its children. Restarting process chains requires ProcessServerService.SAP.ProcessChainRestart license key.

Parameters

Name

Description

Direction

Data Type

Default Expression

Values

SAP_SYSTEMS

SAP System

In

String

NAME

SAP BW process name

In

String

ID

SAP BW process id

In

String

TYPE

SAP BW process type

In

String

CHAIN, TRIGGER, ABAP ...

PCHAIN_NAME

Technical name of the SAP BW Process Chain

In

String

LOGID

SAP BW process chain LogID

In

String

BW_RESTART_UNCHECKED

Restart unchecked

In

String

N

Y, N

JOBCOUNT

SAP BW process batch job count

In

String

SHOWLOG

Retrieve joblog?

In

String

N

Y, N
More Information

Restarting Process Chains

SAP_BW_RestartProcessChain

This job restarts an instance of an SAP BW Process Chain. You do not have to submit this job definition, when a job of a process chain fails, the parent job of the job chain will have an operator message with which you can restart the process chain or one or more of its children. Restarting process chains requires ProcessServerService.SAP.ProcessChainRestart license key.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

NAME

Technical name of the SAP BW Process Chain

In

String

LOGID

SAP BW process chain LogID

In/Out

String

BW_RESTART_UNCHECKED

Restart unchecked

In

String

Y
SAP_BW_ProcessChainRun

This job definition is used to run BW Process Chains in SAP.

Parameters

Name

Description

Data Type

Default Expression

Default List of Values

CHAIN_RESTARTABLE

Make processes restartable on error?

String

F (Failed)

F (Failed) A (All) N (Not restartable)

LOGID

SAP BW process chain LogID

String

NAME

Technical name of the SAP BW Process Chain

String

NOPLAN

No plan?

String

N

Y, N

SAP_SYSTEMS

SAP System

String

SHOWLOG

Retrieve joblog?

String

Y

Y, N

SIMULATE

Simulate run?

String

N

Y, N

SYNCHRONOUS

Synchronous run?

String

N

Y, N
SAP_CcmsJob

This job definition represents an SAP batch process that is monitored by SAP CPS yet running under full control of the SAP System. It is not supposed to be scheduled by the user.

Parameters

Name

Description

Data Type

Default Expression

CLIENT

SAP client

String

DELETE_JOB

Delete job when finished?

String

N

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

SAP_USER_NAME

SAP user name

String

SHOWLOG

Retrieve joblog?

String

Y

SHOWSPOOL

Retrieve spoollist?

String

Y
SAP_CcmsJobCheckStatus

This job checks if the status of up to 10 SAP batch jobs in the database is valid and updates the database otherwise. It is not supposed to be scheduled by the user.

Parameters

Name

Description

Direction

Data Type

CLIENT

SAP client

In

String

JOBCOUNT

SAP job count

In

String

JOBCOUNT_1

SAP job count 1

In

String

JOBCOUNT_10

SAP job count 10

In

String

JOBCOUNT_2

SAP job count 2

In

String

JOBCOUNT_3

SAP job count 3

In

String

JOBCOUNT_4

SAP job count 4

In

String

JOBCOUNT_5

SAP job count 5

In

String

JOBCOUNT_6

SAP job count 6

In

String

JOBCOUNT_7

SAP job count 7

In

String

JOBCOUNT_8

SAP job count 8

In

String

JOBCOUNT_9

SAP job count 9

In

String

JOBNAME

SAP job name

In

String

JOBNAME_1

SAP job name 1

In

String

JOBNAME_10

SAP job name 10

In

String

JOBNAME_2

SAP job name 2

In

String

JOBNAME_3

SAP job name 3

In

String

JOBNAME_4

SAP job name 4

In

String

JOBNAME_5

SAP job name 5

In

String

JOBNAME_6

SAP job name 6

In

String

JOBNAME_7

SAP job name 7

In

String

JOBNAME_8

SAP job name 8

In

String

JOBNAME_9

SAP job name 9

In

String

JOB_STATUS

Job status

Out

String

JOB_STATUS_1

Job status 1

Out

String

JOB_STATUS_10

Job status 10

Out

String

JOB_STATUS_2

Job status 2

Out

String

JOB_STATUS_3

Job status 3

Out

String

JOB_STATUS_4

Job status 4

Out

String

JOB_STATUS_5

Job status 5

Out

String

JOB_STATUS_6

Job status 6

Out

String

JOB_STATUS_7

Job status 7

Out

String

JOB_STATUS_8

Job status 8

Out

String

JOB_STATUS_9

Job status 9

Out

String

SAP_SYSTEMS

SAP System

In

String
SAP_CcmsJobGetApplicationLog

Get an application log of an SAP batch job.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

JOBCOUNT

SAP job count

In

String

JOB_ID

Job id

In

Number

LOGHANDLE

Application log handle

In

String
SAP_CcmsJobGetApplicationLogHandles

Get the list of application log handles of an SAP batch job.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

JOBCOUNT

SAP job count

In

String

JOB_ID

Job id

In

Number
SAP_CcmsJobGetLog

Get the job log of an SAP batch job.

Parameters

Name

Description

Direction

Data Type

Default Value

CLIENT

SAP client

In

String

CONSIDER_SIZE_CONSTRAINTS

Consider file size constraints?

In

String

N

JOBCOUNT

SAP job count

In

String

JOBNAME

SAP job name

In

String

JOB_ID

Job id

In

Number

SAP_SYSTEMS

SAP System

In

String

SAP_CcmsJobGetSpoollist

Get a spool list of an SAP batch job.

Name

Description

Direction

Data Type

Default Value

CLIENT

SAP client

In

String

CONSIDER_SIZE_CONSTRAINTS

Consider file size constraints?

In

String

N

JOBCOUNT

SAP job count

In

String

JOBNAME

SAP job name

In

String

JOB_ID

Job id

In

Number

SAP_SYSTEMS

SAP System

In

String

SPOOLID

Spoollist ID

In

String

STEP_NUMBER

Step number of the SAP batch job

In

Number

SAP_CcmsJobGetStatistics

Get the runtime statistics of an SAP batch job.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

JOBCOUNT

SAP job count

In

String

JOB_ID

Job id

In

Number
SAP_CcmsJobModifyHeader
Parameters

Name

Description

Direction

Data Type

Default Expression

CLIENT

SAP client

In

String

EVENT_ID

Event ID

In

String

EVENT_PARAMETER

Event parameter

In

String

JOBCOUNT

SAP job count

In

String

JOBNAME

SAP job name

In

String

PERIODIC

Periodic job?

In

String

READ_JOB_INFO

Read job info?

In

String

Y

RELEASE_JOB

Release job in SAP?

In

String

N

SAP_SYSTEMS

SAP System

In

String

START_TIME

Start time

In

DateTimeZone

TARGET_GROUP

SAP target server group name

In

String

TARGET_SERVER

SAP target server name

In

String

SAP_CcmsJobGetStatus

This job retrieves the status of an SAP batch job.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

JOBCOUNT

SAP job count

In

String

JOB_STATUS

Job status

Out

String
SAP_ClosingCockpit_AbapRun

Run an ABAP report from SAP Closing Cockpit.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

JOBCLASS

SAP job class

In

String

C

A, B, C

SAP_USER_NAME

SAP user name

In

String

TARGET_SERVER

SAP target application server name

In

String

JOBDOCID

Job documentation ID

In

String

PRINT_ARMOD

Print/Archive mode

In

String

1 (Print only)

1 (Print only) 2 (Archive only) 3 (Print and Archive)

PRINT_PDEST

Printer

In

String

PRINT_PRTXT

Cover sheet title

In

String

PRINT_PRCOP

# of copies

In

String

1

PRINT_PRNEW

New spool?

In

String

Y

Y, N

PRINT_PLIST

Spoollist name

In

String

PRINT_PRIMM

Print immediately?

In

String

N

Y, N

PRINT_PRREL

Release print job?

In

String

N

Y, N

PRINT_PEXPI

Expiration in days

In

String

8

0 (Do not Delete)1-8 days

PRINT_LICT

Print lines per page

In

String

PRINT_LISZ

Print columns per page

In

String

PRINT_PAART

Print format

In

String

PRINT_PRBIG

Selection cover sheet?

In

String

N

Y, N

PRINT_PRSAP

SAP cover page?

In

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PRREC

Spool list recipient

In

String

PRINT_PRABT

Department on cover page

In

String

PRINT_PRBER

Authority for printing

In

String

PRINT_PRDSN

Spool dataset name

In

String

PRINT_PTYPE

Spool type

In

String

PRINT_FOOTL

Print a footer?

In

String

N

Y, N

PRINT_PRUNX

OS cover sheet?

In

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

ARCHIVE_SAP_OBJECT

Archive SAP object

In

String

ARCHIVE_AR_OBJECT

Document type

In

String

ARCHIVE_INFO

Archive info

In

String

ARCHIVE_ARCTEXT

Archive text information field

In

String

REC_RECIPIENT

Spool list recipient

In

String

REC_TYPE

Recipient type

In

String

U (Internet User) B (SAP user) O (SAP-Office user) P (Personel distribution list) C (Shared distribution list) F (Fax number)

REC_COPY

Recipient copy flag

In

String

N

Y, N

REC_BLIND_COPY

Recipient blind copy flag

In

String

N

Y, N

REC_EXPRESS

Recipient express flag

In

String

N

Y, N

REC_NO_FORWARDING

Recipient no forwarding flag

In

String

N

Y, N

REC_NO_PRINT

Recipient no print flag

In

String

N

Y, N

REC_DELIVER

Report send status

In

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

REC_MAILSTATUS

Report status by e-mail

In

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

SAP_CC_LDAY_P

Closing key day (as single value)

In

String

SAP_CC_LDAY_S

Closing key day (as range)

In

String

SAP_CC_PERIOD_P

Period (as single value)

In

String

SAP_CC_PERIOD_S

Period (as range)

In

String

SAP_CC_GJAHR_P

Financial year (as single value)

In

String

SAP_CC_GJAHR_S

Financial year (as range)

In

String

SAP_CC_RESPONSIBLE

Responsible

In

String

SAP_CC_EXECUTIVE

Executioner

In

String

SAP_CC_ESTIMATED_RUNTIME

Estimated runtime

In

Number

SAP_CC_MAX_START_DELAY

Max. start delay

In

Number

SAP_CC_CONTEXT_ID

Context ID

In

String

SAP_CC_CONTEXT_DESCR

Context descriptions

In

String

SAP_CC_EXE_USR_SMTP

Executioner user email address

In

String

SAP_CC_RES_USR_SMTP

Responsible user email address

In

String

SAP_CC_SMTP_SERVER

SMTP server

In

String

SHOWLOG

Retrieve joblog?

In

String

Y

Y, N

SHOWSPOOL

Retrieve spoollist?

In

String

Y

Y, N

SHOWSTAT

Retrieve job statistics?

In

String

Y

Y, N

SHOWAPPLLOG

Retrieve application logs?

In

String

Y

Y, N

DELETE_JOB

Delete job when finished?

In

String

N

Y, N
More Information

Handling ABAP programs

SAP_ClosingCockpit_ManualTask

Manual task in the context of SAP Closing Cockpit.

Parameters

Name

Description

Direction

Data Type

JOB_ID

Job id

In

Number

SAP_CC_CONTEXT_DESCR

Context descriptions

In

String

SAP_CC_CONTEXT_ID

Context ID

In

String

SAP_CC_ESTIMATED_RUNTIME

Estimated runtime

In

Number

SAP_CC_EXECUTIVE

Executioner

In

String

SAP_CC_EXE_USR_SMTP

Executioner user email address

In

String

SAP_CC_MAX_START_DELAY

Max. start delay

In

Number

SAP_CC_RESPONSIBLE

Responsible

In

String

SAP_CC_RES_USR_SMTP

Responsible user email address

In

String

SAP_CC_SMTP_SERVER

SMTP server

In

String

SAP_CC__GJAHR_P

Financial year (as single value)

In

String

SAP_CC__GJAHR_S

Financial year (as range)

In

String

SAP_CC__LDAY_P

Closing key day (as single value)

In

String

SAP_CC__LDAY_S

Closing key day (as range)

In

String

SAP_CC__PERIOD_P

Period (as single value)

In

String

SAP_CC__PERIOD_S

Period (as range)

In

String
SAP_CopyVariant

Copy a variant from SAP CPS or from one SAP System to another.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

TARGET_SAP_SYSTEMS

Target SAP System

In

String

TARGET_CLIENT

Target client

In

String

TARGET_VARIANT

Target variant name

In

String

WRITE_MODE

If the variant already exists in the SAP System

In

String

E (Fail)

E (Fail) S (Skip) R (Replace) C (Change)
More Information

Handling Variants

SAP_DeleteCcmsMonitors

This job definition is used to delete CCMS monitors from the alert tree of SAP CPS so that these monitors are no longer fed with values from the SAP CCMS monitoring infrastructure.

Parameters

Name

Description

Data Type

MONITOR_NAME

CCMS monitor name

String

MONITOR_SET_NAME

CCMS monitor set name

String

SAP_SYSTEMS

SAP System

String
More Information

Integrating CCMS Monitors

SAP_DeleteVariant

Delete a variant from an SAP System.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

CLIENT_ONLY

Client only?

In

String

Y

DELETE_DEFINITION

Delete variant definition?

In

String

Y
More Information

Handling Variants

SAP_ExternalCommandRun

This job definition is used to run external commands in SAP. This job definition requires XBP 2.0.

Parameters

Name

Description

Direction

Data Type

Default Expression

CLIENT

SAP client

In/Out

String

DELETE_JOB

Delete job when finished?

In

String

Y

EXT_COMMAND_NAME

External command name

In

String

EXT_COMMAND_PARAMETERS

External command parameters

In

String

JOBCLASS

SAP job class

In

String

C

JOBCOUNT

SAP job count

Out

String

JOBNAME

SAP job name

In

String

LANGUAGE

SAP language for the step

In

String

OPERATING_SYSTEM

Operating system

In

String

SAP_SYSTEMS

SAP System

In

String

SAP_USER_NAME

SAP user name

In

String

SHOWLOG

Retrieve joblog?

In

String

Y

STDERRCNTL

Log external errors to job log?

In

String

Y

STDOUTCNTL

Log external output to job log?

In

String

Y

TARGET_GROUP

SAP target server group name

In

String

TARGET_HOST

Target host to run the external command

In

String

TARGET_SERVER

SAP target server name

In

String

TRACECNTL

Activate external trace?

In

String

N

WAIT_FOR_TERMINATION

Wait for external termination

In

String

Y
Advanced

By adding the following two parameters, you can make jobs wait on events in SAP:

Parameter

Description

Direction

Data Type

STARTCOND_EVENTID

batch event id

In

String

STARTCOND_EVENTPARM

parameter of the event id

In

String

Note that you have to duplicate the job definition and modify the duplicate.

SAP_ExternalProgramRun

This job definition is used to run external programs in SAP.

Parameters

Name

Description

Direction

Data Type

Default Expression

CLIENT

SAP client

In/Out

String

DELETE_JOB

Delete job when finished?

In

String

N

EXT_PROGRAM_NAME

External program name

In

String

EXT_PROGRAM_PARAMETERS

External program parameters

In

String

JOBCLASS

SAP job class

In

String

C

JOBCOUNT

SAP job count

Out

String

JOBNAME

SAP job name

In

String

LANGUAGE

SAP language for the step

In

String

SAP_SYSTEMS

SAP System

In

String

SAP_USER_NAME

SAP user name

In

String

SHOWLOG

Retrieve joblog?

In

String

Y

STDERRCNTL

Log external errors to job log?

In

String

Y

STDOUTCNTL

Log external output to job log?

In

String

Y

TARGET_GROUP

SAP target server group name

In

String

TARGET_HOST

Target host to run the external command

In

String

TARGET_SERVER

SAP target server name

In

String

TRACECNTL

Activate external trace?

In

String

N

WAIT_FOR_TERMINATION

Wait for external termination

In

String

Y
Advanced

By adding the following two parameters, you can make jobs wait on events in SAP:

Parameter

Description

Direction

Data Type

STARTCOND_EVENTID

batch event id

In

String

STARTCOND_EVENTPARM

parameter of the event id

In

String

Note that you have to duplicate the job definition and modify the duplicate.

SAP_GenerateCcmsJobDefinition

This job definition is used to generate a job definition in SAP CPS based on the job definition in SAP. The job name and job count must match exactly one SAP job (these parameters may not contain wildcard characters).

Parameters

Name

Description

Direction

Data Type

Default Expression

ADD_STEP_NUMBERS

Add step numbers to SAP job names?

In

String

N

APPLICATION

Application

In

String

CLIENT

SAP client

In

String

CLIENT_SPECIFIC

Generate job definitions for this client only?

In

String

N

CREATE_JOBDEFS_FOR_STEPS

Create a job definition for each step?

In

String

N

DELETE_JOB

Delete job when finished?

In

String

N

JOBCOUNT

SAP job count

In

String

JOBDEF_NAME

Name for the generated job definition

In

String

JOBNAME

SAP job name

In

String

OVERWRITE

Overwrite existing job definitions?

In

String

Y

OVERWRITE_LANGUAGE

Force step language

In

String

OVERWRITE_USER

Force step user

In

String

SAP_SYSTEMS

SAP System

In

String

SHOWLOG

Retrieve joblog?

In

String

Y

SHOWSPOOL

Retrieve spoollist?

In

String

Y
SAP_GetBatchResources

This job definition is used to retrieve the batch resources of an application server of an SAP instance at a given date.

Parameters

Name

Description

Direction

Data Type

ON_DATE

On date

In

DateTimeZone

SAP_SYSTEMS

SAP System

In

String

TARGET_SERVER

SAP target server name

In

String
SAP_GetEventHistory

This job definition is used to retrieve synchronized batch event history from an SAP System.

Parameters

Name

Description

Direction

Data Type

FROM_TIMESTAMP

Starting from

In

DateTimeZone

SAP_SYSTEMS

SAP System

In

String
SAP_GetInstalledComponents

This job definition is used to retrieve the list of installed components of an SAP System.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String
SAP_GetXmiLog

Retrieves the XMI log.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

XMI_INTERFACE

XMI interface

In

String

FROM_TIMESTAMP

Start time of the XMI log

In

Date Time Zone

TO_TIMESTAMP

End time of the XMI log

In

Date Time Zone

SESSION_ID

XMI session ID

In

String

OBJECT

Object

In

String
SAP_ImportAbapParameterDefinition

This job imports the parameter definition of an ABAP program.

Parameters

Name

Description

Data Type

Direction

Default Expression

SAP_SYSTEMS

SAP System

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_DEF_OVERWRITE

Overwrite ABAP parameters?

In

String

Y
More Information

Importing ABAP Program Parameter Definitions

SAP_ImportAbapPrograms

Import ABAP programs.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

MAX_COUNT

Max. count

In

Number

DROP_OLD_SELECTION

Drop old selection?

In

String

Y
More Information

Importing ABAP Programs

SAP_ImportApplicationServers

This is an internal job definition to retrieve the list of application servers in an SAP instance and is mainly used for load balancing. This job definition does not need to be submitted by a user.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String
SAP_ImportArchiveObjects

Imports SAP objects and the document types they support.

Note Note

This job definition requires XBP 3.0 enabled on the target system.

End of the note.
Parameters

Name

Description

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

DROP_OLD_SELECTION

Drop old selection?

String

Y
More Information

Importing Archive Objects

SAP_ImportBatchEvents

This job definition allows you to import SAP batch events, these values are used to create drop-down menus for event history.

Note Note

XBP 3.0 is required.

End of the note.
Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

MAX_COUNT

Max. count

In

Number

DROP_OLD_SELECTION

Drop old selection?

In

String

Y
More Information

Importing Batch Events

SAP_ImportCalendars

Import SAP calendars.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CALENDAR_TYPE

SAP Calendar type

In

String
SAP_ImportExternalCommands

Import external commands.

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

EXT_COMMAND_NAME

External command name

In

String

OPERATING_SYSTEM

Operating system

In

String

MAX_COUNT

Max. count

In

Number

DROP_OLD_SELECTION

Drop old selection?

In

String

Y
More Information

Importing External Commmands

SAP_ImportCcmsJobs

This job definition is used to import CCMS jobs into SAP CPS. These CCMS jobs can then be scheduled to run through SAP CPS allowing you to use the advanced scheduling features of SAP CPS. The job name and job count parameters may contain wildcard characters. In this case all matching jobs will be imported. This job definition scans the SAP System for jobs matching the parameters and calls SAP_GenerateCcmsJobDefinition with the job name and job count of the matched jobs, where the actual import of the job happens. Moreover, it does conflict resolution when multiple jobs with the same name are found, it will select the latest job that matches the search criteria.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP Client

In Out

String

JOBNAME

SAP Job Name

In

String

JOBCOUNT

SAP Job Count

In

String

SAP_USER_NAME

SAP User Name

In

String

CLIENT_SPECIFIC

Generate Job Definitions for This Client Only?

In

String

N

Y,N

JOBDEF_NAME

Name of the Generated Job Definition

In

String

OVERWRITE

Overwrite Existing Job Definitions?

In

String

Y

Y,N

OVERWRITE_LANGUAGE

Force Step Language

In

String

OVERWRITE_USER

Force Step User

In

String

APPLICATION

Application

In

String

CREATE_JOBDEFS_FOR_STEPS

Create a Job Definition for Each Step?

In

String

N

N (Never) A (Abap) S (Step)

EXTENDED_PRINT_PARAMETERS

Generate Extra Print Parameters?

In

String

N

Y,N

ADD_STEP_NUMBERS

Add Step Numbers to SAP Job Names?

In

String

N

Y,N

SHOWLOG

Retrieve Job Log?

In

String

Y

Y,N

SHOWSPOOL

Retrieve Spool Lists?

In

String

Y

Y,N

DELETE_JOB

Delete Job When Finished?

In

String

N

Y,N
SAP_ImportCcmsMonitors

This job definition is used to import CCMS monitors from an SAP System. Once the monitors are imported, they will be automatically fed with values from the SAP CCMS monitoring infrastructure, provided XAL is enabled.

Parameters

Name

Description

Data Type

MONITOR_NAME

CCMS monitor name

String

MONITOR_SET_NAME

CCMS monitor set name

String

SAP_SYSTEMS

SAP System

String
SAP_ImportOutputDevices

Imports output devices (printers) and the formats they support.

Note Note

This job definition requires XBP 2.0 enabled on the target system.

End of the note.
Parameters

Name

Description

Data Type

Default Expression

SAP_SYSTEMS

SAP System

String

OUTPUT_DEVICE

The output device to import

String

*

OUTPUT_DEVICE_LONG

The long name of output device to import(XBP 3.0 only)

String

*

CHANGE_TIME

Change time stamp (XBP 3.0 only)

DateTimeZone

*

DROP_OLD_SELECTION

Drop old selection?

String

Y
More Information

Importing Output Devices

SAP_ImportRecipients

This job definition is used to import the list of recipients from an SAP System, and will allow drop-down menus with all available recipients of an SAP System. This helps prevent problems due to human errors, like typos.

Parameters

Name

Description

Direction

Data Type

Default Expression

CLIENT

SAP client

In

String

DISTRIBUTION_LIST

Distribution list

In

String

DROP_OLD_SELECTION

Drop old matching values?

In

String

N

SAP_SYSTEMS

SAP System

In

String

SAP_USER_NAME

SAP user name

In

String

SAP_ImportVariantDefinition

Import variants definitions of ABAP programs.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

DROP_OLD_SELECTION

Drop old selection?

In

String

Y
More Information^M
SAP_ImportVariants

Import variants of ABAP programs.

Parameters

Name

Description

Direction

Data Type

Default Expression

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

CLIENT

SAP client

In

String

DROP_OLD_SELECTION

Drop old matching values?

In

String

Y

IMPORT_DEFINITION

Import variant definition?

In

String

MAX_COUNT

Max. count

In

Number

SAP_SYSTEMS

SAP System

In

String

More Information
SAP_Info

This job definition is used to retrieve information about the SAP System, like codepage, version, or list of installed components.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String
SAP_InterceptedJob

This job definition represents an SAP batch process that is intercepted in the SAP System. It is not supposed to be scheduled by the user.

Parameters

Name

Description

Data Type

Default Expression

CLIENT

SAP client

String

DELETE_JOB

Delete job when finished?

String

N

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

SAP_USER_NAME

SAP user name

String

SHOWLOG

Retrieve joblog?

String

Y

SHOWSPOOL

Retrieve spoollist?

String

Y
SAP_JXBP_GenerateJobDefinition

This job definition is used to generate JXBP job definitions inside SAP CPS and does not to be submitted by users.

Parameters

Name

Description

Direction

Data Type

Default Expression

APPLICATION

Application

In

String

JOBDEF_NAME

Name for the generated job definition

In

String

JOBNAME

SAP job name

In

String

OVERWRITE

Overwrite existing job definitions?

In

String

N

SAP_SYSTEMS

SAP System

In

String

SYSTEM_SPECIFIC

System specific?

In

String

N

SAP_SYSTEMS

SAP System

In

String

More Information

Importing Java Job Definitions

SAP_JXBP_ImportJobDefinitions

This job definition allows you to retrieve all JXBP job definitions from the SAP Java Scheduler, these will be available in drop-down menus in SAP CPS.

Parameters

Name

Description

Direction

Data Type

Default Expression

APPLICATION

Application

In

String

JOBDEF_NAME

Name for the generated job definition

In

String

JOBNAME

J2EE job definition

In

String

OVERWRITE

Overwrite existing job definitions?

In

String

N

SAP_SYSTEMS

SAP System

In

String

SYSTEM_SPECIFIC

System specific?

In

String

N
More Information

Importing Java Job Definitions

SAP_MA_CopyParameters

This job copies a mass activity parameter record and changes the parameters according to the provided parameter set.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_PARAMETER_SET

Mass activity parameter set

In

String

MASS_ACTIVITY_SOURCE_DATE_ID

Source Date ID

In

Date Time Zone

MASS_ACTIVITY_SOURCE_ID

Source Identification

In

String

MASS_ACTIVITY_TARGET_DATE_ID

Target Date ID

In

Date Time Zone

MASS_ACTIVITY_TARGET_ID

Target Identification

In

String

MASS_ACTIVITY_DATE_SHIFT

Date shift

In

Number
SAP_MA_CreateParameters

This job creates a mass activity parameter record and changes the parameters according to the provided parameter set.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_PARAMETER_SET

Mass activity parameter set

In

String

MASS_ACTIVITY_TARGET_DATE_ID

Target Date ID

In

Date Time Zone

MASS_ACTIVITY_TARGET_ID

Target Identification

In

String
SAP_MA_DeleteDunningProposal

This job deletes a dunning proposal of a new mass activity.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_DATE_ID

Date ID

In

Date Time Zone

MASS_ACTIVITY_ID

Identification

In

String
SAP_MA_ImportMassActivities

This job imports SAP mass activity definitions.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

DROP_OLD_SELECTION

Drop old matching values?

In

String

N
More Information

Importing and Running Mass Activities

SAP_MA_ImportMassActivity

This job imports an SAP mass activity definition.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_TCODE

Mass activity transaction code

In

String

DROP_OLD_SELECTION

Drop old matching values?

In

String

N
More Information

Importing and Running Mass Activities

SAP_MA_MassActivityRun

This job creates a parameter record and starts a mass activity run.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_PARAMETER_SET

Mass activity parameter set

In

String

MASS_ACTIVITY_DATE_ID

Date ID

In/Out

Date Time Zone

MASS_ACTIVITY_ID

Identification

In/Out

String
More Information

Importing and Running Mass Activities

SAP_MA_MassActivityTemplateRun

This job starts a mass activity run using an existing parameter record.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_DATE_ID

Date ID

In

Date Time Zone

MASS_ACTIVITY_ID

Identification

In

String
More Information

Importing and Running Mass Activities

SAP_MA_ResumeMassActivity

This job resumes processing of an interrupted SAP mass activity run.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_DATE_ID

Date ID

In

Date Time Zone

MASS_ACTIVITY_ID

Identification

In

String
More Information

Importing and Running Mass Activities

SAP_MA_ShowMassActivity

This job shows the difinition of an SAP mass activity.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String
SAP_MA_StopMassActivity

This job stops an SAP mass activity run.

This job definition requires the Redwood transport files to be loaded.

Parameters

Name

Description

Direction

Data Type

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In/Out

String

MASS_ACTIVITY

Mass activity

In

String

MASS_ACTIVITY_DATE_ID

Date ID

In

Date Time Zone

MASS_ACTIVITY_ID

Identification

In

String
SAP_MaintainXbpOptions

This job maintains XBP options for interception and parent/child functionality.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

INTERCEPTION_ACTION

Interception action

In

String

R (Show)

R (Show) S (Enable) 3 (Enable with XBP 3.0 features) C (Disable)

PARENTCHILD_ACTION

Parent/Child action

In

String

R (Show)

R (Show) S (Enable) C (Disable)

INTERCEPTION_OPTION

Interception enabled?

Out

String

PARENTCHILD_OPTION

Parent/Child enabled?

Out

String

Values

The job will output the current setting when run with R (Show), change the setting and output the result when you usethe other values.

Code

Description

S

Enabled

C

Disabled

3

XBP 3.0 features enabled (valid only for interception)

The output can be found in the out parameters on the job and in the output file. Note that to use the XBP 3.0 features your system needs to have XBP 3.0.

More Information
SAP_PI_GetChannelStatus
Purpose

Retrieves the current status of an SAP XI/PI channel.

Parameters

Parameter

Description

Direction

Data Type

SAP_SYSTEMS

SAP system

In

String

CHANNEL_NAME

Channel name

In

String

CHANNEL_ID

Channel id

In

String

CHANNEL_STATUS

Channel activation status

Out

String

CHANNEL_STATE

Channel state

Out

String
SAP_PI_ImportChannels
Purpose

Imports SAP XI/PI channels so you can control the channels from within SAP CPS

Parameters

Parameter

Description

Direction

Data Type

Default Value

SAP_SYSTEMS

SAP system

In

String

CHANNEL_NAME

Channel name

In

String

CHANNEL_SERVICE

Channel service

In

String

CHANNEL_PARTY

Channel party

In

String

DROP_OLD_SELECTION

Drop old matching values?

In

String

N
More Information

Importing Communication Channels

SAP_PI_StartChannel
Purpose

Starts an SAP XI/PI channel

Parameter

Parameter

Description

Direction

Data Type

SAP_SYSTEMS

SAP system

In

String

CHANNEL_NAME

Channel name

In

String

CHANNEL_ID

Channel id

In

String

CHANNEL_STATUS

Channel activation status

Out

String

CHANNEL_STATE

Channel state

Out

String
SAP_PI_StopChannel
Purpose

Stops an SAP XI/PI channel

Parameter

Parameter

Description

Direction

Data Type

SAP_SYSTEMS

SAP system

In

String

CHANNEL_NAME

Channel name

In

String

CHANNEL_ID

Channel id

In

String

CHANNEL_STATUS

Channel activation status

Out

String

CHANNEL_STATE

Channel state

Out

String
SAP_RaiseEvent

This job definition is used to raise a batch event in SAP.

Parameters

Name

Description

Data Type

SAP_SYSTEMS

SAP System

String

EVENT_ID

Event ID

String

EVENT_PARAMETER

Event parameter

String
SAP_ReloadApplicationLinks

This job definition reloads the SAP Application links.

Parameters

Name

Description

Direction

Data Type

Default Expression

DROP_OLD_SELECTION

Drop old matching values?

In

String

N

SAP_SYSTEMS

SAP System

In

String

SAP_ReleaseInterceptedJobs

Releases intercepted SAP jobs.

Parameters

Name

Description

Direction

Data Type

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

SAP_SYSTEMS

SAP System

In

String

SAP_USER_NAME

SAP user name

In

String
SAP_RunTemplateJob

This job definition is used to run a job that exists in SAP by making a copy of this job and running this copy. The original job is not changed. Only jobs with ABAP steps can be run by this job definition.

Note Note

Jobs with steps containing external programs or commands require Chargeable version of SAP CPS

End of the note.
Parameters

Name

Description

Data Type

Default Expression

DELETE_JOB

Delete job when finished?

String

N

FROM_STEP

From step (0, 1 = all steps)

Number

JOBCOUNT

SAP job count

String

JOBNAME

SAP job name

String

SAP_USER_NAME

SAP user name

String

SHOWLOG

Retrieve joblog?

String

Y

SHOWSPOOL

Retrieve spoollist?

String

Y

TARGET_GROUP

SAP target group name

String

TARGET_JOBNAME

SAP target job name

String

TARGET_SERVER

SAP target application server name

String

SAP_SetXmiAuditLevel

This job definition lets you manage the audit level of an XMI interface. Valid audit levels are integers ranging from 0 to 3.

Parameters

Name

Description

Data Type

SAP_SYSTEMS

SAP System

String

AUDIT_LEVEL

Audit level

Number

XMI_INTERFACE

XMI interface

String
SAP_SolutionManager_AbapRun

Run an ABAP report from SAP Solution Manager.

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

SAP_SYSTEMS

SAP System

In

String

CLIENT

SAP client

In

String

JOBNAME

SAP job name

In

String

ABAP_PROGRAM_NAME

ABAP program

In

String

ABAP_VARIANT_NAME

ABAP variant

In

String

TEMPORARY_VARIANT

Create temporary variant?

String

N

Y,N

JOBCLASS

SAP job class

In

String

C

A, B, C

SAP_USER_NAME

SAP user name

In

String

TARGET_SERVER

SAP target application server name

In

String

JOBDOCID

Job documentation ID

In

String

PRINT_ARMOD

Print/Archive mode

In

String

1 (Print only)

1 (Print only) 2 (Archive only) 3 (Print and Archive)

PRINT_PDEST

Printer

In

String

PRINT_PRTXT

Cover sheet title

In

String

PRINT_PRCOP

# of copies

In

String

1

PRINT_PRNEW

New spool?

In

String

Y

Y, N

PRINT_PLIST

Spoollist name

In

String

PRINT_PRIMM

Print immediately?

In

String

N

Y, N

PRINT_PRREL

Release print job?

In

String

N

Y, N

PRINT_PEXPI

Expiration in days

In

String

8

0 (Do not Delete)1-8 days

PRINT_LICT

Print lines per page

In

String

PRINT_LISZ

Print columns per page

In

String

PRINT_PAART

Print format

In

String

PRINT_PRBIG

Selection cover sheet?

In

String

N

Y, N

PRINT_PRSAP

SAP cover page?

In

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

PRINT_PRREC

Spool list recipient

In

String

PRINT_PRABT

Department on cover page

In

String

PRINT_PRBER

Authority for printing

In

String

PRINT_PRDSN

Spool dataset name

In

String

PRINT_PTYPE

Spool type

In

String

PRINT_FOOTL

Print a footer?

In

String

N

Y, N

PRINT_PRUNX

OS cover sheet?

In

String

D (System Default)

D (System Default)Y (Print)N (Do not print)

ARCHIVE_SAP_OBJECT

Archive SAP object

In

String

ARCHIVE_AR_OBJECT

Document type

In

String

ARCHIVE_INFO

Archive info

In

String

ARCHIVE_ARCTEXT

Archive text information field

In

String

REC_RECIPIENT

Spool list recipient

In

String

REC_TYPE

Recipient type

In

String

U (Internet User)

U (Internet User) B (SAP user) O (SAP-Office user) P (Personel distribution list) C (Shared distribution list) F (Fax number)

REC_COPY

Recipient copy flag

In

String

N

Y, N

REC_BLIND_COPY

Recipient blind copy flag

In

String

N

Y, N

REC_EXPRESS

Recipient express flag

In

String

N

Y, N

REC_NO_FORWARDING

Recipient no forwarding flag

In

String

N

Y, N

REC_NO_PRINT

Recipient no print flag

In

String

N

Y, N

REC_DELIVER

Report send status

In

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

REC_MAILSTATUS

Report status by e-mail

In

String

_ (System Default)

_ (System Default) A (Always) E (On error) N (Never)

SHOWLOG

Retrieve joblog?

In

String

Y

Y, N

SHOWSPOOL

Retrieve spoollist?

In

String

Y

Y, N

SHOWSTAT

Retrieve job statistics?

In

String

Y

Y, N

SHOWAPPLLOG

Retrieve application logs?

In

String

Y

Y, N

DELETE_JOB

Delete job when finished?

In

String

N

Y, N
More Information

Handling ABAP programs

SAP_StoreVariant

Store a variant of an ABAP program.

Parameters

Parameter

Desctiption

Data Type

Default Value

Default List of Values

SAP_SYSTEMS

The SAP System

String

CLIENT

The client of the SAP System

String

ABAP_PROGRAM_NAME

The variants ABAP program

String

ABAP_VARIANT_NAME

Variant

String

WRITE_MODE

The write mode allows you to specify how the job will handle duplicate entries.

String

E (Error) - the job gets the status error, nothing is changed in the SAP System

E (Error) - the job gets the status error, nothing is changed in the SAP System S (Skip) - the variant is skipped R (Replace) - the variant is overwritten with the variant definition from SAP CPS C (Change) - only different parameters are changed, deleted variant parameters will not be removed (recommended)
SAP_SynchronizeEventHistoryCriteria

This job definition is used to synchronize batch event criteria in SAP. This job definition requires XBP 3.0. The Additional Conditions parameter allows you to use BNF expressions to create complex expressions, the syntax is as follows:

<expr> ::= <term> { OR <term> }

<term> ::= <factor> { AND <factor> }

<factor> ::= [ NOT ] <mask>

<mask> ::= event id mask

Parameters

Name

Description

Direction

Data Type

Default Expression

Default List of Values

ACTIVATE_RULES

Activate rules after synchronization

In

String

Y

ADDITIONAL_CONDITIONS

Addtional conditions

In

String

SAP_SYSTEMS

SAP System

In

String

SAP_SynchronizeInterceptionCriteria

This job definition synchronizes interception criteria (job control rules) between SAP CPS and SAP. This job definition requires XBP 2.0.

Parameters

Name

Description

Data Type

Default Expression

Default List of Values

OVERWRITE

Append or overwrite criteria in SAP?

String

A

A (Append) O (Overwrite)

SAP_SYSTEMS

SAP System

String

SYNC_DIRECTION

Synchronization direction

String

N

N (Show Only) S (SAP -> Scheduler) B (SAP <-> Scheduler) C (Scheduler -> SAP)
SYNC_DIRECTION

  • Show Only : view option, display current interception criteria as defined in the SAP System as

well as job control rules of SAP CPS.

  • Scheduler -> SAP: all SAP CPS rules are transferred to SAP

and afterwards the SAP table contains the same rules as in SAP CPS.

  • With Scheduler <-> SAP: all roles both from SAP CPS and SAP are

synchronized. That means the rules of SAP are going into the SAP CPS tables

and the rules of SAP CPS are going to the SAP tables. Final result is that

both tables are equal with respect to the rule-definitions.

  • With SAP -> Scheduler: all SAP rules are transferred to SAP CPS

and afterwards the SAP CPS table contain the same rules as in SAP.

OVERWRITE

Append and Overwrite options only work for syn_direction SAP CPS -> SAP and

SAP CPS <-> SAP.

  • Append: keeps the interception criteria that are already in

the SAP table intact and adds our rules.

  • Overwrite: replaces all interception

criteria that might be defined in SAP by our rules.

SAP_SynchronizeTerminatedCcmsJobs

This job definition synchronizes jobstates between SAP CPS and SAP. Normally, customers will schedule this job definition to run regularly, for example once per day.

Parameters

Name

Description

Direction

Data Type

Default Expression

SAP_SYSTEMS

SAP System

In

String

DELETE_JOBS_OLDER_THEN

Delete terminated jobs that are older then that number of days

Number

MAX_ALLOWED_EXCEPTIONS

Max consecutive exceptions allowed

Number

Example

In the following example, you include all events in event history which have names (event id's) starting with EventBI or EventBW; you exclude the EventBITest event and all events starting with EventBWtest.

not EventBITest and EventBI* or EventBW* and not EventBWtest*