1 Package HR_KI_INTEGRATIONS_API AUTHID CURRENT_USER as
2 /* $Header: hrintapi.pkh 120.1 2005/10/02 02:03:08 aroussel $ */
3 /*#
4 * This package contains APIs that maintain HR Knowledge Integration
5 * definition.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Knowledge Integration
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |----------------------------< create_integration >------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a knowledge integration definition.
18 *
19 * The integration definition can be to any content provider or a third party
20 * application. This enable seamless interation to be provided from Oracle HRMS
21 * UI.
22 *
23 * <p><b>Licensing</b><br>
24 * This API is licensed for use with all products in the HRMS Product Family.
25 *
26 * <p><b>Prerequisites</b><br>
27 * Valid Integration Key, Partner Name, Service Name, Source Language and
28 * either URL,external application details to register in Single Sign On server
29 * or XML Gateway details should be entered.
30 *
31 * <p><b>Post Success</b><br>
32 * The knowledge integration definition is successfully created into the
33 * database.
34 *
35 * <p><b>Post Failure</b><br>
36 * The knowledge integration definition will not be created and an error will
37 * be raised.
38 * @param p_validate If true, then validation alone will be performed and the
39 * database will remain unchanged. If false and all validation checks pass,
40 * then the database will be modified.
41 * @param p_language_code Specifies to which language the translation values
42 * apply. You can set to the base or any installed language. The default value
43 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
44 * value.
45 * @param p_integration_key Unique identifier for knowledge integration record.
46 * @param p_party_type Type of trading partner.
47 * @param p_party_name Name of the party.
48 * @param p_party_site_name Party site name.
49 * @param p_transaction_type Product short name for the base Oracle
50 * application.
51 * @param p_transaction_subtype Code for a particular transaction within the
52 * application specified by the p_transaction_type.
53 * @param p_standard_code XML standard to be used.
54 * @param p_ext_trans_type External identifier for the XML message.
55 * @param p_ext_trans_subtype Secondary external identifier for the XML
56 * message.
57 * @param p_trans_direction Indicates if the message is inbound or outbound.
58 * @param p_url URL for the simple URL type integration.
59 * @param p_partner_name Name of partner.
60 * @param p_service_name Name of services provided by the partner.
61 * @param p_ext_application_id Internal identifier of the external application.
62 * @param p_application_name External application name.
63 * @param p_application_type External application type.
64 * @param p_application_url URL for the external application.
65 * @param p_logout_url URL to log out of the external application.
66 * @param p_user_field Name of user field.
67 * @param p_password_field Name of password field.
68 * @param p_authentication_needed Type of authentication used. Valid values are
69 * BASIC or POST.
70 * @param p_field_name1 Additional name and value pair field.
71 * @param p_field_value1 Additional name and value pair field.
72 * @param p_field_name2 Additional name and value pair field.
73 * @param p_field_value2 Additional name and value pair field.
74 * @param p_field_name3 Additional name and value pair field.
75 * @param p_field_value3 Additional name and value pair field.
76 * @param p_field_name4 Additional name and value pair field.
77 * @param p_field_value4 Additional name and value pair field.
78 * @param p_field_name5 Additional name and value pair field.
79 * @param p_field_value5 Additional name and value pair field.
80 * @param p_field_name6 Additional name and value pair field.
81 * @param p_field_value6 Additional name and value pair field.
82 * @param p_field_name7 Additional name and value pair field.
83 * @param p_field_value7 Additional name and value pair field.
84 * @param p_field_name8 Additional name and value pair field.
85 * @param p_field_value8 Additional name and value pair field.
86 * @param p_field_name9 Additional name and value pair field.
87 * @param p_field_value9 Additional name and value pair field.
88 * @param p_integration_id If p_validate is false, then this uniquely
89 * identifies the knowledge integration been created. If p_validate is true,
90 * then set to null.
91 * @param p_object_version_number If p_validate is false, then set to the
92 * version number of the created knowledge integration record. If p_validate is
93 * true, then the value will be null.
94 * @rep:displayname Create Integration
95 * @rep:category BUSINESS_ENTITY HR_KI_MAP
96 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
97 * @rep:scope public
98 * @rep:lifecycle active
99 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
100 */
101 --
102 -- {End Of Comments}
103 --
104 procedure create_integration
105 (p_validate in boolean default false
106 ,p_language_code in varchar2 default hr_api.userenv_lang
107 ,p_integration_key in varchar2
108 ,p_party_type in varchar2 default null
109 ,p_party_name in varchar2 default null
110 ,p_party_site_name in varchar2 default null
111 ,p_transaction_type in varchar2 default null
112 ,p_transaction_subtype in varchar2 default null
113 ,p_standard_code in varchar2 default null
114 ,p_ext_trans_type in varchar2 default null
115 ,p_ext_trans_subtype in varchar2 default null
116 ,p_trans_direction in varchar2 default null
117 ,p_url in varchar2 default null
118 ,p_partner_name in varchar2
119 ,p_service_name in varchar2
120 ,p_ext_application_id in number default null
121 ,p_application_name in varchar2 default null
122 ,p_application_type in varchar2 default null
123 ,p_application_url in varchar2 default null
124 ,p_logout_url in varchar2 default null
125 ,p_user_field in varchar2 default null
126 ,p_password_field in varchar2 default null
127 ,p_authentication_needed in varchar2 default null
128 ,p_field_name1 in varchar2 default null
129 ,p_field_value1 in varchar2 default null
130 ,p_field_name2 in varchar2 default null
131 ,p_field_value2 in varchar2 default null
132 ,p_field_name3 in varchar2 default null
133 ,p_field_value3 in varchar2 default null
134 ,p_field_name4 in varchar2 default null
135 ,p_field_value4 in varchar2 default null
136 ,p_field_name5 in varchar2 default null
137 ,p_field_value5 in varchar2 default null
138 ,p_field_name6 in varchar2 default null
139 ,p_field_value6 in varchar2 default null
140 ,p_field_name7 in varchar2 default null
141 ,p_field_value7 in varchar2 default null
142 ,p_field_name8 in varchar2 default null
143 ,p_field_value8 in varchar2 default null
144 ,p_field_name9 in varchar2 default null
145 ,p_field_value9 in varchar2 default null
146 ,p_integration_id out nocopy number
147 ,p_object_version_number out nocopy number
148 );
149 --
150 -- ----------------------------------------------------------------------------
151 -- |---------------------------< validate_integration >-----------------------|
152 -- ----------------------------------------------------------------------------
153 --
154 -- {Start Of Comments}
155 /*#
156 * This API validates a knowledge integration definition.
157 *
158 * Keeps an integration in synch with external application in Single Sign On
159 * server and XML Gateway schema. If the integration is valid then the value of
160 * SYNCHED is set to Y.
161 *
162 * <p><b>Licensing</b><br>
163 * This API is licensed for use with all products in the HRMS Product Family.
164 *
165 * <p><b>Prerequisites</b><br>
166 * A valid integration_id should be entered.
167 *
168 * <p><b>Post Success</b><br>
169 * The knowledge integration validation definition will be successfully
170 * inserted into the database.
171 *
172 * <p><b>Post Failure</b><br>
173 * The knowledge integration validation definition will not be created and an
174 * error will be raised.
175 * @param p_validate If true, then validation alone will be performed and the
176 * database will remain unchanged. If false and all validation checks pass,
177 * then the database will be modified.
178 * @param p_integration_id Internal unique identifier of the knowledge
179 * integration record.
180 * @param p_object_version_number If p_validate is false, then set to the
181 * version number of the validation record for the knowledge integration
182 * record. If p_validate is true, then the value will be null.
183 * @rep:displayname Validate Knowledge Integration
184 * @rep:category BUSINESS_ENTITY HR_KI_MAP
185 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
186 * @rep:scope public
187 * @rep:lifecycle active
188 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
189 */
190 --
191 -- {End Of Comments}
192 --
193 procedure validate_integration
194 (p_validate in boolean default false
195 ,p_integration_id in number
196 ,p_object_version_number in out nocopy number
197 );
198 --
199 -- ----------------------------------------------------------------------------
200 -- |----------------------------< update_integration >------------------------|
201 -- ----------------------------------------------------------------------------
202 --
203 -- {Start Of Comments}
204 /*#
205 * This API updates a knowledge integration definition.
206 *
207 *
208 * <p><b>Licensing</b><br>
209 * This API is licensed for use with all products in the HRMS Product Family.
210 *
211 * <p><b>Prerequisites</b><br>
212 * A valid integration must exist.
213 *
214 * <p><b>Post Success</b><br>
215 * The integration definition will be successfully updated in the database.
216 *
217 * <p><b>Post Failure</b><br>
218 * The integration will not be updated and an error will be raised.
219 * @param p_validate If true, then validation alone will be performed and the
220 * database will remain unchanged. If false and all validation checks pass,
221 * then the database will be modified.
222 * @param p_language_code Specifies to which language the translation values
223 * apply. You can set to the base or any installed language. The default value
224 * of hr_api.userenv_lang is equivalent to the RDBMS userenv('LANG') function
225 * value.
226 * @param p_integration_id Internal unique identifier of the knowledge
227 * integration record.
228 * @param p_source_type Source type of the integration.
229 * @param p_target_type Target type of the integration.
230 * @param p_party_type Type of trading partner.
231 * @param p_party_name Name of the party.
232 * @param p_party_site_name Party site name.
233 * @param p_transaction_type Product short name for the base Oracle
234 * application.
235 * @param p_transaction_subtype Code for a particular transaction within the
236 * application specified by the p_transaction_type.
237 * @param p_standard_code XML standard to be used.
238 * @param p_ext_trans_type External identifier for the XML message.
239 * @param p_ext_trans_subtype Secondary external identifier for the XML
240 * message.
241 * @param p_trans_direction Indicates if the message is inbound or outbound.
242 * @param p_url URL for the simple URL type integration.
243 * @param p_partner_name Name of partner.
244 * @param p_service_name Name of services provided by the partner.
245 * @param p_application_name External application code.
246 * @param p_application_type External application type.
247 * @param p_application_url URL for the external application.
248 * @param p_logout_url URL to log out of the external application.
249 * @param p_user_field Name of user field.
250 * @param p_password_field Name of password field.
251 * @param p_authentication_needed Type of authentication used. Valid values are
252 * BASIC or POST.
253 * @param p_field_name1 Additional name and value pair field.
254 * @param p_field_value1 Additional name and value pair field.
255 * @param p_field_name2 Additional name and value pair field.
256 * @param p_field_value2 Additional name and value pair field.
257 * @param p_field_name3 Additional name and value pair field.
258 * @param p_field_value3 Additional name and value pair field.
259 * @param p_field_name4 Additional name and value pair field.
260 * @param p_field_value4 Additional name and value pair field.
261 * @param p_field_name5 Additional name and value pair field.
262 * @param p_field_value5 Additional name and value pair field.
263 * @param p_field_name6 Additional name and value pair field.
264 * @param p_field_value6 Additional name and value pair field.
265 * @param p_field_name7 Additional name and value pair field.
266 * @param p_field_value7 Additional name and value pair field.
267 * @param p_field_name8 Additional name and value pair field.
268 * @param p_field_value8 Additional name and value pair field.
269 * @param p_field_name9 Additional name and value pair field.
270 * @param p_field_value9 Additional name and value pair field.
271 * @param p_object_version_number Pass in the current version number of the
272 * knowledge integration to be updated. When the API completes if p_validate is
273 * false, will be set to the new version number of the updated backfeed payment
274 * detail. If p_validate is true will be set to the same value which was passed
275 * in.
276 * @rep:displayname Update Integration
277 * @rep:category BUSINESS_ENTITY HR_KI_MAP
278 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
279 * @rep:scope public
280 * @rep:lifecycle active
281 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
282 */
283 --
284 -- {End Of Comments}
285 --
286 procedure update_integration
287 (p_validate in boolean default false
288 ,p_language_code in varchar2 default hr_api.userenv_lang
289 ,p_integration_id in number
290 ,p_source_type in varchar2
291 ,p_target_type in varchar2
292 ,p_party_type in varchar2 default hr_api.g_varchar2
293 ,p_party_name in varchar2 default hr_api.g_varchar2
294 ,p_party_site_name in varchar2 default hr_api.g_varchar2
295 ,p_transaction_type in varchar2 default hr_api.g_varchar2
296 ,p_transaction_subtype in varchar2 default hr_api.g_varchar2
297 ,p_standard_code in varchar2 default hr_api.g_varchar2
298 ,p_ext_trans_type in varchar2 default hr_api.g_varchar2
299 ,p_ext_trans_subtype in varchar2 default hr_api.g_varchar2
300 ,p_trans_direction in varchar2 default hr_api.g_varchar2
301 ,p_url in varchar2 default hr_api.g_varchar2
302 ,p_partner_name in varchar2 default hr_api.g_varchar2
303 ,p_service_name in varchar2 default hr_api.g_varchar2
304 ,p_application_name in varchar2 default hr_api.g_varchar2
305 ,p_application_type in varchar2 default hr_api.g_varchar2
306 ,p_application_url in varchar2 default hr_api.g_varchar2
307 ,p_logout_url in varchar2 default hr_api.g_varchar2
308 ,p_user_field in varchar2 default hr_api.g_varchar2
309 ,p_password_field in varchar2 default hr_api.g_varchar2
310 ,p_authentication_needed in varchar2 default hr_api.g_varchar2
311 ,p_field_name1 in varchar2 default hr_api.g_varchar2
312 ,p_field_value1 in varchar2 default hr_api.g_varchar2
313 ,p_field_name2 in varchar2 default hr_api.g_varchar2
314 ,p_field_value2 in varchar2 default hr_api.g_varchar2
315 ,p_field_name3 in varchar2 default hr_api.g_varchar2
316 ,p_field_value3 in varchar2 default hr_api.g_varchar2
317 ,p_field_name4 in varchar2 default hr_api.g_varchar2
318 ,p_field_value4 in varchar2 default hr_api.g_varchar2
319 ,p_field_name5 in varchar2 default hr_api.g_varchar2
320 ,p_field_value5 in varchar2 default hr_api.g_varchar2
321 ,p_field_name6 in varchar2 default hr_api.g_varchar2
322 ,p_field_value6 in varchar2 default hr_api.g_varchar2
323 ,p_field_name7 in varchar2 default hr_api.g_varchar2
324 ,p_field_value7 in varchar2 default hr_api.g_varchar2
325 ,p_field_name8 in varchar2 default hr_api.g_varchar2
326 ,p_field_value8 in varchar2 default hr_api.g_varchar2
327 ,p_field_name9 in varchar2 default hr_api.g_varchar2
328 ,p_field_value9 in varchar2 default hr_api.g_varchar2
329 ,p_object_version_number in out nocopy number
330 );
331 --
332 -- ----------------------------------------------------------------------------
333 -- |----------------------------< delete_integration >------------------------|
334 -- ----------------------------------------------------------------------------
335 --
336 -- {Start Of Comments}
337 /*#
338 * This API deletes a knowledge integration definition.
339 *
340 *
341 * <p><b>Licensing</b><br>
342 * This API is licensed for use with all products in the HRMS Product Family.
343 *
344 * <p><b>Prerequisites</b><br>
345 * The integration must exist before it can be deleted.
346 *
347 * <p><b>Post Success</b><br>
348 * This API successfully deletes the integration and if applicable, also
349 * deletes the associated external application from Single Sign On server.
350 *
351 * <p><b>Post Failure</b><br>
352 * The knowledge integration definition will not be deleted and an error will
353 * be raised.
354 * @param p_validate If true, then validation alone will be performed and the
355 * database will remain unchanged. If false and all validation checks pass,
356 * then the database will be modified.
357 * @param p_sso_enabled Valid values are TRUE or FALSE. Should be set to TRUE
358 * for integrations using Single Sign On server.
359 * @param p_integration_id Internal unique identifier of the knowledge
360 * integration record
361 * @param p_object_version_number Current version number of the knowledge
362 * integration definition to be deleted.
363 * @rep:displayname Delete Integration
364 * @rep:category BUSINESS_ENTITY HR_KI_MAP
365 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
366 * @rep:scope public
367 * @rep:lifecycle active
368 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
369 */
370 --
371 -- {End Of Comments}
372 --
373 procedure delete_integration
374 (
375 P_VALIDATE in boolean default false
376 ,P_SSO_ENABLED in boolean default false
377 ,P_INTEGRATION_ID in number
378 ,P_OBJECT_VERSION_NUMBER in number
379 );
380 --
381 end HR_KI_INTEGRATIONS_API;
[Home] [Help]