PRCS_SCHEDULE

Use this service operation to schedule a job or process. Most of the elements are optional and required only if you want to override the default values for the process.

Request Message: PRQ_SCHEDULE_REQ

Element Name	Description
RunControlId Required	Run control ID. You can enter an existing run control ID or create a new one.
ProcessType Required	Process type. Use service operation PRCS_GETPROMPT with ParameterName ProcessType for a list of valid process types.
ProcessName Either a ProcessName or a JobName is required.	Process name. Use service operation PRCS_GETPROCESSNAMES if you are not sure of the process name. Note: Process name is case-sensitive.
JobName Either a ProcessName or a JobName is required.	Job name. Note: Job name is case-sensitive.
ServerName	Server name. Use service operation PRCS_GETPROMPT with ParameterName ServerName for a list of valid servers.
RunDateTime	Custom run date time in the format 2008-11-17 192.0.2.0000.
TimeZone	Time zone.
Recurrence	Recurrence Use service operation PRCS_GETPROMPT with ParameterName RecurrenceName for a list of valid recurrence definitions.
OutputDestinationType	If this element is omitted, the default output type is used. To override the default output, enter a valid output type for the process. See Process Scheduler: Selecting Output Types and Formats.
OutputDestinationFormat	If this element is omitted, the default output format is used. To override the default format, enter a valid output format for the process. See Process Scheduler: Selecting Output Types and Formats.
OutputDestinationString	If the output type is File or Printer, specify the file path or printer destination for the output.
ReportFolderName	Report folder name. This folder name applies to the main job or process. For a process within a job, enter the override for job item node (<JobItems> section).
ProcessFileName	Dependant file name. Use this value to override the file name in the process definition.
RetentionDays	Retention days. Note: Retention days applies to a process. For a process within a job, enter the override for job item (<JobItems> section).

<PrcsDistributionOption> Use these elements to enter distribution overrides at the process level.

Process Distribution Option Elements	Description
PrcsDistributionIdType	Specify either User or Role.
PrcsDistributionId	Specify the corresponding distribution ID for the DistributionIdType.

<PrcsOutputOption> Use these elements to modify the output options at the process level.

Process Output Option Elements	Description
PrcsOutputDestinationType	If this element is omitted, the default output type is used. To override the default output, enter a valid output type for the process. See Process Scheduler: Selecting Output Types and Formats.
PrcsOutputDestinationFormat	If this element is omitted, the default output format is used. To override the default format, enter a valid output format for the process. See Process Scheduler: Selecting Output Types and Formats.
PrcsOutputDestinationString	If the output type is File or Printer, specify the file path or printer destination for the output.

Process Output Option Elements

Description

PrcsOutputDestinationType

If this element is omitted, the default output type is used. To override the default output, enter a valid output type for the process.

See Process Scheduler: Selecting Output Types and Formats.

PrcsOutputDestinationFormat

If this element is omitted, the default output format is used. To override the default format, enter a valid output format for the process.

See Process Scheduler: Selecting Output Types and Formats.

PrcsOutputDestinationString

If the output type is File or Printer, specify the file path or printer destination for the output.

<PrcsEmailOption> Use these elements to enter email overrides at the process level.

Process Email Option Elements	Description
PrcsEmailSubject	Enter the text that appears in the subject line of the email. If this element is omitted, the default text message is used.
PrcsEmailText	Enter text to appear in the body of the email. If this element is omitted, the default text message is used
PrcsEmailAddresses	Enter a list of email addresses, separated by semicolons, to which the email should be sent.
PrcsEmailAttachLog	Enter true to include log files resulting from the Structured Query Report (SQR) program as attachments to the email file (SQR only).
PrcsEmailWebReport	Enter true to send an email with a link to the completed report output. This option is available only when the output type for the request is Web.

<JobItem> If the request is for a job, use these elements to enter the job information.

Job Item Elements	Description
JobName	Job name.
ProcessItemLevel	Specify the job item's process level within the main job as a number.
JobSequenceNumber	Specify the parent item’s sequence number as a number.
SeqNoInItemLevel	Specify the item’s sequence number as a number.
ReportFolderName	Enter the name of the folder in which the report results are posted.
RetentionDays	Enter the number of days before the files that are on the report repository are deleted. If no value is entered, the default retention days for the process is used.

<DistributionOption> Use these elements to modify the distribution list for job items.

Job Item Distribution Option Elements	Description
DistributionIdType	Specify either User or Role.
DistributionId	Specify the corresponding distribution ID for the DistributionIdType.

<OutputOption> Use these elements to modify the output options for job items.

Job Item Output Option Elements	Description
OutputDestinationType	If this element is omitted, the default output type is used. To override the default output, enter a valid output type for the process. See Process Scheduler: Selecting Output Types and Formats.
OutputDestinationFormat	If this element is omitted, the default output format is used. To override the default format, enter a valid output format for the process. See Process Scheduler: Selecting Output Types and Formats.
OutputDestinationString	If the output type is File or Printer, specify the file path or printer destination for the output.

Job Item Output Option Elements

Description

OutputDestinationType

If this element is omitted, the default output type is used. To override the default output, enter a valid output type for the process.

See Process Scheduler: Selecting Output Types and Formats.

OutputDestinationFormat

If this element is omitted, the default output format is used. To override the default format, enter a valid output format for the process.

See Process Scheduler: Selecting Output Types and Formats.

OutputDestinationString

If the output type is File or Printer, specify the file path or printer destination for the output.

<EmailOption> Use these elements to enter email options for job items.

Job Item Email Option Elements	Description
EmailSubject	Enter the text that appears in the subject line of the email. If this element is omitted, the default text message is used.
EmailText	Enter text to appear in the body of the email. If this element is omitted, the default text message is used
EmailAddresses	Enter a list of email addresses, separated by semicolons, to which the email should be sent.
EmailAttachLog	Enter true to include log files resulting from the Structured Query Report (SQR) program as attachments to the email file (SQR only).
EmailWebReport	Enter true to send an email with a link to the completed report output. This option is available only when the output type for the request is Web.

<RunTimeParameters> Use these elements to enter runtime parameters.

RunTime Parameter Elements	Description
ProcessName	Process name. Process name is case-sensitive.
ProcessType	Process type.
ParameterName	Parameter name.
ParameterValue	Parameter value.

Example Request:

This is an example request for a process with no runtime parameters or overrides:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:⇒
prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <prq:Schedule>
         <RunControlId>TEST1</RunControlId>
         <ProcessType>Application Engine</ProcessType>
         <!--Optional:-->
         <ProcessName>AEMINITEST</ProcessName>
       </prq:Schedule>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: PRQ_SCHEDULE_RES

Element	Description
ProcessInstance	Process instance number.
JobName	Job name.
ProcessName	Name of process within the job.
ProcessType	Process type.
JobSequenceNumber	Sequence number within the job.
ProcessItemLevel	Process item level within the job.
ProcessInstance	Process instance number for the job item.

Example Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:⇒
soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/⇒
2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <prq:ScheduleResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise⇒
/⇒
Tools/schemas/PRQ_SCHEDULE_RES.VERSION_1 PRQ_SCHEDULE_RES.VERSION_1.xsd"⇒
 xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/⇒
PRQ_SCHEDULE_RES.VERSION_1">
         <ProcessInstance>33</ProcessInstance>
      </prq:ScheduleResponse>
   </soapenv:Body>
</soapenv:Envelope>

Schedule a Process with Prompts

This is an example of a request for a process that has two parameters:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"⇒
 xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE⇒
_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <prq:Schedule>
         <RunControlId>SYNC</RunControlId>
         <ProcessType>Application Engine</ProcessType>
         <!--Optional:-->
         <ProcessName>PORTAL_CSS</ProcessName>
         <!--Zero or more repetitions:-->
         <RunTimeParameter>
            <ProcessName>PORTAL_CSS</ProcessName>
            <ProcessType>Application Engine</ProcessType>
            <ParameterName>Portal Name</ParameterName>
            <ParameterValue>EMPLOYEE</ParameterValue>
         </RunTimeParameter>
         <RunTimeParameter>
            <ProcessName>PORTAL_CSS</ProcessName>
            <ProcessType>Application Engine</ProcessType>
            <ParameterName>Delete invalid security</ParameterName>
            <ParameterValue>Y</ParameterValue>
         </RunTimeParameter>
      </prq:Schedule>
   </soapenv:Body>
</soapenv:Envelope>

Schedule a Job with Overrides for Output

This is an example to schedule a job with overrides for report distribution, output type and format for one of the processes within the job.:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:⇒
prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <prq:Schedule>
         <RunControlId>TEST1</RunControlId>
         <ProcessType>PSJob</ProcessType>
         <!--Optional:-->
         <JobName>3SQR</JobName>
         <JobItem>
            <JobName>XRFIELDS</JobName>
            <!--Optional:-->
            <ProcessItemLevel>1</ProcessItemLevel>
            <!--Optional:-->
            <JobSequenceNumber>1</JobSequenceNumber>
            <!--Optional:-->
            <SeqNoInItemLevel>1</SeqNoInItemLevel>
            <!--Optional:-->
            <DistributionOption>
               <DistributionIdType>User</DistributionIdType>
               <DistributionId>QEDMO</DistributionId>
            </DistributionOption>
            <OutputOption>
               <OutputDestinationType>WEB</OutputDestinationType>
               <OutputDestinationFormat>PDF</OutputDestinationFormat>
            </OutputOption>
         </JobItem>
      </prq:Schedule>
   </soapenv:Body>
</soapenv:Envelope>

The response for a job will include the process instance ID at each level:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:
soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/
2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <prq:ScheduleResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise
/Tools/schemas/PRQ_SCHEDULE_RES.VERSION_1 PRQ_SCHEDULE_RES.VERSION_1.xsd" xmlns:
prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_RES.VERSION_1">
         <ProcessInstance>21</ProcessInstance>
         <JobItem>
            <JobName>3SQR</JobName>
            <ProcessName>3SQR</ProcessName>
            <ProcessType>PSJob</ProcessType>
            <JobSequenceNumber>0</JobSequenceNumber>
            <ProcessItemLevel>0</ProcessItemLevel>
            <ProcessInstance>21</ProcessInstance>
         </JobItem>
         <JobItem>
            <JobName>3SQR</JobName>
            <ProcessName>XRFIELDS</ProcessName>
            <ProcessType>SQR Report</ProcessType>
            <JobSequenceNumber>1</JobSequenceNumber>
            <ProcessItemLevel>1</ProcessItemLevel>
            <ProcessInstance>22</ProcessInstance>
         </JobItem>
         <JobItem>
            <JobName>3SQR</JobName>
            <ProcessName>XRFMENU</ProcessName>
            <ProcessType>SQR Report</ProcessType>
            <JobSequenceNumber>2</JobSequenceNumber>
            <ProcessItemLevel>1</ProcessItemLevel>
            <ProcessInstance>23</ProcessInstance>
         </JobItem>
         <JobItem>
            <JobName>3SQR</JobName>
            <ProcessName>XRFRCFL</ProcessName>
            <ProcessType>SQR Report</ProcessType>
            <JobSequenceNumber>3</JobSequenceNumber>
            <ProcessItemLevel>1</ProcessItemLevel>
            <ProcessInstance>24</ProcessInstance>
         </JobItem>
      </prq:ScheduleResponse>
   </soapenv:Body>
</soapenv:Envelope>