[Home] [Help]
PACKAGE: APPS.EGO_REPORT_WF_UTIL
Source
1 PACKAGE EGO_REPORT_WF_UTIL AUTHID CURRENT_USER AS
2 /* $Header: EGORWKFS.pls 115.4 2004/01/07 02:12:26 mkimizuk noship $ */
3 --
4 -- Constant Variables : GetWorkflowMonitorURL
5 --
6
7 -- None Return Status
8 G_RET_STS_NONE CONSTANT VARCHAR2(1) := 'N';
9
10 -- Seeded OCD Workflow Item Types
11 G_STD_ITEM_TYPE CONSTANT VARCHAR2(8) := 'ENGWFSTD';
12 G_SEND_REPORT_ITEM_TYPE CONSTANT VARCHAR2(8) := 'EGOSREP';
13
14
15 -- Seeded Eng Worklfow Block Abort Activity
16 G_BLOCK_ABORT_ACTIVITY CONSTANT VARCHAR2(30) := 'BLOCK_ABORT';
17
18 -- Eng Change Object Name
19 G_ENG_CHANGE CONSTANT VARCHAR2(10) := 'ENG_CHANGE' ;
20
21 -- Workflow Adhoc Role Pre-Fix
22 -- ':', '#' or '/' should not be included
23 --
24 G_ADHOC_PARTY_ROLE CONSTANT VARCHAR2(20) := 'EGO_ADHOC,';
25 G_OWNER_ROLE CONSTANT VARCHAR2(20) := 'EGO_OWNER,';
26
27 -- Action System Party ID
28 G_ACT_SYSTEM_USER_ID CONSTANT NUMBER := -10000 ;
29
30 -- Workflow Seeded Internal Status
31 G_WF_NOTIFIED CONSTANT VARCHAR2(8) := 'NOTIFIED' ;
32 G_WF_ACTIVIE CONSTANT VARCHAR2(8) := 'ACTIVE' ;
33 G_WF_COMPLETE CONSTANT VARCHAR2(8) := 'COMPLETE' ;
34 G_WF_ERROR CONSTANT VARCHAR2(8) := 'ERROR' ;
35 G_WF_SUSPEND CONSTANT VARCHAR2(8) := 'SUSPEND' ;
36 G_WF_DEFERRED CONSTANT VARCHAR2(8) := 'DEFERRED' ;
37 G_WF_WAITING CONSTANT VARCHAR2(8) := 'WAITING' ;
38
39
40 -- FND Lookup Type: ENG_ROUTE_ASSIGNEE_TYPES
41 -- Used for Change Route People's Assignee Type
42 -- ENG_CHANGE_ROUTE_PEOPLE.ASSIGNEE_TYPE_CODE
43 G_PERSON CONSTANT VARCHAR2(30) := 'PERSON' ; -- Person
44 G_GROUP CONSTANT VARCHAR2(30) := 'GROUP' ; -- Group
45 G_ROLE CONSTANT VARCHAR2(30) := 'ROLE' ; -- Role
46
47
48 -- WFSTD_VOTING_OPTION: Standard Voting Option Lookup Codes
49 G_WAIT_FOR_ALL_VOTES CONSTANT VARCHAR2(30) := 'WAIT_FOR_ALL_VOTES' ;
50 G_REQUIRE_ALL_VOTES CONSTANT VARCHAR2(30) := 'REQUIRE_ALL_VOTES' ;
51 G_TALLY_ON_EVERY_VOTE CONSTANT VARCHAR2(30) := 'TALLY_ON_EVERY_VOTE' ;
52
53 -- Monitor URL Types for GetWorkflowMonitorURL
54 G_MONITOR_ACCESSKEY CONSTANT VARCHAR2(15) := 'ACCESSKEY';
55 G_MONITOR_DIAGRAM CONSTANT VARCHAR2(15) := 'DIAGRAM';
56 G_MONITOR_ENVELOPE CONSTANT VARCHAR2(15) := 'ENVELOPE';
57 G_MONITOR_ADVANCED_ENVELOPE CONSTANT VARCHAR2(20) := 'ADVANCED_ENVELOPE';
58
59
60
61 /********************************************************************
62 * Debug APIs : Open_Debug_Session, Close_Debug_Session,
63 * Write_Debug
64 * Parameters IN :
65 * Parameters OUT:
66 * Purpose : These procedures are for test and debug
67 *********************************************************************/
68 -- Open_Debug_Session
69
70 PROCEDURE Open_Debug_Session
71 ( p_output_dir IN VARCHAR2 := NULL
72 , p_file_name IN VARCHAR2 := NULL
73 );
74
75 -- Close Debug_Session
76 PROCEDURE Close_Debug_Session ;
77
78 -- Write Debug Message
79 PROCEDURE Write_Debug
80 ( p_debug_message IN VARCHAR2 ) ;
81
82 -- Write Debug Mode from Workflow Function Activities
83 PROCEDURE Get_Debug_Mode
84 ( p_item_type IN VARCHAR2
85 , p_item_key IN VARCHAR2
86 , x_debug_flag OUT NOCOPY BOOLEAN
87 , x_output_dir OUT NOCOPY VARCHAR2
88 , x_debug_filename OUT NOCOPY VARCHAR2
89 );
90
91 /********************************************************************
92 * API Type : Private APIs
93 * Purpose : Those APIs are private
94 *********************************************************************/
95
96
97 FUNCTION GetUserName
98 ( p_user_id IN NUMBER)
99 RETURN VARCHAR2;
100
101
102 -- API name : GetMessageTextBody
103 -- Type : Private
104 -- Pre-reqs : None.
105 -- Function : Workflow PL/SQL CLOB Document API to get ntf text message body
106 -- Parameters : p_document_id IN VARCHAR2 Required
107 -- Format:
108 -- <wf item type>:<wf item key>:<&#NID>
109 PROCEDURE GetMessageTextBody
110 ( document_id IN VARCHAR2
111 , display_type IN VARCHAR2
112 , document IN OUT NOCOPY CLOB
113 , document_type IN OUT NOCOPY VARCHAR2
114 ) ;
115
116
117 -- API name : GetMessageHTMLBody
118 -- Type : Private
119 -- Pre-reqs : None.
120 -- Function : Workflow PL/SQL CLOB Document API to get ntf HTML message body
121 -- Parameters : p_document_id IN VARCHAR2 Required
122 -- Format:
123 -- <wf item type>:<wf item key>:<&#NID>
124 PROCEDURE GetMessageHTMLBody
125 ( document_id IN VARCHAR2
126 , display_type IN VARCHAR2
127 , document IN OUT NOCOPY CLOB
128 , document_type IN OUT NOCOPY VARCHAR2
129 ) ;
130
131 /*
132 -- Get Ntf Message PL/SQL Document API Info
133 PROCEDURE GetNtfMessageDocumentAPI
134 ( p_item_type IN VARCHAR2
135 , p_item_key IN VARCHAR2
136 , p_process_name IN VARCHAR2
137 , x_message_text_body OUT NOCOPY VARCHAR2
138 , x_message_html_body OUT NOCOPY VARCHAR2
139 );
140 */
141
142
143
144 PROCEDURE SetAttributes
145 ( x_return_status OUT NOCOPY VARCHAR2
146 , x_msg_count OUT NOCOPY NUMBER
147 , x_msg_data OUT NOCOPY VARCHAR2
148 , p_item_type IN VARCHAR2
149 , p_item_key IN VARCHAR2
150 , p_process_name IN VARCHAR2
151 , p_report_url IN VARCHAR2
152 , p_subject IN VARCHAR2
153 , p_message IN VARCHAR2
154 , p_wf_user_id IN NUMBER
155 , p_wf_user_name IN VARCHAR2 := NULL
156 , p_adhoc_party_list IN VARCHAR2 := NULL
157 , p_report_fwk_region IN VARCHAR2 := NULL
158 , p_report_custom_code IN VARCHAR2 := NULL
159 , p_browse_mode IN VARCHAR2 := NULL
160 , p_report_org_id IN NUMBER := NULL
161 ) ;
162
163
164 PROCEDURE SetAdhocPartyRole
165 ( x_return_status OUT NOCOPY VARCHAR2
166 , x_msg_count OUT NOCOPY NUMBER
167 , x_msg_data OUT NOCOPY VARCHAR2
168 , p_item_type IN VARCHAR2
169 , p_item_key IN VARCHAR2
170 , p_adhoc_party_list IN VARCHAR2
171 ) ;
172
173
174 PROCEDURE DeleteAdhocRolesAndUsers
175 ( x_return_status OUT NOCOPY VARCHAR2
176 , x_msg_count OUT NOCOPY NUMBER
177 , x_msg_data OUT NOCOPY VARCHAR2
178 , p_item_type IN VARCHAR2
179 , p_item_key IN VARCHAR2
180 ) ;
181
182
183
184
185 -- API name : StartWorkflow
186 -- Type : Public
187 PROCEDURE StartWorkflow
188 ( p_api_version IN NUMBER
189 , p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE
190 , p_commit IN VARCHAR2 := FND_API.G_FALSE
191 , p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
192 , x_return_status OUT NOCOPY VARCHAR2
193 , x_msg_count OUT NOCOPY NUMBER
194 , x_msg_data OUT NOCOPY VARCHAR2
195 , p_item_type IN VARCHAR2
196 , x_item_key IN OUT NOCOPY VARCHAR2
197 , p_process_name IN VARCHAR2
198 , p_report_url IN VARCHAR2 := NULL
199 , p_subject IN VARCHAR2 := NULL
200 , p_message IN VARCHAR2 := NULL
201 , p_wf_user_id IN NUMBER
202 , p_adhoc_party_list IN VARCHAR2 := NULL
203 , p_report_fwk_region IN VARCHAR2 := NULL
204 , p_report_custom_code IN VARCHAR2 := NULL
205 , p_browse_mode IN VARCHAR2 := NULL -- EGO_SUMMARY or EGO_SEQUENTIAL
206 , p_report_org_id IN NUMBER := NULL
207 , p_debug IN VARCHAR2 := FND_API.G_FALSE
208 , p_output_dir IN VARCHAR2 := NULL
209 , p_debug_filename IN VARCHAR2 := 'EgoReportStartWf.log'
210 ) ;
211
212 -- PROCEDURE SELECT_ADHOC_PARTY
213 --
214 -- Select Adhoc Party and Set users to Adhoc Role
215 --
216 -- IN
217 -- itemtype - type of the current item
218 -- itemkey - key of the current item
219 -- actid - process activity instance id
220 -- funcmode - function execution mode. this is set by the engine
221 -- as either 'RUN', 'CANCEL', 'TIMEOUT'
222 -- OUT
223 -- result
224 -- - COMPLETE
225 -- activity has completed
226 -- - COMPLETE:NONE
227 -- activity could not find any adhoc parties
228 PROCEDURE SELECT_ADHOC_PARTY(
229 itemtype in varchar2,
230 itemkey in varchar2,
231 actid in number,
232 funcmode in varchar2,
233 result in out NOCOPY varchar2);
234
235
236 -- PROCEDURE DELETE_ADHOC_ROLES_AND_USERS
237 --
238 -- Delete Workflow Adhoc Role and Local Users
239 --
240 -- IN
241 -- itemtype - type of the current item
242 -- itemkey - key of the current item
243 -- actid - process activity instance id
244 -- funcmode - function execution mode ('RUN', 'CANCEL', 'TIMEOUT', ...)
245 -- OUT
246 -- result
247 -- - COMPLETE
248 -- activity has completed
249 PROCEDURE DELETE_ADHOC_ROLES_AND_USERS(
250 itemtype in varchar2,
251 itemkey in varchar2,
252 actid in number,
253 funcmode in varchar2,
254 result in out NOCOPY varchar2);
255
256
257 END EGO_REPORT_WF_UTIL ;