Default System Job Definitions 
System job definitions are internal job definitions and can be recognized by their prefix System_ and their job definition type which is System. The following system job definitions are available:
System_Alert_Send - Raise an ad hoc alert.
System_ArchiveAuditObjects - Remove old audits.
System_ArchiveEvents Remove cleared events.
System_Backup - Detects database type for backup.
System_CreateMonitorTree - Create a default monitor tree for all queues and process servers.
System_DeleteJobFiles - Background job file deleter.
System_Derby_Backup - Backup the Derby database to a file.
System_DynamicTrace - Enable dynamic trace to provide additional information to support.
System_ExecuteExternalJob - Runs a Redwood supplied external job.
System_ExplainJobStatus - Explain why a job has a specific status.
System_Export_Application - This job will export an application and all its descendent objects; they are exported to an archive that is attached to the job as a jobfile.
System_Export_RuleSet - Export a rule-set.
System_ForceJobStatusUnknown - Force running jobs to status Unknown.
System_GetSupportFiles - Retrieve log files and other important SAP CPS information from a process server.
System_Get_Tutorials_List - Retreive the list of tutorials from www.redwood.com.
System_Ignored_Alert_Reporter - Send reports for the number of ignored alerts by email to the addresses that have been ignored.
System_Import_Archive - Import definitions from a CAR archive.
System_Import_JarFile - Import a jar file into a library for use in SAP CPS.
System_Info - Generate an overview of the system.
System_Isolation_Deisolation - Deisolate the system by removing all isolation groups.
System_Isolation_SetUser - Set a user to be able to read all isolation groups.
System_Mail_Configure - Set (or detect) the mail server and from address to use.
System_Mail_Send - Send an email using SMTP.
System_OperatorMessage - Raise an operator message.
System_ProcessKeepClauses - Background job definition keep clause processor.
System_RaiseClearEvent - Allows to choose an EventDefinition and perform a clear or raise on it.
System_ReconfigureLogging - Centrally reset the logging configuration.
System_RemoveDeletedJobFiles - Remove deleted job files.
System_RemoveOldJobs - Remove old jobs.
System_ReportRun - Create a report based on a query filter.
System_Restore_Object - Restore an object according to the audit.
System_Restore_Point_In_Time - Restore objects or the entire repository to a point in time according to the audit.
System_SetDefaultLanguage - Set Default Language.
System_SetSystemDataRootDirectory - Set the DataRootDirectory of the System process server.
System_Sleep - Sleep a number of seconds.
System_SMS_Configure - Set the SMS/SMTP gateway to use.
System_SMS_Send - Send an SMS using SMTP.
System_SNMP_SendTrap - Send an SNMP trap.
System_UpdateJobStatistics - Background job definition statistics updater.
System_Upgrade - Perform any long running actions required after an upgrade.
System_Version_Info - Generate an overview of the systems version and patch levels.
System_Alert_Send
Purpose
Raise an ad hoc alert, used in job chains to raise alerts in specific circumstances. This job definition requires the Active Monitoring Module.
Parameters
Parameter |
Direction |
Description |
Data type |
alertSource |
Alert Source |
In |
String |
data |
Data |
In |
String |
reply |
Reply |
Out |
String |
Schedule
This job definition is designed to be scheduled in job chains to raise alerts.
System_ArchiveAuditObjects
Purpose
Archive old audits, for future reference.
Parameters
Parameter |
Direction |
Description |
Data type |
AuditAgeUnitType |
Age unit type |
In |
String |
AuditAgeUnits |
Age is older than |
In |
Number |
BusinessKeyPattern |
Business Key contains |
In |
String |
CreationDate |
Date is before |
In |
DateTimeZone |
Kind |
Archive audit objects by |
In |
String |
ObjectType |
Object Type |
In |
String |
System_ArchiveEvents
Purpose
Archive old events, for future reference.
Parameters
Parameter |
Direction |
Description |
Data type |
ClearedDate |
Remove before date: |
In |
DateTimeZone |
EventAgeUnitType |
Use age unit type: |
In |
String |
EventAgeUnits |
Remove before age: |
In |
Number |
EventPrefix |
Restrict search using event name prefix |
In |
String |
Kind |
Remove cleared events using: |
In |
String |
RaisedSequence |
Remove before raised sequence no: |
In |
Number |
Schedule
This job can be scheduled regularly to decrease the amount of events stored in the repository.
System_Backup
Purpose
Perform a database backup. This is the database independent job definition that will submit the correct database backup script.
This job definition can be used to backup the database when no other third-party measures have already been taken to backup the database.
Note
When SAP CPS is running inside SAP NetWeaver AS Java, then there should already be a database backup planned for the SAP NetWeaver database, which SAP CPS uses as well.
Parameters
Parameter |
Direction |
Description |
Data type |
Filename |
Filename |
In |
String |
Platform |
Platform |
In |
String |
The Filename parameter can contain the following substitution parameters
${SystemId} - system id with all characters except A-Z, a-z and 0-9 replaced with underscores.
${date:format} - date using format 'format'. The format is any valid Java SimpleDateFormat.
Schedule
This job definition can be used to backup the database, on SAP NetWeaver, the database should already have a backup scheme, so this jobs definition does not need to be used.
System_CreateMonitorTree
Purpose
Create a monitor tree that contains runtime information regarding process servers and queues. The root of the monitor tree will be named /System. This script is idempotent if the set of queues and process servers has not changed. The script will not remove monitor nodes for queues/process servers that do not exist anymore since the last time it was run, it will however add monitor nodes for new queues/process servers. The resulting monitor tree might be sent to SAP via the XMW interface.
System_DeleteJobFiles
Purpose
Delete job output files of jobs that have been deleted. This job definition is automatically scheduled by the system, there is no need to run it manually.
Schedule
This job definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_DeleteJobFilesSubmitFrame in 
Environment → Submit Frames 
.
System_Derby_Backup
Purpose
This job definition is used to backup Apache Derby databases. It is submitted by the System_Backup job.
Parameter
Parameter |
Description |
Data Type |
Filename |
Filename |
String |
The Filename parameter can contain the following substitution parameters
${SystemId} - system id with all characters except A-Z, a-z and 0-9 replaced with underscores.
${date:format} - date using format 'format'. The format is any valid Java SimpleDateFormat.
System_DynamicTrace
Purpose
Enables dynamic tracing to help with problem solving. The format of the trace string is <category>=<level>;<category>=<level>;.... Valid categories are Redwood Java classes, like com.redwood.scheduler.; valid levels are debug, warn, info, error, and fatal. You should only use this job definition when asked to by SAP support staff, in which case they will provide you with an appropriate class and debug level.
Parameters
This job definition has one compulsory parameter:
Parameter |
Description |
Use |
Data Type |
TraceString |
Trace string |
Categories to be traced with verbosity level. |
String |
System_ExecuteExternalJob
Purpose
This job definition executes an external job definition (eg. a patch or diagnostic tool) from a file. You should only use this job definition when asked to by SAP support staff, in which case they will provide you with an appropriate file.
Parameter |
Description |
Data Type |
fileName |
File name. |
String |
System_ExplainJobStatus
Purpose
This job definition is used to troubleshoot a job that remains in status Queued, it will provide an explanation as to why that job is in the Queued state.
Parameters
This job definition has one compulsory parameter:
Parameter |
Description |
Use |
Data Type |
jobId |
Job Id. |
The job id of the job to be examined. |
Number |
System_Export_Application
Purpose
This job will export an application and all its descendant objects; they are exported to an archive that is attached to the job as a job file.
Requires a Import/Export Module license, please check your license.
Parameters
Parameter |
Description |
Use |
Data Type |
applicationPath |
Path of application to export. |
The path to the application, For example Redwood for the Redwood application or Redwood.System for the System application inside the Redwood application. |
String |
System_Export_RuleSet
Purpose
Export various objects defined in an export rule-set. Used to schedule the export of specific objects.
Requires a Import/Export Module license, please check your license.
Parameters
Parameter |
Description |
Direction |
Data type |
exportRuleSetName |
Name of the export rule-set which specifies the objects to export. |
In |
String |
System_ForceJobStatusUnknown
Purpose
Force a running job, which should not or cannot be killed, into status unknown.
Parameters
Parameter |
Description |
Direction |
Data type |
JobId |
Job ID |
In |
Number |
ProcessServer |
Process server |
In |
String |
System_GetSupportFiles
Purpose
Retrieve the logs from a process server, operator messages and other important system information for troubleshooting. This job is automatically submitted when you use the Get Support Files action on a process server or a job that reached Error, for example ; it should not be submitted manually.
This information will be required by SAP support personnel when you want to report a problem.
Parameters
Parameter |
Description |
Direction |
Data type |
JobId |
Job ID |
In |
Number |
ProcessServerId |
Process server id |
In |
String |
Files |
The list of files to retrieve |
In |
String |
System_Get_Tutorials_List
Purpose
This job definition retrieves the list of tutorials that are available on www.redwood.com. These tutorials illustrate basic functionality and are free to view, a tutorial button will appear in the user interface when a tutorial is available for the object you are using. Some tutorials require you to register; registration is free.
Schedule
This job definition should be scheduled when you want to update the list of tutorials that are available.
System_Ignored_Alert_Reporter
Purpose
Send reports for the number of ignored alerts by email to the addresses that have been ignored. An address will be ignored if the number of emails sent to the address exceeds the alert rate limit (in an alert rate window). This job definition requires the Active Monitoring Module license.
Schedule
This job definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_Ignored_Alert_ReporterSubmitFrame in Environment → Submit Frames .
System_Import_Archive
Purpose
This job definition is used to import CAR archive files.
Requires a Import/Export Module license, please check your license.
Parameters
CarURL - File/Http URL to the car file, for example R:\Car\Masalan.car or http://filserver.masalan.com/shared/CarFiles/Masalan.car.
Parameter |
Description |
Data type |
CarUrl |
Filename or URL of archive |
String |
ImportRuleSetName |
Name of import rule-set to apply to imported objects |
String |
System_Import_JarFile
Purpose
This job definition allows you to import all your java packages from a JAR file into a library. It is called when you choose Import JAR from the context menu of a library.
Parameter |
Description |
Direction |
Data type |
Jar |
Filename or URL of the archive |
In |
String |
Library |
Name of the library that the archive is to be a part of |
In |
String |
auditReason |
Reason for change |
In |
String |
System_Info
Purpose
This job definition is used to retrieve information about the Java Virtual Machine that the System scheduler is running in. You may be asked to run this job by SAP Support for diagnostic purposes, there is no need to run it yourself.
System_Isolation_Deisolation
Purpose
This job definition is used to remove all isolation groups, allowing you to interact with more than one SAP system in a session, this requires the Chargeable version license.
System_Isolation_SetUser
Purpose
This job definition allows you to authorize a user to read all isolation groups.
Parameters
Parameter |
Description |
Use |
Data Type |
UserName |
User Name |
String |
System_Mail_Configure
Purpose
Configure the Mail module to allow the process server to send emails.
A Mail module license is necessary, please check your license.
Parameters
This job definition has two compulsory parameters:
Parameter |
Description |
Use |
Data Type |
From |
From |
The default From: Address used in the emails the process server sends. |
String |
Server |
Server |
The SMTP server to use |
String |
System_Mail_Send
Purpose
Send job output via email using SMTP.
A Mail module license is necessary, please check your license.
Parameters
Parameter |
Description |
Use |
Data Type |
From |
From |
The sender's email address. |
String |
JobFile |
Job file |
The output file of the RelativeJob. You can use regular expression to match multiple output files, .* matches all files. |
String |
RelativeJob |
Relative job |
The job that generated the output that is to be sent, syntax ''job n', where n is the job id, for example job 122588. In a job chain, you can use the syntax Step n, Job m or Step 2, Job 3 for the third job of the second step; it has to be a previous step to the one this job definition is in. |
String |
Server |
Server |
The SMTP server to use. |
String |
Subject |
Subject |
The subject of the email. |
String |
Text |
Text |
The text of the email. |
String |
To |
To |
The recipients' email address. |
String |
System_OperatorMessage
Purpose
This job definition is used to create Operator messages. You can use this job within a job chain to send one-way messages, or to send messages that wait for a reply. Use this job definition if you want to log that something has happened, or contact the operator to confirm a condition or provide input.
Parameters
Parameter |
Description |
Use |
Data Type |
message |
Message. |
The message that the operator has to reply to. |
String |
replyExpression |
Reply Expression. |
A regular expression of valid replies. |
String |
reply |
Reply. |
The reply to the operator message (output parameter) |
String |
System_ProcessKeepClauses
Purpose
Delete old jobs according to their keep clause. This job definition is automatically scheduled by the system, there is no need to run it manually.
Schedule
This job definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_ProcessKeepClausesSubmitFrame in Environment → Submit Frames .
System_RaiseClearEvent
Purpose
Allows to choose an EventDefinition and perform a clear or raise on it.
Parameters
Parameter |
Description |
Direction |
Data type |
Values |
Action |
Action |
In |
String |
R (Raise) C (Clear) |
EventDefinition |
Event Definition |
In |
String |
|
Comment |
Comment |
In |
String |
System_ReconfigureLogging
Purpose
Centrally reset the logging configuration.
System_RemoveDeletedJobFiles
Purpose
This job definition allows you to delete multiple old job files.
Parameters
Paratemer |
Description |
Direction |
Data type |
ProcessServer |
Process server |
In |
String |
Code |
Code |
In |
String |
System_RemoveOldJobs
Purpose
Allows you to delete multiple jobs from the repository.
Note
Please do not schedule the job definition regularly, use keep clauses instead.
Parameters
Parameter |
Description |
Direction |
Data type |
Default Value |
Default List of Values |
JobAgeUnitType |
Age unit type |
In |
String |
||
JobAgeUnits |
Age is older than |
In |
Number |
||
JobDate |
Date is before |
In |
DateTimeZone |
||
JobDefinitionPrefix |
Filter by job definition name |
In |
String |
||
JobDefinition |
The description of the job definition |
In |
Number |
||
JobId |
JobId is before |
In |
Number |
||
Kind |
Remove jobs by |
In |
String |
I (JobId) D (Date) A (Age) |
|
Statuses |
Restrict to statuses (comma separated codes) |
In |
String |
C,E,U,A |
System_ReportRun
Purpose
Generates a report on the resultset of a query filter, defined in a report object. The output can be generated in three formats, comma-separated, HTML, and XML.
Paramters
Parameter |
Description |
Direction |
Data Type |
OutputFormat |
Report format |
In |
String |
RecordCount |
Maximum umber of records |
Out |
Number |
Report |
Report |
In |
String |
System_Restore_Object
Purpose
Allows you to restore an object from the auditing record for the object at a point in time.
Note
This may have dependency issues if a dependent object has been deleted.
Parameters
Parameter |
Description |
Direction |
Data type |
BusinessKey |
Business Key |
In |
String |
DateTimeToRestore |
Restoration Time |
In |
DateTimeZone |
ObjectType |
Object Type |
In |
String |
System_Restore_Point_In_Time
Purpose
Allows you to restore the repository to a given point in time according to auditing.
Held jobs are generated to restore the system to a point in time. To continue with the restoration run the held jobs (in the order required to meet dependency requirements).
Parameter
Parameter |
Description |
Data Type |
DateTimeToRestore |
The point to restore to. |
DateTimeZone |
System_SetDefaultLanguage
Purpose
Set Default Language.
Parameters
Paratemer |
Description |
Direction |
Data type |
Language |
Language |
In |
String |
System_SetSystemDataRootDirectory
Purpose
Set the DataRootDirectory of the System process server.
Parameters
Paratemer |
Description |
Direction |
Data type |
Directory |
Directory |
In |
String |
System_Sleep
Purpose
Wait a number of seconds; allows to make your process wait for some seconds.
Parameter |
Description |
Data Type |
Default Value |
MilliSeconds |
Time to sleep (in milliseconds) |
Number |
1000 |
System_SMS_Configure
Purpose
Set the SMS/SMTP gateway to use. The SMS gateway will be automatically detected using an email address of one of the mobile phones.
A Mail module license is necessary, please check your license.
Parameters
Parameter |
Description |
Direction |
Data type |
SMSGatewayPassword |
The gateway password. |
In |
String |
SMSGatewayUser |
The gateway username. |
In |
String |
SMSGateway |
The gateway email address. |
In |
String |
System_SMS_Send
Parameters
Parameter |
Description |
Direction |
Data type |
MobileNumber |
Mobile number |
In |
Number |
Tags |
Vendor Specific Tags |
In |
String |
Text |
Message |
In |
String |
System_SNMP_SendTrap
Parameters
Parameter |
Description |
Direction |
Data type |
community |
Community |
In |
String |
data |
Data |
In |
String |
host |
Host |
In |
String |
id |
Id |
In |
Number |
port |
Port |
In |
Number |
System_UpdateJobStatistics
Update the statistics of job definitions with runtime data from jobs that have run, this data is available in the statistics section in the details pane of Definitions → Job Definitions . This job definition is automatically scheduled
by the system, there is no need to run it manually.
Schedule
This job definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_UpdateJobStatisticsSubmitFrame in Environment → Submit Frames .
System_Upgrade
Purpose
This job definition performs post-upgrade tasks and should not be submitted by users, unless you are instructed to do so by SAP support.
Parameters
Parameter |
Description |
Data Type |
Mode |
Mode |
String |
System_Version_Info
Purpose
Retrieve version information of SAP CPS. The output is especially useful for support requests.