Default SAP Process Definitions · Redwood Documentation

SAP-specific process definitions can be recognized by their prefix SAP_ and their definition type which is SAPR3 for most. 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 chains, so both are listed here.

Disabling Process Description Updates

Over the life-cycle of the process, the description is updated. You can disable this feature for all or only built-in SAP processes. You set the process server parameter SAP_JobDescriptionPolicy on the process server of the SAP system, the parameter accepts the following values:

All (A) - automatic description change is active for all SAP process definitions
StandardOnly (S) - automatic description change is active only for processes of process definitions listed in this topic
None (N)- description updates are disabled for all SAP processes

SAP Process Definitions

The following SAP process definitions are available:

SAP_AbapRun - Run ABAP Report
SAP_AbapRunPrint - Run an ABAP report with print parameters
SAP_AbapRunPrintExt - Run an ABAP report with print parameters and spool list recipient
SAP_ACC_Controller - Control SAP application services through the ACC-CCI interface
SAP_BObj_DataServicesJobRun - Runs a Data Services job
SAP_BObj_GenerateReportDefinition - Generates a process definition of an SAP BusinessObjects report in the scheduler repository
SAP_BObj_ImportReportDefinitions - Imports SAP BusinessObjects reports into the scheduler repository
SAP_BObj_ReportRun - Runs an SAP BusinessObjects Crystal Reports or Web Intelligence report
SAP_BObj_TriggerEvent - Triggers an event in the SAP BusinessObjects system
SAP_BW_GenerateInfoPackageGroup - Generate a chain definition for an SAP BW InfoPackage group
SAP_BW_GenerateJobDefinition - Generates the definition of a single BW process chain job in the scheduler repository
SAP_BW_ImportInfoPackageGroups - Import InfoPackage groups
SAP_BW_ImportInfoPackages - Import InfoPackages
SAP_BW_ImportProcessChainDefinition - Import process chain definition
SAP_BW_ImportProcessChains - Import Process Chains
SAP_BW_InfopackageRun - Runs an SAP BW InfoPackage
SAP_BW_MaintainProcessChainDefinition - Maintains the definition of an SAP BW process chain
SAP_BW_Process - Represents a process of an SAP BW process chain
SAP_BW_ProcessChain - Represents an SAP BW process chain
SAP_BW_ProcessChainRun - Runs an SAP BW process chain
SAP_BW_RestartProcess - Restart a process of an SAP BW process chain
SAP_BW_RestartProcessChain - Restarts an SAP BW process chain
SAP_CcmsJob - Monitored SAP batch job
SAP_CcmsJobCheckStatus - Reconcile the status of an SAP batch job according to the DB with the actual status
SAP_CcmsJobGetApplicationLog - Get an application log of an SAP batch job
SAP_CcmsJobGetApplicationLogExt - Get an application log in different formats of an SAP batch job
SAP_CcmsJobGetApplicationLogHandles - Get the list of application log handles of an SAP batch job
SAP_CcmsJobGetLog - Get the job log of an SAP batch job
SAP_CcmsJobGetSpoollist - Get a spool list of an SAP batch job
SAP_CcmsJobGetStatistics - Get the runtime statistics of an SAP batch job
SAP_CcmsJobGetStatus - Get the status of an SAP batch job
SAP_CcmsJobModifyHeader - Modifies the header data of an SAP batch job
SAP_ClosingCockpit_AbapRun - Run an ABAP report from SAP Closing Cockpit
SAP_ClosingCockpit_ManualTask - Manual task in SAP Closing Cockpit
SAP_ConvertSpoolFileToRtx - Convert SAP spool to RTX
SAP_ConvertSpoolFileToRtxLowLevel - Convert SAP spool to RTX with more parameters
SAP_CopyParameters - Add all missing parameters and constraints of the source ABAP job definition to the target ABAP job definition
SAP_CopyVariant - Copy a variant of an ABAP program
SAP_DeleteCcmsMonitors - Removes an SAP CCMS monitor from observation
SAP_DeleteJobs - Delete SAP Jobs
SAP_DeleteVariant - Delete a variant of an ABAP program
SAP_ExportRFCFunctionModuleInterface - Export the definition of a RFC function module
SAP_ExternalCommandRun - Run an external command
SAP_ExternalProgramRun - Run an external program
SAP_GenerateCcmsJobDefinition - Generates the definition of a single SAP batch job in the scheduler repository
SAP_GetBatchResources - Retrieves information about available application servers and batch work processes
SAP_GetEventHistory - Retrieves the batch event history
SAP_GetInstalledComponents - Retrieves the list of installed components
SAP_GetSyslog - Retrieves the SAP syslog
SAP_GetXmiLog - Retrieves XMI Log
SAP_ImportAbapParameterDefinition - Import the parameter definition an ABAP program
SAP_ImportAbapPrograms - Import ABAP Programs
SAP_ImportApplicationServers - Import SAP application servers
SAP_ImportArchiveObjects - Import archive objects and document types
SAP_ImportBatchEvents - Import SAP batch events
SAP_ImportCalendars - Import SAP Calendars
SAP_ImportCcmsJobs - Imports SAP batch jobs
SAP_ImportCcmsMonitors - Adds a CCMS monitor to the list of observed monitors
SAP_ImportExternalCommands - Import external commands
SAP_ImportOutputDevices - Import output devices and formats
SAP_ImportRecipients - Import the definition of the SAP recipients
SAP_ImportVariantDefinition - Import the definition of a variant of an ABAP program
SAP_ImportVariants - Import variants of ABAP programs
SAP_Info - Retrieves details of an SAP system
SAP_InterceptedJob - Intercepted SAP batch job
SAP_MaintainXbpOptions - Maintain XBP Options
SAP_MA_CopyParameters - Copy mass activity parameters
SAP_MA_CreateParameters - create a new mass activity parameter record (deprecated)
SAP_MA_DeleteDunningProposal - Delete the dunning proposal of a new mass activity
SAP_MA_ImportMassActivities - Import SAP mass activity definitions
SAP_MA_ImportMassActivity - Import an SAP mass activity definition
SAP_MA_MassActivityRun - create a parameter record and start a mass activity run (deprecated)
SAP_MA_MassActivityTemplateRun - Start a mass activity run using an existing parameter record
SAP_MA_ResumeMassActivity - Resume processing of an interrupted SAP mass activity run
SAP_MA_ShowMassActivity - Show SAP mass activity definition
SAP_MA_StopMassActivity - Stop an SAP mass activity run
SAP_PI_GetChannelStatus - Retrieves the current status of an SAP XI/PI channel
SAP_PI_ImportChannels - Imports SAP XI/PI channels
SAP_PI_StartChannel - Starts an SAP XI/PI channel
SAP_PI_StopChannel - Stops an SAP XI/PI channel
SAP_RaiseEvent - Raises a batch event in the SAP system
SAP_ReleaseInterceptedJobs - Releases intercepted SAP jobs
SAP_ReloadApplicationLinks - Reload SAP application link definitions
SAP_RfcAgent_RetrieveOutput - Retrieve SAP output; internal use, only.
SAP_RunTemplateJob - Copy and run an SAP batch job
SAP_SetXmiAuditLevel - Sets XMI Log Level
SAP_SolutionManager_AbapRun - Run an ABAP report from SAP Solution Manager
SAP_StoreVariant - Store a variant of an ABAP program
SAP_SwitchOperationMode - Switches the operation mode in the SAP system
SAP_SynchronizeEventHistoryCriteria - Synchronizes the event history criteria with the SAP system
SAP_SynchronizeInterceptionCriteria - Synchronizes the SAP interception criteria with job control rules
SAP_SynchronizeTerminatedCcmsJobs - Checks the status of all terminated SAP jobs

SAP_AbapRun

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

This process 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

Tab	Parameter	Description	Data Type	Default Expression	Default List of Values
Parameters	SAP_SYSTEMS	SAP System	String
Parameters	CLIENT	SAP client	String
Parameters	JOBNAME	SAP job name	String
Parameters	ABAP_PROGRAM_NAME	ABAP program	String
Parameters	ABAP_VARIANT_NAME	ABAP variant	String
Parameters	TEMPORARY_VARIANT	Create temporary variant?	String	`N`	`Y`, `N`
Parameters	JOBCLASS	SAP job class	String	`C`	`A`, `B`, `C`
Parameters	SAP_USER_NAME	SAP user name	String
Parameters	LANGUAGE	SAP language for the step	String
Parameters	TARGET_SERVER	SAP target server name	String
Parameters	TARGET_GROUP	SAP target server group name	String
Parameters	JOBCOUNT	SAP job count stored in Out value	String
Print Parameters	PRINT_ARCMODE	Print/Archive mode	String	`1` (Print only)	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_DESTIN	Printer	String
Print Parameters	PRINT_IMMEDIATE	Print immediately?	String	`N`	`Y`, `N`
Print Parameters	PRINT_RELEASE	Release print job?	String	`N`	`Y`, `N`
Print Parameters	PRINT_COPIES	# of copies	String	`1`
Print Parameters	PRINT_SHOWPASSWD	Authority for printing	String
Print Parameters	PRINT_SAPBANNER	SAP cover page?	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_BANNERPAGE	Selection cover sheet?	String	`N`	`Y`, `N`
Print Parameters	PRINT_EXPIRATION	Expiration in days	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_RECIPIENT	Spool list recipient	String
Print Parameters	PRINT_NUMLINES	Print lines per page	String
Print Parameters	PRINT_NUMCOLUMNS	Print columns per page	String
Archive Parameters	ARCHIVE_SAPOBJECT	Archive SAP object	String
Archive Parameters	ARCHIVE_OBJECT	Document type	String
Archive Parameters	ARCHIVE_INFO	Archive info	String
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
Job Output Parameters	DELETE_JOB	Delete job when finished?	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

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

Waiting for SAP Events

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 process definition and modify the duplicate.

Retrieving Spool Output as PDF

By duplicating the AbapRun process definitions and changing the default output format for the process definition to PDF, you can force the SAP system to convert the Spool to PDF. This way, you can see colors, if there are any. This should work if you can retrieve the spool as PDF from within SAPGui.

Additional Print Parameters

The additional print parameters can be generated when importing CCMS jobs by setting the parameter Generate Extra Print Parameters? (EXTENDED_PRINT_PARAMETERS) to Yes.

It is also possible to duplicate any of the AbapRun process definitions and add the parameters there. The following parameters are recognized:

EMAIL_ADDRESS - The email address for the mail printer
PAGE_FROM / PAGE_TO - page range, numeric values
DRAFT_MODE - draft mode. Valid values: Y (Yes) and N (No)
PAGE_ORIENTATION - page orientation. Valid values: L (Landscape) and P (Portrait)

note

Due to the limited size of the field in SAP, the max length of the email address is limited to 50 characters.

note

According to SAP Note 513352, printing with access method "M" (email printer) will not be developed further.

Retrieving Part of the Job Log

You can retrieve part of the job log by duplicating one of the AbapRun process definitions and specifying one of the following parameters:

JOBLOG_FIRST_LINES - retrieve the first <n> lines of the job log
JOBLOG_LAST_LINES - retrieve the last <n> lines of the job log

When filled with a value > 0, only the given number of lines either from the beginning or from the end of the joblog is retrieved.

Temporary Variants

By duplicating the AbapRun process definitions and adding job parameters, you can make use of temporary variants. A temporary variant is created for the job and deleted once the job has finished.

You specify the values and select options by creating job parameters with names matching the technical name of the parameter or select option and setting Create Temporary Variant? or TEMPORARY_VARIANT to Y. You can use the SAP Object Editor to inspect previously imported variants for the specific names, see Creating and Modifying Variants in Redwood Server for more information.

More Information

Handling ABAP programs

SAP_AbapRunPrint

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

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

This process 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

Tab	Parameter	Description	Data Type	Default Expression	Default List of Values
Parameters	SAP_SYSTEMS	SAP System	String
Parameters	CLIENT	SAP client	String
Parameters	JOBNAME	SAP job name	String
Parameters	ABAP_PROGRAM_NAME	ABAP program	String
Parameters	ABAP_VARIANT_NAME	ABAP variant	String
Parameters	TEMPORARY_VARIANT	Create temporary variant?	String	`N`	`Y`, `N`
Parameters	JOBCLASS	SAP job class	String	`C`	`A`, `B`, `C`
Parameters	SAP_USER_NAME	SAP user name	String
Parameters	LANGUAGE	SAP language for the step	String
Parameters	TARGET_SERVER	SAP target server name	String
Parameters	TARGET_GROUP	SAP target server group name	String
Parameters	JOBCOUNT	SAP job count stored in Out value	String
Print Parameters	PRINT_ARMOD	Print/Archive mode	String	`1` (Print only)	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_PDEST	Printer	String
Print Parameters	PRINT_PRTXT	Cover Page Title	String
Print Parameters	PRINT_PRCOP	# of copies	String	`1`
Print Parameters	PRINT_PRNEW	New spool?	String	`Y`	`Y`, `N`
Print Parameters	PRINT_PLIST	Spool list name	String
Print Parameters	PRINT_PRIMM	Print immediately?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRREL	Release print job?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PEXPI	Expiration in days	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_LICT	Print lines per page	String
Print Parameters	PRINT_LISZ	Print columns per page	String
Print Parameters	PRINT_PAART	Print format	String
Print Parameters	PRINT_PRBIG	Selection cover sheet?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRSAP	SAP cover page?	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_PRREC	Spool list recipient	String
Print Parameters	PRINT_PRABT	Department on cover page	String
Print Parameters	PRINT_PRBER	Authority for printing	String
Print Parameters	PRINT_PRDSN	Spool dataset name	String
Print Parameters	PRINT_PTYPE	Spool type	String
Print Parameters	PRINT_FOOTL	Print a footer?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRUNX	OS cover sheet?	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	DRAFT_MODE	Draft Mode?	String	`N`	`Y`, `N`
Print Parameters	PAGE_ORIENTATION	Page Orientation	String	(None)	- None `L` - Landscape `P` - Portrait
Print Parameters	NO_FRAME	No Frame Characters	String	`N`	`Y`, `N`
Print Parameters	SMS	Spool list with structure information	String	`N`	`Y`, `N`
Print Parameters	NO_SHADE	Suppress colors/shades when printing	String	`N`	`Y`, `N`
Print Parameters	EMAIL_ADDRESS	E-Mail address (only for mail printer)	String
Archive Parameters	ARCHIVE_ARCTEXT	Archive text information field	String
Archive Parameters	ARCHIVE_AR_OBJECT	Document type	String
Archive Parameters	ARCHIVE_INFO	Archive info	String
Archive Parameters	ARCHIVE_SAP_OBJECT	Archive SAP object	String
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
Job Output Parameters	DELETE_JOB	Delete job when finished?	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

Waiting for SAP Events

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 process definition and modify the duplicate.

Retrieving Spool Output and Log as Different Formats

When the EnableFLParameters registry does not exist (default) or is set to true, the FL_SHOWSPOOL, FL_SHOWLOG, and FL_SHOWAPPLLOG parameters are available. They override the SHOWSPOOL, SHOWLOG, and SHOWAPPLOG parameters, respectively, and allow you to specify one or more formats for the output, log, and application log files.

By duplicating the AbapRun process definitions and adding the FL_SHOWSPOOL parameter (data type String) you specify the format(s) you want to retrieve the spool as. Multiple formats are separated by semi-colon (;), see Spool Output for more information.

Likewise, the FL_SHOWLOG is used to specify the format of the log output. The Standard, PDF, and Text formats are supported; None disables log retrieval. This parameter only accepts a single format, see Log.

Likewise, the FL_SHOWAPPLLOG is used to specify the format of the application log output. Multiple formats can be specified semi-colon separated, see (FL_SHOWSPOOL).

The parameters can also be set to None which will not retrieve the file.

This should work if you can retrieve the spool, log, or application log in the desired format from within SAPGui.

Additional Print Parameters

The additional print parameters can be generated when importing CCMS jobs by setting the parameter Generate Extra Print Parameters? (EXTENDED_PRINT_PARAMETERS) to Yes.

It is also possible to duplicate any of the AbapRun process definitions and add the parameters there. The following parameters are recognized:

EMAIL_ADDRESS - The email address for the mail printer
PAGE_FROM / PAGE_TO - page range, numeric values
DRAFT_MODE - draft mode. Valid values: Y (Yes) and N (No)
PAGE_ORIENTATION - page orientation. Valid values: L (Landscape) and P (Portrait)

note

Due to the limited size of the field in SAP, the max length of the email address is limited to 50 characters.

note

According to SAP Note 513352, printing with access method "M" (email printer) will not be developed further.

Retrieving Part of the Job Log

You can retrieve part of the job log by duplicating one of the AbapRun process definitions and specifying one of the following parameters:

JOBLOG_FIRST_LINES - retrieve the first <n> lines of the job log
JOBLOG_LAST_LINES - retrieve the last <n> lines of the job log

When filled with a value > 0, only the given number of lines either from the beginning or from the end of the joblog is retrieved.

Temporary Variants

By duplicating the AbapRun process definitions and adding job parameters, you can make use of temporary variants. A temporary variant is created for the job and deleted once the job has finished.

More Information

Handling ABAP programs

SAP_AbapRunPrintExt

This process definition is used to run ABAP's via the XBP interface in SAP Systems; it 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 process 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

Tab	Parameter	Description	Data Type	Default Expression	Default List of Values
Parameters	SAP_SYSTEMS	SAP System	String
Parameters	CLIENT	SAP client	String
Parameters	JOBNAME	SAP job name	String
Parameters	ABAP_PROGRAM_NAME	ABAP program	String
Parameters	ABAP_VARIANT_NAME	ABAP variant	String
Parameters	TEMPORARY_VARIANT	Create temporary variant?	String	`N`	`Y`, `N`
Parameters	JOBCLASS	SAP job class	String	`C`	`A`,`B`,`C`
Parameters	SAP_USER_NAME	SAP user name	String
Parameters	LANGUAGE	SAP language for the step	String
Parameters	TARGET_SERVER	SAP target server name	String
Parameters	TARGET_GROUP	SAP target server group name	String
Parameters	JOBCOUNT	SAP job count stored in Out value	String
Print Parameters	PRINT_ARMOD	Print/Archive mode	String	`1` (Print only)	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_PDEST	Printer	String
Print Parameters	PRINT_PRTXT	Cover Page Title	String
Print Parameters	PRINT_PRCOP	# of copies	String	`1`
Print Parameters	PRINT_PRNEW	New spool?	String	`Y`	`Y`, `N`
Print Parameters	PRINT_PLIST	Spool list name	String
Print Parameters	PRINT_PRIMM	Print immediately?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRREL	Release print job?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PEXPI	Expiration in days	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_LICT	Print lines per page	String
Print Parameters	PRINT_LISZ	Print columns per page	String
Print Parameters	PRINT_PAART	Print format	String
Print Parameters	PRINT_PRBIG	Selection cover sheet?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRSAP	SAP cover page?	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_PRREC	Spool list recipient	String
Print Parameters	PRINT_PRABT	Department on cover page	String
Print Parameters	PRINT_PRBER	Authority for printing	String
Print Parameters	PRINT_PRDSN	Spool dataset name	String
Print Parameters	PRINT_PTYPE	Spool type	String
Print Parameters	PRINT_FOOTL	Print a footer?	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRUNX	OS cover sheet?	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	DRAFT_MODE	Draft Mode?	String	`N`	`Y`, `N`
Print Parameters	PAGE_ORIENTATION	Page Orientation	String	(None)	- None `L` - Landscape `P` - Portrait
Print Parameters	NO_FRAME	No Frame Characters	String	`N`	`Y`, `N`
Print Parameters	SMS	Spool list with structure information	String	`N`	`Y`, `N`
Print Parameters	NO_SHADE	Suppress colors/shades when printing	String	`N`	`Y`, `N`
Print Parameters	EMAIL_ADDRESS	E-Mail address (only for mail printer)	String
Archive Parameters	ARCHIVE_ARCTEXT	Archive text information field	String
Archive Parameters	ARCHIVE_AR_OBJECT	Document type	String
Archive Parameters	ARCHIVE_INFO	Archive info	String
Archive Parameters	ARCHIVE_SAP_OBJECT	Archive SAP object	String
Recipient Parameters	REC_TYPE	Recipient type	String	`U` (Internet User)	`U` (Internet User) `B` (SAP user) `O` (SAP-Office user) `P` (Personnel distribution list) `C` (Shared distribution list) `F` (Fax number) `A` (External User)
Recipient Parameters	REC_RECIPIENT	Spool list recipient	String
Recipient Parameters	REC_COPY	Recipient copy flag	String	`N`	`Y`, `N`
Recipient Parameters	REC_BLIND_COPY	Recipient blind copy flag	String	`N`	`Y`, `N`
Recipient Parameters	REC_EXPRESS	Recipient express flag	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_FORWARDING	Recipient no forwarding flag	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_PRINT	Recipient no print flag	String	`N`	`Y`, `N`
Recipient Parameters	REC_DELIVER	Report send status	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Recipient Parameters	REC_MAILSTATUS	Report status by e-mail	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	DELETE_JOB	Delete job when finished?	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

Waiting for SAP Events

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 process definition and modify the duplicate.

Retrieving Spool Output as PDF

Additional Print Parameters

The additional print parameters can be generated when importing CCMS jobs by setting the parameter Generate Extra Print Parameters? (EXTENDED_PRINT_PARAMETERS) to Yes.

It is also possible to duplicate any of the AbapRun process definitions and add the parameters there. The following parameters are recognized:

EMAIL_ADDRESS - The email address for the mail printer
PAGE_FROM / PAGE_TO - page range, numeric values
DRAFT_MODE - draft mode. Valid values: Y (Yes) and N (No)
PAGE_ORIENTATION - page orientation. Valid values: L (Landscape) and P (Portrait)

note

Due to the limited size of the field in SAP, the max length of the email address is limited to 50 characters.

note

According to SAP Note 513352, printing with access method "M" (email printer) will not be developed further.

Retrieving Part of the Job Log

You can retrieve part of the job log by duplicating one of the AbapRun process definitions and specifying one of the following parameters:

JOBLOG_FIRST_LINES - retrieve the first <n> lines of the job log
JOBLOG_LAST_LINES - retrieve the last <n> lines of the job log

When filled with a value > 0, only the given number of lines either from the beginning or from the end of the joblog is retrieved.

Temporary Variants

By duplicating the AbapRun process definitions and adding job parameters, you can make use of temporary variants. A temporary variant is created for the job and deleted once the job has finished.

More Information

Handling ABAP programs

SAP_ACC_Controller

This process definition allows you to control (for example start and stop) SAP application services via Adaptive Computing Controller - Controller Command Interface (ACC-CCI).

Parameters

Parameter	Description	Direction	Data Type	Default Value	Values
Url	URL of the ACC-CCI interface	In	String
Username	User name	In	String
Password	Password	In	String
Command	ACC-CCI Command	In	String
ServiceId	Service Id	In	String
Hostname	Hostname	In	String
ForceSmallServer	Force start on small server?	In	String	`false`	`true`, `false`
ReplyLog	Get reply log	In	String	`true`	`true`, `false`

More Information

Controlling SAP Adapting Computing Environments with Redwood Server

SAP_BObj_DataServicesJobRun

Runs a Data Services job.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String
DS_REPO_NAME	Repository name	In	String
DS_JOB_NAME	Job name	In	String
DS_JOB_SERVER	Job server	In	String
DS_JOB_SERVER_GROUP	Job server group	In	String

SAP_BObj_GenerateReportDefinition

Generates a process definition of an SAP BusinessObjects report in the scheduler repository.

Parameters

Parameter	Description	Direction	Data Type	Default Value	Values
SAP_SYSTEMS	SAP System	In	String
REPORT_PATH	Report path	In	String
REPORT_CUID	Report CUID	In	String
OVERWRITE	Overwrite Existing Job Definitions?	In	String	`Y`	`Y`, `N`
JOBDEF_NAME	Name of Generated Job Definition	In	String
APPLICATION	Application	In	String
PARTITION	Partition	In	String
GENERATE_DESTINATION_PARAMS	Generate destination parameters?	In	String

The Report path (REPORT_PATH) parameter accepts the path to the report within BusinessObjects (for example Feature Samples/Drilldown); note that this is the path in the user interface, not the path on the file system. The folder Public Folder is implied and should not be specified. You may use wildcards, however, no more than 200 reports will be imported; this is a limitation of the BusinessObjects API. Also, /**/*/ is added to the end of the report folder if you omit it; /**/ means sub-folders. You may specify the SI_KIND in the value as such //InfoObjects/Root Folder/**/*[SI_KIND='Webi'] or //InfoObjects/Root Folder/**/*[SI_KIND='CrystalReport'].

SAP_BObj_ImportReportDefinitions

Imports SAP BusinessObjects reports into the scheduler repository.

Parameters

Tab	Parameter	Description	Documentation	Direction	Data Type	Default Value	Values
Parameters	SAP_SYSTEMS	SAP System	SAP BusinessObjects system to import from	In	String
Parameters	REPORT_PATH	Report path	The report path; `Public Folder` is implied	In	String
Parameters	TEST_RUN	Test run?	By default, the definition will import nothing and generate a list of definitions it would have imported if Test run? had been set to `Y`	In	String	`Y`	`Y` - Do not actually perform the import `N` - Import the definitions
Generation Settings	JOBDEF_NAME	Name of Generated Definition	By default, the definition will have the report name as found in BusinessObjects; this parameter allows you to specify a name or prefix	In	String
Generation Settings	JOBNAME_GENERATION	Use name as	This parameter specifies how the value specified in `JOBDEF_NAME` is to be used, as a definition name or a prefix to the report name	In	String	`F`	`F` Name of definition - Use the name specified in `JOBDEF_NAME` as the definition name `P` Prefix in front of source name - Use the name specified in `JOBDEF_NAME` as a prefix in front of the report name
Generation Settings	OVERWRITE	Overwrite Existing Definitions?	By default, the import process will overwrite any existing definitions in Redwood Server.	In	String	`Y`	`Y` - Overwrite existing process definitions `N` - Do not overwrite any process definitions
Generation Settings	APPLICATION	Application	Application to assign to imported definitions	In	String
Generation Settings	PARTITION	Partition	Partition to assign to imported definitions	In	String
Generation Settings	GENERATE_DESTINATION_PARAMS	Generate destination parameters?	Add Destination parameters to the generated definitions to allow you to send the report via email or FTP, place it into a user's Inbox, or store it on the file system	In	String	`Y`	`Y` - Generate Destination parameters `N` - Do not generate Destination parameters

SAP_BObj_ReportRun

Start SAP BusinessObjects reports from within Redwood Server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
SAP_SYSTEMS	SAP System	SAP BusinessObjects system to import from	In	String
REPORT_PATH	Report path	The report path; `Public Folder` is implied	In	String
REPORT_CUID	Report CUID	The `CUID` of the report as found in the report properties in BusinessObjects	In Out	String
REPORT_ID	Report Id	The `ID` of the report as found in the report properties in BusinessObjects	Out	String
REPORT_KIND	Report Kind	The process will detect the report type and fill this parameter when the report ran successfully	Out	String

SAP_BObj_TriggerEvent

Triggers an event of type Custom in the SAP BusinessObjects system. Note that events of type File or Schedule are used by SAP BusinessObjects and cannot be triggered.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String
EVENT_ID	Event	In	String

SAP_BW_GenerateInfoPackageGroup

Generate an InfoPackage group in an SAP System.

Parameters

Parameter	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 process definition	In	String
OVERWRITE	Overwrite existing process definitions?	In	String	`Y`
PARTITION	Partition	In	String
APPLICATION	Application	In	String
SHOWLOG	Retrieve job log?(*)	In	String	`Y`

SAP_BW_GenerateJobDefinition

Generates the definition of a single BW process chain job in the scheduler repository. Submit this process definition to start the BW process chain from within Redwood Server.

Parameters

Tab	Parameter	Description	Direction	Data Type	Default Value	Values
Parameters	SAP_SYSTEMS	SAP System	In	String
Parameters	PCHAIN_NAME	Technical Name of SAP BW Process Chain	In	String
Parameters	CCMS_JOB_DEFINITION	Template CCMS process definition to use for generated process definitions.	In	String
Parameters	CLIENT	Target Client; the client the process will use.	In	String
Generation Settings	OVERWRITE	Overwrite Existing Job Definitions?	In	String	`N`	`Y`, `N`
Generation Settings	JOBDEF_NAME	Name of Generated Job Definition	In	String
Generation Settings	APPLICATION	Application	In	String
Generation Settings	PARTITION	Partition	In	String
Generation Settings	CHAIN_RESTARTABLE	Make Processes Restartable If Errors Occur?	In	String	`F`	`F` (Failed) `A` (All) `N` (Not restartable)
Generation Settings	SYNCHRONOUS	Synchronous Run?	In	String	`N`	`Y`, `N`
Job Output Parameters	SHOWLOG	Retrieve Job Log?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve Spool Lists?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?	In	String	`N`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`Y`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

SAP_BW_ImportInfoPackageGroups

Import InfoPackage groups from an SAP System.

Parameter

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String

SAP_BW_ImportInfoPackages

Import InfoPackages.

Parameters

Parameter	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	Data source of the SAP BW InfoPackage	In	String

SAP_BW_ImportProcessChainDefinition

Import the definition of a Process Chain.

Parameters

Parameter	Description	Direction	Data Type	Default Expression	Values
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`	`Y`, `N`

More Information

Running Process Chains

SAP_BW_ImportProcessChains

Import process chains.

Parameters

Tab	Parameter	Description	Direction	Data Type	Default Expression	Values
Parameters	SAP_SYSTEMS	SAP System	InOut	String
Parameters	PCHAIN_NAME	Technical Name of SAP BW Process Chain	In	String
Parameters	PCHAIN_TEXT	Description of SAP BW Process Chain	In	String
Parameters	MAX_COUNT	Maximum Count	In	Number
Parameters	IMPORT_CHAIN_DEFINITION	Import Process Chain Definition?	In	String	`N`	`Y`, `N`
Parameters	CREATE_JOBDEFS	Create a Job Definition?	In	String	`N`	`Y`, `N`
Parameters	DROP_OLD_SELECTION	Drop Old Matching Values?	In	String	`Y`	`Y`, `N`
Parameters	TEST_RUN	Test run?	In	String	`N`	`Y`, `N`
Parameters	CCMS_JOB_DEFINITION	Template CCMS process definition to use for generated process definitions. Applicable when parameter Create a Job Definition? (`CREATE_JOBDEFS`) is set to `Y`	In	String
Parameters	CLIENT	Target Client; the client the process will use.	In	String
Generation Settings	NAME	Name of Generated Job Definition	In	String
Generation Settings	JOBNAME_GENERATION	Use name as	In	String	`F`	`F` Name of definition - Use the name specified in `JOBDEF_NAME` as the definition name `P` Prefix in front of source name - Use the name specified in `JOBDEF_NAME` as a prefix in front of the report name
Generation Settings	APPLICATION	Application	In	String
Generation Settings	PARTITION	Partition	In	String
Generation Settings	OVERWRITE	Overwrite Existing Job Definitions?	In	String	`Y`	`Y`, `N`
Generation Settings	CHAIN_RESTARTABLE	Make Processes Restartable If Errors Occur?	In	String	`F`	`F` (Failed) `A` (All) `N` (Not restartable)
Generation Settings	SYNCHRONOUS	Synchronous Run?	In	String	`N`	`Y`, `N`
Generation Settings	SIMULATE	Simulate Run?	In	String	`N`	`Y`, `N`
Generation Settings	NOPLAN	No Plan?	In	String	`N`	`Y`, `N`
Job Output Parameters	SHOWLOG	Retrieve Job Log?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve Spool Lists?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?	In	String	`N`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`Y`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

More Information

Running Process Chains

SAP_BW_InfopackageRun

This process definition is used to run InfoPackages in SAP BW.

Parameters

Parameter	Description	Data Type	Direction	Default Expression	Values
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 job log?(*)	In	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`Y`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

SAP_BW_MaintainProcessChainDefinition

Maintain the definition of a Process Chain.

Parameters

Parameter	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 process definition represents a process of a BW Process Chain. It is not supposed to be scheduled by the user.

Parameters

Group	Parameter	Description	Data Type	Default Expression	Values
Parameters	NAME	SAP BW process name	String
Parameters	ID	SAP BW process id	String
Parameters	TYPE	SAP BW process type	String
Parameters	LOGID	SAP BW process chain logid	String
Parameters	JOBCOUNT	SAP BW Process Batch Job Count	String
Parameters	CCMS_JOB_DEFINITION	Template CCMS process definition to use for generated process definitions.	In	String
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	String	`Y`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
Job Output Parameters	JOBCOUNT	SAP BW process batch job count	String

SAP_BW_ProcessChain

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

Parameters

Parameter	Description	Direction	Data Type	Default Expression	Values
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`	`Y`, `N`
SIMULATE	Simulate run?	In	String	`N`	`Y`, `N`
NOPLAN	No plan?	In	String	`N`
SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`Y`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`

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

Parameter	Description	Direction	Data Type	Default Expression	Values
SAP_SYSTEMS	SAP System	In	String
CLIENT	SAP Client	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 job log?(*)	In	String	`N`	`Y`, `N`

More Information

Restarting Process Chains

SAP_BW_RestartProcessChain

Parameters

Parameter	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 process definition is used to run BW Process Chains in SAP.

Parameters

Parameter	Description	Data Type	Default Expression	Default List of Values
SAP_SYSTEMS	SAP System	String
CLIENT	SAP Client	String
NAME	Technical name of the SAP BW Process Chain	String
CHAIN_RESTARTABLE	Make processes restartable on error?	String	`F` (Failed)	`F` (Failed) `A` (All) `N` (Not restartable)
LOGID	SAP BW process chain LogID	String
SYNCHRONOUS	Synchronous run?	String	`N`	`Y`, `N`
SIMULATE	Simulate run?	String	`N`	`Y`, `N`
NOPLAN	No plan?	String	`N`	`Y`, `N`
SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

SAP_CcmsJob

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

You can duplicate it and set it on the SAP System to customize all processes scheduled by that remote SAP system, for example.

Parameters

Parameter	Description	Data Type	Default Expression	Values
CLIENT	SAP client	String
DELETE_JOB	Delete job when finished?	String	`N`	`Y`, `N`
JOBCOUNT	SAP job count	String
JOBNAME	SAP job name	String
SAP_USER_NAME	SAP user name	String
SHOWLOG	Retrieve job log?(*)	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	String	`Y`	`Y`, `N`

SAP_CcmsJobCheckStatus

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

Parameters

Parameter	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
JOB_DB_STATUS	Job status according to database	Out	String

SAP_CcmsJobGetApplicationLog

Get an application log of an SAP batch job.

Parameters

Parameter	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_CcmsJobGetApplicationLogExt

Get an application log of an SAP batch job in different formats.

Parameters

Group	Parameter	Description	Direction	Data Type	Default Value	Values
Parameters	SAP_SYSTEMS	SAP System	In Out	String
Parameters	CLIENT	SAP Client	In Out	String
Parameters	JOBNAME	SAP Job Name	In	String
Parameters	ABAP_PROGRAM_NAME	ABAP Program	In	String	`SBAL_DISPLAY_2`
Parameters	ABAP_VARIANT_NAME	ABAP Variant	In Out	String
Parameters	TEMPORARY_VARIANT	Create Temporary Variant?	In	String	`Y`	`Y`, `N`
Parameters	JOBCLASS	SAP Job Class	In	String	`C`	`A`, `B`, `C`
Parameters	SAP_USER_NAME	SAP User Name	In Out	String
Parameters	LANGUAGE	SAP Language for the Step	In Out	String
Parameters	TARGET_SERVER	SAP Target Server Name	In Out	String
Parameters	TARGET_GROUP	SAP Target Server Group Name	In	String
Parameters	JOBCOUNT	SAP Job Count	Out	String
Parameters	SEL_SO_HDL	LogHandler	In	String
Parameters	FL_SHOWSPOOL	FL_SHOWSPOOL	In	String
Parameters	PAR_PA_DF	Date from	In	String
Parameters	PAR_PA_TF	Time from	In	String	`000000`
Parameters	PAR_PA_DT	Date to	In	String
Parameters	PAR_PA_TT	Time to	In	String	`235959`
Print Parameters	PRINT_ARCMODE	Print/Archive Mode	In	String	`1`	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_DESTIN	Printer	In	String
Print Parameters	PRINT_IMMEDIATE	Print Immediately?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_RELEASE	Delete Spool After Print?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_COPIES	Number of Copies	In	String	`1`
Print Parameters	PRINT_SHOWPASSWD	Authority for Printing	In	String
Print Parameters	PRINT_SAPBANNER	SAP Cover Page?	In	String	`D`	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_BANNERPAGE	Selection Cover Page?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_EXPIRATION	Expiration in Days	In	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_RECIPIENT	Spool List Recipient	In	String
Print Parameters	PRINT_NUMLINES	Print Lines per Page	In	String
Print Parameters	PRINT_NUMCOLUMNS	Print Columns per Page	In	String
Archive Parameters	ARCHIVE_SAPOBJECT	Archive SAP Object	In	String
Archive Parameters	ARCHIVE_OBJECT	Document Type	In	String
Archive Parameters	ARCHIVE_INFO	Archive Information	In	String
Job Output Parameters	SHOWLOG	Retrieve Job Log?	In	String	`N`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve Spool Lists?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?	In	String	`N`	`Y`, `N`
Job Output Parameters	IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
Job Output Parameters	DELETE_JOB	Delete job when finished?	In	String	`N`	`Y`, `N`

SAP_CcmsJobGetApplicationLogHandles

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

Parameters

Parameter	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

Parameter	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.

Parameter	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	Spool list 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

Parameter	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

Parameter	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

Parameter	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
JOBNAME_1	SAP Job Name 1	In	String
JOBCOUNT_1	SAP Job Count 1	In	String
JOB_STATUS_1	SAP Status 1	Out	String
JOBNAME_2	SAP Job Name 2	In	String
JOBCOUNT_2	SAP Job Count 2	In	String
JOB_STATUS_2	SAP Status 2	Out	String
JOBNAME_3	SAP Job Name 3	In	String
JOBCOUNT_3	SAP Job Count 3	In	String
JOB_STATUS_3	SAP Status 3	Out	String
JOBNAME_4	SAP Job Name 4	In	String
JOBCOUNT_4	SAP Job Count 4	In	String
JOB_STATUS_4	SAP Status 4	Out	String
JOBNAME_5	SAP Job Name 5	In	String
JOBCOUNT_5	SAP Job Count 5	In	String
JOB_STATUS_5	SAP Status 5	Out	String
JOBNAME_6	SAP Job Name 6	In	String
JOBCOUNT_6	SAP Job Count 6	In	String
JOB_STATUS_6	SAP Status 6	Out	String
JOBNAME_7	SAP Job Name 7	In	String
JOBCOUNT_7	SAP Job Count 7	In	String
JOB_STATUS_7	SAP Status 7	Out	String
JOBNAME_8	SAP Job Name 8	In	String
JOBCOUNT_8	SAP Job Count 8	In	String
JOB_STATUS_8	SAP Status 8	Out	String
JOBNAME_9	SAP Job Name 9	In	String
JOBCOUNT_9	SAP Job Count 9	In	String
JOB_STATUS_9	SAP Status 9	Out	String
JOBNAME_10	SAP Job Name 10	In	String
JOBCOUNT_10	SAP Job Count 10	In	String
JOB_STATUS_10	SAP Status 10	Out	String

SAP_ClosingCockpit_AbapRun

Run an ABAP report from SAP Closing Cockpit.

Parameters

Tab	Parameter	Description	Direction	Data Type	Default Expression	Default List of Values
Parameters	SAP_SYSTEMS	SAP System	In	String
Parameters	CLIENT	SAP client	In	String
Parameters	JOBNAME	SAP job name	In	String
Parameters	ABAP_PROGRAM_NAME	ABAP program	In	String
Parameters	ABAP_VARIANT_NAME	ABAP variant	In	String
Parameters	TEMPORARY_VARIANT	Create temporary variant?	In	String	`N`	`Y`, `N`
Parameters	JOBCLASS	SAP job class	In	String	`C`	`A`, `B`, `C`
Parameters	SAP_USER_NAME	SAP user name	In	String
Parameters	TARGET_SERVER	SAP target application server name	In	String
Parameters	JOBDOCID	Job documentation ID	In	String
Print Parameters	PRINT_ARMOD	Print/Archive mode	In	String	`1` (Print only)	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_PDEST	Printer	In	String
Print Parameters	PRINT_PRTXT	Cover sheet title	In	String
Print Parameters	PRINT_PRCOP	# of copies	In	String	`1`
Print Parameters	PRINT_PRNEW	New spool?	In	String	`Y`	`Y`, `N`
Print Parameters	PRINT_PLIST	Spool list name	In	String
Print Parameters	PRINT_PRIMM	Print immediately?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRREL	Release print job?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PEXPI	Expiration in days	In	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_LICT	Print lines per page	In	String
Print Parameters	PRINT_LISZ	Print columns per page	In	String
Print Parameters	PRINT_PAART	Print format	In	String
Print Parameters	PRINT_PRBIG	Selection cover sheet?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRSAP	SAP cover page?	In	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_PRREC	Spool list recipient	In	String
Print Parameters	PRINT_PRABT	Department on cover page	In	String
Print Parameters	PRINT_PRBER	Authority for printing	In	String
Print Parameters	PRINT_PRDSN	Spool dataset name	In	String
Print Parameters	PRINT_PTYPE	Spool type	In	String
Print Parameters	PRINT_FOOTL	Print a footer?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRUNX	OS cover sheet?	In	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Archive Parameters	ARCHIVE_SAP_OBJECT	Archive SAP object	In	String
Archive Parameters	ARCHIVE_AR_OBJECT	Document type	In	String
Archive Parameters	ARCHIVE_INFO	Archive info	In	String
Archive Parameters	ARCHIVE_ARCTEXT	Archive text information field	In	String
Recipient Parameters	REC_RECIPIENT	Spool list recipient	In	String
Recipient Parameters	REC_TYPE	Recipient type	In	String	`U` (Internet User)	`U` (Internet User) `B` (SAP user) `O` (SAP-Office user) `P` (Personnel distribution list) `C` (Shared distribution list) `F` (Fax number)
Recipient Parameters	REC_COPY	Recipient copy flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_BLIND_COPY	Recipient blind copy flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_EXPRESS	Recipient express flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_FORWARDING	Recipient no forwarding flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_PRINT	Recipient no print flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_DELIVER	Report send status	In	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Recipient Parameters	REC_MAILSTATUS	Report status by e-mail	In	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Closing Cockpit Parameters	SAP_CC__LDAY_P	Closing key day (as single value)	In	String
Closing Cockpit Parameters	SAP_CC__LDAY_S	Closing key day (as range)	In	String
Closing Cockpit Parameters	SAP_CC__PERIOD_P	Period (as single value)	In	String
Closing Cockpit Parameters	SAP_CC__PERIOD_S	Period (as range)	In	String
Closing Cockpit Parameters	SAP_CC__GJAHR_P	Financial year (as single value)	In	String
Closing Cockpit Parameters	SAP_CC__GJAHR_S	Financial year (as range)	In	String
Closing Cockpit Parameters	SAP_CC_RESPONSIBLE	Responsible	In	String
Closing Cockpit Parameters	SAP_CC_EXECUTIVE	Executioner	In	String
Closing Cockpit Parameters	SAP_CC_ESTIMATED_RUNTIME	Estimated runtime	In	Number
Closing Cockpit Parameters	SAP_CC_MAX_START_DELAY	Max. start delay	In	Number
Closing Cockpit Parameters	SAP_CC_CONTEXT_ID	Context ID	In	String
Closing Cockpit Parameters	SAP_CC_CONTEXT_DESCR	Context descriptions	In	String
Closing Cockpit Parameters	SAP_CC_EXE_USR_SMTP	Executioner user email address	In	String
Closing Cockpit Parameters	SAP_CC_RES_USR_SMTP	Responsible user email address	In	String
Closing Cockpit Parameters	SAP_CC_SMTP_SERVER	SMTP server	In	String
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSTAT	Retrieve job statistics?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	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

Parameter	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_CopyParameters

Add all missing parameters and constraints of the source ABAP job definition to the target ABAP job definition.

Parameters

Parameter	Description	Direction	Data Type	Default Value
TARGET_JOBDEF	Target Definition	In	String
SOURCE_JOBDEF	Source Definition	In	String

SAP_CopyVariant

Copy a variant from Redwood Server or from one SAP System to another.

Parameters

Parameter	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_ConvertSpoolFileToRtx

This process definition converts SAP spool to Redwood RTX.

Parameters

Name	Description	Documentation	Data Type	Direction	Default Expression	Values
spoolFile	Spool file	The SAP spool file	File	In
SAP_SYSTEMS	SAP System		String	In
CLIENT	SAP Client		String	In
ABAP_PROGRAM_NAME	ABAP Program Name		String	In
tableName	Table name		String	In
ABAP_VARIANT_NAME	Layout		String	In
SAP_USER_NAME	User name for user-specific storage		String	In
excludedFields	Excluded fields	List of fields that are not shown in the Spoolfile, although the Layout included these fields	String	In
language	Language	The language in SAP, which is used to generate the spool file. This is needed to be able to convert text to numbers or dates.	String	In
integerPattern	Whole number pattern	The pattern to use for the conversion of INT1, INT2 and INT4 values to whole numbers.	String	In
floatingPointPattern	Floatingpoint number pattern	The pattern to use for the conversion of QUAN and FLTP values to floating point numbers	String	In
currencyPattern	Amounts pattern	The pattern to use for the conversion of DEC and CURR (amounts) values to floating point numbers	String	In
datePattern	Date pattern	The pattern to use for the conversion of DATS (date) values to dates	String	In
decimalSeparator	Decimal separator		Character	In
groupingSeparator	Grouping separator		Character	In
exponentSeparator	Exponent separator		String	In
minusSign	Minus sign		Character	In
percent	Percent sign		Character	In
perMill	Permill sign		Character	In
zeroDigit	Zero digit		Character	In
tableDescriptions	Table descriptions	The descriptions of the tables in their Metadata in the resulting RTX output	String	In
rowKeyFormat	Format of row keys	The format of the keys of the rows in the resulting RTX output. The supported formats are `none`, `id` or `idPageRow`.	String	In	`none`	`none` `rownum` `idPageRow`
headerExtractionPatterns	Regular expressions to extract additional columns.	These regular expressions are matched with lines outside tables. When they match, the name of named groups will be added as additional columns to the next table and the value of these named groups will be the column values in the following rows of that table.	String	In
tableCount	Number of tables extracted from the spool file		Number	Out
tables	Tables extracted from the spool file		String	Out
totalRowCount	Total of rows parsed (sum of all rows of all tables)		Number	Out
rowCounts	Rows parsed per table		Number	Out

SAP_ConvertSpoolFileToRtxLowLevel

This process definition converts SAP spool to Redwood RTX.

Parameters

Name	Description	Documentation	Data Type	Direction	Default Expression	Values
spoolFile	Spool file	The SAP spool file	File	In
minimumNumberOfColumns	Minimum number of columns	Only convert tables from the SAP spool file that have a least this number of columns	Number	In		`=0 <= value && value <= Logic.nvl(parameters.maximumNumberOfColumns, 2147483647)`
maximumNumberOfColumns	Maximum number of columns	Only convert tables from the SAP spool file that have a most this number of columns	Number	In		`=value >= Logic.nvl(parameters.minimumNumberOfColumns, 0)`
columnNames	Column names to use in the output RTX	Column names to use in the output RTX	String	In
columnWidths	Column widths	Mandatory, when the table in the SAP spoolfile is not separated by a vertical bar (pipe). When specified, only the tables with these column widths are converted.	Number	In		`=value >= 0`
sapDataTypes	SAP data types	The SAP data types of the columns. This is also used to convert it to the correct data types in the RTX output.	String	In		`ACCP`=Posting period. `CHAR`=Fixed-length character string. `CLNT`=Client field. `CUKY`=Currency key. Fields of this type are referenced by fields of type `CURR`. `CURR`=Currency field. Corresponds to the `DEC` field. Field refers to a field of type `CUKY`. `DATS`=Date values. `DEC`=Calculation/amount field. `DF16_RAW`=Normalized decimal floating point number `DF16_SCL`=Scaled decimal floating point number `DF34_RAW`=Normalized decimal floating point number. `DF34_SCL`=Scaled decimal floating point number `FLTP`=Floating-point number. `INT1`=Very small signed, exact whole number. `INT2`=Small signed, exact whole number. `INT4`=Regular signed, exact whole number. `LANG`=Language key, which has its own field format for special functions. `LCHR`=Fixed-length character string. `LRAW`=Uninterpreted varying-length byte string. `NUMC`=Text string. `PREC`=The precision of a `QUAN` field. `QUAN`=A quantity that corresponds to the `DEC` field. `RAW`=An uninterpreted byte string. `RAWSTRING`=Byte sequence `SSTRING`=Short Character string `STRING`=Character string `TIMS`=Time value. `UNIT`=Units key and referenced by a `QUAN` data type. `VARC`=Varying-length character string data.
shortColumnDescriptions	Short column descriptions	The short column descriptions; if any of the column description parameters are set, only tables that match the relevant column descriptions in the column-headers are converted	String	In
mediumColumnDescriptions	Medium column descriptions	The medium column descriptions; if any of the column description parameters are set, only tables that match the relevant column descriptions in the column-headers are converted	String	In
longColumnDescriptions	Long column descriptions	The long column descriptions; if any of the column description parameters are set, only tables that match the relevant column descriptions in the column-headers are converted	String	In
language	Language	The language in SAP, which is used to generate the spool file. This is needed to be able to convert text to numbers or dates.	String	In
integerPattern	Whole number pattern	The pattern to use for the conversion of `INT1`, `INT2` and `INT4` values to whole numbers.	String	In
zeroDigit	Zero digit		Character	In
tableDescriptions	Table descriptions	The descriptions of the tables in their Metadata in the resulting RTX output	String	In
rowKeyFormat	Format of row keys	The format of the keys of the rows in the resulting RTX output. The supported formats are `none`, `id` or `idPageRow`.	String	In	none	`none` `rownum` `idPageRow`
headerExtractionPatterns	Regular expressions to extract additional columns.	These regular expressions are matched with lines outside tables. When they match, the name of named groups will be added as additional columns to the next table and the value of these named groups will be the column values in the following rows of that table.	String	In
tableCount	Number of tables extracted from the spool file		Number	Out
tables	Tables extracted from the spool file		String	Out
totalRowCount	Total of rows parsed (sum of all rows of all tables)		Number	Out
rowCounts	Rows parsed per table		Number	Out
floatingPointPattern	Floatingpoint number pattern	The pattern to use for the conversion of `QUAN` and `FLTP` values to floating point numbers	String	In
currencyPattern	Amounts pattern	The pattern to use for the conversion of `DEC` and `CURR` (amounts) values to floating point numbers	String	In
datePattern	Date pattern	The pattern to use for the conversion of `DATS` (date) values to dates	String	In
decimalSeparator	Decimal separator		Character	In
groupingSeparator	Grouping separator		Character	In
exponentSeparator	Exponent separator		String	In
minusSign	Minus sign		Character	In
percent	Percent sign		Character	In
perMill	Permill sign		Character	In

SAP_DeleteCcmsMonitors

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

Parameters

Parameter	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_DeleteJobs

Delete SAP Jobs according SAP job name, SAP user, and/or times and dates.

Parameters

Parameter	Description	Direction	Data Type	Default Value
SAP_SYSTEMS	SAP System	In	String
CLIENT	SAP Client	In	String
JOBNAME	SAP Job Name	In	String
JOB_STATUSES	Job statuses to consider	In	String
SAP_USER_NAME	SAP User Name	In	String
FROM_TIMESTAMP	Starting from	In	DateTimeZone
TO_TIMESTAMP	Up to	In	DateTimeZone
TEST_RUN	Test run?	In	String	`Y`

SAP_DeleteVariant

Delete a variant from an SAP System.

Parameters

Parameter	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_ExportRFCFunctionModuleInterface

You use this process definition to export an RFC function module

Parameters

Parameter	Description	Direction	Data Type	Default Expression
SAP_SYSTEMS	SAP System	In	String
FUNCTION_MODULE	Function Module Name	In	String

SAP_ExternalCommandRun

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

Parameters

Parameter	Description	Direction	Data Type	Default Expression	Values
CLIENT	SAP client	In/Out	String
DELETE_JOB	Delete job when finished?	In	String	`Y`	`Y`, `N`
EXT_COMMAND_NAME	External command name	In	String
EXT_COMMAND_PARAMETERS	External command parameters	In	String
JOBCLASS	SAP job class	In	String	`C`	`A`, `B`, `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 job log?(*)	In	String	`Y`	`Y`, `N`
STDERRCNTL	Log external errors to job log?	In	String	`Y`	`Y`, `N`
STDOUTCNTL	Log external output to job log?	In	String	`Y`	`Y`, `N`
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`	`Y`, `N`
WAIT_FOR_TERMINATION	Wait for external termination	In	String	`Y`	`Y`, `N`

Waiting for SAP Events

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 process definition and modify the duplicate.

Retrieving Spool Output as PDF

Additional Print Parameters

The additional print parameters can be generated when importing CCMS jobs by setting the parameter Generate Extra Print Parameters? (EXTENDED_PRINT_PARAMETERS) to Yes.

It is also possible to duplicate any of the AbapRun process definitions and add the parameters there. The following parameters are recognized:

EMAIL_ADDRESS - The email address for the mail printer
PAGE_FROM / PAGE_TO - page range, numeric values
DRAFT_MODE - draft mode. Valid values: Y (Yes) and N (No)
PAGE_ORIENTATION - page orientation. Valid values: L (Landscape) and P (Portrait)

note

Due to the limited size of the field in SAP, the max length of the email address is limited to 50 characters.

note

According to SAP Note 513352, printing with access method "M" (email printer) will not be developed further.

Retrieving Part of the Job Log

You can retrieve part of the job log by duplicating one of the AbapRun process definitions and specifying one of the following parameters:

JOBLOG_FIRST_LINES - retrieve the first <n> lines of the job log
JOBLOG_LAST_LINES - retrieve the last <n> lines of the job log

When filled with a value > 0, only the given number of lines either from the beginning or from the end of the joblog is retrieved.

Temporary Variants

By duplicating the AbapRun process definitions and adding job parameters, you can make use of temporary variants. A temporary variant is created for the job and deleted once the job has finished.

SAP_ExternalProgramRun

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

Parameters

Parameter	Description	Direction	Data Type	Default Expression	Values
CLIENT	SAP client	In/Out	String
DELETE_JOB	Delete job when finished?	In	String	`N`	`Y`, `N`
EXT_PROGRAM_NAME	External program name	In	String
EXT_PROGRAM_PARAMETERS	External program parameters	In	String
JOBCLASS	SAP job class	In	String	`C`	`A`, `B`, `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 job log?(*)	In	String	`Y`	`Y`, `N`
STDERRCNTL	Log external errors to job log?	In	String	`Y`	`Y`, `N`
STDOUTCNTL	Log external output to job log?	In	String	`Y`	`Y`, `N`
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`	`Y`, `N`
WAIT_FOR_TERMINATION	Wait for external termination	In	String	`Y`	`Y`, `N`

Waiting for SAP Events

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 process definition and modify the duplicate.

Retrieving Spool Output as PDF

Additional Print Parameters

The additional print parameters can be generated when importing CCMS jobs by setting the parameter Generate Extra Print Parameters? (EXTENDED_PRINT_PARAMETERS) to Yes.

It is also possible to duplicate any of the AbapRun process definitions and add the parameters there. The following parameters are recognized:

EMAIL_ADDRESS - The email address for the mail printer
PAGE_FROM / PAGE_TO - page range, numeric values
DRAFT_MODE - draft mode. Valid values: Y (Yes) and N (No)
PAGE_ORIENTATION - page orientation. Valid values: L (Landscape) and P (Portrait)

note

Due to the limited size of the field in SAP, the max length of the email address is limited to 50 characters.

note

According to SAP Note 513352, printing with access method "M" (email printer) will not be developed further.

Retrieving Part of the Job Log

You can retrieve part of the job log by duplicating one of the AbapRun process definitions and specifying one of the following parameters:

JOBLOG_FIRST_LINES - retrieve the first <n> lines of the job log
JOBLOG_LAST_LINES - retrieve the last <n> lines of the job log

When filled with a value > 0, only the given number of lines either from the beginning or from the end of the joblog is retrieved.

Temporary Variants

By duplicating the AbapRun process definitions and adding job parameters, you can make use of temporary variants. A temporary variant is created for the job and deleted once the job has finished.

SAP_GenerateCcmsJobDefinition

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

See SAP_ImportCcmsJobs for more information on these parameters.

Parameters

Parameter	Description	Direction	Data Type	Default Expression	Values
ADD_STEP_NUMBERS	Add step numbers to SAP job names?	In	String	`N`	`Y`, `N`
APPLICATION	Application	In	String
CLIENT	SAP client	In	String
CLIENT_SPECIFIC	Generate process definitions for this client only?	In	String	`N`	`Y`, `N`
CREATE_JOBDEFS_FOR_STEPS	Create a process definition for each step?	In	String	`N`	`Y`, `N`
DELETE_JOB	Delete job when finished?	In	String	`N`	`Y`, `N`
EXTENDED_PRINT_PARAMETERS	Generate additional print parameters?	In	String	`N`	`Y`, `N`
GENERATE_RECIPIENTPARAMETERS	Generate recipient parameters?	In	String	`N`	`Y`, `N`
GENERATE_ARCHIVEPARAMETERS	Generate archive parameters?	In	String	`N`	`Y`, `N`
GENERATE_PRINTPARAMETERS	Generate print parameters?	In	String	`N`	`Y`, `N`
JOBCOUNT	SAP job count	In	String
JOBDEF_NAME	Name for the generated process definition	In	String
JOBNAME	SAP job name	In	String
OVERWRITE	Overwrite existing process definitions?	In	String	`Y`	`Y`, `N`
OVERWRITE_LANGUAGE	Force step language	In	String
OVERWRITE_USER	Force step user	In	String
SAP_SYSTEMS	SAP System	In	String
SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
DELETE_JOB	Delete job when finished?	In	String	`N`	`Y`, `N`
TEMPLATE_JDNAME	Template Definition Name	In	String

SAP_GetBatchResources

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

Parameters

Parameter	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 process definition is used to retrieve synchronized batch event history from an SAP System.

Parameters

Parameter	Description	Direction	Data Type
FROM_TIMESTAMP	Starting from	In	DateTimeZone
SAP_SYSTEMS	SAP System	In	String

SAP_GetInstalledComponents

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

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String

SAP_GetSysLog

Retrieves the system log.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String
FROM_TIMESTAMP	Starting from	In	Date Time Zone
TO_TIMESTAMP	Up to	In	Date Time Zone
TARGET_SERVER	SAP Target Server Name	In	String

SAP_GetXmiLog

Retrieves the XMI log.

Parameters

Parameter	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

Parameter	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

Parameter	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 process definition to retrieve the list of application servers in an SAP instance and is mainly used for load balancing. This process definition does not need to be submitted by a user.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String

SAP_ImportArchiveObjects

Imports SAP objects and the document types they support.

note

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

Parameters

Parameter	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 process definition allows you to import SAP batch events, these values are used to create drop-down menus for event history.

note

XBP 3.0 is required.

Parameters

Parameter	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

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String
CALENDAR_TYPE	SAP Calendar type	In	String

More Information

Importing Calendars

SAP_ImportExternalCommands

Import external commands.

Parameter	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 Commands

SAP_ImportCcmsJobs

This process definition is used to import CCMS jobs into Redwood Server. These CCMS jobs can then be scheduled to run through Redwood Server allowing you to use the advanced scheduling features of Redwood Server. The job name and job count parameters may contain wildcard characters. In this case all matching jobs will be imported. This process 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. It is a good practice to create as few parameters as possible on SAP process definitions.

Parameters

Name	Description	Data Type	Direction	Default Expression	Values
SAP_SYSTEMS	SAP System	String	In
CLIENT	SAP Client	String	InOut
JOBNAME	SAP Job Name	String	In
JOBCOUNT	SAP Job Count	String	In
SAP_USER_NAME	SAP User Name	String	In
JOB_STATUSES	Job statuses to consider	String	In
FROM_TIMESTAMP	Starting from	Date Time Zone	In
CLIENT_SPECIFIC	Generate Definitions for This Client Only?	String	In	`N`	`Y`, `N`
TEST_RUN	Test run?	String	In	`N`	`Y`, `N`
JOBDEF_NAME	Name of Generated Definition	String	In
JOBNAME_GENERATION	Use name as	String	In	`F`	`F` Name of definition - Use the name specified in `JOBDEF_NAME` as the definition name `P` Prefix in front of source name - Use the name specified in `JOBDEF_NAME` as a prefix in front of the report name
OVERWRITE	Overwrite Existing Definitions?	String	In	`N`	`Y`, `N`
OVERWRITE_LANGUAGE	Force Step Language	String	In
OVERWRITE_USER	Force Step User	String	In
APPLICATION	Application	String	In
PARTITION	Partition	String	In
CREATE_JOBDEFS_FOR_STEPS	Create a Definition for Each Step?	String	In	`N`	`N` (Never) `A` (ABAP) `S` (Step) `M` (Single process definition)
EXTENDED_PRINT_PARAMETERS	Generate additional print parameters?	String	In	`N`	`Y`, `N`
GENERATE_RECIPIENTPARAMETERS	Generate recipient parameters?	String	In	`N`	`Y`, `N`
GENERATE_ARCHIVEPARAMETERS	Generate archive parameters?	String	In	`N`	`Y`, `N`
GENERATE_PRINTPARAMETERS	Generate print parameters?	String	In	`N`	`Y`, `N`
ADD_STEP_NUMBERS	Add Step Numbers to SAP Job Names?	String	In	`N`	`Y`, `N`
SHOWLOG	Retrieve Job Log?	String	In	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve Spool Lists?	String	In	`N`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?	String	In	`N`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	String	In	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code
DELETE_JOB	Delete job when finished?	String	In	`N`	`Y`, `N`
TEMPLATE_JDNAME	Template Definition Name	String	In

Note that the `JOB_STATUSES` parameter takes a string of CCMS job statuses; the following statuses are valid:

Canceled - The job finished with error, or has been killed.
Finished - The job finished successfully.
Intercepted - The job has been intercepted.
Ready - The job has been picked up by a batch work process but not started yet.
Released - The job has been scheduled and is now waiting for execution according to its start conditions.
ReleaseSuspended - The job has been suspended because an upgrade of the SAP batch system is currently running.
Running - The job is currently running.
Scheduled - The job is created with no start condition.

For example, to match all jobs that have a final state, you specify the following:

Finished, Canceled

More Information

Importing SAP CCMS Jobs

SAP_ImportCcmsMonitors

This process 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

Parameter	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

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

Parameters

Parameter	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	`*`
OUTPUT_DEVICE_CHANGE_TIMESTAMP	Change time stamp (XBP 3.0 only)	DateTimeZone	`*`
DROP_OLD_SELECTION	Drop old selection?	String	`Y`

More Information

Importing Output Devices

SAP_ImportRecipients

This process 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

Parameter	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

Parameter	Description	Direction	Data Type	Default Expression	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
DROP_OLD_SELECTION	Drop old selection?	In	String	`Y`	`Y`, `N`
IMPORT_ABAP_VARIANT	Import AbapProgram/Variant? (optional)	In	String	`N`	`Y`, `N`

More Information

SAP_ImportVariants

Import variants of ABAP programs.

Parameters

Parameter	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 process definition is used to retrieve information about the SAP System, like code-page, version, or list of installed components.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String

SAP_InterceptedJob

note

This process definition is deprecated in favor of SAP_CcmsJob.

This process definition used to represent an SAP batch process that was intercepted in the SAP System. It has been replaced with SAP_CcmsJob and is not supposed to be scheduled by the user.

Parameters

Parameter	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 job log?(*)	String	`Y`
SHOWSPOOL	Retrieve spool list?(*)	String	`Y`

SAP_MA_CopyParameters

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

This process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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
MASS_ACTIVITY_DUNNING_DATE_ID	Dunning Date Id	In	Date Time Zone
MASS_ACTIVITY_DUNNING_ID	Dunning Id	In	String

If MASS_ACTIVITY_DATE_SHIFT is left blank, dates will be automatically shifted the number of days between source and target date ID's, when you set it to 0, then no date shift is performed.

SAP_MA_CreateParameters

This job creates a mass activity parameter record and changes the parameters according to the provided parameter set. (deprecated in favor of SAP_MA_CopyParameters )

This process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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 process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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 process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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 process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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. The entire parameter set must be specified in Redwood Server, if you do not wish to do this, you can use SAP_MA_CopyParameters followed by SAP_MA_MassActivityTemplateRun. (Deprecated in favor of SAP_MA_MassActivityTemplateRun )

This process definition requires the MassActivity Redwood transport files to be loaded.

Parameters

Parameter	Description	Direction	Data Type	Default Value	Values
SAP_SYSTEMS	SAP System	In	String
CLIENT	SAP client	In/Out	String
SAP_USER_NAME	SAP user name	In	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
MAX_NUMBER_ERRONEOUS_JOBS	Maximum number of allowed erroneous jobs	In	Number
SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

More Information

Importing and Running Mass Activities

SAP_MA_MassActivityTemplateRun

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

This process definition requires the MassActivity Redwood transport files to be loaded.

Parameters

Parameter	Description	Direction	Data Type	Default Value	Values
SAP_SYSTEMS	SAP System	In	String
CLIENT	SAP client	In/Out	String
SAP_USER_NAME	SAP user name	In	String
MASS_ACTIVITY	Mass activity	In	String
MASS_ACTIVITY_DATE_ID	Date ID	In	Date Time Zone
MASS_ACTIVITY_ID	Identification	In	String
MAX_NUMBER_ERRONEOUS_JOBS	Maximum number of allowed erroneous jobs	In	Number
SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?	In	String	`N`	`Y` - Ignore return code `N` - Use system default `U` - Use return code

More Information

Importing and Running Mass Activities

SAP_MA_ResumeMassActivity

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

This process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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 definition of an SAP mass activity. You use it to inspect the structure of a mass activity; the output lists all function modules, fields and data types.

This process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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 process definition requires the Mass Activity Redwood transport files to be loaded.

Parameters

Parameter	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

Parameter	Description	Direction	Data Type	Default Expression	Default List of Values
SAP_SYSTEMS	SAP System	In	String
INTERCEPTION_ACTION	Interception action	In	String	R (Show)	Disable (`C`) Enable (`S`) Enable (XBP 3.0) (`3`) Show (`R`)
PARENTCHILD_ACTION	Parent/Child action	In	String	R (Show)	Show (`R`) Enable (`S`) Disable (`C`)
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 use the 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 Redwood Server

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 process definition is used to raise a batch event in SAP.

Parameters

Parameter	Description	Data Type
SAP_SYSTEMS	SAP System	String
EVENT_ID	Event ID	String
EVENT_PARAMETER	Event parameter	String

SAP_ReloadApplicationLinks

This process definition reloads the SAP Application links.

Parameters

Parameter	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

Parameter	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_RfcAgent_RetrieveOutput

Retrieves SAP output. Internal use only.

Parameters

Name	Description	Data Type	Direction
JSON	Parameters	String	In
JSONOUT	Result	String	Out
password		String	In

SAP_RunTemplateJob

This process 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 process definition.

Parameters

Parameter	Description	Documentation	Data Type	Default Expression	Values
SAP_SYSTEMS	SAP System	SAP System on which to find and run the batch job	String
CLIENT	SAP client	SAP client to use	String
JOBNAME	SAP job name	Name of the SAP batch job to use as template (mandatory)	String
JOBCOUNT	SAP job count	Job count of the SAP batch job to use a template	String
SAP_USER_NAME	SAP user name		String
TARGET_JOBNAME	SAP target job name		String
FROM_STEP	From step (0, 1 = all steps)		Number
TARGET_SERVER	SAP target application server name		String
TARGET_GROUP	SAP target group name		String
SHOWLOG	Retrieve Job log?(*)		String	`Y`	`Y`, `N`
SHOWSPOOL	Retrieve Spool list?(*)		String	`Y`	`Y`, `N`
SHOWAPPLLOG	Retrieve Application log?(*)		String	`Y`	`Y`, `N`
IGNORE_APPL_RC	Ignore Application Return Code?		String	`N`	`Y`, `N`
DELETE_JOB	Delete job when finished?		String	`N`	`Y`, `N`
JOB_STATUSES	Job statuses to consider	Comma-separated list of allowed SAP batch job statuses the template job is allowed to have for it to be used.	String

SAP Batch Job Statuses and Codes

The following SAP batch job statuses are supported:

Canceled: A
Finished: F
Intercepted: I
Ready: Y
Released: S
ReleaseSuspended: Z
Running: R
Scheduled: P

SAP_SetXmiAuditLevel

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

Parameters

Parameter	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

Tab	Parameter	Description	Direction	Data Type	Default Expression	Default List of Values
Parameters	SAP_SYSTEMS	SAP System	In	String
Parameters	CLIENT	SAP client	In	String
Parameters	JOBNAME	SAP job name	In	String
Parameters	ABAP_PROGRAM_NAME	ABAP program	In	String
Parameters	ABAP_VARIANT_NAME	ABAP variant	In	String
Parameters	TEMPORARY_VARIANT	Create temporary variant?	In	String	`N`	`Y`, `N`
Parameters	JOBCLASS	SAP job class	In	String	`C`	`A`, `B`, `C`
Parameters	SAP_USER_NAME	SAP user name	In	String
Parameters	TARGET_SERVER	SAP target application server name	In	String
Parameters	JOBDOCID	Job documentation ID	In	String
Print Parameters	PRINT_ARMOD	Print/Archive mode	In	String	`1` (Print only)	`1` (Print only) `2` (Archive only) `3` (Print and Archive)
Print Parameters	PRINT_PDEST	Printer	In	String
Print Parameters	PRINT_PRTXT	Cover sheet title	In	String
Print Parameters	PRINT_PRCOP	# of copies	In	String	`1`
Print Parameters	PRINT_PRNEW	New spool?	In	String	`Y`	`Y`, `N`
Print Parameters	PRINT_PLIST	Spool list name	In	String
Print Parameters	PRINT_PRIMM	Print immediately?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRREL	Release print job?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PEXPI	Expiration in days	In	String	`8`	`1`-`8` days `9` (Do not Delete)
Print Parameters	PRINT_LICT	Print lines per page	In	String
Print Parameters	PRINT_LISZ	Print columns per page	In	String
Print Parameters	PRINT_PAART	Print format	In	String
Print Parameters	PRINT_PRBIG	Selection cover sheet?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRSAP	SAP cover page?	In	String	`D` (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Print Parameters	PRINT_PRREC	Spool list recipient	In	String
Print Parameters	PRINT_PRABT	Department on cover page	In	String
Print Parameters	PRINT_PRBER	Authority for printing	In	String
Print Parameters	PRINT_PRDSN	Spool dataset name	In	String
Print Parameters	PRINT_PTYPE	Spool type	In	String
Print Parameters	PRINT_FOOTL	Print a footer?	In	String	`N`	`Y`, `N`
Print Parameters	PRINT_PRUNX	OS cover sheet?	In	String	``D (System Default)	`D` (System Default) `Y` (Print) `N` (Do not print)
Archive Parameters	ARCHIVE_SAP_OBJECT	Archive SAP object	In	String
Archive Parameters	ARCHIVE_AR_OBJECT	Document type	In	String
Archive Parameters	ARCHIVE_INFO	Archive info	In	String
Archive Parameters	ARCHIVE_ARCTEXT	Archive text information field	In	String
Recipient Parameters	REC_RECIPIENT	Spool list recipient	In	String
Recipient Parameters	REC_TYPE	Recipient type	In	String	`U` (Internet User)	`U` (Internet User) `B` (SAP user) `O` (SAP-Office user) `P` (Personnel distribution list) `C` (Shared distribution list) `F` (Fax number)
Recipient Parameters	REC_COPY	Recipient copy flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_BLIND_COPY	Recipient blind copy flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_EXPRESS	Recipient express flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_FORWARDING	Recipient no forwarding flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_NO_PRINT	Recipient no print flag	In	String	`N`	`Y`, `N`
Recipient Parameters	REC_DELIVER	Report send status	In	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Recipient Parameters	REC_MAILSTATUS	Report status by e-mail	In	String	`_` (System Default)	`_` (System Default) `A` (Always) `E` (On error) `N` (Never)
Job Output Parameters	SHOWLOG	Retrieve job log?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSPOOL	Retrieve spool list?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWSTAT	Retrieve job statistics?	In	String	`Y`	`Y`, `N`
Job Output Parameters	SHOWAPPLLOG	Retrieve Application Logs?(*)	In	String	`Y`	`Y`, `N`
Job Output Parameters	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	Description	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 Redwood Server `C` (Change) - only different parameters are changed, deleted variant parameters will not be removed (recommended)
ENVIRONMENT	Environment for the variant	String	`A`	`A` (All) `B` (Background) `O` (Online)
PASSNULLVALUES	Copy variant definition from SAP	String	`N`	`Y` (Yes) `N` (No)

You use the PASSNULLVALUES parameter to specify how you want empty/missing parameters to be interpreted. The parameter accepts the following values:

N - missing parameters are ignored, the SAP variant parameter/selopt default values will be used; empty parameters are passed on as is, variant parameter/selopt is empty (but set).
Y - missing parameters cause the corresponding SAP variant parameters/selopts to be unset; empty parameters are passed on as is, variant parameter/selopt is empty (but set).

To unset an existing parameter, specify >!<; Parameters with this value are not forwarded to the SAP system.

SAP_SwitchOperationMode

Switches the operation mode in the SAP system (ABAP stack). Requires Redwood transport files.

Parameters

Parameter	Description	Data Type
SAP_SYSTEMS	SAP System	In
OPERATION_MODE	Operation mode	In

SAP_SynchronizeEventHistoryCriteria

This process definition is used to synchronize batch event criteria in SAP. This process 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

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*

Parameters

Parameter	Description	Direction	Data Type	Default Expression
ACTIVATE_RULES	Activate rules after synchronization	In	String	`Y`
ADDITIONAL_CONDITIONS	Additional Conditions	In	String
SAP_SYSTEMS	SAP System	In	String

SAP_SynchronizeInterceptionCriteria

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

Parameters

Parameter	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 Redwood Server.
Scheduler -> SAP: all Redwood Server rules are transferred to SAP and afterwards the SAP table contains the same rules as in Redwood Server.
With Scheduler <-> SAP: all roles both from Redwood Server and SAP are synchronized. That means the rules of SAP are going into the Redwood Server tables and the rules of Redwood Server 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 Redwood Server and afterwards the Redwood Server table contain the same rules as in SAP.

OVERWRITE

Append and Overwrite options only work for syn_direction Redwood Server -> SAP and

Redwood Server <-> 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 process definition synchronizes job states between Redwood Server and SAP. Normally, customers will schedule this process definition to run regularly, for example once per day.

Parameters

Parameter	Description	Direction	Data Type
SAP_SYSTEMS	SAP System	In	String
DELETE_JOBS_OLDER_THEN	Delete terminated jobs that are older then that number of days	In	Number
MAX_ALLOWED_EXCEPTIONS	Max consecutive exceptions allowed	In	Number

*) The child jobs get the output parameters (for example SHOWSPOOL) set according to the following order:

From a matching job control rule.
From the parent job.
Default expression of SAP_CcmsJob.

Disabling Process Description Updates

SAP Process Definitions

SAP_AbapRun

Parameters

note

Waiting for SAP Events

Retrieving Spool Output as PDF

Additional Print Parameters

note

note

Retrieving Part of the Job Log

Temporary Variants

More Information

SAP_AbapRunPrint

Parameters

Waiting for SAP Events

Retrieving Spool Output and Log as Different Formats

Additional Print Parameters

note

note

Retrieving Part of the Job Log

Temporary Variants

More Information

SAP_AbapRunPrintExt

Parameters

Waiting for SAP Events

Retrieving Spool Output as PDF

Additional Print Parameters

note

note

Retrieving Part of the Job Log

Temporary Variants

More Information

SAP_ACC_Controller

Parameters

More Information

SAP_BObj_DataServicesJobRun

Parameters

SAP_BObj_GenerateReportDefinition

Parameters

SAP_BObj_ImportReportDefinitions

Parameters

SAP_BObj_ReportRun

Parameters

SAP_BObj_TriggerEvent

Parameters

SAP_BW_GenerateInfoPackageGroup

Parameters

SAP_BW_GenerateJobDefinition

Parameters

SAP_BW_ImportInfoPackageGroups

Parameter

SAP_BW_ImportInfoPackages

Parameters

SAP_BW_ImportProcessChainDefinition

Parameters

More Information

SAP_BW_ImportProcessChains

Parameters

More Information

SAP_BW_InfopackageRun

Parameters

SAP_BW_MaintainProcessChainDefinition

Parameters

See Also

SAP_BW_Process

Parameters

SAP_BW_ProcessChain

Parameters

SAP_BW_RestartProcess

Parameters

More Information

SAP_BW_RestartProcessChain

Parameters

SAP_BW_ProcessChainRun

Parameters

SAP_CcmsJob

Parameters

SAP_CcmsJobCheckStatus

Parameters