DBA Data[Home] [Help]

PACKAGE: APPS.PA_REPORT_WORKFLOW_CLIENT

Source


1 package pa_report_workflow_client AUTHID CURRENT_USER as
2 /* $Header: PAPRWFCS.pls 120.5 2006/07/25 07:12:12 sukhanna noship $ */
3 /*#
4  * This extension enables you to customize the workflow processes for submitting, approving, and publishing a
5  * project status report.
6  * @rep:scope public
7  * @rep:product PA
8  * @rep:lifecycle active
9  * @rep:displayname Project Status Report Workflow
10  * @rep:compatibility S
11  * @rep:category BUSINESS_ENTITY PA_PROJECT
12  * @rep:category BUSINESS_ENTITY PA_PERF_REPORTING
13  * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
14 */
15 /*============================================================================+
16 |  Copyright (c) 1993 Oracle Corporation    Belmont, California, USA          |
17 |                        All rights reserved.                                 |
18 |                        Oracle Manufacturing                                 |
19 +=============================================================================+
20 
21  FILE NAME   : PAPRWFCS.pls
22 
23  USAGE:    sqlplus apps/apps @PAPRWFCS.pls
24 
25  DESCRIPTION :
26   This file provides client extension procedures for
27   various Status Reports Workflow activities.
28 
29  PROCEDURES AND PARAMETERS:
30 
31   start_workflow
32 
33     p_item_type:     The workflow item type.
34     p_process_name:  Name of the workflow process.
35     p_item_key:      The workflow item key.
36     p_version_id:    Identifier of the version.
37     x_msg_count:     The number of messages being sent.
38     x_msg_data:      The content of the message.
39     x_return_status: The return status of the message.
40 
41   set_report_approver
42 
43     p_process:       Name of the workflow process.
44     p_item_key:      The workflow item key.
45     actid:           Identifier of the action.
46     funcmode:        Workflow function mode.
47     resultout:       Process result.
48 
49   set_report_notification_party
50 
51     p_item_type:     The workflow item type.
52     p_item_key:      The workflow item key.
53     p_status:        The report status.
54     actid:           Identifier of the action.
55     funcmode:        Workflow function mode.
56     resultout:       Process result.
57 
58 
59  HISTORY     : 06/22/00 SYAO Initial Creation
60              : 04/22/04 mchava Interface Reporsitory Annotation Standards
61                                are incorporated.
62              : 02-Jun-2006 vgottimu Changed the doccd annotation file name to 120pjapi.pdf.
63              : 03-Jul-2006 vgottimu Bug#5367820 Changed the descriptions of the
64 				    APIs and also changed the descriptions of parameters as suggested by Doc team
65 				    for IRep.
66              : 24-Jul-2006 sukhanna Bug#5406254. Add business entity  PA_PERF_REPORTING
67 =============================================================================*/
68 
69 
70 
71 /*#
72  * This procedure starts the workflow process for a project status report.
73  * You can modify this procedure to add company specific business rules
74  * that are validated using this procedure.
75  * @param p_item_type The workflow item type
76  * @rep:paraminfo {@rep:required}
77  * @param p_process_name Name of the workflow process
78  * @rep:paraminfo {@rep:required}
79  * @param p_item_key   The workflow item key
80  * @rep:paraminfo {@rep:required}
81  * @param p_version_id    Identifier of the version
82  * @rep:paraminfo {@rep:required}
83  * @param x_msg_count API standard: number of error messages
84  * @rep:paraminfo {@rep:required}
85  * @param x_msg_data  API standard: error message
86  * @rep:paraminfo {@rep:required}
87  * @param x_return_status  API standard: return status of the API (success/failure/unexpected error)
88  * @rep:paraminfo {@rep:required}
89  * @rep:scope public
90  * @rep:lifecycle active
91  * @rep:displayname  Start Workflow
92  * @rep:compatibility S
93 */
94 
95 Procedure  start_workflow (
96 			     p_item_type         IN     VARCHAR2
97 			   , p_process_name      IN     VARCHAR2
98 			   , p_item_key          IN     NUMBER
99 			   , p_version_id        IN     NUMBER
100 
101                            , x_msg_count         OUT    NOCOPY NUMBER --File.Sql.39 bug 4440895
102 			   , x_msg_data          OUT    NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
103 			   , x_return_status     OUT    NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
104 			   );
105 
106 /*#
107  *This procedure determines the approver for the status report. You can modify the procedure to determine
108  * the status report approver. The default procedure identifies the supervisor of the person
109  * who submitted the status report.
110  * @param p_item_type    The workflow item type
111  * @rep:paraminfo {@rep:required}
112  * @param p_item_key   The workflow item key
113  * @rep:paraminfo {@rep:required}
114  * @param actid Identifier of the action
115  * @rep:paraminfo {@rep:required}
116  * @param funcmode The workflow function mode
117  * @rep:paraminfo {@rep:required}
118  * @param resultout  Process result
119  * @rep:paraminfo {@rep:required}
120  * @rep:scope public
121  * @rep:lifecycle active
122  * @rep:displayname Set Report Approver
123  * @rep:compatibility S
124 */
125 
126 PROCEDURE set_report_approver(
127 			       p_item_type                   IN      VARCHAR2
128 			      ,p_item_key                    IN      VARCHAR2
129 			      ,actid                         IN      NUMBER
130 			      ,funcmode                      IN      VARCHAR2
131 
132 			      ,resultout                     OUT     NOCOPY VARCHAR2 ); --File.Sql.39 bug 4440895
133 
134 /*#
135  * This procedure determines which users receive workflow notifications
136  * when a project status report is submitted, approved, rejected, or published.
137  * @param p_item_type  The workflow item type
138  * @rep:paraminfo {@rep:required}
139  * @param p_item_key  The workflow item key
140  * @rep:paraminfo {@rep:required}
141  * @param p_status   The report status
142  * @rep:paraminfo {@rep:required}
143  * @param actid Identifier of the action
144  * @rep:paraminfo {@rep:required}
145  * @param funcmode Workflow function mode
146  * @rep:paraminfo {@rep:required}
147  * @param resultout  Process result
148  * @rep:paraminfo {@rep:required}
149  * @rep:scope public
150  * @rep:lifecycle active
151  * @rep:displayname Set Report Notification Party
152  * @rep:compatibility S
153 */
154 
155 PROCEDURE set_report_notification_party(
156 			       		 p_item_type         IN      VARCHAR2
157 					,p_item_key          IN      VARCHAR2
158 					,p_status            IN      VARCHAR2
159 					,actid               IN      NUMBER
160 					,funcmode            IN      VARCHAR2
161 
162 					,resultout           OUT     NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
163 					);
164 
165 
166 
167 END pa_report_workflow_client;
168