1 package WF_LOCAL_SYNCH as
2 /* $Header: WFLOCALS.pls 120.10.12010000.2 2008/08/26 20:37:41 alepe ship $ */
3 /*#
4 * This interface provides APIs that enable synchronization
5 * between the user and role information stored in
6 * application tables by various Oracle e-Business Suite modules
7 * and the information stored in the Workflow local tables.
8 * @rep:scope internal
9 * @rep:product OWF
10 * @rep:displayname Workflow Local Synchronization
11 * @rep:lifecycle active
12 * @rep:compatibility S
13 * @rep:category BUSINESS_ENTITY WF_USER
14 * @rep:ihelp FND/@lsyapi See the related online help
15 */
16
17 /*
18 ** propagate_user - Synchronizes the WF_LOCAL_USERS table and
19 ** updates the entity mgr if appropriate
20 */
21 /*#
22 * This API synchronizes the information for a user
23 * from an application table with the WF_LOCAL_ROLES
24 * table .The user is identified by the specified
25 * originating system and originating system ID.
26 * @param p_orig_system Originating System
27 * @param p_orig_system_id Originating System ID
28 * @param p_attributes Attribute list for the user
29 * @param p_start_date Start Date
30 * @param p_expiration_date Expiration Date
31 * @rep:scope internal
32 * @rep:lifecycle active
33 * @rep:displayname Propagate User
34 * @rep:ihelp FND/@lsyapi#a_lspu See the related online help
35 */
36 PROCEDURE propagate_user(p_orig_system in varchar2,
37 p_orig_system_id in number,
38 p_attributes in wf_parameter_list_t,
39 p_start_date in date default null,
40 p_expiration_date in date default null);
41 ------------------------------------------------------------------------------
42 /*
43 ** propagate_role - Synchronizes the WF_LOCAL_ROLES table and
44 ** updates the entity mgr if appropriate
45 */
46 /*#
47 * This API synchronizes the information for a role
48 * from an application table with the WF_LOCAL_ROLES
49 * table .The user is identified by the specified
50 * originating system and originating system ID.
51 * @param p_orig_system Originating System
52 * @param p_orig_system_id Originating System ID
53 * @param p_attributes Attribute list for the user
54 * @param p_start_date Start Date
55 * @param p_expiration_date Expiration Date
56 * @rep:scope internal
57 * @rep:lifecycle active
58 * @rep:displayname Propagate Role
59 * @rep:ihelp FND/@lsyapi#a_lspr See the related online help
60 */
61 PROCEDURE propagate_role(p_orig_system in varchar2,
62 p_orig_system_id in number,
63 p_attributes in wf_parameter_list_t,
64 p_start_date in date default null,
65 p_expiration_date in date default null);
66 ------------------------------------------------------------------------------
67 /*
68 ** propagate_user_role - (DEPRECATED) use propagateUserRole()
69 */
70 /*#
71 * This API Synchronizes the information for an
72 * association of a user and a role from an application
73 * table with the WF_LOCAL_USER_ROLES table.
74 * @param p_user_orig_system User Originating System
75 * @param p_user_orig_system_id User Originating System ID
76 * @param p_role_orig_system Role Originating System
77 * @param p_role_orig_system_id Role Originating System ID
78 * @param p_start_date Start Date
79 * @param p_expiration_date Expiration Date
80 * @param p_overwrite Overwrite
81 * @param p_raiseErrors Raise Errors
82 * @rep:scope internal
83 * @rep:lifecycle active
84 * @rep:displayname Propagate User
85 * @rep:ihelp FND/@lsyapi#a_lspur See the related online help
86 */
87 PROCEDURE propagate_user_role(p_user_orig_system in varchar2,
88 p_user_orig_system_id in number,
89 p_role_orig_system in varchar2,
90 p_role_orig_system_id in number,
91 p_start_date in date default null,
92 p_expiration_date in date default null,
93 p_overwrite in boolean default FALSE,
94 p_raiseErrors in boolean default FALSE);
95 ------------------------------------------------------------------------------
96 /*
97 ** propagateUserRole - Synchronizes the WF_LOCAL_USER_ROLES table and
98 ** updates the entity mgr if appropriate
99 */
100 PROCEDURE propagateUserRole(p_user_name in varchar2,
101 p_role_name in varchar2,
102 p_user_orig_system in varchar2 default null,
103 p_user_orig_system_id in number default null,
104 p_role_orig_system in varchar2 default null,
105 p_role_orig_system_id in number default null,
106 p_start_date in date default null,
107 p_expiration_date in date default null,
108 p_overwrite in boolean default FALSE,
109 p_raiseErrors in boolean default FALSE,
110 p_parent_orig_system in varchar2 default null,
111 p_parent_orig_system_id in varchar2 default null,
112 p_ownerTag in varchar2 default null,
113 p_createdBy in number default null,
114 p_lastUpdatedBy in number default null,
115 p_lastUpdateLogin in number default null,
116 p_creationDate in date default null,
117 p_lastUpdateDate in date default null,
118 p_assignmentReason in varchar2 default null,
119 p_updateWho in boolean default null,
120 p_attributes in wf_parameter_list_t default null);
121 ------------------------------------------------------------------------------
122
123 /*
124 ** BulkSynchronization - Synchronize the LOCAL tables en masse from
125 ** the old views for the specified orig system
126 */
127 PROCEDURE BulkSynchronization(p_orig_system in varchar2 default 'ALL',
128 p_parallel_processes in number default 0,
129 p_logging in varchar2 default 'LOGGING',
130 p_raiseErrors in boolean default TRUE,
131 p_temptablespace in varchar2 default null);
132 ------------------------------------------------------------------------------
133 /*
134 ** BulkSynchronization_conc - CM cover routine for BulkSynchronization
135 */
136 PROCEDURE BulkSynchronization_conc(errbuf out NOCOPY varchar2,
137 retcode out NOCOPY varchar2,
138 p_orig_system in varchar2 default 'ALL',
139 p_parallel_processes in varchar2 default '0',
140 p_logging in varchar2 default 'LOGGING',
141 p_temptablespace in varchar2 default null,
142 p_raiseerrors in varchar2 default null);
143
144 ------------------------------------------------------------------------------
145 /*
146 ** CheckCache - <private>
147 **
148 ** Checks to see if a role is in the cache of recently created roles.
149 ** IN
150 ** p_role_name VARCHAR2
151 ** RETURNS
152 ** BOOLEAN
153 */
154 FUNCTION CheckCache (p_role_name in VARCHAR2) return boolean;
155
156 ------------------------------------------------------------------------------
157 /*
158 ** DeleteCache - <private>
159 **
160 ** Removes a role from the cache of newly created roles.
161 ** IN
162 ** p_role_name VARCHAR2
163 */
164 PROCEDURE DeleteCache (p_role_name in VARCHAR2);
165
166 ------------------------------------------------------------------------------
167 /*
168 ** ValidateUserRoles - Validates and corrects denormalized user and role
169 ** information in user/role relationships.
170 */
171 PROCEDURE ValidateUserRoles(p_BatchSize in NUMBER default null,
172 p_check_dangling in BOOLEAN default null,
173 p_check_missing_ura in BOOLEAN default null,
174 p_UpdateWho in BOOLEAN default null,
175 p_parallel_processes in number default null);
176 ------------------------------------------------------------------------------
177 /*
178 ** ValidateUserRoles_conc - CM cover routine for ValidateUserRoles()
179 */
180 PROCEDURE ValidateUserRoles_conc(errbuf out NOCOPY varchar2,
181 retcode out NOCOPY varchar2,
182 p_BatchSize in varchar2 default null,
183 p_check_dangling in varchar2 default null,
184 p_check_missing_ura in varchar2 default null,
185 p_UpdateWho in varchar2 default null,
186 p_parallel_processes in number default null);
187
188 ------------------------------------------------------------------------------
189 /*
190 ** Create_Stage_Indexes - <private>
191 **
192 ** This routine examines the base table provided and creates matching indexes
193 ** on the stage table.
194 */
195 PROCEDURE Create_Stage_Indexes (p_sourceTable in VARCHAR2,
196 p_targetTable in VARCHAR2);
197
198 end WF_LOCAL_SYNCH;