Monitoring a Request
Client applications can use service operations to monitor a process and get a report. This section describes the service operations available to monitor the request.
Use this service operation to find process requests.
Request Message: PRQ_FINDREQUESTS_REQ
Element Name |
Description |
---|---|
ProcessInstanceFrom |
Enter the process instance number for the beginning of a range of instances by which to limit the process requests that are returned. |
ProcessInstanceTo |
Enter the process instance number for the end of a range of instances by which to limit the process requests that are returned. |
OperatorId |
Enter the ID of the user who submitted the process. Leave blank to view all of the processes that you are authorized to view. Use service operation PRCS_GETPROMPT with ParameterName OperatorId for a list of valid user IDs. |
ProcessType |
Enter a process type to limit the returned list to a specific process type. |
ProcessName |
Enter a process name to limit the returned list to a specific process name. Process name is case-sensitive. |
ServerRun |
Enter the name of a server to limit the returned list to a specific server. |
RunStatus |
Enter the run status to limit the returned list to a specific status. Use service operation PRCS_GETPROMPT with ParameterName RunStatus for a list of valid run statuses. |
DistributionStatus |
Enter the distribution status to limit the returned list to a specific distribution status. Use service operation PRCS_GETPROMPT with ParameterName DistributionStatus for a list of valid distribution statuses. |
ProcessRequestCount |
Enter a number to limit the returned list. |
IsProcessCount |
Use this parameter to receive all data and process count. Specify 0 to receive all data but no ProcessCount. Specify 1 to receive all data and ProcessCount. |
<FilterType> The filter type can be either Last or Date Range
For <Last> specify an interval of time by which to limit the process requests that appear in the list.
Last Elements |
Description |
---|---|
FilterValue |
Enter a custom numerical value. |
FilterUnit |
Enter the interval. Valid values are:
|
Date Range
For <CustomDates> specify dates to get a list of requests created between two specific dates.
Date Range Elements |
Description |
---|---|
FromDate |
Enter a from date. |
ToDate |
Enter a to date. |
Example Request:
<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing/" xmlns:xsd="http://www.w3.org/2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
<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>
<wsse:Username>QEDMO</wsse:Username>
<wsse:Password>QEDMO</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>
<soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<prq:FindRequests xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_FINDREQUESTS_REQ.VERSION_1">
<OperatorId>QEDMO</OperatorId>
<ProcessType>SQR Report</ProcessType>
<ProcessName></ProcessName>
<RunStatus>Success</RunStatus>
<DistributionStatus>Posted</DistributionStatus>
<FilterType>
<CustomDates>
<FromDate>2009-02-01</FromDate>
<ToDate>2009-02-10</ToDate>
</CustomDates>
</FilterType>
</prq:FindRequests>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_FINDREQUESTS_RES
Element Name |
Description |
---|---|
ProcessInstance |
Process instance. |
ProcessName |
Process name. |
ProcessType |
Process type. |
RunControlID |
Run control ID. |
ServerNameRequested |
Name of the server requested for the process. |
ServerNameRun |
Name of the server where the process was run. |
OperatorID |
ID that submitted the process. |
RequestDateTime |
Date and time that the process request was submitted. |
RunDateTime |
The date and time that the process request was created. |
BeginDateTime |
The date and time that the process started. |
EndDateTime |
The date and time that the process ended. |
OutputDestinationFormat |
Output format. |
OutputDestinationType |
Output type. |
Recurrence |
Recurrence. |
RunStatus |
Run status. |
DistributionStatus |
Distribution status. |
ContentId |
Content ID is the Report ID assigned to the individual report by the Process Scheduler. The Content ID is used to view reports in the Report Repository. Note: For bursted reports all the associated content IDs will be retrieved and will be a part of the response. |
IsProcessCount |
Process count. |
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:FindRequestsResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_FINDREQUESTS_RES.VERSION_1 PRQ_FINDREQUESTS_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_FINDREQUESTS_RES.VERSION_1">
<ProcessRequestItem>
<ProcessInstance>9999941</ProcessInstance>
<ProcessName>DDDAUDIT</ProcessName>
<ProcessType>SQR Report</ProcessType>
<RunControlId>2</RunControlId>
<ServerNameRequested>PSNT</ServerNameRequested>
<ServerNameRun>PSNT</ServerNameRun>
<OperatorId>QEDMO</OperatorId>
<RequestDateTime>2009-02-03-13.12.33.921000</RequestDateTime>
<RunDateTime>2009-02-03-13.12.19.000000</RunDateTime>
<BeginDateTime>2009-02-03-13.13.00.000000</BeginDateTime>
<EndDateTime>2009-02-03-13.13.12.640000</EndDateTime>
<OutputDestinationFormat>PDF</OutputDestinationFormat>
<OutputDestinationType>WEB</OutputDestinationType>
<RecurranceName/>
<RunStatus>Success</RunStatus>
<DistributionStatus>Posted</DistributionStatus>
<ContentId>9999905</ContentId>
</ProcessRequestItem>
<ProcessRequestItem>
<ProcessInstance>9999948</ProcessInstance>
<ProcessName>SYSAUDIT</ProcessName>
<ProcessType>SQR Report</ProcessType>
<RunControlId>2</RunControlId>
<ServerNameRequested>PSNT</ServerNameRequested>
<ServerNameRun>PSNT</ServerNameRun>
<OperatorId>QEDMO</OperatorId>
<RequestDateTime>2009-02-05-09.53.32.296000</RequestDateTime>
<RunDateTime>2009-02-05-09.52.57.000000</RunDateTime>
<BeginDateTime>2009-02-05-09.54.33.000000</BeginDateTime>
<EndDateTime>2009-02-05-09.56.28.640000</EndDateTime>
<OutputDestinationFormat>PDF</OutputDestinationFormat>
<OutputDestinationType>WEB</OutputDestinationType>
<RecurranceName/>
<RunStatus>Success</RunStatus>
<DistributionStatus>Posted</DistributionStatus>
<ContentId>9999914</ContentId>
</ProcessRequestItem>
</prq:FindRequestsResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation is used to get the process request status.
Request Message: PRQ_GETREQUEST_REQ
Element Name |
Description |
---|---|
ProcessInstance |
Process instance number. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETREQUEST_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetRequest>
<ProcessInstance>9999951</ProcessInstance>
</prq:GetRequest>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GETREQUEST_RES
Element Name |
Description |
---|---|
ProcessInstance |
Process instance. |
ProcessName |
Process name. |
ProcessType |
Process type. |
RunControlID |
Run control ID. |
ServerNameRun |
Server name. |
OperatorID |
ID of the user who submitted the process. |
RequestDateTime |
The date and time that the process request was submitted. |
RunDateTime |
The date and time that the process request was scheduled to run. |
BeginDateTime |
The date and time that the process started. |
EndDateTime |
The date and time that the process ended. |
OutputDestinationFormat |
Output format. |
OutputDestinationType |
Output type. |
RunStatus |
Run status. |
DistributionStatus |
Distribution status. |
ContentId |
Report ID assigned in the Report Repository. Note: For bursted reports all the associated content IDs will be retrieved and will be a part of the response. |
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:GetRequestResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETREQUEST_RES.VERSION_1 PRQ_GETREQUEST_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETREQUEST_RES.VERSION_1">
<ProcessRequestItem>
<ProcessInstance>9999951</ProcessInstance>
<ProcessName>DDDAUDIT</ProcessName>
<ProcessType>SQR Report</ProcessType>
<RunControlId>TEST</RunControlId>
<ServerNameRun>PSNT</ServerNameRun>
<OperatorId>QEMGR</OperatorId>
<RequestDateTime>2009-02-05-11.32.37.125000</RequestDateTime>
<RunDateTime>2009-02-05-11.32.36.000000</RunDateTime>
<BeginDateTime>2009-02-05-11.33.01.000000</BeginDateTime>
<EndDateTime>2009-02-05-11.33.25.468000</EndDateTime>
<OutputDestinationFormat>PDF</OutputDestinationFormat>
<OutputDestinationType>WEB</OutputDestinationType>
<RunStatus>Success</RunStatus>
<DistributionStatus>Posted</DistributionStatus>
<ContentId>9999917</ContentId>
</ProcessRequestItem>
</prq:GetRequestResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation is used to update a request.
Request Message: PRQ_UPDATEREQUEST_REQ
Element Name |
Description |
---|---|
ProcessInstance |
The process instance to update. |
RunStatus |
Indicate the new status. Valid values are:
|
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_UPDATEREQUEST_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:UpdateProcessRequest>
<ProcessInstance>9999940</ProcessInstance>
<RunStatus>Deleted</RunStatus>
</prq:UpdateProcessRequest>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_UPDATEREQUEST_RES
Element Name |
Description |
---|---|
RequestStatus |
Returns the status of either Success orFailure. |
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:UpdateProcessRequestResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_UPDATEREQUEST_RES.VERSION_1 PRQ_UPDATEREQUEST_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_UPDATEREQUEST_RES.VERSION_1">
<RequestStatus>Success</RequestStatus>
</prq:UpdateProcessRequestResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation is used to retrieve a report from the report repository.
Request Message: PRQ_GETREPORT_REQ
Element Name |
Description |
---|---|
ContentID |
The content ID for the report. Use service operation PRCS_GETREQUEST to retrieve the content ID for the report. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETREPORT_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetReport>
<ContentId>9999917</ContentId>
</prq:GetReport>
</soapenv:Body>
</soapenv:Envelope>
Response Message:
Element Name |
Description |
---|---|
Content ID |
Content ID. |
Report URL |
Returns the URL to the report, log. and trace files. |
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:GetReportResponse xsi:schemaLocation="http://xmlns.oracle.com /Enterprise/Tools/schemas/PRQ_GETREPORT_RES.VERSION_1 PRQ_GETREPORT_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETREPORT_RES.VERSION_1">
<Report>
<ContentID>9999917</ContentID>
<ReportDetails>
<ReportURL>//ple-infodev-08.peoplesoft.com:8010/psreports/QEDMO/9999917/DDDAUDIT_9999951.PDF</ReportURL>
<ReportDescription>Portable Document Format</ReportDescription>
</ReportDetails>
<ReportDetails>
<ReportURL>//ple-infodev-08.peoplesoft.com:8010/psreports/QEDMO/9999917/DDDAUDIT_9999951.out</ReportURL>
<ReportDescription>Trace File</ReportDescription>
</ReportDetails>
<ReportDetails>
<ReportURL>//ple-infodev-08.peoplesoft.com:8010/psreports/QEDMO/9999917/SQR_DDDAUDIT_9999951.log</ReportURL>
<ReportDescription>Message Log</ReportDescription>
</ReportDetails>
</Report>
</prq:GetReportResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation retrieves server specific constraints data from the database. As a response, Max load and current load information will be returned in the XML response message.
Request Message: PRQ_GETSERVERCONSTRAINTS_REQ
Element Name |
Description |
---|---|
ServerName |
Specifies the server name for the service operation PRCS_GETSERVERCONSTRAINTS. |
ProcessType |
Specifies the process type for the service operation PRCS_GETSERVERCONSTRAINTS. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETSERVERCONSTRAINTS_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetServerConstraints>
<!--Optional:-->
<ServerName>PSNT</ServerName>
</prq:GetServerConstraints>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GETSERVERCONSTRAINTS_RES
Element Name |
Description |
---|---|
RaiseAlert |
Specifies the server suspended state. |
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:GetServerConstraintsResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETSERVERCONSTRAINTS_RES.VERSION_1 PRQ_GETSERVERCONSTRAINTS_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GETSERVERCONSTRAINTS_RES.VERSION_1">
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Application Engine</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>COBOL SQL</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Cube Builder</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Data Mover</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Essbase Cube Builder</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Optimization Engine</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>2</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>PSJob</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>SQR Process</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>SQR Report</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>SQR Report For WF Delivery</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>Winword</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>XML Publisher</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>nVision-Report</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
<ServerInfo>
<ServerName>PSNT</ServerName>
<ProcessType>nVision-ReportBook</ProcessType>
<CurrentLoad>0</CurrentLoad>
<MaxLoad>3</MaxLoad>
</ServerInfo>
</prq:GetServerConstraintsResponse>
</soapenv:Body>
</soapenv:Envelope>
<
This service operation retrieves output types.
Request Message: PRCS_GET_OUTPUTTYPES_REQ
Element Name |
Description |
---|---|
ProcessType |
Specifies the name of a predefined process type as a string. |
ProcessName |
Specifies the name of a predefined process as a string. |
LangCode |
Specifies the language code associated with the task to be enqueued. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTTYPES_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetOutputTypes>
<ProcessType>AppEngine</ProcessType>
</prq:GetOutputTypes>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRCS_GET_OUTPUTTYPES_RES
Element Name |
Description |
---|---|
OutputTypeValue |
Specifies the output type as a string. |
IsActive |
Specifies the active type. |
IsDefaultType |
Specifies the default type. |
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:GetOutputTypesResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTTYPES_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTTYPES_RES.VERSION_1">
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>-</ProcessName>
<OutputTypeValue>FILE</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>-</ProcessName>
<OutputTypeValue>WINDOW</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>-</ProcessName>
<OutputTypeValue>EMAIL</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>-</ProcessName>
<OutputTypeValue>WEB</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>FILE</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>WINDOW</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>WEB</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSQUERY</ProcessName>
<OutputTypeValue>FILE</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSQUERY</ProcessName>
<OutputTypeValue>WINDOW</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSQUERY</ProcessName>
<OutputTypeValue>EMAIL</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSQUERY</ProcessName>
<OutputTypeValue>WEB</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSQUERY</ProcessName>
<OutputTypeValue>FEED</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSXPQRYRPT</ProcessName>
<OutputTypeValue>FILE</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSXPQRYRPT</ProcessName>
<OutputTypeValue>PRINTER</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSXPQRYRPT</ProcessName>
<OutputTypeValue>WINDOW</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSXPQRYRPT</ProcessName>
<OutputTypeValue>EMAIL</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>0</IsDefaultType>
</OutputTypeInfo>
<OutputTypeInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSXPQRYRPT</ProcessName>
<OutputTypeValue>WEB</OutputTypeValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputTypeInfo>
</prq:GetOutputTypesResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation retrieves output format for a given process.
Request Message: PRQ_GET_OUTPUTFORMATS_REQ
Element Name |
Description |
---|---|
ProcessType |
Specifies the process type. Process type is case sensitive. |
ProcessName |
Specifies the process name. |
OutDestType |
Specifies the output type to filter the response. |
LangCode |
Specifies the language code associated with the task to be enqueued. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTFORMATS_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:GetOutputFormats>
<ProcessType>AppEngine</ProcessType>
<!--Optional:-->
<ProcessName>PSCONQRS</ProcessName>
<!--Optional:-->
<LangCode>FRA</LangCode>
</prq:GetOutputForma t s>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_GET_OUTPUTFORMATS_RES
Element Name |
Description |
---|---|
OutputTypeValue |
Specifies the output type value. |
OutputFormatValue |
Specifies the output format value. |
IsDefaultType |
Specifies the default value of the output format. |
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:GetOutputFormatsResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTFORMATS_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_GET_OUTPUTFORMATS_RES.VERSION_1">
<OutputFormatInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>FILE</OutputTypeValue>
<OutputFormatValue>XML Format(*.xml)</OutputFormatValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputFormatInfo>
<OutputFormatInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>WINDOW</OutputTypeValue>
<OutputFormatValue>XML Format(*.xml)</OutputFormatValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputFormatInfo>
<OutputFormatInfo>
<ProcessType>AppEngine</ProcessType>
<ProcessName>PSCONQRS</ProcessName>
<OutputTypeValue>WEB</OutputTypeValue>
<OutputFormatValue>XML Format(*.xml)</OutputFormatValue>
<IsActive>1</IsActive>
<IsDefaultType>1</IsDefaultType>
</OutputFormatInfo>
</prq:GetOutputFormatsResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operations retrieves an HTML formatted report in a tree displaying all items in a job or jobset, as defined in the Job Definition component.
Request Message: PRQ_PRINTJOBHTMLREPORT_REQ
Element Name |
Description |
---|---|
JobName |
Specifies the name of the job. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_JOBHTMLREPORT_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:PrintJobHTMLReport>
<JobName>3SQR</JobName>
</prq:PrintJobHTMLReport>
</soapenv:Body>
</soapenv:Envelope>
PRQ_PRINTJOBHTMLREPORT_RES
Element Name |
Description |
---|---|
HTMLReport |
Returns an HTML formatted report in a tree displaying all items in a job or jobset. |
Example Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Body>
<SOAP-ENV:Fault>
<faultcode>SOAP-ENV:Server</faultcode>
<faultstring>null</faultstring>
<detail>
<IBResponse type="error">
<DefaultTitle>Integration Broker Response</DefaultTitle>
<StatusCode>20</StatusCode>
<MessageID>554</MessageID>
<DefaultMessage>Encryption and Digital Signed or Https required for Service Operation PRCS_PRINT_JOBHTMLREPORT. (158,554)</DefaultMessage>
<MessageParameters>
<Parameter>PRCS_PRINT_JOBHTMLREPORT</Parameter>
</MessageParameters>
</IBResponse>
</detail>
</SOAP-ENV:Fault>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
This service operation retrieves an html formatted report displaying the current status of a specific process, job, and jobset.
Request Message: PRQ_PRINTJOBREQUESTREPORT_REQ
Element Name |
Description |
---|---|
ProcessInstance |
Specifies the process instance number of the scheduled job, jobset or process. |
ItemInstance |
Specifies the item instance number of the scheduled job or jobset. |
PrintJobTree |
Specify whether to have the job tree displayed in the HTML report. This parameter takes a string value:
Note: The default value is 1. |
PrintDistList |
Specify whether you want the list of Users and Roles who will be the recipient of a report generated for a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
PrintSystemMessage |
Specify whether you want to have the message specified from the Process Definition or Job Definition page displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
PrintApplicationMessage |
Specify whether you want the application messages displayed in the HTML report. These are the application messages that can be viewed from the Message Log subpage of the Process Monitor Detail page. This parameter takes a string value:
Note: The default value is 0. |
PrintParamList |
Specify whether you want the parameter list for a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_JOBREQUESTREPORT_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:PrintJobRequestReport>
<ProcessInstance>10901</ProcessInstance>
<PrintSystemMessage>1</PrintSystemMessage>
<PrintApplicationMessage>1</PrintApplicationMessage>
<PrintParamList>1</PrintParamList>
</prq:PrintJobRequestReport>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_PRINT_ JOBREQUESTREPORT_RES
Element Name |
Description |
---|---|
HTML Report |
Returns HTML 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:PrintJobRequestReportResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_JOBREQUESTREPORT_RES.VERSION_1 PRQ_PRINT_JOBREQUESTREPORT_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_JOBREQUESTREPORT_RES.VERSION_1">
<HTMLReport><![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD><TITLE>Job Report</TITLE>
<META content="text/html; charset=windows-1252" http-equiv=Content-Type>
<STYLE type=text/css>
.PSHEADER {BACKGROUND-COLOR: rgb(51,51,153); COLOR: rgb(255,255,255); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: bold}
.PSEVENROW {BACKGROUND-COLOR: rgb(255,255,255); COLOR: rgb(0,0,0); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: normal}
.PSODDROW {BACKGROUND-COLOR: rgb(226,226,226); COLOR: rgb(0,0,0); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: normal}
</STYLE>
<META content="MSHTML 5.00.3103.1000" name=GENERATOR></HEAD>
<BODY>
<img src="%IMAGE(PT_JOB_EXPANDED)" height='12' width='15' border='0' />
<span class='PSTEXT' ><strong></strong></span><br />
<p> </p><TABLE cellPadding=2 cellSpacing=0 width="100%">
<TBODY>
<TR>
<TD>
</TD></TR></TBODY></TABLE>
<BR></BODY></HTML>]]></HTMLReport>
</prq:PrintJobRequestReportResponse>
</soapenv:Body>
</soapenv:Envelope>
This service operation retrieves an HTML formatted report displaying all items in a job or jobset as defined in the Scheduled Jobset Definition component.
Request Message: PRQ_PRINTSCHEDULEHTMLREPORT_REQ
Element Name |
Description |
---|---|
MainSchedName |
Specifies the name of the jobset schedule. |
MainJobName |
Specifies the name of job within the jobset schedule. |
PrintJobTree |
Specify whether to have the job tree displayed in the HTML report. This parameter takes a string value:
Note: The default value is 1. |
PrintDistList |
Specify whether you want the list of Users and Roles who will be the recipient of a report generated for a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
PrintNotifyList |
Specify whether you want the list of Users and Roles who will be notified for the status of a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
PrintMessageList |
Specify whether you want the messages that will be emailed upon completion of a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
PrintParamList |
Specify whether you want the parameter list for a job item displayed in the HTML report. This parameter takes a string value:
Note: The default value is 0. |
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_SCHEDHTMLREPORT_REQ.VERSION_1">
<soapenv:Header/>
<soapenv:Body>
<prq:PrintScheduleHTMLReport>
<MainSchedName>sct</MainSchedName>
<MainJobName>3SQR</MainJobName>
<PrintJobTree>1</PrintJobTree>
<PrintDistList>1</PrintDistList>
</prq:PrintScheduleHTMLReport>
</soapenv:Body>
</soapenv:Envelope>
Response Message: PRQ_PRINTSCHEDULEHTMLREPORT_RES
Element Name |
Description |
---|---|
HTMLReport |
Returns HTML 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:PrintScheduleHTMLReportResponse xsi:schemaLocation="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_SCHEDHTMLREPORT_RES.VERSION_1 PRQ_PRINT_SCHEDHTMLREPORT_RES.VERSION_1.xsd" xmlns:prq="http://xmlns.oracle.com/Enterprise/Tools/schemas/PRQ_PRINT_SCHEDHTMLREPORT_RES.VERSION_1">
<HTMLReport><![CDATA[<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD><TITLE>Job Report</TITLE>
<META content="text/html; charset=windows-1252" http-equiv=Content-Type>
<STYLE type=text/css>
.PSHEADER {BACKGROUND-COLOR: rgb(51,51,153); COLOR: rgb(255,255,255); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: bold}
.PSEVENROW {BACKGROUND-COLOR: rgb(255,255,255); COLOR: rgb(0,0,0); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: normal}
.PSODDROW {BACKGROUND-COLOR: rgb(226,226,226); COLOR: rgb(0,0,0); FONT-FAMILY: "Arial","sans-serif"; FONT-SIZE: 9pt; FONT-STYLE: normal; FONT-WEIGHT: normal}
</STYLE>
<META content="MSHTML 5.00.3103.1000" name=GENERATOR></HEAD>
<BODY>
<img src="%IMAGE(PT_JOB_EXPANDED)" height='12' width='15' border='0' />
<span class='PSTEXT' ><strong>sct</strong></span><br />
<img src="%IMAGE(PSTREEMGR_ENDCONNECT)" height='17' width='15' border='0' />
<img src="%IMAGE(PT_JOB_EXPANDED)" height='12' width='15' border='0' />
<span class='PSTEXT' ><strong>3SQR</strong></span><br />
<img src="%IMAGE(PT_PIXEL)" width='15' height='1' />
<img src="%IMAGE(PSTREEMGR_CONNECT)" height='17' width='15' border='0' />
<img src="%IMAGE(PT_JOB_PROCESS)" height='12' width='15' border='0' />
<span class='PSTEXT' >1 XRFIELDS: Cross Reference Field Listing (SQR Report)</span><br />
<img src="%IMAGE(PT_PIXEL)" width='15' height='1' />
<img src="%IMAGE(PSTREEMGR_CONNECT)" height='17' width='15' border='0' />
<img src="%IMAGE(PT_JOB_PROCESS)" height='12' width='15' border='0' />
<span class='PSTEXT' >2 XRFMENU: Menu Listing Report (SQR Report)</span><br />
<img src="%IMAGE(PT_PIXEL)" width='15' height='1' />
<img src="%IMAGE(PSTREEMGR_ENDCONNECT)" height='17' width='15' border='0' />
<img src="%IMAGE(PT_JOB_PROCESS)" height='12' width='15' border='0' />
<span class='PSTEXT' >3 XRFRCFL: Cross Reference - Records and (SQR Report)</span><br />
<p> </p><TABLE cellPadding=2 cellSpacing=0 width="100%">
<TBODY>
<TR>
<TD>
<TABLE border=1 cellPadding=3 cellSpacing=0 width="100%">
<TBODY>
<tr>
<th class='PSHEADER' colspan="10" bordercolor=rgb(51,51,153)><p align="left">Job Name: 3SQR - SQR Multi-process Job</p></th>
</tr>
<tr>
<th class='PSHEADER' colspan="3" bordercolor=rgb(51,51,153)><p align="left">Mode: Serial</p></th>
<th class='PSHEADER' colspan="7" bordercolor=rgb(51,51,153)> </th>
</tr>
<tr>
<tr>
<th class='PSHEADER' width="5%">Seq.</th>
<th class='PSHEADER' width="10%">Process Name</th>
<th class='PSHEADER' width="15%">Description</th>
<th class='PSHEADER' width="10%">Process Type</th>
<th class='PSHEADER' width="10%">Run Control ID</th>
<th class='PSHEADER' width="5%">Type</th>
<th class='PSHEADER' width="8%">Output
Format</th>
<th class='PSHEADER' width="10%">Destination</th>
<th class='PSHEADER' width="8%">Server Option</th>
<th class='PSHEADER' width="5%">Run Time</th>
</tr>
<tr>
<td class='PSEVENROW' align="center" width="5%">1</td>
<td class='PSEVENROW' width="10%">XRFIELDS</td>
<td class='PSEVENROW' width="15%">Cross Reference Field Listing</td>
<td class='PSEVENROW' align="center" width="10%">SQR Report</td>
<td class='PSEVENROW' align="center" width="5%">t1</td>
<td class='PSEVENROW' align="center" width="5%">Web</td>
<td class='PSEVENROW' align="center" width="8%">Acrobat (*.pdf)</td>
<td class='PSEVENROW' align="center" width="10%">Distribution List</td>
<td class='PSEVENROW' align="center" width="8%">Any Server </td>
<td class='PSEVENROW' align="center" width="5%"> </td>
</tr>
<tr>
<td class='PSEVENROW' colspan="2"> </td>
<td class='PSEVENROW' colspan="8">
<p><strong>Distribution List:</strong></p>
<table border="1" cellpadding="3" cellspacing="0" bordercolor="#CCCCCC"> <tr>
<td class='PSEVENROW' ><strong>Type</strong></td>
<td class='PSEVENROW' ><strong>Name</strong></td>
</tr>
<tr>
<td class='PSEVENROW' >User </td>
<td class='PSEVENROW' >VP1 </td>
</tr>
</table>
</td></tr>
<tr>
<td class='PSODDROW' align="center" width="5%">2</td>
<td class='PSODDROW' width="10%">XRFMENU</td>
<td class='PSODDROW' width="15%">Menu Listing Report</td>
<td class='PSODDROW' align="center" width="10%">SQR Report</td>
<td class='PSODDROW' align="center" width="5%">t1</td>
<td class='PSODDROW' align="center" width="5%">Web</td>
<td class='PSODDROW' align="center" width="8%">Acrobat (*.pdf)</td>
<td class='PSODDROW' align="center" width="10%">Distribution List</td>
<td class='PSODDROW' align="center" width="8%">Any Server </td>
<td class='PSODDROW' align="center" width="5%"> </td>
</tr>
<tr>
<td class='PSODDROW' colspan="2"> </td>
<td class='PSODDROW' colspan="8">
<p><strong>Distribution List:</strong></p>
<table border="1" cellpadding="3" cellspacing="0" bordercolor="#CCCCCC"> <tr>
<td class='PSODDROW' ><strong>Type</strong></td>
<td class='PSODDROW' ><strong>Name</strong></td>
</tr>
<tr>
<td class='PSODDROW' >User </td>
<td class='PSODDROW' >VP1 </td>
</tr>
</table>
</td></tr>
<tr>
<td class='PSEVENROW' align="center" width="5%">3</td>
<td class='PSEVENROW' width="10%">XRFRCFL</td>
<td class='PSEVENROW' width="15%">Cross Reference - Records and</td>
<td class='PSEVENROW' align="center" width="10%">SQR Report</td>
<td class='PSEVENROW' align="center" width="5%">t1</td>
<td class='PSEVENROW' align="center" width="5%">Web</td>
<td class='PSEVENROW' align="center" width="8%">Acrobat (*.pdf)</td>
<td class='PSEVENROW' align="center" width="10%">Distribution List</td>
<td class='PSEVENROW' align="center" width="8%">Any Server </td>
<td class='PSEVENROW' align="center" width="5%"> </td>
</tr>
<tr>
<td class='PSEVENROW' colspan="2"> </td>
<td class='PSEVENROW' colspan="8">
<p><strong>Distribution List:</strong></p>
<table border="1" cellpadding="3" cellspacing="0" bordercolor="#CCCCCC"> <tr>
<td class='PSEVENROW' ><strong>Type</strong></td>
<td class='PSEVENROW' ><strong>Name</strong></td>
</tr>
<tr>
<td class='PSEVENROW' >User </td>
<td class='PSEVENROW' >VP1 </td>
</tr>
</table>
</td></tr>
</TBODY></TABLE>
<p> </p> </TD></TR></TBODY></TABLE>
<BR></BODY></HTML>]]></HTMLReport>
</prq:PrintScheduleHTMLReportResponse>
</soapenv:Body>
</soapenv:Envelope>