Scheduling a Request
Client applications can use service operations to find a process for specified process type, retrieve the run time parameters, prompt values for a specified parameters, and schedule the process request. This section describes the service operations available to help in scheduling the request.
Use this service operation to retrieve the prompts for a process.
Request Message: PRQ_GETPROMPT_REQ
Element Name |
Description |
---|---|
ParameterName |
Valid values are:
All values are case-sensitive. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROMPT_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetPromptValues>
<ParameterName>RunStatus</ParameterName>
</prq:GetPromptValues>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GETPROMPT_RES
Element Name |
Description |
---|---|
Prompt Value |
Returns a list of values for the request prompt. |
Example Response:
This response returns the values for Run Status.
<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:GetPromptValuesResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROMPT_RES.VERSION_1 PRQ_GETPROMPT_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROMPT_RES.VERSION_1">
<PromptValue>Cancel</PromptValue>
<PromptValue>No Success</PromptValue>
<PromptValue>Posted</PromptValue>
<PromptValue>Not Posted</PromptValue>
<PromptValue>Resend</PromptValue>
<PromptValue>Posting</PromptValue>
<PromptValue>Generated</PromptValue>
<PromptValue>Pending</PromptValue>
<PromptValue>Warning</PromptValue>
<PromptValue>Blocked</PromptValue>
<PromptValue>Restart</PromptValue>
<PromptValue>Delete</PromptValue>
<PromptValue>Error</PromptValue>
<PromptValue>Hold</PromptValue>
<PromptValue>Queued</PromptValue>
<PromptValue>Initiated</PromptValue>
<PromptValue>Processing</PromptValue>
<PromptValue>Cancelled</PromptValue>
<PromptValue>Success</PromptValue>
</prq:GetPromptValuesResponse>
</soapenv:Body>
</soapenv:Envelope>
Use this service operation to retrieve a list of process names.
Request Message: PRQ_GETPROCESSNAMES_REQ
Element Name |
Description |
---|---|
ProcessType |
Process type. Process type is case-sensitive. Use service operation PRCS_GETPROMPT with ParameterName ProcessTypes for a list of valid process types. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROCESSNAMES_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetProcessNames>
<ProcessType>XML Publisher</ProcessType>
</prq:GetProcessNames>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GETPROCESSNAMES_RES
Element Name |
Description |
---|---|
ProcessName |
Returns a list of process names. |
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:GetProcessNamesResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROCESSNAMES_RES.VERSION_1 PRQ_GETPROCESSNAMES_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPROCESSNAMES_RES.VERSION_1">
<ProcessName>PSXPQRYRPT</ProcessName>
<ProcessName>QE_ETEXT</ProcessName>
<ProcessName>QE_GLX8100</ProcessName>
<ProcessName>QE_I9</ProcessName>
<ProcessName>QE_LOCALE</ProcessName>
<ProcessName>QE_TIMEZONE</ProcessName>
<ProcessName>QE_UNICODE</ProcessName>
<ProcessName>QE_XMD_BURST</ProcessName>
<ProcessName>QE_XMD_XLS</ProcessName>
<ProcessName>QE_XMLDOC</ProcessName>
<ProcessName>XRFWIN</ProcessName>
</prq:GetProcessNamesResponse>
</soapenv:Body>
</soapenv:Envelope>
Use this service operation to retrieve parameter values for a job or process. The job or process must have generic prompting enabled and runtime parameters defined.
Request Message: PRQ_GETPARAMS_REQ
Element Name |
Description |
---|---|
JobName |
Job name in upper case. |
ProcessName |
Process name in uppercase. |
ProcessType |
Process type. Use service operation PRCS_GETPROMPT with ParameterName ProcessTypes for a list of valid process types. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPARAMS_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetRunTimeParametersRequest>
<!--Optional:-->
<ProcessName>PORTAL_CSS</ProcessName>
<!--Optional:-->
<ProcessType>Application Engine</ProcessType>
</prq:GetRunTimeParametersRequest>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GETPARAMS_RES
Element Name |
Description |
---|---|
ProcessName |
Process name. |
ProcessType |
Process type. |
RecordName |
Prompt record name. |
RecordFieldName |
Prompt field name. |
ParameterName |
Parameter label. |
ApplicationClassMethod |
Application class method. |
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:GetRunTimeParametersResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPARAMS_RES.VERSION_1 PRQ_GETPARAMS_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETPARAMS_RES.VERSION_1">
<ProcessParameters>
<ProcessName>PORTAL_CSS</ProcessName>
<ProcessType>Application Engine</ProcessType>
<RecordName>PORTAL_CSS_RUN</RecordName>
<RecordFieldName>PORTAL_NAME</RecordFieldName>
<ParameterName>Portal Name</ParameterName>
<ApplicationClassMethod>.</ApplicationClassMethod>
</ProcessParameters>
<ProcessParameters>
<ProcessName>PORTAL_CSS</ProcessName>
<ProcessType>Application Engine</ProcessType>
<RecordName>PORTAL_CSS_RUN</RecordName>
<RecordFieldName>PORTAL_FLDRP_FLAG</RecordFieldName>
<ParameterName>Delete invalid security</ParameterName>
<ApplicationClassMethod>.</ApplicationClassMethod>
</ProcessParameters>
</prq:GetRunTimeParametersResponse>
</soapenv:Body>
</soapenv:Envelope>
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 01.11.37.000000. |
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. |
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. |
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. |
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. |
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 orRole. |
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. |
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. |
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>
This service operation schedules PSQuery process.
Request Message: PRQ_SCHEDULE_PSQUERY_REQ
Element Name |
Description |
---|---|
QueryName |
Specifies a string representing the name of a query. |
RunControlId |
Specifies a new or an existing run control ID. |
PromptName |
Specifies the name of the prompt for this query. |
PromptValue |
Specifies prompt value for its matching prompt names. |
FieldName |
Specifies the field name for the query tree prompt. |
ExpressionText |
Specifies the query expression text for the query tree prompt. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_PSQUERY_REQ.VERSION_1">
<soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>QE_QUERY</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">QE_QUERY</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<prq:SchedulePSQuery>
<QueryName>QE_TREE_OPT_PROMPTS</QueryName>
<Prompts>
<PromptName>SetID</PromptName>
<PromptValue>QEDM1</PromptValue>
</Prompts>
<TreePrompts>
<FieldName>A.QE_JOBCODE</FieldName>
<ExpressionText>,,QE_JOBCODES,1999-01-01,ALL_JOBS</ExpressionText>
</TreePrompts>
<TreePrompts>
<FieldName>C.DEPTID</FieldName>
<ExpressionText>SHARE,,DEPARTMENTS,1900-01-01,DEPARTMENTS</ExpressionText>
</TreePrompts>
<RunControlId>QE_TREE_OPT_PROMPTS</RunControlId>
</prq:SchedulePSQuery>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_SCHEDULE_PSQUERY_RES
Element Name |
Description |
---|---|
ProcessInstance |
Specifies a number representing a process instance for running the report. |
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:SchedulePSQueryResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_PSQUERY_RES.VERSION_1 PRQ_SCHEDULE_PSQUERY_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_PSQUERY_RES.VERSION_1">
<ProcessInstance>11078</ProcessInstance>
</prq:SchedulePSQueryResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation schedules non unique connected query process.
Request Message: PRQ_SCHEDULE_CONQUERY_REQ
Element Name |
Description |
---|---|
ConQueryName |
Specifies the connected query name. |
RunControlId |
Specifies a new or an existing run control ID. |
QueryName |
Specifies the name of a query that participates in the connected query. |
PromptName |
Specifies name of the prompt for this query. |
PromptValue |
Specifies prompt value for its matching query prompt. |
DistributionIdType |
Specify either User or Role. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_CONQUERY_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:ScheduleConQuery>
<ConQueryName>APX1090</ConQueryName>
<RunParam>
<QueryName>APY1090_MATCH_EXCEPTIONS</QueryName>
<Prompts>
<PromptName>MatchStatus</PromptName>
<PromptValue>Matched</PromptValue>
</Prompts>
<Prompts>
<PromptName>RunControlId</PromptName>
<PromptValue>PAYCYCLE</PromptValue>
</Prompts>
</RunParam>
<RunControlId>APX1090</RunControlId>
</prq:ScheduleConQuery>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_SCHEDULE_CONQUERY_RES
Element Name |
Description |
---|---|
ProcessInstance |
Specifies a number representing a process instance for running the report. |
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:ScheduleConQueryResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_CONQUERY_RES.VERSION_1 PRQ_SCHEDULE_CONQUERY_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_CONQUERY_RES.VERSION_1">
<ProcessInstance>11073</ProcessInstance>
</prq:ScheduleConQueryResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation schedules non unique BI Publisher processe.
Request Message: PRQ_SCHEDULE_BIPUBLISHER_REQ
Element Name |
Description |
---|---|
ReportName |
Specifies the name of the report. |
RunControlId |
Specifies a new or an existing run control ID. |
PromptName |
Specifies name of the prompt for the report. |
PromptValue |
Specifies prompt value for its matching query prompt. |
DistributionIdType |
Specify either User or Role. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_PSQUERY_REQ.VERSION_1">
<soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>VP1</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">VP1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<prq:ScheduleBIPublisher>
<ReportName>AMDE5001</ReportName>
<RunParam>
<Prompts>
<PromptName>OPRID</PromptName>
<PromptValue>VP1</PromptValue>
</Prompts>
<Prompts>
<PromptName>RUN_CNTL_ID</PromptName>
<PromptValue>test</PromptValue>
</Prompts>
</RunParam>
<RunControlId>AMDE5001</RunControlId>
</prq:ScheduleBIPublisher>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_SCHEDULE_BIPUBLISHER_RES
Element Name |
Description |
---|---|
ProcessInstance |
Specifies a number representing a process instance for running the report. |
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:ScheduleBIPublisherResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_BIPUBLISHER_RES.VERSION_1 PRQ_SCHEDULE_BIPUBLISHER_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_BIPUBLISHER_RES.VERSION_1">
<ProcessInstance>10570</ProcessInstance>
</prq:ScheduleBIPublisherResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation schedules a JobSet based on the settings as defined in the Scheduled JobSet Definition component.
Request Message: PRQ_RUNJOBSETNOW_REQ
Element Name |
Description |
---|---|
MainSchedName |
Specifies the name of the jobset schedule. |
MainJobName |
Specifies the name of job within the jobset schedule. |
Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_SCHEDULE_PSQUERY_REQ.VERSION_1">
<soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken wsu:Id="UsernameToken-1" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<wsse:Username>VP1</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">VP1</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body>
<prq:RunJobSetNow>
<MainSchedName>js1</MainSchedName>
<MainJobName>j1</MainJobName>
</prq:RunJobSetNow>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_RUNJOBSETNOW_RES
Element Name |
Description |
---|---|
ProcessInstance |
Specifies a number representing a process instance for running the report. |
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:RunJobSetNowResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_RUNJOBSETNOW_RES.VERSION_1 PRQ_RUNJOBSETNOW_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_RUNJOBSETNOW_RES.VERSION_1">
<ProcessInstance>10554</ProcessInstance>
</prq:RunJobSetNowResponse>
</soapenv:Body>
</soapenv:Envelope>