[Home] [Help]
PACKAGE: APPS.FND_MANAGER
Source
1 PACKAGE fnd_manager AS
2 /* $Header: AFCPMGRS.pls 120.2.12000000.2 2007/07/16 04:39:04 ggupta ship $ */
3
4
5 --
6 -- Procedure
7 -- SET_SESSION_MODE
8 --
9 -- Purpose
10 -- Sets the package mode for the current session.
11 --
12 -- Arguments:
13 -- session_mode - 'seed_data' if new data is for Datamerge.
14 -- 'customer_data' is the default.
15 --
16 PROCEDURE set_session_mode(session_mode IN VARCHAR2);
17
18
19 -- Function
20 -- MESSAGE
21 --
22 -- Purpose
23 -- Return an error message. Messages are set when
24 -- validation (program) errors occur.
25 --
26 FUNCTION message RETURN VARCHAR2;
27
28 -- Function
29 -- GET_SPECIALIZATION_TYPE_ID
30 --
31 -- Purpose
32 -- Get a Type (Object) ID from FND_CONCURRENT_QUEUE_CONTENT
33 -- (fcqc.TYPE_ID) given the Object's Name, Application ID, and
34 -- Lookup Code
35 --
36 -- Arguments:
37 -- obj_name - The name of the specialization object
38 -- (complex rule name/oracle username/program name/
39 -- request class name/apps username)
40 -- obj_appl_id - The application id (fcqc.TYPE_APPLICATION_ID) of the
41 -- specialization object
42 -- obj_code - The lookup code (fcqc.TYPE_CODE) of the specialization
43 -- object which corresponds to CP_SPECIAL_RULES lookup type
44 -- (C/O/P/R/U)
45
46 FUNCTION get_specialization_type_id(obj_name varchar2,
47 obj_appl_id number,
48 obj_code varchar2) return number;
49
50
51 -- Procedure
52 -- REGISTER
53 --
54 -- Purpose
55 -- Register a concurrent manager.
56 --
57 -- Arguments
58 -- Manager - Concurrent manager name.
59 -- Application - Manager application short name.
60 -- Short_Name - Short (non-translated) name
61 -- Description - Manager description (Optional).
62 -- Type - 'Concurrent Manager', 'Internal Monitor', or
63 -- 'Transaction Manager'.
64 -- Cache_Size - Request cache size (Optional; Concurrent Managers only).
65 -- Data_Group - Data group name (Transaction Managers only).
66 -- Primary_Node - Primary node (optional).
67 -- Primary_Queue - Primary OS queue (Optional).
68 -- Secondary_Node - Secondary node (optional).
69 -- Secondary_Queue - Secondary OS queue (Optional).
70 -- Library - Concurrent processing library (e.g. FNDLIBR).
71 -- Library_Application - Library application short name.
72 -- Data_Group_id - Optional. Overrides 'data_group' parameter.
73 -- Language_code - Langauge code for translated values.
74 -- Last_Update_Date- Who information for FNDLOAD standards
75 -- Last_Updated_By - Who information for FNDLOAD standards
76 --
77 PROCEDURE register(manager IN VARCHAR2,
78 application IN VARCHAR2,
79 short_name IN VARCHAR2,
80 description IN VARCHAR2 DEFAULT NULL,
81 type IN VARCHAR2,
82 cache_size IN NUMBER DEFAULT NULL,
83 data_group IN VARCHAR2 DEFAULT NULL,
84 primary_node IN VARCHAR2 DEFAULT NULL,
85 primary_queue IN VARCHAR2 DEFAULT NULL,
86 secondary_node IN VARCHAR2 DEFAULT NULL,
87 secondary_queue IN VARCHAR2 DEFAULT NULL,
88 library IN VARCHAR2,
89 library_application IN VARCHAR2,
90 data_group_id IN NUMBER DEFAULT NULL,
91 language_code IN VARCHAR2 DEFAULT 'US',
92 last_update_date IN DATE DEFAULT NULL,
93 last_updated_by IN NUMBER DEFAULT NULL);
94
95 -- Procedure
96 -- REGISTER_SI
97 --
98 -- Purpose
99 -- Register a Service Instance.
100 --
101 -- Arguments
102 -- Manager - Service Instance name.
103 -- Application - Manager application short name.
104 -- Short_Name - Short (non-translated) name
105 -- Description - Manager description (Optional).
106 -- Service_Type -
107 -- Primary_Node - Primary node (optional).
108 -- Primary_Queue - Primary OS queue (Optional).
109 -- Secondary_Node - Secondary node (optional).
110 -- Secondary_Queue - Secondary OS queue (Optional).
111 -- Language_code - Langauge code for translated values.
112 -- Last_Update_Date- Who information for FNDLOAD standards
113 -- Last_Updated_By - Who information for FNDLOAD standards
114 --
115 PROCEDURE register_si (manager IN VARCHAR2,
116 application IN VARCHAR2,
117 short_name IN VARCHAR2,
118 description IN VARCHAR2 DEFAULT NULL,
119 service_handle IN VARCHAR2,
120 primary_node IN VARCHAR2 DEFAULT NULL,
121 primary_queue IN VARCHAR2 DEFAULT NULL,
122 secondary_node IN VARCHAR2 DEFAULT NULL,
123 secondary_queue IN VARCHAR2 DEFAULT NULL,
124 language_code IN VARCHAR2 DEFAULT 'US',
125 last_update_date IN DATE DEFAULT NULL,
126 last_updated_by IN VARCHAR2 DEFAULT NULL);
127
128
129 -- Procedure
130 -- REGISTER_SVC
131 --
132 -- Purpose
133 -- Register a Service .
134 --
135 -- Arguments
136 -- Service_name - Service name.
137 -- Service_Handle - Service Handle
138 -- DESCRIPTION
139 -- CARTRIDGE_HANDLE
140 -- ALLOW_MULTIPLE_PROC_INSTANCE -Y/N
141 -- ALLOW_MULTIPLE_PROC_NODE -Y/N
142 -- MIGRATE_ON_FAILURE -Y/N
143 -- ALLOW_SUSPEND -Y/N
144 -- ALLOW_VERIFY -Y/N
145 -- ALLOW_PARAMETER -Y/N
146 -- ALLOW_START -Y/N
147 -- ALLOW_RESTART -Y/N
148 -- ALLOW_RCG -Y/N
149 -- ALLOW_CREATE - Y/N
150 -- ALLOW_EDIT -Y/N
151 -- PARAMETER_CHANGE_ACTION V=Verify, R=Restart
152 -- DEVELOPER_PARAMETERS
153 -- SERVER_TYPE
154 -- ENV_FILE_NAME -might not be used
155 -- SERVICE_CLASS
156 -- SERVICE_INSTANCE_CLASS
157 -- OAM_DISPLAY_ORDER
158 -- DEBUG_CHANGE_ACTION N=No followup action V=Verify X=Dynamic change off
159 -- ENABLED -Y/N
160 -- CARTRIDGE_APPLICATION - Defaults to 'FND'
161 -- DEBUG_TYPE
162 -- SERVICE_PLURAL_NAME
163 -- ALLOW_MULTIPLE_PROC_SI -Y/N
164 -- DEFAULT_DEBUG_LEVEL
165
166 PROCEDURE register_svc (
167 SERVICE_NAME IN VARCHAR2,
168 SERVICE_HANDLE IN VARCHAR2,
169 DESCRIPTION IN VARCHAR2 DEFAULT NULL,
170 CARTRIDGE_HANDLE IN VARCHAR2,
171 ALLOW_MULTIPLE_PROC_INSTANCE IN VARCHAR2 DEFAULT 'Y',
172 ALLOW_MULTIPLE_PROC_NODE IN VARCHAR2 DEFAULT 'Y',
173 MIGRATE_ON_FAILURE IN VARCHAR2 DEFAULT 'Y',
174 ALLOW_SUSPEND IN VARCHAR2 DEFAULT 'Y',
175 ALLOW_VERIFY IN VARCHAR2 DEFAULT 'Y',
176 ALLOW_PARAMETER IN VARCHAR2 DEFAULT 'Y',
177 ALLOW_START IN VARCHAR2 DEFAULT 'Y',
178 ALLOW_RESTART IN VARCHAR2 DEFAULT 'Y',
179 ALLOW_RCG IN VARCHAR2 DEFAULT 'Y',
180 ALLOW_CREATE IN VARCHAR2 DEFAULT 'Y',
181 ALLOW_EDIT IN VARCHAR2 DEFAULT 'Y',
182 PARAMETER_CHANGE_ACTION IN VARCHAR2 DEFAULT 'V',
183 DEVELOPER_PARAMETERS IN VARCHAR2 DEFAULT NULL,
184 SERVER_TYPE IN VARCHAR2 DEFAULT 'C',
185 language_code IN VARCHAR2 DEFAULT 'US',
186 ENV_FILE_NAME IN VARCHAR2 DEFAULT NULL,
187 SERVICE_CLASS IN VARCHAR2 DEFAULT NULL,
188 SERVICE_INSTANCE_CLASS IN VARCHAR2 DEFAULT NULL,
189 OAM_DISPLAY_ORDER IN NUMBER DEFAULT NULL,
190 DEBUG_CHANGE_ACTION IN VARCHAR2 DEFAULT 'N',
191 ENABLED IN VARCHAR2 DEFAULT 'Y',
192 CARTRIDGE_APPLICATION IN VARCHAR2 DEFAULT NULL,
193 DEBUG_TYPE IN VARCHAR2 DEFAULT NULL,
194 SERVICE_PLURAL_NAME IN VARCHAR2 DEFAULT NULL,
195 ALLOW_MULTIPLE_PROC_SI IN VARCHAR2 DEFAULT 'Y',
196 DEFAULT_DEBUG_LEVEL IN VARCHAR2 DEFAULT NULL,
197 last_updated_by IN NUMBER DEFAULT NULL);
198
199 -- Procedure
200 -- DELETE_MANAGER
201 --
202 -- Purpose
203 -- Delete a concurrent manager and all its dependent data.
204 --
205 -- Arguments
206 -- Manager_Short_Name - Concurrent manager short name.
207 -- Application - Manager application short name.
208 --
209 -- Warning:
210 -- This will delete request and process data belonging to the
211 -- manager.
212 --
213 PROCEDURE delete_manager (manager_short_name IN VARCHAR2,
214 application IN VARCHAR2);
215
216
217
218 -- Procedure
219 -- ASSIGN_WORK_SHIFT
220 --
221 -- Purpose
222 -- Assign a work shift to a manager.
223 --
224 -- Arguments
225 -- Manager_Short_Name - Concurrent manager name.
226 -- Manager_Application - Manager application short name.
227 -- Work_Shift - Work shift name.
228 -- Processes - Number of concurrent processes.
229 -- Sleep_Seconds - Length of sleep interval.
230 -- Work_Shift_ID - ID of Work Shift (Optional, overrides parameter
231 -- 'work_shift')
232 -- Last_Update_Date- Who information for FNDLOAD standards
233 -- Last_Updated_By - Who information for FNDLOAD standards
234 --
235 PROCEDURE assign_work_shift(manager_short_name IN VARCHAR2,
236 manager_application IN VARCHAR2,
237 work_shift IN VARCHAR2 DEFAULT NULL,
238 processes IN NUMBER,
239 sleep_seconds IN NUMBER,
240 work_shift_id IN NUMBER DEFAULT NULL,
241 svc_params in VARCHAR2 DEFAULT NULL,
242 last_update_date IN DATE DEFAULT NULL,
243 last_updated_by IN VARCHAR2 DEFAULT NULL);
244
245 -- Procedure
246 -- CREATE_LIBRARY
247 --
248 -- Purpose
249 -- Create a concurrent program library.
250 --
251 -- Arguments
252 -- Library - Library name.
253 -- Application - Library application short name.
254 -- Description - Library description.
255 -- Type - 'Concurrent Programs Library' or
256 -- 'Transaction Programs Library'
257 --
258 PROCEDURE create_library(library IN VARCHAR2,
259 application IN VARCHAR2,
260 description IN VARCHAR2 DEFAULT NULL,
261 type IN VARCHAR2);
262
263
264 -- Procedure
265 -- DELETE_LIBRARY
266 --
267 -- Purpose
268 -- Delete a concurrent program library.
269 --
270 -- Arguments
271 -- Library - Library name.
272 -- Application - Library application short name.
273 --
274 PROCEDURE delete_library(library IN VARCHAR2,
275 application IN VARCHAR2);
276
277 -- Procedure
278 -- ADD_PROGRAM_TO_LIBRARY
279 --
280 -- Purpose
281 -- Add a concurrent program to a concurrent library.
282 --
283 -- Arguments
284 -- Library - Library name.
285 -- Library_Application - Library application short name.
286 -- Program - Program short name.
287 -- Program_Application - Program application short name.
288 --
289 PROCEDURE add_program_to_library(library IN VARCHAR2,
290 library_application IN VARCHAR2,
291 program IN VARCHAR2,
292 program_application IN VARCHAR2);
293
294
295 -- Procedure
296 -- SPECIALIZE
297 --
298 -- Purpose
299 -- Register a specialization rule for a manager.
300 --
301 -- Arguments
302 -- manager_short_name - Concurrent manager short name.
303 -- manager_application - Manager application short name.
304 -- action - 'Include' or 'Exclude'.
305 -- object_type - 'Combined Rule', 'ORACLE ID', 'Program',
306 -- 'Request Type', 'User'.
307 -- object_name - Name of the object being included or excluded.
308 -- (Short name for Programs.)
309 -- object_application - Application short name of the object being
310 -- included or excluded. (Not used for Oracle IDs
311 -- or Users.)
312 -- Last_Update_Date- Who information for FNDLOAD standards
313 -- Last_Updated_By - Who information for FNDLOAD standards
314 --
315 PROCEDURE specialize(manager_short_name in VARCHAR2,
316 manager_application in VARCHAR2,
317 action in VARCHAR2,
318 object_type in VARCHAR2,
319 object_name in VARCHAR2 DEFAULT NULL,
320 object_application in VARCHAR2 DEFAULT NULL,
321 last_update_date in DATE DEFAULT NULL,
322 last_updated_by in NUMBER DEFAULT NULL);
323
324
325 -- Function
326 -- MANAGER_EXISTS
327 --
328 -- Purpose
329 -- Return TRUE if a manager exists.
330 --
331 -- Arguments
332 -- Manager_Short_Name - Manager short name.
333 -- Application - Manager application short name.
334 --
335 FUNCTION manager_exists(manager_short_name IN VARCHAR2,
336 application IN VARCHAR2
337 ) RETURN BOOLEAN;
338
339 -- Function
340 -- SERVICE_EXISTS
341 --
342 -- Purpose
343 -- Return TRUE if a service exists.
344 --
345 -- Arguments
346 -- svc_handle - service_handle.
347 --
348 FUNCTION Service_exists(svc_handle IN VARCHAR2) RETURN BOOLEAN;
349
350 -- Function
351 -- MANAGER_WORK_SHIFT_EXISTS
352 --
353 -- Purpose
354 -- Return TRUE if a manager has an assignment for a work shift.
355 --
356 -- Arguments
357 -- Manager_Short_Name - Manager short name.
358 -- Manager_Application - Manager application short name.
359 -- Work_Shift - Work shift name.
360 -- Work_Shift_ID - ID of Work Shift (Optional, overrides parameter
361 -- 'work_shift')
362 --
363 FUNCTION manager_work_shift_exists(
364 manager_short_name IN VARCHAR2,
365 manager_application IN VARCHAR2,
366 work_shift IN VARCHAR2 DEFAULT NULL,
367 work_shift_id IN NUMBER DEFAULT NULL)
368 RETURN BOOLEAN;
369
370
371 -- Function
372 -- LIBRARY_EXISTS
373 --
374 -- Purpose
375 -- Return TRUE if a library exists.
376 --
377 -- Arguments
378 -- Library - Library name.
379 -- Application - Library application short name.
380 --
381 FUNCTION library_exists(library IN VARCHAR2,
382 application IN VARCHAR2) RETURN BOOLEAN;
383
384
385 -- Function
386 -- PROGRAM_IN_LIBRARY
387 --
388 -- Purpose
389 -- Return TRUE if a library exists.
390 --
391 -- Arguments
392 -- Library - Library name.
393 -- Library_Application - Library application short name.
394 -- Program - Program short name.
395 -- Program_Application - Program application short name.
396 --
397 FUNCTION program_in_library(library IN VARCHAR2,
398 library_application IN VARCHAR2,
399 program IN VARCHAR2,
400 program_application IN VARCHAR2)
401 RETURN BOOLEAN;
402
403
404 -- FUNCTION
405 -- SPECIALIZATION_EXISTS
406 --
407 -- Purpose
408 -- Check if a manager has been specialized for an object.
409 --
410 -- Arguments
411 -- manager_short_name - Concurrent manager short name.
412 -- manager_application - Manager application short name.
413 -- object_type - 'Combined Rule', 'Oracle ID', 'Program',
414 -- 'Request Type', 'User'.
415 -- object_name - Name of the object being included or excluded.
419 -- or Users.)
416 -- (Short name for Programs.)
417 -- object_application - Application short name of the object being
418 -- included or excluded. (Not used for Oracle IDs
420 --
421 FUNCTION specialization_exists(
422 manager_short_name in VARCHAR2,
423 manager_application in VARCHAR2,
424 object_type in VARCHAR2,
425 object_name in VARCHAR2 DEFAULT NULL,
426 object_application in VARCHAR2 DEFAULT NULL)
427 RETURN BOOLEAN;
428
429 -- Procedure
430 -- STANDARDIZE
431 --
432 -- Purpose
433 -- Changes the value of a concurrent_queue_id and all references
434 -- to that ID.
435 --
436 -- Arguments
437 -- Manager_short_name - Concurrent manager short name.
438 -- Application - Manager application short name.
439 -- Queue_ID - New ID
440 --
441 PROCEDURE standardize (manager_short_name IN VARCHAR2,
442 application IN VARCHAR2,
443 manager_id IN number);
444 -- Procedure
445 -- UPDATE_NODE
446 --
447 -- Purpose
448 -- Set Primary and/or Secondary Node assignment for a Service Instance
449 --
450 -- Arguments
451
452 -- Short_Name - Concurrent Queue Name
453 -- Application - Application short name
454 -- Primary_Node - Primary node
455 -- Secondary_Node - Secondary node
456 --
457 -- Node names may be set to null.
458
459 PROCEDURE update_node(short_name IN VARCHAR2,
460 application IN VARCHAR2,
461 primary_node IN VARCHAR2 DEFAULT fnd_api.g_miss_char,
462 secondary_node IN VARCHAR2 DEFAULT fnd_api.g_miss_char);
463
464
465 END fnd_manager;