Default System Process Definitions

System process definitions are internal process definitions and can be recognized by their prefix System_ and their definition type which is System. The following system process definitions are available:

• System_Aggregate_History - Collects history data for processes
• System_AggregateMonitorData - Collects history data for monitor values
• System_Alert_Send - Raises ad hoc alerts
• System_APP_Install - Installs signed CAR files
• System_APP_Uninstall - Uninstalls signed CAR files
• System_ArchiveAuditObjects - Archives audit entries into an XML file and deletes them from the Audit Trail
• System_ArchiveEvents - Removes cleared events
• System_AS400_Command - Executes a command on an AS/400 system
• System_AS400_Trace - Trace a command that runs on a AS400 system
• System_Backup - Performs a database backup
• System_ChangeOwner - Change the Owner of Process Definitions and/or Recurrences
• System_CollectJobOutput - Collects process output for a comma-separated list of process id's
• System_CollectStatistics - Collects system statistics
• System_CreateEditScreenEntries - Creates registry entries for all tabs of all object type edit screens
• System_CreateMonitorTree - (Obsolete) Created a default monitor tree for all queues and process servers
• System_CredentialTrace - Traces the credential retrieval operations of a process
• System_Defaults_Partition - Holds default values for objects in a partition
• System_Defaults_System - Holds system-wide default values
• System_DeleteJobFiles - Deletes process files
• System_DoNothing - Process that does nothing, for use in test situations, for example
• System_DynamicTrace - Enable dynamic trace to provide additional information to support
• System_ExecuteExternalJob - Runs an external process supplied by Redwood
• System_ExplainJobStatus - Explains why a process still has "Queued" status
• System_Export_Application - Exports an application
• System_Export_RuleSet - Exports objects as defined in an export rule set
• System_External_Command - Runs a command native to the operating system
• System_External_REL_Command - Runs a (REL evaluated) command native to the operating system
• System_FetchRemoteMonitorTree - Retrieves specific alert monitors from a remote central Redwood Server
• System_ForceJobStatusUnknown - Forces a running process to status "Unknown"
• System_FTP_delete - Deletes a file from the remote server
• System_FTP_get - Gets a file from the remote server
• System_FTP_list - Lists a directory on the remote server
• System_FTP_mget - Retrieves files matching a pattern from the remote server
• System_FTP_mget_Parallel - Retrieves files matching a pattern from the remote server (multi-threaded)
• System_FTP_mkdir - Creates a directory on the remote server
• System_FTP_mput - Uploads files matching a pattern to the remote server
• System_FTP_mput_Parallel - Multi-threaded upload of files matching a pattern to the remote server
• System_FTP_put - Uploads a file to the remote server
• System_FTP_rmdir - Removes a directory on the remote server
• System_GetSupportFiles - Gets available support files
• System_GrantAccessToOwnedObjects - Grants All privilege rank on objects owned
• System_Ignored_Alert_Reporter - Sends reports for the number of ignored alerts
• System_Import_Archive - Imports definitions from a Redwood Server Archive (CAR)
• System_Import_JarFile - Imports Java archives (JAR) into a library
• System_Import_Settings - Sets import settings used by System_Import_Archive
• System_Import_SystemCarFiles - Imports system supplied Redwood Server Archive (CAR) definitions
• System_Import_ThirdParty_Plugin - Starts the import of data from third parties into Redwood Server
• System_Info - Generates an overview of the system
• System_InitializeOracleService - Initializes the Oracle Process service
• System_Internal_Chain - Prefix for chain definitions created as unnamed child chain definitions in the chain definition editor
• System_Isolation_Deisolation - (Obsolete) Deisolates the system
• System_Isolation_SetUser - (Obsolete) Sets user as isolation group reader
• System_LicenseCheck - Produces an XML report of the licenses that are currently in use in the system
• System_Loop_Aggregate - Creates an RTX table of parameters and values
• System_Loop_Over_Table - Loops over an RTX table and adds processes to the next chain step
• System_Mail_Configure - Sets (or detect) the mail server and from address to be used
• System_Mail_Send - Sends an e-mail using SMTP
• System_MonitorTables - Adds the database table row counts to the monitor tree
• System_OperatorMessage - Raises an operator message
• System_OraApps_ConcurrentProgramImport - Imports concurrent programs for creating Oracle Applications process definitions
• System_OraApps_ConcurrentProgramMultipleImport - Imports multiple concurrent programs for creating Oracle Applications process definitions
• System_OraApps_InstallInterceptFunctionality - Installs the intercept functionality in the remote Oracle Applications system
• System_OraApps_PackageMethodImport - Imports a function or procedure from a remote Oracle Applications system
• System_OraApps_RequestSetImport - Imports a request set for creating Oracle Applications process definition
• System_OraApps_RequestSetMultipleImport - Imports multiple request sets for creating Oracle Applications process definitions
• System_OraApps_UnInstallInterceptFunctionality - Removes the intercept functionality in the remote Oracle Applications system
• System_OraOHI_ImportAll - Imports all Oracle Health Insurance scripts
• System_OraOHI_ImportSingle - Imports a specific Oracle Health Insurance script
• System_OraOHI_MonitorJob - Monitors Oracle Health Insurance scripts (Internal process definition)
• System_OutputMonitorTree - Creates a binary file containing part of a remote monitoring tree
• System_PeopleSoft_ProgramMultipleImport - Imports multiple Oracle PeopleSoft programs
• System_PeopleSoft_ProgramImport - Imports a specific Oracle PeopleSoft program
• System_PeopleSoft_ReportImport - Imports a specific Oracle PeopleSoft report
• System_PeopleSoft_ReportMultipleImport - Imports a specific Oracle PeopleSoft report
• System_PeopleSoft_RunControl - Imports Oracle PeopleSoft controls
• System_PeopleSoft_RunJob - Imports Oracle PeopleSoft processes
• System_PeopleSoft_RunProcess - Imports Oracle PeopleSoft processes
• System_ProcessKeepClauses - Deletes processes and chain processes according to their keep clauses
• System_Promote - Promotes CAR files to remote systems
• System_Promote_Further - Promotes a recently imported CAR file to another remote system
• System_R2W_Approval - Publishes process files to a Report2Web Catalog for approval
• System_R2W_Connection_Setup - Sends the server address and connection information for the remote R2W server
• System_R2W_Publish - Publishes process files to a Report2Web Catalog
• System_RaiseClearEvent - Raises or clears an event
• System_RaiseRemoteEvent - Raises an event on a remote version 8 or 9 system
• System_RaiseRemoteEvent_Repository - Raises an event on a remote version 6 or 7 system
• System_ReconfigureLogging - Reconfigures logging for the central Redwood Server
• System_RemoveDeletedJobFiles - Removes deleted process files
• System_RemoveOldJobs - Removes old processes
• System_RemoveOperatorMessages - Removes replied operator messages
• System_RemoveRepliedMessages - Removes replied operator messages
• System_ReportRun - Generates a report using a report object
• System_Restore_Object - Restores an object to a previous point in time
• System_Restore_Point_In_Time - Creates held processes that restore audited objects to a point in time
• System_SecureStorage_Configure - Enables AES encryption of passwords; cannot be undone
• System_SetDefaultLanguage - Sets the default language
• System_SetSystemDataRootDirectory - Sets the DataRootDirectory of the System process server
• System_Sleep - Sleeps for a number of milliseconds
• System_SMS_Configure - Sets the SMS/SMTP gateway to be used
• System_SMS_Send - Sends an SMS Using SMTP
• System_SNMP_Configure - Configures SNMP Trap defaults
• System_SNMP_SendTrap - Sends SNMP Traps
• System_SQLPLUS_Command - Performs a query using SQLPLUS
• System_SynchronizeBackgroundJobs - Synchronizes background maintenance processes
• System_UpdateJobStatistics - Updates process definition statistics
• System_Upgrade - Performs any long running actions required after an upgrade
• System_UserMessage - Creates a standard Accept/Reject user message
• System_UserMessage_Notification - Creates an email user message
• System_VersionInfo - Generates an overview of the system version and Support Package levels
• System_VersionUpdateCheck - Checks if a new version of the software is available
• System_Windows_Session_Close - Closes a specific session as opened by System_Windows_Session_Create
• System_Windows_Session_Create - Creates a terminal services session per specified user

System_Aggregate_History

Purpose

Collect history data for processes to be used in the scorecard. It makes sure that there are only <n> number of days of history processes available in the system. <n> defaults to 365 days and can be set via the registry.

Schedule

This process is scheduled to run daily at 1:00 AM.

System_AggregateMonitorData

Purpose

Collect the monitor data for monitor values.

Schedule

This process is scheduled hourly.

System_Alert_Send

Purpose

Raise an ad hoc alert, used in chain processes to raise alerts in specific circumstances. This process definition requires the Active Monitoring Module.

Parameters

Parameter	Description	Documentation	Direction	Data Type
alertSource	Alert Source	This parameter needs to be set to the ad hoc alert source to be triggered.	In	String
data	Data	The optional data parameter is used to store data that can be used in the operator message/email of the alert.	In	String
reply	Reply	This parameter will hold the reply of the operator message.	Out	String

Schedule

This process definition is designed to be scheduled in chain processes to raise alerts.

System_APP_Install

Purpose

Installs signed applications provided by Redwood that add custom functionality to Redwood Server.

Parameters

Name	Description	Document	Direction	Data Type
CarUrl	Signed application file	You upload the signed CAR file to be installed using this parameter.	In	File
TargetPartition	Partition	The target partition for all objects in the signed CAR file; if you are upgrading the application, ensure this is set to the same partition as the previous run.	In	String
ApplicationData	Output data	This parameter is used to store property data used duing the installation process; not all signed CAR files use this parameter.	Out	String

System_APP_Uninstall

Purpose

Removes signed applications from Redwood Server. This definition cannot be used to remove ordinary, unsigned applications. If the App_Administrator has been enabled, users will need that.

Parameters

Name	Description	Documentation	Direction	Data Type
Application	Application	Name of the signed application; all currently installed signed applications will be displayed in a drop-down.	In	String

System_ArchiveAuditObjects

Purpose

Archive audit entries and delete them from the Audit Trail.

Parameters

Parameter	Description	Direction	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

Remove cleared, unused events. Cleared events that are referenced by other objects will not be removed.

Parameters

Parameter	Description	Direction	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 process should be scheduled regularly to decrease the amount of events stored in the repository.

System_AS400_Command

Purpose

Run a command on a AS400 system. Requires the ProcessServerService.AS400.limit license key.

Parameters

Parameter	Description	Direction	Data Type
AS400Server	The name of the AS400 server to connect with	In	String
AS400User	The account to establish the connection with	In	String
COMMAND	The command to execute on the system	In	String

System_AS400_Trace

Trace a command that runs on a AS400 system

Parameters

Name	Description	Direction	Data Type
AS400Server	The name of the AS400 server to connect with	In	String
AS400TraceLevel	Trace level that needs to be set	In	String

System_Backup

Purpose

Perform a database backup. This is the database independent process definition that will submit the correct database backup script.

This process definition can be used to backup the database when no other third-party measures have already been taken to backup the database.

Parameters

Parameter	Description	Direction	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 DateTimeFormatter

Schedule

This process definition can be used to backup the database.

System_ChangeOwner

Change the Owner of Process Definitions and/or Recurrences

Parameters

Name	Description	Direction	Data Type
currentUser	Current Owner of the Objects	In	String
newUser	New Owner of the Objects	In	String
includeJobDefinitions	Change Owner of Process Definitions?	In	String
includeRecurrences	Change Owner of Recurrences?	In	String
DryRun	Do a dry run? (no changes will be persisted)	In	String
ChangeLocked	Also change owner of locked objects?	In	String

System_CollectJobOutput

Creates a ZIP file with process overviews for a list of processes, including all job files.

Parameters

Name	Description	Documentation	Data Type	Direction	Default Expression	Values
JobIds	Process ids	Comma separated list of process ids	String	In
JobQueryFilter	Query filter	Business key of the job query filter	String	In
JobFileLinkType	Type of links	Type of links to be used in the process overviews, either relative links or permalinks	String	In	RelativeLink
IgnoreMissingFiles	Ignore non-available files	Indicates if the job should continue or go to error if a non existing file is encountered	String	In	Yes	Yes, No
ZipEntryPattern	Zip entry pattern	Pattern for the folder name of zip entries, may contain expressions such as ${JobId}, ${Description} and ${ScheduledStartTime}	String	In	ProcessOverview_${Description}_${JobId}_${ScheduledStartTime}
JtoolOptions	Options for jtool	Options to be appended to the jtool command	String	In

The Zip entry pattern (ZipEntryPattern) parameter defaults to ProcessOverview_${Description}_${JobId}_${ScheduledStartTime} for example ProcessOverview_Aggregate the monitor data for MonitorValues_21_20231002091820

The Options for jtool (JtoolOptions) parameter accepts any parameters support by jgetfile; note that options -j (use process context), -o (destination file), -s (file specification) are set by default. This option is intended to allow you to specify log verbosity of the jgetfile process.

System_CollectStatistics

Purpose

This process definition collects system statistics.

System_CreateEditScreenEntries

Purpose

Creates registry entries for all tabs of all object type edit screens. A registry entry is created for each edit screen and all tabs available. This allows for setting of visibility levels per tab.

These registry entries have the following naming convention: /configuration/ui/visibility/<object_type>/<tab_name>

System_CredentialTrace

Purpose

Enables dynamic trace of credential handling for a single process. Submit the process that needs to be traced in Hold status, locate its ID, then submit this process definition with the ID. This will release the process and an extra file named stdcredential.log will be created with the desired trace information.

Parameters

Parameter	Description	Documentation	Data Type	Direction
jobId	Process ID	The ID of the Held process that you would like to troubleshoot	String	In

System_Defaults_Partition

Purpose

This process definition allows you to set partition-wide default restart behavior of processes. If this process definition is not available, you need to create it in the partition where you want to set the restart behavior. You create a process definition with this name, as soon as you save it will be converted to the special process definition. Note that you can only change the restart behavior and security on this process definition. See Controlling Global and Partition Restart Behavior for instructions on how to create the process definitions.

note

The partition of a process is inherited from the queue, not its process definition.

System_Defaults_System

Purpose

This process definition allows you to set system-wide default restart behavior of processes. If this process definition is not available, you need to create a process definition with this name, as soon as you save it will be converted to the special process definition. Note that you can only change the restart behavior and security on this process definition. See Controlling Global and Partition Restart Behavior for instructions on how to create the process definitions.

System_DeleteJobFiles

Purpose

Delete process output files of processes that have been deleted. This process definition is automatically scheduled by the system, there is no need to run it manually.

Schedule

This process definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_DeleteJobFilesSubmitFrame in "Environment > Submit Frames".

System_DoNothing

Purpose

A placeholder script that does nothing. This script does nothing, and can be used as a placeholder script while building a chain. Can be used for testing-purposes as well.

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 process definition when asked to by Redwood support staff, in which case they will provide you with an appropriate class and debug level.

Parameters

This process definition has one compulsory parameter which is TraceString:

Parameter	Description	Use	Data Type
TraceString	Trace string	Categories to be traced with verbosity level.	String
MinutesToRun	Minutes To Run	Duration of the trace.	Number

System_ExecuteExternalJob

Purpose

This process definition executes an external process definition (for example a patch or diagnostic tool) from a file. You should only use this process definition when asked to by Redwood 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 process definition is used to troubleshoot a process that remains in status Queued, it will provide an explanation as to why that process is in the Queued state.

Parameters

This process definition has one compulsory parameter:

Parameter	Description	Use	Data Type
jobId	Process ID.	The process ID of the process to be examined.	Number

System_ExportAuditObjects

Purpose

Archive audit entries without deleting them from the Audit Trail.

Parameters

Parameter	Description	Direction	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	Export audit objects by	In	String
ObjectType	Object Type	In	String

System_Export_Application

Purpose

This process will export an application and all its descendant objects; they are exported to an archive that is attached to the process as a process file.

note

The Promotion Module requires the Module.ImportExport license key

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.

note

The Promotion Module requires the Module.ImportExport license key

Parameters

Parameter	Description	Direction	Data Type
exportRuleSetName	Name of the export rule-set which specifies the objects to export.	In	String

System_External_Command

Purpose

Allows you to execute a command natively, requires a process server with the new OSNative process server parameter.

Parameters

Parameter	Description	Direction	Data Type
COMMAND	Command to perform	In	String
JCS_USER	The OS Account under which this process will run	In	String

System_External_REL_Command

Purpose

Allows you to specify an expression which will evaluated and executed natively; requires a process server with the new OSNative process server parameter.

Parameters

Parameter	Description	Direction	Data Type
JCS_REL_COMMAND	The (REL Evaluated) Command to execute	In	String
JCS_USER	The OS Account under which this process will run	In	String

System_FetchRemoteMonitorTree

Purpose

Fetches part of the monitor tree from a remote Redwood Server system to the local Redwood Server system.

Parameters

Name	Description	Direction	Data Type
MonitorTreeCredTable	Monitor credential table name	In	String

System_ForceJobStatusUnknown

Purpose

Force a running process, which should not or cannot be killed, into status unknown.

Parameters

Parameter	Description	Direction	Data Type
JobId	ID	In	Number

System_FTP_delete

Purpose

Delete a file from the remote server. This process definition runs on a platform agent and executes jftp to delete a file or folder on the FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteFile	The name of the remote file	This parameter takes a UNIX-style path to the remote file to delete. Directory is optional, defaults to /. For example: /bedian/pool/main/s/sysdmb/libsysdmb-baemon1_919-19+bed1u9_amb19.bed	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_get

Purpose

Get a file from the remote server. This process definition runs on a platform agent and executes jftp to retrieve a file from an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteFile	The name of the remote file	This parameter takes a UNIX-style path to the remote file to retrieve; directory defaults to /. For example: /bedian/pool/main/s/sysdmb/libsysdmb-baemon1_919-19+bed1u9_amb19.bed	In	String
LocalFile	The name of the local file	This parameter takes a path to the local file. The path must be local to the server where the platform agent runs that executes this process.For example: C:\\Windows\\temp\\myFile.txt	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_list

Purpose

List a directory on the remote server. This process definition runs on a platform agent and executes jftp to list the contents of a folder in the FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
ListDirectory	The name of the directory to get a listing from	This parameter always takes a UNIX-style path to the directory. For example: /bedian/pool/main/s	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_mget

Purpose

Retrieve files matching a pattern from the remote server. This process definition runs on a platform agent and executes jftp to retrieve a number of files sequencially from an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
Pattern	The pattern of files to match	The directory part always takes a UNIX-style path to the directory; defaults to /. The pattern part depends on your FTP server, usually, GLOB is supported: asterisk (*) - zero or more characters question mark (?) - exactly one characterFor example: /bedian/pool/main/s/myFile*.tx?	In	String
LocalDirectory	The name of the local directory	This parameter allows you to specify the target directory for all downloaded files. The path must be local to the server where the platform agent runs that executes this process; default directory is working directory of the process.For example: C:\\Windows\\Temp	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_mget_Parallel

Purpose

Download files using FTP (multi-threaded). This process definition runs on a platform agent and executes jftp to retrieve a number of files simultaneously from an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
ProcessServer	The name of the process server that this process will run on	In	String
Queue	The name of the queue that this process will run in	In	String
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteFile	Source directory and pattern	The directory part always takes a UNIX-style path to the directory; directory defaults to /. The pattern part depends on your FTP server, usually, GLOB is supported: asterisk (*) - zero or more characters question mark (?) - exactly one character. For example: /bedian/pool/main/s/myFile*.tx?	In	String
LocalFile	Destination directory	This parameter allows you to specify the target directory for all downloaded files. The path must be local to the server where the platform agent runs that executes this process.For example: C:\\Windows\\Temp	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_mkdir

Purpose

Create a directory on the remote server. This process definition runs on a platform agent and executes jftp to create a directory on an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteDirectory	The name of the remote directory	This parameter always takes a UNIX-style path to the directory. For example: /bedian/pool/main/s	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_mput

Purpose

Upload files matching a pattern to the remove server. This process definition runs on a platform agent and executes jftp to upload files sequencially to an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
Pattern	The pattern of files to match	The directory part always takes a native path to the server that runs the platform agent that executes process; directory defaults to the working directory of the process. The pattern part depends on your FTP server, usually, GLOB is supported: asterisk (*) - zero or more characters question mark (?) - exactly one character, for example: /tmp/myFile*.doc.*	In	String
RemoteDirectory	The name of the remote directory	This parameter always takes a UNIX-style path to the directory; defaults to /. For example: /bedian/pool/main/s	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_mput_Parallel

Purpose

Multi-threaded upload of files using FTP. This process definition runs on a platform agent and executes jftp to upload files simultaneously to an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
ProcessServer	The name of the process server that this process will run on	In	String
Queue	The name of the queue that this process will run in	In	String
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
LocalFile	Source directory and pattern	The directory part always takes a native path to the server that runs the platform agent that executes process; directory defaults to working directory of the process. The pattern part depends on your server, usually, GLOB is supported: asterisk (*) - zero or more characters question mark (?) - exactly one character (On MS Windows, one or zero characters)For example: C:\\Windows\\temp\\myFile*.doc?	In	String
RemoteFile	Destination directory	This parameter always takes a UNIX-style path to the directory; directory defaults to /. For example: /bedian/pool/main/s	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_put

Purpose

Upload a file to the remote server. This process definition runs on a platform agent and executes jftp to upload a single file to an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteFile	The name of the remote file	The directory part always takes a UNIX-style path to the directory; defaults to /.	In	String
LocalFile	The name of the local file	This parameter allows you to specify the file to upload to the FTP server. The path must be local to the server where the platform agent runs that executes this process; directory defaults to working directory of the process..For example: C:\\Windows\\Temp\\my_file.txt	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_FTP_rmdir

Purpose

Remove a directory on the remote server. This process definition runs on a platform agent and executes jftp to remove a directory on an FTP server.

Parameters

Parameter	Description	Documentation	Direction	Data Type
JCS_REMOTE_ENDPOINT	The hostname of the FTP server to connect with	This parameter allows you to select a credential, in combination with JCS_REMOTE_USER, to retrieve the password. The parameter has an LOV (list of values) that allows you to select an endpoint from the list of credentials with CredentialProtocol login.	In	String
JCS_REMOTE_USER	The name of the account to login with	This parameter allows you to select a credential, in combination with JCS_REMOTE_ENDPOINT, to retrieve the password. The parameter has an LOV that allows you to select a real user from the list of credentials with CredentialProtocol login.	In	String
RemoteDirectory	The name of the remote directory	This parameter always takes a UNIX-style path to the directory. For example: /bedian/pool/main/s	In	String
JCS_SSL_ENABLE	Enable SSL	This parameter allows you to enable secure connections (SSL v3 or TLS).	In	String
JCS_SSL_METHOD	Secure protocol	This parameter allows you to select either SSL or TLS as protocol; Note that TLS is highly recommended over SSL.	In	String
JCS_SSL_CERTIFICATE_PATH	Path to the certificate file	This parameter allows you to specify a X.509 certificate for authentication. The path must be local to the server where the platform agent runs that executes this process.	In	String
JCS_SSL_KEYPATH	Path to the key file	The public key file of the certificate; only required if the key is not in the certificate file specified in JCS_SSL_CERTIFICATE_PATH.	In	String

System_GetSupportFiles

Purpose

Retrieve the logs from a process server, operator messages and other important system information for troubleshooting. This process is automatically submitted when you use the Get Support Files action on a process server or a process that reached Error, for example ; it should not be submitted manually.

This information will be required by Redwood support personnel when you want to report a problem.

Parameters

Parameter	Description	Direction	Data Type
JobId	ID	In	Number
ProcessServerId	Process server ID	In	String
Files	The list of files to retrieve	In	String

System_GrantAccessToOwnedObjects

This process can be used to grant access to objects that have an owner. It selects objects that have fromOwnerSubject as owner subject and creates All privileges for the toSubject. If the toSubject already has a privilege for a given object, it changes this privilege into an All privilege.

Parameters

Name	Description	Documentation	Data Type	Direction	Default Expression	Values
fromOwnerSubject	Owner of the objects		String	In
toSubject	Grant privileges to		String	In
includeQueryFilters	Create privileges for Query Filters?		String	In	No	Y, N
includeNavigationBars	Create privileges for Navigation Bars?		String	In	N	Y, N
includeDashboards	Create privileges for Dashboards?		String	In	No	Y, N
includeVisualizationAlerts	Create privileges for Visualization Alerts?		String	In	No	Y, N
includeVisualizationPSQueues	Create privileges for Visualization PS Queues?		String	In	No	Y, N
DryRun	Do a dry run? (No changes will be persisted)		String	In	No	Y, N

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 process definition requires the Active Monitoring Module.

note

The Active Monitoring Module requires the Module.Alerting license key

Schedule

This process 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 process definition is used to import CAR archive files.

note

The Promotion Module requires the Module.ImportExport license key

Parameters

Parameter	Description	Documentation	Direction	Data Type
CarUrl	File Name or URL of Archive	A URL to the CAR file, for example R:\\Car\\Example.car or http://filserver.example.com/shared/CarFiles/Example.car. See Importing Redwood Server Objects with Imports for more information.	In	String
ImportRuleSetName	Name of import rule-set to apply to imported objects	(Optional) Import rule set to apply to objects	In	String
TestMode	Test mode activated	Allows you to perform a dry run so you can see what would have been imported. Accepts values true and false (default)	In	String
ImportResult	Import result as REST objects	An XML representation of what was imported listing the business key, Permalink, and description of each imported object.	Out	String
TargetPartition	The target partition of the imported objects	When this parameter is set, an import rule set will be generated with a partition rename and will be used on the imported objects. The target partition you specify will be used in the partition rename rule.	In	String
ImportRuleSetProperties	<variable>=<value> pairs to be used by the Import Rule Set action.

More Information

• Importing Redwood Server Objects with Imports

System_Import_Archive_WithApproval

Purpose

You use this definition in combination with remote systems for promotion to control inbound promotion requests.

Parameters

Name	Description	Direction	Type	Values
CarUrl	File Name or URL of Archive	In	String
ImportRuleSetName	Name of import rule set to be applied to imported objects	In	String
TestMode	Test mode activated	In	String	true, false
ImportResult	Import result as REST objects	Out	String
TargetPartition	The target partition of the imported objects	In	String
auditReason	Reason for Change	In	String
ImportRuleSetProperties	The properties of the import rule set	In	String
ApplicationData	Output data	Out	String
InvalidateOnError	Invalidate definitions on error	In	String

System_Import_JarFile

Purpose

This process 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
JarFileName	The new name of the jar file to be saved in the library	In	String
auditReason	Reason for change	In	String

System_Import_Settings

Purpose

Configure the behavior of System_Import_Archive. Specify a run-as user to limit access to running imports or set lockdown to true to prohibit imports from unauthorized sources.

note

The Promotion Module requires the Module.ImportExport license key

Parameters

Parameter	Description	Direction	Data Type
runAsUser	Run-as user	In	String
lockdown	Lockdown	In	String

System_Import_SystemCarFiles

Purpose

This process imports the Redwood Server Archive (CAR) definitions that are supplied with Redwood Server. Archives can be selected via a drop-down list. This process definition requires the Import/Export Module.

note

The Promotion Module requires the Module.ImportExport license key

Parameters

Parameter	Description	Direction	Data Type
CarFile	File name of Archive	In	String

System_Import_ThirdParty_Plugin

Purpose

Import data from third-party scheduling environments. You use the System_Import_SystemCarFiles process definition to import plugins for the source system.

Parameters

Parameter	Description	Direction	Data Type
Source	Source system to import the data from	In	String
JobDefinitionPerformingImport	process definition to use to import the data	In	String
DefaultTimeZone	The default timezone to use	In	String
DestinationPartition	Destination partition for the generated Redwood Server object definitions	In	String
OutFileUrl	URL to the output file	Out	String

System_Info

Purpose

This process definition is used to retrieve information about the Java Virtual Machine that the central Redwood Server uses. You may be asked to run this process by Redwood Support for diagnostic purposes, there is no need to run it yourself.

System_InitializeOracleService

Purpose

Create or update the System_Oracle process server for use with the legacy PL/SQL API. Note that the process definition requires the passwords for both the Redwood Server version 2023.2.0 schema as well as Oracle user SYS.

Parameters

Parameter	Description	Direction	Data Type
Password	Oracle Password of Redwood Server user	In	String
SysPassword	Oracle Password of SYS user	In	String

note

The submit wizard will expect you to retype the password for safety reasons.

System_Internal_Chain

Purpose

These chain definitions are created by the chain editor when you convert chain calls into child chains. These chains are only displayed in the chain editor and backend; not under "Definitions > Chains". You can specify a name for them in the chain editor and they will be displayed alongside other chain definitions.

System_Isolation_Deisolation

Purpose

This process definition is used to remove all isolation groups from an OEM version of the software (SAP CPS, SAP BPA), allowing you to interact with more than one SAP system in a session.

System_Isolation_SetUser

Purpose

This process definition allows you to authorize a user to read all isolation groups.

Parameters

Parameter	Description	Data Type
UserName	User Name	String

System_LicenseCheck

Purpose

Generate an XML file containing all the licensed items.

Schedule

You schedule this process definition when instructed to do so by Redwood Support Services.

System_Loop_Aggregate

Writes all parameters and their values from the previous job chain step in an RTX table.

Parameters

Name	Description	Documentation	Data Type	Direction	Default Expression	Values
Table	RTX Table output		Table	Out
ConcatenateTableParameters	Table outparameters to concatenate		String	In
IncludeParameters	Parameters to include		String	In
DebugJobId	JobId for debug purposes		String	In
OutFiles	Out files		String	Out

System_Loop_Over_Table

Loops over the given table parameter and submit for every row in the table the single process in the next step of the job chain.

Parameters

Tab|Name|Description|Documentation|Data Type|Direction|Default Expression|Values |---|---|---|---|---|---|--- |Table|RTX Table to loop over|

|Table|In|

|

|Filter|REL to filter the rows, must return true to process the current row|

|String|In|

|

|JobDescription|REL for description of looped jobs|

|String|In|

|

System_Mail_Configure

Purpose

Configure the Mail module to allow the process server to send emails.

note

The Mail Module requires the Module.Mail license key

Parameters

This process 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 process output via email using SMTP.

note

The Mail Module requires the Module.Mail license key

Parameters

Parameter	Description	Data Type
To	To	The recipients' email address(es). Multiple email addresses are specified comma- (,) or semicolon-separated (;), such as jdoe@example.com,jsmith@example.com or jdoe@example.com;jsmith@example.com.
Subject	Subject	The subject of the email.
Text	Text	The text of the email.
RelativeJob	Relative process (optional)	The process that generated the output that is to be sent, syntax job n, where n is the process ID, for example job 122588. In a chain, you use the syntax <Step_name> <n>, Process <m> for example, Step 2, Process 3 for the third process of the step named Step 2; it has to be a previous step to the one this process definition is in.
JobFile	Process file (optional)	The output file of the process specified in the RelativeJob parameter. You use GLOB (? and *) to match multiple output files, * matches all files.
Server	Server	The SMTP server to use (optional).
From	From	The sender's email address (optional).

System_MonitorTables

Purpose

Add the database table row counts to the monitor tree.

System_OperatorMessage

Purpose

This process definition is used to create Operator messages. You can use this process within a chain to send one-way messages, or to send messages that wait for a reply. Use this process definition if you want to log that something has happened, or contact the operator to confirm a condition or provide input.

Parameters

Parameter	Description	Data Type
message	Message.	The message that the operator has to reply to.
replyExpression	Reply Expression.	A regular expression of valid replies.
reply	Reply.	The reply to the operator message (output parameter)

System_OraApps_ConcurrentProgramImport

Purpose

You use this job definition to import Oracle Applications or Oracle EBS jobs into Redwood Server. Requires the ProcessServerService.OraApps.limit license key.

Parameters

Parameter	Description	Documentation	Direction	Data Type	Default Value
OraApps_SystemName	Applications System name	The name of the Oracle Applications system in Redwood Server	In	String
SRS	Include Non-SRS programs?	This allows you to limit the selection to Standard Request Submission-compliant (SRS) concurrent programs (default)	In	String
ApplicationShortName	Application Short name	The short name of the application that holds the concurrent program.	In	String
ConcurrentProgramName	Concurrent Program name	The concurrent program name, note that although the end-user friendly name will be selected, the technical name is used to identify the program	In	String
OVERWRITE	Overwrite Existing Process Definitions?	By default, existing process definitions are not overwritten; when you wish to re-import a concurrent program, ensure this parameter is set to Y	In	String	N
PARTITION	Partition	The partition to use for the process definition	In	String
APPLICATION	Application	The Redwood Server application to use for the process definition	In	String

System_OraApps_ConcurrentProgramMultipleImport

Purpose

Import Multiple Concurrent Program definitions for creating Oracle Applications job definitions. This job can be used to import multiple job definitions reading concurrent program definitions out of the Oracle Applications system. Requires the ProcessServerService.OHI.limit license key.

Parameters

Parameter	Description	Documentation	Direction	Data Type
OraApps_SystemName	Applications System name	The name of the Oracle Applications system in Redwood Server; this parameter allows you select an Oracle Applications system from a list.	In	String
ApplicationShortName	Application Short name	The short name of the application that holds the concurrent program.	In	String
ConcurrentProgramName	Concurrent Program name	The concurrent program name; SQL type wildcards (% for any number of characters and _ for one character) are accepted.	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String
SRS	Include Non-SRS programs?	In	String
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_OraApps_InstallInterceptFunctionality

Purpose

Installs the interception capabilities in the designated Oracle Applications server. This process installs the necessary PL/SQL trigger that performs the intercept.

Parameters

Parameter	Description	Documentation	Data Type
OraApps_SystemName	Applications System name	The name of the Oracle Applications system in Redwood Server; this parameter allows you select an Oracle Applications system from a list.	String

System_OraApps_PackageMethodImport

Purpose

Creates a process definition that allows you to execute a stored procedure or funtion in the Oracle Applications system.

Parameters

Parameter	Description	Documentation	Data Type
OraApps_SystemName	Applications System name	The name of the Oracle Applications system in Redwood Server; this parameter allows you select an Oracle Applications system from a list.	String
ApplicationShortName	Application Short name	The short name of the application from which you would like to use a procedure or function. You select the application short name from a list.	String
PackageName	Package API name	The package name containing the procedure or function	String
PackageMethodName	Package Method name	The name of the procedure or function you want to call; you can select it out of a list.	String

System_OraApps_RequestSetImport

Purpose

You use this job definition to import Oracle Applications or Oracle EBS request sets into Redwood Server. Requires the ProcessServerService.OraApps.limit license key.

Parameters

Parameter	Description	Direction	Data Type	Default Value
OraApps_SystemName	Applications System name	In	String
ApplicationShortName	Application Short name	In	String
RequestSetName	Request set name	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String	N
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_OraApps_RequestSetMultipleImport

Purpose

Import Multiple Request Set definitions for creating Oracle Applications process definitions. This process can be used to create multiple process definitions reading request set definitions out of the Oracle Applications system.

Parameters

Parameter	Description	Direction	Data Type
OraApps_SystemName	Applications System name	In	String
ApplicationShortName	Application Short name	In	String
RequestSetName	Request set name	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_OraApps_UnInstallInterceptFunctionality

Purpose

Removes the interception capabilities from the designated Oracle Applications server. This process removes the PL/SQL trigger that performs the intercept.

Parameters

Parameter	Description	Documentation	Data Type
OraApps_SystemName	Applications System name	The name of the Oracle Applications system in Redwood Server; this parameter allows you select an Oracle Applications system from a list.	String

System_OraOHI_ImportAll

Import All OHI script definitions for creating Oracle Health Insurance job definitions. This job can be used to import all job definitions reading script definitions out of the Oracle Health Insurance system. Requires the ProcessServerService.OHI.limit license key

Parameters

Parameter	Description	Direction	Data Type
OraOhi_SystemName	OraOhi_SystemName	In	String
OraOhi_ScriptName	OHI Script name	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_OraOHI_ImportSingle

Purpose

Import an OHI Script definition for creating an Oracle Health Insurance job definition. Requires the ProcessServerService.OHI.limit license key

Parameters

Parameter	Description	Direction	Data Type	Default Value
OraOhi_SystemName	OraOhi_SystemName	In	String
OraOhi_ScriptName	OHI Script name	In	String
OraOhi_TestRun	Test run?	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String	N
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_OraOHI_MonitorJob

Purpose

Internal process definition for monitoring Oracle Health Insurance (OHI) workload. Do not submit this process definition.

Parameters

Parameter	Description	Direction	Data Type	Default Value
OraOhi_SystemName	OraOhi_SystemName	In	String

System_OutputMonitorTree

Outputs a part of the monitor tree into a binary file. This process definition is called by System_FetchRemoteMonitorTree via SOAP. There is no need to schedule this process definition manually.

Parameters

Name	Description	Direction	Data Type
MonitorTreePath	Monitor tree path	In	String

System_PeopleSoft_ProgramImport

Import PeopleSoft Program definitions for creating PeopleSofts process definitions This process can be used to import process definitions reading PeopleSoft program definitions out of the PeopleSoft system.

Parameters

Parameter	Description	Direction	Data Type
PeopleSoft_SystemName	PeopleSoft System name	In	String
ProcessType	Process Type	In	String
ProcessName	Process Name	In	String
OVERWRITE	Overwrite Existing Process Definitions?	In	String
PARTITION	Partition	In	String
APPLICATION	Application	In	String

System_PeopleSoft_ProgramMultipleImport

This process can be used to import one or more definitions reading PeopleSoft program definitions out of the PeopleSoft system.

Parameters

Tab	Name	Description	Documentation	Data Type	Direction	Default Expression	Values
null	PeopleSoft_SystemName	PeopleSoft System name		String	In
null	ProcessType	Process Type		String	In
null	ProcessName	Process Name		String	In
Generation Settings	OVERWRITE	Overwrite Existing Process Definitions?		String	In	N	Y, N
Generation Settings	PARTITION	Partition		String	In
Generation Settings	APPLICATION	Application		String	In

System_PeopleSoft_ReportImport

Create a process definition from an imported definition reading PeopleSoft query definitions out of the PeopleSoft system.

Parameters

Tab	Name	Description	Documentation	Data Type	Direction	Default Expression	Values
null	PeopleSoft_SystemName	PeopleSoft System name		String	In
null	SearchString	Report Name		String	In
Generation Settings	OVERWRITE	Overwrite Existing Process Definitions?		String	In	N	Y, N
Generation Settings	PARTITION	Partition		String	In
Generation Settings	APPLICATION	Application		String	In

System_PeopleSoft_ReportMultipleImport

This process can be used to import one or more process definition from an imported query definition reading PeopleSoft query definitions out of the PeopleSoft system.

Parameters

Tab	Name	Description	Documentation	Data Type	Direction	Default Expression	Values
null	PeopleSoft_SystemName	PeopleSoft System name		String	In
null	SearchString	Report Name		String	In
Generation Settings	OVERWRITE	Overwrite Existing Process Definitions?		String	In	N	Y, N
Generation Settings	PARTITION	Partition		String	In
Generation Settings	APPLICATION	Application		String	In

System_PeopleSoft_RunControl

Template to run PeopleSoft run control definitions This template can be used to run PeopleSoft run controls already defined in the PeopleSoft system.

Parameters

Parameter	Description	Direction	Data Type
PeopleSoft_SystemName	PeopleSoft System name	In	String
PeopleSoft_UserName	Run User Name	In	String
RunControlId	Run Control ID	In	String
ServerName	Server Name	In	String
OutputDestinationFormat	Output Destination Format	In	String
OutputDestinationString	Output Destination String	In	String
ReportFolderName	Report Folder Name	In	String
ProcessFileName	Process File Name	In	String
PrcsDistributionIdType	Distribution ID Type	In	String
PrcsDistributionId	Distribution ID	In	String
PrcsOutputDestinationType	Output Destination Type	In	String
PrcsOutputDestinationFormat	Output Destination Format	In	String
PrcsOutputDestinationString	Output Destination String	In	String
PrcsEmailSubject	Email Subject	In	String
PrcsEmailText	Email Text	In	String
PrcsEmailAddresses	Email Addresses	In	String
PrcsEmailAttachLog	Email Attach Log	In	String
PrcsEmailWebReport	Email Web Report	In	String

System_PeopleSoft_RunJob

Template to run PeopleSoft process definitions This template can be used to run PeopleSoft process definitions already defined in the PeopleSoft system.

Parameters

Parameter	Description	Direction	Data Type
PeopleSoft_SystemName	PeopleSoft System name	In	String
PeopleSoft_UserName	Run User Name	In	String
RunControlId	Run Control ID	In	String
ProcessType	Process Type	In	String
JobName	Job Name	In	String
ServerName	Server Name	In	String
OutputDestinationFormat	Output Destination Format	In	String
OutputDestinationString	Output Destination String	In	String
ReportFolderName	Report Folder Name	In	String
ProcessFileName	Process File Name	In	String
PrcsDistributionIdType	Distribution ID Type	In	String
PrcsDistributionId	Distribution ID	In	String
PrcsOutputDestinationType	Output Destination Type	In	String
PrcsOutputDestinationFormat	Output Destination Format	In	String
PrcsOutputDestinationString	Output Destination String	In	String
PrcsEmailSubject	Email Subject	In	String
PrcsEmailText	Email Text	In	String
PrcsEmailAddresses	Email Addresses	In	String
PrcsEmailAttachLog	Email Attach Log	In	String
PrcsEmailWebReport	Email Web Report	In	String

System_PeopleSoft_RunProcess

Template to run PeopleSoft process definitions This template can be used to run PeopleSoft process definitions already defined in the PeopleSoft system.

Parameters

Parameter	Description	Direction	Data Type
PeopleSoft_SystemName	PeopleSoft System name	In	String
PeopleSoft_UserName	Run User Name	In	String
RunControlId	Run Control ID	In	String
ProcessType	Process Type	In	String
ProcessName	Process Name	In	String
ServerName	Server Name	In	String
OutputDestinationFormat	Output Destination Format	In	String
OutputDestinationString	Output Destination String	In	String
ReportFolderName	Report Folder Name	In	String
ProcessFileName	Process File Name	In	String
PrcsDistributionIdType	Distribution ID Type	In	String
PrcsDistributionId	Distribution ID	In	String
PrcsOutputDestinationType	Output Destination Type	In	String
PrcsOutputDestinationFormat	Output Destination Format	In	String
PrcsOutputDestinationString	Output Destination String	In	String
PrcsEmailSubject	Email Subject	In	String
PrcsEmailText	Email Text	In	String
PrcsEmailAddresses	Email Addresses	In	String
PrcsEmailAttachLog	Email Attach Log	In	String
PrcsEmailWebReport	Email Web Report	In	String

System_ProcessKeepClauses

Purpose

Deletes old processes and chain processes according to their keep clause along with any runtime submit frames and/or time windows they referenced, provided the submit frames/time windows are not used by other objects.

This process definition is automatically scheduled by the system, there is no need to run it manually.

Schedule

This process definition gets submitted every 15 min automatically, to customize this behavior, you can edit the submit frame System_ProcessKeepClausesSubmitFrame in "Environment > Submit Frames".

System_Promote

Purpose

This process takes care of car file promotion.

Parameters

Parameter	Description	Direction	Data Type
exportRuleSetBusinessKey	Export Rule Set	In	String
remoteSystemBusinessKey	Remote System	In	String
sendToRemoteSystem	Promote to System	In	String

System_Promote_Further

Purpose

This process definition is submitted when you select a System_Import_Archive process and promote it further.

Parameter	Description	Direction	Data Type
SourceObject	Name of the Remote System	In	String
SourceObjectUniqueId	Unique ID of the Remote System	In	Number
SourceObjectType	Object type of the Remote System, this will always be RemoteSystem	In	String
Address	URL of where the car file needs to be send to	In	String
Message	Message associated with the Promote Further	In	String
Data	Location of the CAR file that needs to be promoted	in	String
CARFileLocation of the CAR file that needs to be promoted	In	File
OriginalJobId	ID of the process that is used as the source of the CAR file	In	String

Schedule

This process definition is submitted ad hoc by the remote system and should not be submitted manually.

System_R2W_Approval

Purpose

Publish process output files into a Report2Web catalog for approval.

Parameters

Parameter	Description	Direction	Data Type
Publish_Catalog	Report2Web Catalog	In	String
Publish_ReportName	Report Name	In	String
Publish_Source	Process file(s)	In	String
Publish_Comment	Approval Comment	Out	String
Publish_Status	Approval Status	Out	String

System_R2W_Connection_Setup

Purpose

Setup a connection to a Report2Web server's catalog.

Parameters

Parameter	Description	Direction	Data Type
ServerUrl	R2W Server URL	In	String
Catalog	Catalog	In	String
Username	Username	In	String
Password	Password	In	String

System_R2W_Publish

Purpose

Publish process output files into a Report2Web catalog.

Parameters

Parameter	Description	Direction	Data Type
Publish_Catalog	Report2Web Catalog	In	String
Publish_ReportName	Report Name	In	String
Publish_Source	Process file(s)	In	String

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_RaiseRemoteEvent

Purpose

Raise an event in a remote Redwood Server instance.

Parameters

Parameter	Description	Direction	Data Type	Default Value
Host	The hostname or IP address	In	String
Port	The port number	In	String
Username	The username to login with	In	String
Password	The password to login with	In	String
EventPartition	The partition of the event	In	String
EventName	The event name	In	String
RaiseComment	The comment added to the raised event	In	String	='Raised by process ' + jobId + ' on ' + String.getSystemId()
RaiseId	The raiseid of the remote event in the remote system	Out	String
URL	The HTTP URL (Overrides Host:Port/Scheduler settings)	In	String
IsolationGroup	The Isolation Group of the user	In	String
Timeout	The timeout for extablishing a connection	In	String	15000
MaxRetries	The max number of retries to establish a connection	In	String	15
Delay	The delay between retries	In	String

System_RaiseRemoteEvent_Repository

Purpose

Raise an event in a remote Redwood Server version 6 or version 7 instance.

Parameters

Parameter	Description	Direction	Data Type	Default Value
Host	The hostname or IP address	In	String
Port	The port number	In	String
Database	The database name	In	String
Username	The username to login with	In	String
Password	The password to login with	In	String
EventPartition	The partition of the event	In	String	SYSJCS
EventName	The event name	In	String
RaiseComment	The comment added to the raised event	In	String	='Raised by process ' + jobId + ' on ' + String.getSystemId()
JDBCURL	The JDBC URL (Overrides Host/Port/Database settings)	In	String

System_ReconfigureLogging

Purpose

Centrally reset the logging configuration.

System_RemoveDeletedJobFiles

Purpose

This process definition allows you to delete multiple old process files.

Parameters

Parameter	Description	Direction	Data Type
ProcessServer	Process server	In	String
Code	Code	In	String

System_RemoveOldJobs

Purpose

Allows you to delete multiple processes from the repository.

note

Please do not schedule the process definition regularly, use keep clauses instead.

Parameters

Parameter	Description	Direction	Data Type	Default Value	Default List of Values
IsolationGroup	Visible from Isolation Group	In	String
JobAgeUnitType	Age unit type	In	String
JobAgeUnits	Age is older than	In	Number
JobDate	Date is before	In	DateTimeZone
JobDefinitionPrefix	Filter by process definition name	In	String
JobDefinition	The description of the process definition	In	Number
JobId	JobId is before	In	Number
Kind	Remove processes by	In	String		I (JobId) D (Date) A (Age)
Statuses	Restrict to statuses (comma separated codes)	In	String	C,E,U,A

System_RemoveOperatorMessages

See System_RemoveRepliedMessages

System_RemoveRepliedMessages

Purpose

Remove old operator messages; messages that require a reply get a reply before removal. This process definition is used to reduce the number of operator messages in the operator message monitor.

note

Both process definitions are the same, the name was changed to System_RemoveOperatorMessages as the other was considered confusing.

Parameters

Parameter	Description	Direction	Data Type	Default Value	Default List of Values
AutoReply	Automatically reply to messages?	In	String	true	true false
ReplyList	Comma separated list of valid replies	In	String
Kind	Age or Date	In	String	D	D (date)A (age)
OperatorMessageDate	Date	In	Date Time Zone
OperatorMessageAgeUnits	Age	In	Number
OperatorMessageAgeUnitType	Age Units	In	String	S (seconds) N (minutes) H (hours) D (days) M (months) Y (years)

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.

Parameters

Parameter	Description	Direction	Data Type
OutputFormat	Report format	In	String
RecordCount	Number of rows generated in the report	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 processes are generated to restore the system to a point in time. To continue with the restoration run the held processes (in the order required to meet dependency requirements).

Parameter

Parameter	Description	Data Type
DateTimeToRestore	The point to restore to.	DateTimeZone

System_SecureStorage_Configure

Purpose

Enable AES encryption of passwords in the database; note that this cannot be undone.

Parameters

Parameter	Description	Direction	Data Type
Encrypt	Storage encryption (activate only)	In	String

Schedule

This process definition should only be submitted once to enable encryption.

System_SetDefaultLanguage

Purpose

Set Default Language.

Parameters

Parameter	Description	Direction	Data Type
Language	Language	In	String

System_SetSystemDataRootDirectory

Purpose

Set the DataRootDirectory of the System process server. The DataRootDirectory where configuration and output files are stored must not reside on an NFS or SMB share on MS Windows servers.

Parameters

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

note

The Mail Module requires the Module.Mail license key

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

Purpose

Send an SMS using SMTP.

note

The Mail Module requires the Module.Mail license key

Parameters

Parameter	Description	Direction	Data Type
MobileNumber	Mobile number	In	Number
Tags	Vendor Specific Tags	In	String
Text	Message	In	String

System_SNMP_Configure

Purpose

This process definition allows you to set SNMP trap defaults. This process definition requires the SNMP Module

note

The SNMP Module requires the Module.SNMP license key

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_SNMP_SendTrap

Purpose

Send an SNMP trap.

note

The SNMP Module requires the Module.SNMP license key

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_SQLPLUS_Command

Purpose

Perform a Query using SQLPLUS. Requires the PLSQL module.

Parameters

Parameter	Description	Direction	Data Type
JCS_USER	The account that will connect to the database	In	String
JCS_ENDPOINT	The database to connect to	In	String
COMMAND	The query to perform	In	String

System_SynchronizeBackgroundJobs

Purpose

Ensure that there is only one instance of each maintenance process running.

System_UpdateJobStatistics

Update the statistics of process definitions with runtime data from processes that have run, this data is available in the statistics section in the details pane of "Definitions > Processes". This process definition is automatically scheduled by the system, there is no need to run it manually.

Schedule

This process 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 process definition performs post-upgrade tasks and should not be submitted by users, unless you are instructed to do so by Redwood support.

Parameters

Parameter	Description	Data Type
Mode	Mode	String

System_UserMessage

This process definition is used to send a message to a user requesting approval. The user can then approve or reject it; this is used to validate processes that have completed. When a user rejects a user message, the user message process reaches status Error.

Parameters

Parameter	Description	Direction	Data Type
UserMessage_SelectedAction	The answer the user selected, approve or reject.	Out	String
UserMessage_Participants	Participant Users	In	String
UserMessage_Comment	The comment the user entered	Out	String
UserMessage_Roles	Participant Roles	In	String

System_UserMessage_Notification

This process definition is used to send a message to a user via email.

Parameters

Parameter	Description	Direction	Data Type	Examples
Mail_To	The email address of the person who will receive this notification.	In	String
UserMessage_Operator	The name of the operator who raised the notification.	In	String
UserMessage_Action	The action performed to the user message, for example, delegated, forwarded, responded.	In	String
UserMessage_Text	The user message text.	In	String
UserMessage_NewAssignee	The person who is now responsible for the user message.	In	String
UserMessage_OldAssignee	The person who was previously responsible for the user message.	In	String
UserMessage_FileLinks	A list of direct URLs to user message attachments.	In	String
Subject_Name	The full name or username of the mail recipient	In	String
Mail_Attachments	A semi-colon delimited list of Process File references to attach to the mail process using the syntax: <file_name>=<relative_process>:<output_file>	In	String	file1=Step 1,Job 1:stdout.log; file2=Step 1, Process 2:stdout.log
UserMessage_Link	The direct link to the user message.	In	String
UserMessage_UniqueId	The Unique ID of the User Message	In	Number
UserMessage_Reply	The current User Message reply	In	String

System_VersionInfo

Purpose

Retrieve version information of Redwood Server. The output is especially useful for support requests.

System_VersionUpdateCheck

Purpose

Check online to see if a critical update of Redwood Server is available. This process definition requires an internet connection to support.eu.redwood.com and support.us.redwood.com. The process generates no output; administrators will see a message when a critical update is available.

note

The process will not check for regular releases, only critical updates.

Schedule

This process should not be submitted manually; it will run regularly if the following registry entry is set to true:

/configuration/update/check

The first time you log in, Redwood Server will ask if you want to be alerted when critical updates are available for the version you are using.

System_Windows_Session_Close

Purpose

Close Terminal Services session on a Microsoft Windows Server.

Parameters

Name	Description	Documentation	Direction	Data Type
JCS_SESSION	Opaque session handle	The session handle as returned by System_Windows_Session_Create (see below).	In	String

System_Windows_Session_Create

Purpose

Create Terminal Services session on a Microsoft Windows Server.

Parameters

Name	Description	Documentation	Direction	Data Type
JCS_SESSION	Opaque session handle	This handle can be used by System_Windows_Session_Close (see above) for closing the terminal services session.	Out	String
JCS_SESSION_ACCOUNTS	List of accounts	A comma separated list of accounts, the asterisk * wildcard is allowed. The platform agent will take the first account in the list that does not yet have an RDP session open and open one.	In	String
JCS_SESSION_TIMEOUT	Session expires after (minutes)	The timeout for the session; once this is reached, the terminal services session is closed.	In	Number