1 package Wf_Directory as
2 /* $Header: wfdirs.pls 120.12.12010000.3 2008/12/04 00:26:34 alepe ship $ */
3 /*#
4 * Provides APIs that can be
5 * called by an application program or a workflow
6 * function in the runtime phase to retrieve information
7 * about existing users and roles, as well as to create
8 * and manage new ad hoc users and roles in the
9 * directory service.
10 * @rep:scope public
11 * @rep:product OWF
12 * @rep:displayname Workflow Directory Services
13 * @rep:lifecycle active
14 * @rep:compatibility S
15 * @rep:category BUSINESS_ENTITY WF_USER
16 * @rep:ihelp FND/@a_ds See the related online help
17 */
18
19 type UserTable is table of varchar2(320)
20 index by binary_integer;
21
22 type RoleTable is table of varchar2(320)
23 index by binary_integer;
24
25 type OrigSysTable is table of varchar2(30) index by binary_integer;
26
27 /*===========================================================================
28
29 PL*SQL TABLE NAME: wf_local_roles_tble_type
30
31 DESCRIPTION: Stores a list of attributes from
32 WF_LOCAL_ROLES
33
34 ============================================================================*/
35
36 TYPE wf_local_roles_rec_type IS RECORD
37 (
38 NAME VARCHAR2(320),
39 DISPLAY_NAME VARCHAR2(360),
40 DESCRIPTION VARCHAR2(1000),
41 NOTIFICATION_PREFERENCE VARCHAR2(8),
42 LANGUAGE VARCHAR2(64),
43 TERRITORY VARCHAR2(64),
44 NLS_DATE_FORMAT varchar2(64), -- <7578908> full NLS support
45 NLS_DATE_LANGUAGE varchar2(64),
46 NLS_CALENDAR varchar2(64),
47 NLS_NUMERIC_CHARACTERS varchar2(64),
48 NLS_SORT varchar2(64),
49 NLS_CURRENCY varchar2(64), -- </7578908>
50 EMAIL_ADDRESS VARCHAR2(320),
51 FAX VARCHAR2(240),
52 STATUS VARCHAR2(8),
53 EXPIRATION_DATE DATE,
54 ORIG_SYSTEM VARCHAR2(240),
55 ORIG_SYSTEM_ID NUMBER,
56 PARENT_ORIG_SYSTEM VARCHAR2(240),
57 PARENT_ORIG_SYSTEM_ID NUMBER,
58 OWNER_TAG VARCHAR2(50),
59 LAST_UPDATE_DATE DATE,
60 LAST_UPDATED_BY NUMBER(15),
61 CREATION_DATE DATE,
62 CREATED_BY NUMBER(15),
63 LAST_UPDATE_LOGIN NUMBER(15)
64 );
65
66 TYPE wf_local_roles_tbl_type IS TABLE OF
67 wf_directory.wf_local_roles_rec_type
68 INDEX BY BINARY_INTEGER;
69
70 /*#
71 * Returns a table of the users
72 * that belong to the specified role.
73 * @param role Role
74 * @param users Users
75 * @rep:scope public
76 * @rep:lifecycle active
77 * @rep:displayname Get Role Users
78 * @rep:ihelp FND/@a_ds#a_getru See the related online help
79 */
80
81 procedure GetRoleUsers(
82 Role in varchar2,
83 Users out nocopy Wf_Directory.UserTable);
84
85 procedure GetUserRelation(
86 Base_User in varchar2,
87 Relation in varchar2,
88 Users out nocopy Wf_Directory.UserTable);
89
90 /*#
91 * Returns a table of the roles to which
92 * the specified user belongs.
93 * @param user User
94 * @param roles Roles
95 * @rep:scope public
96 * @rep:lifecycle active
97 * @rep:displayname Get User Roles
98 * @rep:ihelp FND/@a_ds#a_getur See the related online help
99 */
100
101 procedure GetUserRoles(
102 User in varchar2,
103 Roles out nocopy Wf_Directory.RoleTable);
104
105 /*#
106 * Returns the display name,
107 * email address, notification preference, language and
108 * territory for the specified role.
109 * @param role Role
110 * @param display_name Display Name
111 * @param email_address E-mail Address
112 * @param notification_preference Notification Preference
113 * @param language Language
114 * @param territory Territory
115 * @rep:scope public
116 * @rep:lifecycle active
117 * @rep:displayname Get Role Info
118 * @rep:ihelp FND/@a_ds#a_getrinf See the related online help
119 */
120
121 procedure GetRoleInfo(
122 Role in varchar2,
123 Display_Name out nocopy varchar2,
124 Email_Address out nocopy varchar2,
125 Notification_Preference out nocopy varchar2,
126 Language out nocopy varchar2,
127 Territory out nocopy varchar2);
128
129 /*#
130 * Returns information about the specified role in a PL/SQL table,
131 * including the role's internal name, display name, description,
132 * notification preference, e-mail address,
133 * fax, status, expiration date, originating system,
134 * originating system ID, parent originating system,
135 * parent originating system ID, owner tag, NLS parameters
136 * (NLS_LANGUAGE, NLS_TERRITORY, NLS_DATE_FORMAT, NLS_DATE_LANGUAGE,
137 * NLS_CALENDAR, NLS_NUMERIC_CHARACTERS, NLS_SORT, and NLS_CURRENCY),
138 * and standard Who columns.
139 * @param role Role
140 * @param Role_Info_Tbl Role Info Table
141 * @rep:scope public
142 * @rep:lifecycle active
143 * @rep:displayname Get Role Info Table
144 * @rep:ihelp FND/@a_ds#a_getrinf2 See the related online help
145 */
146
147
148 procedure GetRoleInfo2(
149 Role in varchar2,
150 Role_Info_Tbl out nocopy wf_directory.wf_local_roles_tbl_type);
151
152 procedure GetRoleInfoMail(
153 role in varchar2,
154 display_name out nocopy varchar2,
155 email_address out nocopy varchar2,
156 notification_preference out nocopy varchar2,
157 language out nocopy varchar2,
158 territory out nocopy varchar2,
159 orig_system out nocopy varchar2,
160 orig_system_id out nocopy number,
161 installed_flag out nocopy varchar2);
162
163 /* (private)
164 *
165 * Returns role attributes for the given role. NLS attribute values are obtained
166 * from EBS profile values when the role orig system is either FND_USR or PER.
167 * Created for phase 1 of full NLS support changes, bug 7578908.
168 */
169 procedure GetRoleInfoMail2( p_role in varchar2,
170 p_display_name out NOCOPY varchar2,
171 p_email_address out NOCOPY varchar2,
172 p_notification_preference out NOCOPY varchar2,
173 p_orig_system out NOCOPY varchar2,
174 p_orig_system_id out NOCOPY number,
175 p_installed_flag out NOCOPY varchar2
176 , p_nlsLanguage out NOCOPY varchar2,
177 p_nlsTerritory out NOCOPY varchar2
178 , p_nlsDateFormat out NOCOPY varchar2
179 , p_nlsDateLanguage out NOCOPY varchar2
180 , p_nlsCalendar out NOCOPY varchar2
181 , p_nlsNumericCharacters out NOCOPY varchar2
182 , p_nlsSort out NOCOPY varchar2
183 , p_nlsCurrency out NOCOPY varchar2);
184 --
185 -- GetRoleOrigSysInfo (PRIVATE)
186 -- Used by Workflow Internal Only
187 --
188 procedure GetRoleOrigSysInfo(
189 Role in varchar2,
190 Orig_System out nocopy varchar2,
191 Orig_System_Id out nocopy number);
192
193 --
194 -- GetRoleNtfPref (PRIVATE)
195 -- Used by Workflow Internal
196 -- To obtain notification preference
197 -- for a given role
198
199 function GetRoleNtfPref(
200 Role in varchar2)
201 return varchar2;
202
203 /*#
204 * Returns TRUE or FALSE to identify
205 * whether the specified user is a performer of
206 * the specified role.
207 * @param user User
208 * @param role Role
209 * @return Is Performer
210 * @rep:scope public
211 * @rep:lifecycle active
212 * @rep:displayname Is Performer
213 * @rep:ihelp FND/@a_ds#a_isperf See the related online help
214 */
215
216 function IsPerformer(
217 User in varchar2,
218 Role in varchar2)
219 return boolean;
220
221 function CurrentUser
222 return varchar2;
223 --
224 -- Function determins if a user is currently active
225 -- and therefore available to participate in a workflow
226 -- In :
227 -- Username
228 -- Returns:
229 -- True - If user is Active
230 -- False - If User is NOT Active
231 --
232 /*#
233 * Returns TRUE or FALSE to identify whether
234 * the specified user currently has a status of 'ACTIVE'
235 * and is available to participate
236 * in a workflow
237 * @param username User Name
238 * @return Is Active
239 * @rep:scope public
240 * @rep:lifecycle active
241 * @rep:displayname User Active
242 * @rep:ihelp FND/@a_ds#a_usract See the related online help
243 */
244
245 function UserActive(username in varchar2)
246 return boolean;
247 --
248 -- Procedure Gets the User_name given the orig system info
249 -- Get the username
250 -- IN:
251 -- orig_system - Code identifying the original table
252 -- orig_system_id - Id of the row in original table
253 -- Returns:
254 -- user_name - Workflow user_name
255 --
256 /*#
257 * Returns the Workflow display name and internal name
258 * for a user given the identifying information for that
259 * user in the directory repository from which it originated.
260 * @param p_orig_system Originating System
261 * @param p_orig_system_id Originating System ID
262 * @param p_name Name
263 * @param p_display_name Display Name
264 * @rep:scope public
265 * @rep:lifecycle active
266 * @rep:displayname Get User Name
267 * @rep:ihelp FND/@a_ds#a_getun See the related online help
268 */
269
270 procedure GetUserName ( p_orig_system in varchar2,
271 p_orig_system_id in varchar2,
272 p_name out nocopy varchar2,
273 p_display_name out nocopy varchar2 );
274 --
275 --
276 --
277 -- Procedure Gets the Role_name given the orig system info
278 -- Get the Role name
279 -- IN:
280 -- orig_system - Code identifying the original table
281 -- orig_system_id - Id of the row in original table
282 -- Returns:
283 -- Role_name - Workflow role_name
284 --
285 /*#
286 * Returns the Workflow display name
287 * and internal name for a role given the
288 * identifying information for that role in the
289 * directory repository from which it originated.
290 * @param p_orig_system Originating System
291 * @param p_orig_system_id Originating System ID
292 * @param p_name Name
293 * @param p_display_name Display Name
294 * @rep:scope public
295 * @rep:lifecycle active
296 * @rep:displayname Get Role Name
297 * @rep:ihelp FND/@a_ds#a_grname See the related online help
298 */
299
300 procedure GetRoleName ( p_orig_system in varchar2,
301 p_orig_system_id in varchar2,
302 p_name out nocopy varchar2,
303 p_display_name out nocopy varchar2 );
304 --
305 /*#
306 * Returns a Workflow role's display
307 * name given an active role's internal name.
308 * @param p_role_name Role Name
309 * @return Display Name
310 * @rep:scope public
311 * @rep:lifecycle active
312 * @rep:displayname Get Active Role Display Name
313 * @rep:ihelp FND/@a_ds#a_grdname See the related online help
314 */
315
316 function GetRoleDisplayName(p_role_name in varchar2)
317 return varchar2;
318 pragma restrict_references(GetRoleDisplayName, WNDS, WNPS);
319
320 /*#
321 * Returns Workflow role's display
322 * name given the role's internal name(active/inactive).
323 * @param p_role_name Role Name
324 * @return Display Name
325 * @rep:scope public
326 * @rep:lifecycle active
327 * @rep:displayname Get Role Display Name
328 * @rep:ihelp FND/@a_ds#a_grdname See the related online help
329 */
330
331 function GetRoleDisplayName2(p_role_name in varchar2)
332 return varchar2;
333 pragma restrict_references(GetRoleDisplayName2, WNDS, WNPS);
334 --
335 --
336
337 --
338 -- SetAdHocUserStatus
339 -- Update status for user
340 -- IN
341 -- user_name -
342 -- status - status could be 'ACTIVE' or 'INACTIVE'
343 -- OUT
344 --
345 /*#
346 * Sets the status of an ad hoc user
347 * as 'ACTIVE' or 'INACTIVE'.
348 * @param user_name User Name
349 * @param status Status
350 * @rep:scope public
351 * @rep:lifecycle active
352 * @rep:displayname Set Ad Hoc User Status
353 * @rep:ihelp FND/@a_ds#a_sahust See the related online help
354 */
355
356 procedure SetAdHocUserStatus(user_name in varchar2,
357 status in varchar2 default 'ACTIVE');
358
359 --
360 -- SetAdHocRoleStatus
361 -- Update status for role
362 -- IN
363 -- role_name -
364 -- status - status could be 'ACTIVE' or 'INACTIVE'
365 -- OUT
366 --
367 /*#
368 * Sets the status of an ad hoc role as
372 * @rep:scope public
369 * 'ACTIVE' or 'INACTIVE'.
370 * @param role_name Role Name
371 * @param status Status
373 * @rep:lifecycle active
374 * @rep:displayname Set Ad Hoc Role Status
375 * @rep:ihelp FND/@a_ds#a_sahrs See the related online help
376 */
377
378 procedure SetAdHocRoleStatus(role_name in varchar2,
379 status in varchar2 default 'ACTIVE');
380
381
382
383 --
384 -- CreateUser (PRIVATE)
385 -- Create a User
386 -- IN
387 -- name - User name
388 -- display_name - User display name
389 -- orig_system
390 -- orig_system_id
391 -- language -
392 -- territory -
393 -- description -
394 -- notification_preference -
395 -- email_address -
396 -- fax -
397 -- status -
398 -- expiration_date - NULL expiration date means no expiration
399 -- start_date
400 -- parent_orig_system
401 -- parent_orig_system_id
402 -- owner_tag -
403 -- last_update_date -
404 -- last_updated_by -
405 -- creation_date -
406 -- created_by -
407 -- last_update_login
408 -- OUT
409 --
410 procedure CreateUser( name in varchar2,
411 display_name in varchar2,
412 orig_system in varchar2,
413 orig_system_id in number,
414 language in varchar2 default null,
415 territory in varchar2 default null,
416 description in varchar2 default null,
417 notification_preference in varchar2 default 'MAILHTML',
418 email_address in varchar2 default null,
419 fax in varchar2 default null,
420 status in varchar2 default 'ACTIVE',
421 expiration_date in date default NULL,
422 start_date in date default sysdate,
423 parent_orig_system in varchar2 default null,
424 parent_orig_system_id in number default null,
425 owner_tag in varchar2 default null,
426 last_update_date in date default sysdate,
427 last_updated_by in number default null,
428 creation_date in date default sysdate,
429 created_by in number default null,
430 last_update_login in number default null);
431
432
433 --
434 -- CreateAdHocUser
435 -- Create an ad hoc user given a user name, display name, etc.
436 -- IN
437 -- name - User name
438 -- display_name - User display name
439 -- description -
440 -- notification_preference -
441 -- language -
442 -- territory -
443 -- email_address -
444 -- fax -
445 -- status -
446 -- expiration_date - NULL expiration date means no expiration
447 -- OUT
448 --
449 /*#
450 * Creates a user in the Workflow local directory service tables
451 * at runtime. This is referred to as an ad hoc user.
452 * @param name Name
453 * @param display_name Display Name
454 * @param language Language
455 * @param territory Territory
456 * @param description Description
457 * @param notification_preference Notification Preference
458 * @param email_address Email Address
459 * @param fax Fax
460 * @param status Status
461 * @param expiration_date Expiration Date
462 * @param parent_orig_system Parent Originating System
463 * @param parent_orig_system_id Parent Originating System ID
464 * @rep:scope public
465 * @rep:lifecycle active
466 * @rep:displayname Create Ad Hoc User
467 * @rep:ihelp FND/@a_ds#a_crahu See the related online help
468 */
469
470 procedure CreateAdHocUser(name in out nocopy varchar2,
471 display_name in out nocopy varchar2,
472 language in varchar2 default null,
473 territory in varchar2 default null,
474 description in varchar2 default null,
475 notification_preference in varchar2 default null,
476 email_address in varchar2 default null,
477 fax in varchar2 default null,
478 status in varchar2 default 'ACTIVE',
479 expiration_date in date default null,
480 parent_orig_system in varchar2 default null,
481 parent_orig_system_id in number default null);
482
483
484 --
485 -- CreateRole (PRIVATE)
486 -- Create an ad hoc role given a specific name
487 -- IN
488 -- role_name -
489 -- role_display_name -
490 -- role_description -
491 -- notification_preference -
492 -- language -
493 -- territory -
494 -- email_address -
495 -- fax -
496 -- status -
497 -- expiration_date - Null means no expiration date
498 -- orig_system -
499 -- orig_system_id
500 -- OUT
501 --
502 procedure CreateRole( role_name in varchar2,
503 role_display_name in varchar2,
504 orig_system in varchar2,
505 orig_system_id in number,
506 language in varchar2 default null,
507 territory in varchar2 default null,
508 role_description in varchar2 default null,
509 notification_preference in varchar2 default null,
510 email_address in varchar2 default null,
511 fax in varchar2 default null,
512 status in varchar2 default 'ACTIVE',
513 expiration_date in date default NULL,
514 start_date in date default sysdate,
515 parent_orig_system in varchar2 default null,
516 parent_orig_system_id in number default null,
517 owner_tag in varchar2 default null,
518 last_update_date in date default sysdate,
519 last_updated_by in number default null,
520 creation_date in date default sysdate,
521 created_by in number default null,
522 last_update_login in number default null);
523
524
525
526
527 --
528 -- CreateAdHocRole
529 -- Create an ad hoc role given a specific name
530 -- IN
531 -- role_name -
532 -- role_display_name -
533 -- role_description -
534 -- notification_preference -
535 -- role_users - Comma or space delimited list
536 -- language -
537 -- territory -
538 -- email_address -
539 -- fax -
540 -- status -
541 -- expiration_date - Null means no expiration date
542 -- OUT
543 --
544 /*#
545 * Creates a role in the Workflow local directory
546 * service tables at runtime. This is referred to as an
547 * ad hoc role.
548 * @param role_name Role Name
549 * @param role_display_name Role Display Name
550 * @param language Language
551 * @param territory Territory
552 * @param role_description Role Description
553 * @param notification_preference Notification Preference
554 * @param role_users Role Users
555 * @param email_address Email Address
556 * @param fax Fax
557 * @param status Status
558 * @param expiration_date Expiration Date
559 * @param parent_orig_system Parent Originating System
560 * @param parent_orig_system_id Parent Originating System ID
561 * @param owner_tag Owner Tag
562 * @rep:scope public
563 * @rep:lifecycle active
564 * @rep:displayname Create Ad Hoc Role
565 * @rep:ihelp FND/@a_ds#a_crahr See the related online help
566 */
567
568 procedure CreateAdHocRole(role_name in out nocopy varchar2,
569 role_display_name in out nocopy varchar2,
570 language in varchar2 default null,
571 territory in varchar2 default null,
572 role_description in varchar2 default null,
573 notification_preference in varchar2 default null,
574 role_users in varchar2 default null,
575 email_address in varchar2 default null,
576 fax in varchar2 default null,
577 status in varchar2 default 'ACTIVE',
578 expiration_date in date default null,
579 parent_orig_system in varchar2 default null,
580 parent_orig_system_id in number default null,
581 owner_tag in varchar2 default null);
582
583
584
585 --
586 -- CreateAdHocRole2
590 -- role_display_name -
587 -- Create an ad hoc role given a specific name
588 -- IN
589 -- role_name -
591 -- role_description -
592 -- notification_preference -
593 -- role_users - Comma or space delimited list
594 -- language -
595 -- territory -
596 -- email_address -
597 -- fax -
598 -- status -
599 -- expiration_date - Null means no expiration date
600 -- OUT
601 --
602 procedure CreateAdHocRole2(role_name in out nocopy varchar2,
603 role_display_name in out nocopy varchar2,
604 language in varchar2 default null,
605 territory in varchar2 default null,
606 role_description in varchar2 default null,
607 notification_preference in varchar2 default null,
608 role_users in WF_DIRECTORY.UserTable,
609 email_address in varchar2 default null,
610 fax in varchar2 default null,
611 status in varchar2 default 'ACTIVE',
612 expiration_date in date default null,
613 parent_orig_system in varchar2 default null,
614 parent_orig_system_id in number default null,
615 owner_tag in varchar2 default null);
616
617
618 --
619 -- CreateUserRole (PRIVATE)
620 -- Create a user to role relationship.
621 -- IN
622 -- user_name -
623 -- role_name -
624 -- user_orig_system -
625 -- user_orig_system_id -
626 -- role_orig_system -
627 -- role_orig_system_id -
628 --
629 procedure CreateUserRole(user_name in varchar2,
630 role_name in varchar2,
631 user_orig_system in varchar2 default NULL,
632 user_orig_system_id in number default NULL,
633 role_orig_system in varchar2 default NULL,
634 role_orig_system_id in number default NULL,
635 validateUserRole in boolean default TRUE,
636 start_date in date default sysdate,
637 end_date in date default NULL,
638 created_by in number default -1,
639 creation_date in date default sysdate,
640 last_updated_by in number default -1,
641 last_update_date in date default sysdate,
642 last_update_login in number default -1,
643 assignment_type in varchar2 default 'D',
644 parent_orig_system in varchar2 default NULL,
645 parent_orig_system_id in number default null,
646 owner_tag in varchar2 default null,
647 assignment_reason in varchar2 default null,
648 eventParams in wf_parameter_list_t default null);
649
650
651 --
652 -- SetUserRoleAttr (PRIVATE)
653 -- Update a user to role relationship.
654 -- IN
655 -- user_name -
656 -- role_name -
657 -- start_date -
658 -- expiration_date -
659 -- user_orig_system -
660 -- user_orig_system_id -
661 -- role_orig_system -
662 -- role_orig_system_id -
663 -- assignment_type -
664 -- parent_orig_system -
665 -- parent_orig_system_id
666 -- owner_tag -
667 --
668 procedure SetUserRoleAttr ( user_name in varchar2,
669 role_name in varchar2,
670 start_date in date default NULL,
671 end_date in date default NULL,
672 user_orig_system in varchar2,
673 user_orig_system_id in number,
674 role_orig_system in varchar2,
675 role_orig_system_id in number,
676 OverWrite in boolean default FALSE,
677 last_updated_by in number default -1,
678 last_update_date in date default sysdate,
679 last_update_login in number default -1,
680 created_by in number default NULL,
681 creation_date in date default NULL,
682 assignment_type in varchar2 default 'D',
683 parent_orig_system in varchar2 default null,
684 parent_orig_system_id in number default null,
685 owner_tag in varchar2 default null,
686 assignment_reason in varchar2 default null,
687 updateWho in BOOLEAN default null,
688 eventParams in wf_parameter_list_t default null);
689
690
691 --
692 -- RemoveUserRole (PRIVATE)
693 -- Remove a user from a role.
694 -- IN
695 -- user_name -
696 -- role_name -
697 -- user_orig_system -
701 --
698 -- user_orig_system_id -
699 -- role_orig_system -
700 -- role_orig_system_id -
702 procedure RemoveUserRole(user_name in varchar2,
703 role_name in varchar2,
704 user_orig_system in varchar2,
705 user_orig_system_id in number,
706 role_orig_system in varchar2,
707 role_orig_system_id in number);
708
709 --
710 -- AddUsersToAdHocRole
711 -- Add users to an existing ad hoc role
712 -- IN
713 -- role_name - AdHoc role name
714 -- role_users - Space or comma delimited list of apps-based users
715 -- or adhoc users
716 -- OUT
717 --
718 /*#
719 * Adds users to an existing ad hoc role.
720 * @param role_name Role Name
721 * @param role_users Role Users
722 * @rep:scope public
723 * @rep:lifecycle active
724 * @rep:displayname Add Users To Ad Hoc Role
725 * @rep:ihelp FND/@a_ds#a_autahr See the related online help
726 */
727 procedure AddUsersToAdHocRole(role_name in varchar2,
728 role_users in varchar2);
729
730 --
731 -- AddUsersToAdHocRole2
732 -- Add users to an existing ad hoc role
733 -- IN
734 -- role_name - AdHoc role name
735 -- role_users - Table of user names.
736 --
737 -- OUT
738 --
739 procedure AddUsersToAdHocRole2(role_name in varchar2,
740 role_users in WF_DIRECTORY.UserTable);
741
742 --
743 -- SetUserAttr (PRIVATE)
744 -- Update additional attributes for users
745 -- IN
746 -- user_name - user name
747 -- orig_system -
748 -- orig_system_id -
749 -- display_name -
750 -- description -
751 -- notification_preference -
752 -- language -
753 -- territory -
754 -- email_address -
755 -- fax -
756 -- expiration_date - New expiration date
757 -- status - status could be 'ACTIVE' or 'INACTIVE'
758 -- start_date
759 -- OverWrite - Turns off existing data protection.
760 -- parent_orig_system -
761 -- parent_orig_system_id -
762 -- owner_tag
763 -- OUT
764 --
765 procedure SetUserAttr(user_name in varchar2,
766 orig_system in varchar2,
767 orig_system_id in number,
768 display_name in varchar2 default null,
769 description in varchar2 default null,
770 notification_preference in varchar2 default null,
771 language in varchar2 default null,
772 territory in varchar2 default null,
773 email_address in varchar2 default null,
774 fax in varchar2 default null,
775 expiration_date in date default null,
776 status in varchar2 default null,
777 start_date in date default null,
778 OverWrite in boolean default FALSE,
779 Parent_Orig_System in varchar2 default null,
780 Parent_Orig_System_ID in number default null,
781 owner_tag in varchar2 default null,
782 last_updated_by in number default null,
783 last_update_date in date default null,
784 last_update_login in number default null,
785 created_by in number default null,
786 creation_date in date default null,
787 eventParams in wf_parameter_list_t default null);
788
789 --
790 -- SetRoleAttr (PRIVATE)
791 -- Update additional attributes for roles
792 -- IN
793 -- role_name - role name
794 -- orig_system -
795 -- orig_system_id -
796 -- display_name -
797 -- notification_preference -
798 -- language -
799 -- territory -
800 -- email_address -
801 -- fax -
802 -- expiration_date - New expiration date
803 -- status - status could be 'ACTIVE' or 'INACTIVE'
804 -- start_date
805 -- OverWrite - Turns off existing data protection.
806 -- OUT
807 --
808 procedure SetRoleAttr(role_name in varchar2,
809 orig_system in varchar2,
810 orig_system_id in number,
811 display_name in varchar2 default null,
812 description in varchar2 default null,
813 notification_preference in varchar2 default null,
814 language in varchar2 default null,
815 territory in varchar2 default null,
816 email_address in varchar2 default null,
817 fax in varchar2 default null,
818 expiration_date in date default null,
822 Parent_Orig_System in varchar2 default null,
819 status in varchar2 default null,
820 start_date in date default null,
821 OverWrite in boolean default FALSE,
823 Parent_Orig_System_ID in number default null,
824 owner_tag in varchar2 default null,
825 last_updated_by in number default null,
826 last_update_date in date default sysdate,
827 last_update_login in number default null,
828 created_by in number default null,
829 creation_date in date default null,
830 eventParams in wf_parameter_list_t default null);
831
832 --
833 -- SetAdHocUserExpiration
834 -- Update expiration date for ad hoc users
835 -- IN
836 -- user_name - Ad hoc user name
837 -- expiration_date - New expiration date
838 -- OUT
839 --
840 /*#
841 * Updates the expiration date for
842 * an ad hoc user.
843 * @param user_name User Name
844 * @param expiration_date Expiration Date
845 * @rep:scope public
846 * @rep:lifecycle active
847 * @rep:displayname Set Ad Hoc User Expiration
848 * @rep:ihelp FND/@a_ds#a_sahue See the related online help
849 */
850
851 procedure SetAdHocUserExpiration(user_name in varchar2,
852 expiration_date in date default sysdate);
853
854 --
855 -- SetAdHocRoleExpiration
856 -- Update expiration date for ad hoc roles, user roles
857 -- IN
858 -- role_name - Ad hoc role name
859 -- expiration_date - New expiration date
860 -- OUT
861 --
862 /*#
863 * Updates the expiration date for
864 * an ad hoc role.
865 * @param role_name Role Name
866 * @param expiration_date Expiration Date
867 * @rep:scope public
868 * @rep:lifecycle active
869 * @rep:displayname Set Ad Hoc Role Expiration
870 * @rep:ihelp FND/@a_ds#a_sahre See the related online help
871 */
872
873 procedure SetAdHocRoleExpiration(role_name in varchar2,
874 expiration_date in date default sysdate);
875
876 --
877 -- SetAdHocUserAttr
878 -- Update additional attributes for ad hoc users
879 -- IN
880 -- user_name - Ad hoc user name
881 -- display_name -
882 -- notification_preference -
883 -- language -
884 -- territory -
885 -- email_address -
886 -- fax -
887 -- OUT
888 --
889 /*#
890 * Updates the attributes for an ad hoc user.
891 * @param user_name User Name
892 * @param display_name Display Name
893 * @param notification_preference Notification Preference
894 * @param language Language
895 * @param territory Territory
896 * @param email_address E-mail address
897 * @param fax Fax
898 * @param parent_orig_system Parent Originating System
899 * @param parent_orig_system_id Parent Originating System ID
900 * @param owner_tag Owner Tag
901 * @rep:scope public
902 * @rep:lifecycle active
903 * @rep:displayname Set Ad Hoc User Attributes
904 * @rep:ihelp FND/@a_ds#a_sahua See the related online help
905 */
906
907 procedure SetAdHocUserAttr(user_name in varchar2,
908 display_name in varchar2 default null,
909 notification_preference in varchar2 default null,
910 language in varchar2 default null,
911 territory in varchar2 default null,
912 email_address in varchar2 default null,
913 fax in varchar2 default null,
914 parent_orig_system in varchar2 default null,
915 parent_orig_system_id in number default null,
916 owner_tag in varchar2 default null);
917
918 --
919 -- SetAdHocRoleAttr
920 -- Update additional attributes for ad hoc roles, user roles
921 -- IN
922 -- role_name - Ad hoc role name
923 -- display_name -
924 -- notification_preference -
925 -- language -
926 -- territory -
927 -- email_address -
928 -- fax -
929 -- OUT
930 --
931 /*#
932 * Updates the attributes for an ad hoc role.
933 * @param role_name Role Name
934 * @param display_name Display Name
935 * @param notification_preference Notification Preference
936 * @param language Language
937 * @param territory Territory
938 * @param email_address E-mail address
939 * @param fax Fax
940 * @param parent_orig_system Parent Originating System
941 * @param parent_orig_system_id Parent Originating System ID
942 * @param owner_tag Owner Tag
943 * @rep:scope public
944 * @rep:lifecycle active
945 * @rep:displayname Set Ad Hoc Role Attributes
946 * @rep:ihelp FND/@a_ds#a_sahra See the related online help
947 */
948 procedure SetAdHocRoleAttr(role_name in varchar2,
952 territory in varchar2 default null,
949 display_name in varchar2 default null,
950 notification_preference in varchar2 default null,
951 language in varchar2 default null,
953 email_address in varchar2 default null,
954 fax in varchar2 default null,
955 parent_orig_system in varchar2 default null,
956 parent_orig_system_id in number default null,
957 owner_tag in varchar2 default null);
958
959 --
960 -- RemoveUsersFromAdHocRole
961 -- Remove users from an existing ad hoc role
962 -- IN
963 -- role_name -
964 -- role_users -
965 -- OUT
966 --
967 /*#
968 * Removes users from an existing
969 * ad hoc role.
970 * @param role_name Role Name
971 * @param role_users Role Users
972 * @rep:scope public
973 * @rep:lifecycle active
974 * @rep:displayname Remove Users From Ad Hoc Role
975 * @rep:ihelp FND/@a_ds#a_rufahr See the related online help
976 */
977
978 procedure RemoveUsersFromAdHocRole(role_name in varchar2,
979 role_users in varchar2 default null);
980
981 --
982 -- ChangeLocalUserName
983 -- Change a User's Name in the WF_LOCAL_USERS table.
984 -- IN
985 -- OldName
986 -- NewName
987 -- Propagate - call WF_MAINTENANCE.PropagateChangedName.
988 -- OUT
989 --
990 function ChangeLocalUserName(OldName in varchar2,
991 NewName in varchar2,
992 Propagate in boolean default true)
993 return BOOLEAN;
994
995 --
996 -- ReassignUserRoles
997 -- Reassigns user/roles when the user information changes.
998 -- IN
999 -- p_user_name
1000 -- p_old_user_origSystem
1001 -- p_old_user_origSystemID
1002 -- p_new_user_origSystem
1003 -- p_new_user_origSystemID
1004 -- p_last_update_date
1005 -- p_last_updated_by
1006 -- p_last_update_login
1007 -- p_overWriteUserRoles - if TRUE, provided new column values should not be null for the
1008 -- corresponding column update to happen.
1009 -- OUT
1010 --
1011 procedure ReassignUserRoles (p_user_name in VARCHAR2,
1012 p_old_user_origSystem in VARCHAR2,
1013 p_old_user_origSystemID in VARCHAR2,
1014 p_new_user_origSystem in VARCHAR2,
1015 p_new_user_origSystemID in VARCHAR2,
1016 p_last_update_date in DATE default NULL,
1017 p_last_updated_by in NUMBER default NULL,
1018 p_last_update_login in NUMBER default NULL
1019 -- <6817561>
1020 , p_overWriteUserRoles in boolean default false -- </6817561>
1021 );
1022
1023
1024 --
1025 -- AssignPartition (PRIVATE)
1026 --
1027 -- IN
1028 -- p_orig_system (VARCHAR2)
1029 --
1030 -- RETURNS
1031 -- Partition ID (NUMBER)
1032 --
1033 -- COMMENTS
1034 -- This api will check to see the partition for the p_orig_system exists.
1035 -- if it does not exist, it will be added to p_table_name. In either case
1036 -- the Partition_ID will be returned for the calling api to properly populate
1037 -- that column on insert/update.
1038 --
1039 procedure AssignPartition (p_orig_system in varchar2,
1040 p_partitionID out nocopy number,
1041 p_partitionName out nocopy varchar2);
1042
1043 --Bug 3090738
1044 --This API queries wf_roles for information of the
1045 --user when the e-mail address is give.
1046 procedure getInfoFromMail(mailid in varchar2,
1047 role out nocopy varchar2,
1048 display_name out NOCOPY varchar2,
1049 description out NOCOPY varchar2,
1050 notification_preference out NOCOPY varchar2,
1051 language out NOCOPY varchar2,
1052 territory out NOCOPY varchar2,
1053 fax out NOCOPY varchar2,
1054 expiration_date out NOCOPY date,
1055 status out NOCOPY varchar2,
1056 orig_system out NOCOPY varchar2,
1057 orig_system_id out NOCOPY number);
1058
1059 /* (PRIVATE) - to be used by WF only
1060 *
1061 * Fetches role information when the e-mail address is given.
1062 * Added other parameters for full NLS support -phase 1-, bug 7578908
1063 */
1064 procedure GetInfoFromMail2( p_emailid in varchar2
1065 , p_role out NOCOPY varchar2,
1066 p_display_name out NOCOPY varchar2,
1067 p_description out NOCOPY varchar2,
1068 p_notification_preference out NOCOPY varchar2,
1069 p_orig_system out NOCOPY varchar2,
1070 p_orig_system_id out NOCOPY number,
1071 p_fax out NOCOPY number,
1072 p_expiration_date out nocopy date,
1073 p_status out NOCOPY varchar2
1074 , p_nlsLanguage out NOCOPY varchar2,
1075 p_nlsTerritory out NOCOPY varchar2
1076 , p_nlsDateFormat out NOCOPY varchar2
1077 , p_nlsDateLanguage out NOCOPY varchar2
1078 , p_nlsCalendar out NOCOPY varchar2
1079 , p_nlsNumericCharacters out NOCOPY varchar2
1080 , p_nlsSort out NOCOPY varchar2
1081 , p_nlsCurrency out NOCOPY varchar2);
1082
1083 function IsMLSEnabled(p_orig_system in varchar2)
1084 return boolean;
1085
1086 --
1087 -- Change_Name_References_RF (PRIVATE)
1088 --
1089 -- IN
1090 -- p_sub_guid (RAW)
1091 -- p_event (WF_EVENT_T)
1092 --
1093 -- RETURNS
1094 -- varchar2
1095 --
1096 -- COMMENTS
1097 -- This api is a rule function to be called by BES. It is primarily used for
1098 -- a user name change to update all the fk references. The subscription is
1099 -- set as deferred to offline the updates to return control back to the user
1100 -- more quickly.
1101 --
1102 function Change_Name_References_RF( p_sub_guid in RAW,
1103 p_event in out NOCOPY WF_EVENT_T )
1104 return varchar2;
1105
1106
1107 --
1108 -- DeleteRole
1109 --
1110 -- IN
1111 -- p_name (VARCHAR2)
1112 -- p_OrigSystem (VARCHAR2)
1113 -- p_OrigSystemID (NUMBER)
1114 --
1115 --
1116 -- COMMENTS
1117 -- This API is to be used to remove a specified end-dated role/user
1118 -- along with its references, from the WFDS Tables.
1119
1120 procedure DeleteRole ( p_name in varchar2,
1121 p_origSystem in varchar2,
1122 p_origSystemID in number);
1123
1124
1125
1126 --
1127 -- DeleteUserRole
1128 --
1129 -- IN
1130 -- p_username (VARCHAR2)
1131 -- p_rolename (VARCHAR2)
1132 -- p_userOrigSystem (VARCHAR2)
1133 -- p_userOrigSystemID (NUMBER)
1134 -- p_roleOrigSystem (VARCHAR2)
1135 -- p_roleOrigSystemID (NUMBER)
1136 --
1137 --
1138 -- COMMENTS
1139 -- This API is to be used to remove a specified end-dated user/role
1140 -- assignment along with its references from the WFDS Tables.
1141 --
1142 procedure DeleteUserRole ( p_username in varchar2 default null,
1143 p_rolename in varchar2 default null,
1144 p_userorigSystem in varchar2 default null,
1145 p_userorigSystemID in number default null,
1146 p_roleorigSystem in varchar2 default null,
1147 p_roleorigSystemID in number default null);
1148
1149 end Wf_Directory;
[Home] [Help]