1 package pa_control_items_wf_client as
2 /* $Header: PACIWFCS.pls 120.4 2006/07/04 05:54:24 vgottimu noship $ */
3 /*#
4 *This extension enables you to customize the workflow processes for
5 * submitting and approving issues and change documents.
6 * @rep:scope public
7 * @rep:product PA
8 * @rep:lifecycle active
9 * @rep:displayname Issue and Change Workflow Extension
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY PA_PROJECT
12 * @rep:doccd 120pjapi.pdf See the Oracle Projects API's, Client Extensions, and Open Interfaces Reference
13 */
14
15
16 /*============================================================================+
17 | Copyright (c) 1993 Oracle Corporation Belmont, California, USA |
18 | All rights reserved. |
19 | Oracle Manufacturing |
20 +=============================================================================+
21
22 FILE NAME : PACIWFCS.pls
23 DESCRIPTION :
24 This file provided client extension procedures that are called
25 to execute each activity in the Issue and Change Document Workflow.
26
27 PROCEDURES AND PARAMETERS
28
29 start_workflow
30
31 p_item_type : The workflow item type.
32 p_process_name : Name of the workflow process.
33 p_item_key : The workflow item key.
34 p_ci_id : Control Item Identifier.
35 x_msg_count : The number of messages being sent.
36 x_msg_data : The content of the message.
37 x_return_status : The return status of the message.
38
39
40 set_ci_approver
41
42 p_item_type : The workflow item type.
43 p_item_key : The workflow item key.
44 actid : Identifier of the action.
45 funcmode : Workflow function mode.
46 resultout : Process result.
47
48 set_notification_party
49
50 p_item_type : The workflow item type.
51 p_item_key : The workflow item key.
52 p_status : The control item status.
53 actid : Identifier of the action.
54 funcmode : Workflow function mode.
55 resultout : Process result.
56
57
58 HISTORY : 06/22/00 SYAO Initial Creation
59 04/22/04 mchava Interface Reporsitory Annotation Standards
60 are incorporated.
61 02-JUN-2006 vgottimu Changed the doccd file name from 115pjoug.pdf to 120pjapi.pdf.
62 03-JUL-2006 vgottimu Bug#5367820 Changed the description of APIs and paramenter
63 description as suggested by the Doc Team for IRep.
64 =============================================================================*/
65
66
67
68 /*#
69 * This procedure is used to start the workflow process for issue and change document approval.
70 * @param p_item_type The workflow item type
71 * @rep:paraminfo {@rep:required}
72 * @param p_process_name Name of the workflow process
73 * @rep:paraminfo {@rep:required}
74 * @param p_item_key The workflow item key
75 * @rep:paraminfo {@rep:required}
76 * @param p_ci_id The identifier of the control item
77 * @rep:paraminfo {@rep:required}
78 * @param x_msg_count API standard: number of error messages
79 * @rep:paraminfo {@rep:required}
80 * @param x_msg_data API standard: error message
81 * @rep:paraminfo {@rep:required}
82 * @param x_return_status API standard: return status of the API (success/failure/unexpected error)
83 * @rep:paraminfo {@rep:required}
84 * @rep:scope public
85 * @rep:lifecycle active
86 * @rep:displayname Start Workflow
87 * @rep:compatibility S
88 */
89
90 Procedure start_workflow (
91 p_item_type IN VARCHAR2
92 , p_process_name IN VARCHAR2
93 , p_item_key IN NUMBER
94
95 , p_ci_id IN NUMBER
96
97 , x_msg_count OUT NOCOPY NUMBER --File.Sql.39 bug 4440895
98 , x_msg_data OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
99 , x_return_status OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
100 );
101
102 /*#
103 * This procedure is used to specify persons who can approve issues and change documents.
104 * @param p_item_type The workflow item type
105 * @rep:paraminfo {@rep:required}
106 * @param p_item_key The workflow item key
107 * @rep:paraminfo {@rep:required}
108 * @param actid The identifier of the action
109 * @rep:paraminfo {@rep:required}
110 * @param funcmode The workflow function mode
111 * @rep:paraminfo {@rep:required}
112 * @param resultout The process result
113 * @rep:paraminfo {@rep:required}
114 * @rep:scope public
115 * @rep:lifecycle active
116 * @rep:displayname Set Control Item Approver
117 * @rep:compatibility S
118 */
119
120 PROCEDURE set_ci_approver(
121 p_item_type IN VARCHAR2
122 ,p_item_key IN VARCHAR2
123 ,actid IN NUMBER
124 ,funcmode IN VARCHAR2
125 ,resultout OUT NOCOPY VARCHAR2 ); --File.Sql.39 bug 4440895
126
127
128 /*#
129 * This procedure is used to specify persons who would be notified about approved and rejected issues and change documents.
130 * @param p_item_type The workflow item type
131 * @rep:paraminfo {@rep:required}
132 * @param p_item_key The workflow item key
133 * @rep:paraminfo {@rep:required}
134 * @param p_status The control item status
135 * @rep:paraminfo {@rep:required}
136 * @param actid The identifier of the action
137 * @rep:paraminfo {@rep:required}
138 * @param funcmode The workflow function mode
139 * @rep:paraminfo {@rep:required}
140 * @param resultout The process result
141 * @rep:paraminfo {@rep:required}
142 * @rep:scope public
143 * @rep:lifecycle active
144 * @rep:displayname Set Notification Party
145 * @rep:compatibility S
146 */
147 PROCEDURE set_notification_party(
148 p_item_type IN VARCHAR2
149 ,p_item_key IN VARCHAR2
150 ,p_status IN VARCHAR2
151 ,actid IN NUMBER
152 ,funcmode IN VARCHAR2
153 ,resultout OUT NOCOPY VARCHAR2 --File.Sql.39 bug 4440895
154 ) ;
155
156
157 END pa_control_items_wf_client;
158