DBA Data[Home] [Help]

PACKAGE: APPS.FND_DOCUMENT_MANAGEMENT

Source


1 package FND_DOCUMENT_MANAGEMENT as
2 /* $Header: AFWFDMGS.pls 120.8 2006/08/18 15:09:38 blash ship $ */
3 
4 /*===========================================================================
5 
6   PL*SQL TABLE NAME:	fnd_dm_product_parms_type
7 
8   DESCRIPTION:		stores the list of parameters for a given function
9 
10 ============================================================================*/
11 
12 TYPE fnd_dm_product_parms_type IS RECORD
13 (
14    parameter_name        VARCHAR2(80),
15    parameter_syntax	 VARCHAR2(240)
16 );
17 
18  TYPE fnd_dm_product_parms_tbl_type IS TABLE OF
19     fnd_document_management.fnd_dm_product_parms_type
20  INDEX BY BINARY_INTEGER;
21 
22 /*===========================================================================
23 
24   PL*SQL TABLE NAME:	fnd_dm_product_parms_type
25 
26   DESCRIPTION:		stores the list of parameters for a given function
27 
28 ============================================================================*/
29 
30 TYPE fnd_document_attributes IS RECORD
31 (
32    document_identifier VARCHAR2(2000),
33    document_name       VARCHAR2(240),
34    document_type       VARCHAR2(80),
35    filename            VARCHAR2(80),
36    created_by          VARCHAR2(80),
37    last_updated_by     VARCHAR2(80),
38    last_update_date    VARCHAR2(40),
39    locked_by           VARCHAR2(80),
40    document_size       VARCHAR2(20),
41    document_status     VARCHAR2(20),
42    current_version     VARCHAR2(10),
43    latest_version      VARCHAR2(10)
44 );
45 
46 /*===========================================================================
47 Function	get_search_document_url
48 
49 Purpose		Bring up a search window to allow the user to find a
50                 document in their document management system. The function
51                 does not take a document system argument because you'll
52                 be first asked to choose which document  management
53                 system to search before given the actual search criteria.
54 
55                 The challenge here is to return the DM system id, the
56                 document id, and the document name for the document that
57                 you've selected during your search process. We'll likely
58                 need our DM software partners to add new arguments to their
59                 standard URL syntax to allow for extra url links/icons that
60                 refer to Oracle Application functions that will allow us to
61                 return the selected documents that you wish to attach to your
62                 application business objects. The extra arguments would be
63                 pushed into the standard HTML templates so you can execute
64                 these functions when you've selected the appropriate document.
65 
66 Parameters
67 
68 callback    -	The URL you would like to envoke after the
69 		user has selected the document.
70 
71 html_formatting - Tells the function whether you want just
72 		  the URL or the URL with the appropriate
73 		  icon and prompt name. If you only want
74 		  the URL then pass FALSE.  If you want
75 		  the URL with a HTML formatted icon
76                   and translated function name then pass TRUE.
77 
78 display_document_URL - The URL result to search for a specific
79                        document
80 
81 ============================================================================*/
82 PROCEDURE get_search_document_url
83 (username               IN  Varchar2,
84  callback_function 	IN  Varchar2,
85  html_formatting 	IN  Boolean,
86  search_document_URL 	OUT NOCOPY Varchar2);
87 
88 /*===========================================================================
89 Function	get_create_document_url
90 
91 Purpose		Create a new document in your Document Management System
92                 for a local file stored on your file system.
93 
94                 The challenge here is to return the DM system name and the
95                 document id/name for the document that you've just added to
96                 the DM system. If your in the attachments form and you've
97                 attached a file, you may wish to add that file to a DM
98                 system by clicking on the Create New link. Once you provide
99                 all the meta data for that document in the DM system we'll
100                 need to push the document information back to the creating
101                 application object. We'll likely need our DM software
102                 partners to add new arguments to their standard URL
103                 syntax to allow for extra url links/icons that refer to
104                 Oracle Application functions that will allow us to return
105                 the selected document id information once you've created
106                 your document. The extra arguments would be pushed into
107                 the standard HTML templates so you can execute these
108                 functions when you've selected the created the document.
109 
110 Parameters
111 
112 callback    -	The URL you would like to envoke after the
113 		user has created in the document.
114 
115 html_formatting - Tells the function whether you want just
116 		  the URL or the URL with the appropriate
117 		  icon and prompt name. If you only want
118 		  the URL then pass FALSE.  If you want
119 		  the URL with a HTML formatted icon
120                   and translated function name then pass TRUE.
121 
122 create_document_URL - The URL result to create the selected
123 		       document on the selected node
124 
125 ============================================================================*/
126 PROCEDURE get_create_document_url
127 (username               IN  Varchar2,
128  callback_function 	IN  Varchar2,
129  html_formatting 	IN  Boolean,
130  create_document_URL 	OUT NOCOPY Varchar2);
131 
132 /*===========================================================================
133 Function	get_browse_document_url
134 
135 Purpose		Browse through a folder hierarchy and choose the document
136 		you wish to attach then return that document to the calling
137 		application.
138 
139                 The challenge here is to return the DM system name and the
140                 document id/name for the document that you've selected in
141                 the DM system. If your in the attachments form and you've
142                 attached a file, you may wish to select a file using the
143 		browse feature. Once you select a  document in the DM
144                 system we'll need to push the document information
145                 back to the creating application object. We'll likely
146                 need our DM software
147                 partners to add new arguments to their standard URL
148                 syntax to allow for extra url links/icons that refer to
149                 Oracle Application functions that will allow us to return
150                 the selected document id information once you've created
151                 your document. The extra arguments would be pushed into
152                 the standard HTML templates so you can execute these
153                 functions when you've selected the created the document.
154 
155 ============================================================================*/
156 PROCEDURE get_browse_document_url
157 (username               IN  Varchar2,
158  callback_function 	IN  Varchar2,
159  html_formatting 	IN  Boolean,
160  browse_document_URL 	OUT NOCOPY Varchar2);
161 
162 /*===========================================================================
163 Function	get_display_document_url
164 
165 Purpose		Invoke the appropriate document viewer for the selected
166 		document. Most document management systems
167 		support a wide range of document formats for viewing.
168 		We will rely on the  document management system to
169                 display the document in it's native format whenever possible.
170 
171 Parameters
172 
173 document_identifier -	The dm document Identifier from which your going
174 			display the document.
175 
176 show_document_icon -	Should the function add an icon along with the
177                         document name to represent the document anchor
178 
179 html_formatting - Tells the function whether you want just
180 		  the URL or the URL with the appropriate
181 		  icon and prompt name. If you only want
182 		  the URL then pass FALSE.  If you want
183 		  the URL with a HTML formatted icon
184                   and translated function name then pass TRUE.
185 
186 display_document_URL - The URL result to display the selected
187 		       document from the selected node
188 
189 ============================================================================*/
190 PROCEDURE get_display_document_url
191 (username             IN  Varchar2,
192  document_identifier  IN  Varchar2,
193  show_document_icon   IN Boolean,
194  html_formatting      IN Boolean,
195  display_document_URL OUT NOCOPY Varchar2);
196 
197 /*===========================================================================
198 Function	get_original_document_url
199 
200 Purpose		Invoke the appropriate document viewer for the latest version
201                 of the selected document. The default operation of the DM
202                 system is to show the version that was attached to the item.
203                 We are providing another function here to show the most
204                 recent version of the document.
205                 Most document management systems
206 		support a wide range of document formats for viewing.
207 		We will rely on the  document management system to
208                 display the document in it's native format whenever possible.
209 
210 Parameters
211 
212 document_identifier -	The dm document Identifier from which your going
213 			display the document.
214 
215 show_document_icon -	Should the function add an icon along with the
216                         document name to represent the document anchor
217 
218 html_formatting - Tells the function whether you want just
219 		  the URL or the URL with the appropriate
220 		  icon and prompt name. If you only want
221 		  the URL then pass FALSE.  If you want
222 		  the URL with a HTML formatted icon
223                   and translated function name then pass TRUE.
224 
225 original_document_URL - The URL result to display the selected
226 		       document from the selected node
227 
228 ============================================================================*/
229 PROCEDURE get_original_document_url
230 (username             IN  Varchar2,
231  document_identifier  IN  Varchar2,
232  show_document_icon   IN Boolean,
233  html_formatting      IN Boolean,
234  original_document_URL OUT NOCOPY Varchar2);
235 
236 /*===========================================================================
237 Function	get_fetch_document_url
238 
239 Purpose		Fetch a copy of a document from a document management system
240                 and place it on the local system.
241 
242 Parameters
243 
244 document_identifier -	The dm document Identifier from which your going
245 			display the document.
246 
247 html_formatting - Tells the function whether you want just
248 		  the URL or the URL with the appropriate
249 		  icon and prompt name. If you only want
250 		  the URL then pass FALSE.  If you want
251 		  the URL with a HTML formatted icon
252                   and translated function name then pass TRUE.
253 
254 fetch_document_URL - The URL result to fetch the selected
255 		       document from the selected node
256 
257 ============================================================================*/
258 PROCEDURE get_fetch_document_url
259 (username               IN  Varchar2,
260  document_identifier    IN  Varchar2,
261  html_formatting 	IN  Boolean,
262  fetch_document_URL 	OUT NOCOPY Varchar2);
263 
264 /*===========================================================================
265 Function	get_check_out_document_url
266 
267 Purpose		Lock the document in the DM system so that no other user can
268                 check in a new revision of the document while you
269                 hold the lock. This function will also allow you to create
270                 a local copy of the document on your file system.
271 
272 Parameters
273 
274 document_identifier -	The dm document Identifier from which your going
275 			display the document.
276 
277 html_formatting - Tells the function whether you want just
278 		  the URL or the URL with the appropriate
279 		  icon and prompt name. If you only want
280 		  the URL then pass FALSE.  If you want
281 		  the URL with a HTML formatted icon
282                   and translated function name then pass TRUE.
283 
284 check_out_document_URL - The URL result to check out the selected
285 		       document from the selected node
286 
287 ============================================================================*/
288 PROCEDURE get_check_out_document_url
289 (username               IN  Varchar2,
290  document_identifier    IN  Varchar2,
291  html_formatting 	IN  Boolean,
292  check_out_document_URL OUT NOCOPY Varchar2);
293 
294 /*===========================================================================
295 Function	get_check_in_document_url
296 
297 Purpose		Copy a new version of a file from your local file system
298                 back into the document management system.  UnLock the
299                 document in the DM system so that other users can work
300                 on the document.
301 
302 Parameters
303 
304 document_identifier -	The dm document Identifier from which your going
305 			display the document.
306 
307 html_formatting - Tells the function whether you want just
308 		  the URL or the URL with the appropriate
309 		  icon and prompt name. If you only want
310 		  the URL then pass FALSE.  If you want
311 		  the URL with a HTML formatted icon
312                   and translated function name then pass TRUE.
313 
314 check_in_document_URL - The URL result to check in the selected
315 		       document from the selected node
316 
317 ============================================================================*/
318 PROCEDURE get_check_in_document_url
319 (username               IN Varchar2,
320 document_identifier     IN  Varchar2,
321 html_formatting 	IN  Boolean,
322 check_in_document_URL 	OUT NOCOPY Varchar2);
323 
324 
325 /*===========================================================================
326 Function	get_lock_document_url
327 
328 Purpose		Lock the document in the DM system so that no other
329                 user can check in a new revision of the document while
330                 you hold the lock.
331 
332 Parameters
333 
334 document_identifier -	The dm document Identifier from which your going
335 			display the document.
336 
337 html_formatting - Tells the function whether you want just
338 		  the URL or the URL with the appropriate
339 		  icon and prompt name. If you only want
340 		  the URL then pass FALSE.  If you want
341 		  the URL with a HTML formatted icon
342                   and translated function name then pass TRUE.
343 
344 lock_document_URL - The URL result to lock the selected
345 		       document from the selected node
346 
347 ============================================================================*/
348 PROCEDURE get_lock_document_url
349 (username               IN  Varchar2,
350  document_identifier    IN  Varchar2,
351  html_formatting 	IN  Boolean,
355 Function	get_unlock_document_url
352  lock_document_URL 	OUT NOCOPY Varchar2);
353 
354 /*===========================================================================
356 
357 Purpose		Unlock the document in the DM system without checking
358                 in a new version of the document so that other users
359                 can check in new revisions of the document.
360 
361 Parameters
362 
363 document_identifier -	The dm document Identifier from which your going
364 			display the document.
365 
366 html_formatting - Tells the function whether you want just
367 		  the URL or the URL with the appropriate
368 		  icon and prompt name. If you only want
369 		  the URL then pass FALSE.  If you want
370 		  the URL with a HTML formatted icon
371                   and translated function name then pass TRUE.
372 
373 unlock_document_URL - The URL result to unlock the selected
374 		       document from the selected node
375 
376 ============================================================================*/
377 PROCEDURE get_unlock_document_url
378 (username               IN  Varchar2,
379  document_identifier    IN  Varchar2,
380  html_formatting 	IN  Boolean,
381  unlock_document_URL 	OUT NOCOPY Varchar2);
382 
383 /*===========================================================================
384 Function	get_display_history_url
385 
386 Purpose		Display the file history for the document in the Document
387                 Management System. Display the document title, type, size,
388                 whether the document is locked and if so by who, who has
389                 edited the document and when, etc.
390 
391 Parameters
392 
393 document_identifier -	The dm document Identifier from which your going
394 			display the document.
395 
396 html_formatting - Tells the function whether you want just
397 		  the URL or the URL with the appropriate
398 		  icon and prompt name. If you only want
399 		  the URL then pass FALSE.  If you want
400 		  the URL with a HTML formatted icon
401                   and translated function name then pass TRUE.
402 
403 unlock_document_URL - The URL result to unlock the selected
404 		       document from the selected node
405 
406 ============================================================================*/
407 PROCEDURE get_display_history_url
408 (username               IN  Varchar2,
409  document_identifier    IN  Varchar2,
410  html_formatting 	IN  Boolean,
411  display_history_URL 	OUT NOCOPY Varchar2);
412 
413 /*===========================================================================
414 
415 Function	get_launch_document_url
416 
417 Purpose		Set up the anchor to launch a new window with a frameset
418                 with two frames.  The upper frame has all the controls.
419                 The lower frame displays the document.
420 
421 ============================================================================*/
422 PROCEDURE get_launch_document_url
423 (username               IN  Varchar2,
424  document_identifier  IN  Varchar2,
425  display_icon         IN  Boolean,
426  launch_document_URL OUT NOCOPY Varchar2);
427 
428 /*===========================================================================
429 
430 Function	create_display_document_url
431 
432 Purpose		Launches the toolbar in one frame for the document
433                 operations and then creates another frame to display
434                 the document.
435 
436 ============================================================================*/
437 PROCEDURE create_display_document_url
438 (username             IN  Varchar2,
439  document_identifier  IN  Varchar2);
440 
441 /*===========================================================================
442 
443 Function	get_open_dm_display_window
444 
445 Purpose		Get the javascript function to open a dm window based on
446                 a url and a window size.  This java script function will
447                 be used by all the DM display functions to open the
448                 appropriate DM window.  This function also gives the
449                 current window a name so that the dm window can call
450                 back to the javascript functions in the current window.
451 
452 Parameters
453 
454 ============================================================================*/
455 PROCEDURE get_open_dm_display_window;
456 
457 /*===========================================================================
458 
459 Function	get_open_dm_attach_window
460 
461 Purpose		Get the javascript function to open a dm window based on
462                 a url and a window size.  This java script function will
463                 be used by all the DM functions to open the appropriate DM
464                 window when attaching a new document to a business object.
465                 This function also gives the current window
466                 a name so that the dm window can call back to the javascript
467                 functions in the current window.
468 
469 Parameters
470 
471 ============================================================================*/
472 PROCEDURE get_open_dm_attach_window;
473 
474 /*===========================================================================
475 
476 Function	set_document_id_html
477 
478 Purpose		Get the javascript function to set the appropriate
482 Parameters
479                 destination field on your html form from the document
480                 management select function.
481 
483 
484 function_name - The name of the javascript function.  This naming allows
485 		you to have multiple document fields on the same page.
486 
487 frame_name  -	The name of the html frame for the current ui that you
488                 wish to interact with
489 
490 form_name  -	The name of the html form for the current ui that you
491                 wish to interact with
492 
493 document_id_field_name  -
494 		The name of the html field that you would like to write
495 		the resulting document identifier to:
496 	        Document identifier is the concatention of the following
497                 values:
498 
499                 nodeid:documentid:version:document_name
500 
501 document_name_field_name  -
502 		The name of the html field that you would like to write
503 		the resulting document name to.
504 
505 
506 ============================================================================*/
507 PROCEDURE set_document_id_html
508 (
509   frame_name  IN VARCHAR2,
510   form_name  IN VARCHAR2,
511   document_id_field_name IN VARCHAR2,
512   document_name_field_name IN VARCHAR2,
513   callback_url   OUT NOCOPY VARCHAR2
514 );
515 
516 --
517 -- PackDocInfo
518 --   Pack together the document components out of a document type
519 --   attribute.
520 --
521 --   dm_node_id -   Id for of the dm system where the document is
522 --                  maintained
523 --
524 --   document_id - Identifier for the document for the particular dm node
525 --
526 --   version - Version of Document that was selected
527 --
528 --   document_info - Concatenated string of characters that includes the
529 --                   nodeid, document id, version, and
530 --                   document name in the following format:
531 --
532 --                   nodeid:documentid:version
533 --
534 --
535 procedure PackDocInfo(dm_node_id    in number,
536                        document_id   in varchar2,
537 		       version       in varchar2,
538 		       document_info out NOCOPY varchar2);
539 
540 --
541 -- ParseDocInfo
542 --   Parse out the document components out of a document type
543 --   attribute.
544 --
545 --   document_info - Concatenated string of characters that includes the
546 --                   nodeid, document id, version, and
547 --                   document name in the following format:
548 --
549 --                   nodeid:documentid:version
550 --
551 --   dm_node_id -   Id for of the dm system where the document is
552 --                  maintained
553 --
554 --   document_id - Identifier for the document for the particular dm node
555 --
556 --   version - Version of Document that was selected
557 --
558 --
559 procedure ParseDocInfo(document_info in  varchar2,
560                        dm_node_id    out NOCOPY number,
561                        document_id   out NOCOPY varchar2,
562 		       version       out NOCOPY varchar2);
563 
564 /*===========================================================================
565 
566 Function	create_document_toolbar
567 
568 Purpose		create the toolbar for checking in/checking out etc.
569                 documents based on the document identifier
570 
571 ============================================================================*/
572 PROCEDURE  create_document_toolbar
573 (
574   username            IN Varchar2,
575   document_identifier IN Varchar2
576 );
577 
578 /*===========================================================================
579 
580 Function	get_launch_attach_url
581 
582 Purpose		Set up the anchor to launch a new window with a frameset
583                 with two frames.  The upper frame has all the controls.
584                 The lower frame displays the document.
585 
586 ============================================================================*/
587 PROCEDURE get_launch_attach_url
588 (username             IN  Varchar2,
589  callback_function    IN  Varchar2,
590  display_icon         IN  Boolean,
591  launch_attach_URL    OUT NOCOPY Varchar2);
592 
593 
594 /*===========================================================================
595 
596 Function	create_display_document_url
597 
598 Purpose		Launches the toolbar in one frame for the document
599                 operations and then creates another frame to display
600                 the document.
601 
602 ============================================================================*/
603 PROCEDURE create_attach_document_url
604 (username           IN     Varchar2,
605  callback_function  IN     Varchar2);
606 
607 
608 /*===========================================================================
609 
610 Function	create_document_toolbar
611 
612 Purpose		create the toolbar for checking in/checking out etc.
613                 documents based on the document identifier
614 
615 ============================================================================*/
616 PROCEDURE  create_attach_toolbar
617 (
618   username          IN  VARCHAR2,
619   callback_function IN  VARCHAR2
620 );
621 
625 
622 /*===========================================================================
623 
624 Function	get_dm_home
626 Purpose		fetch the document management home preference for a given
627                 user.  If there is no home defined for a user then go
628                 check the default.  If there is no default defined then
629                 get the first dm_node in the list.
630 
631 ============================================================================*/
632 procedure get_dm_home (
633 username     IN  VARCHAR2,
634 dm_node_id   OUT NOCOPY VARCHAR2,
635 dm_node_name OUT NOCOPY VARCHAR2);
636 
637 
638 /*===========================================================================
639 
640 Function	set_dm_home
641 
642 Purpose		set the document management home preference for a given
643                 user.
644 
645 ============================================================================*/
646 procedure set_dm_home (
647 username     IN  VARCHAR2,
648 dm_node_id   IN  VARCHAR2);
649 
650 /*===========================================================================
651 
652 Function	set_dm_home_html
653 
654 Purpose		set the document management home preference for a given
655                 user throught the html interface
656 
657 ============================================================================*/
658 procedure set_dm_home_html (
659 dm_node_id   IN  VARCHAR2,
660 username     IN  VARCHAR2,
661 callback     IN  VARCHAR2);
662 
663 /*===========================================================================
664 
665 Function	Dm_Nodes_Display
666 
667 Purpose		Display the various document management server nodes that the
668                 administrator has set up as their enterprise document network
669 
670 ============================================================================*/
671 procedure Dm_Nodes_Display;
672 
673 /*===========================================================================
674 
675 Function	Dm_Nodes_edit
676 
677 Purpose		Edit or add a new node to the enterprise document network
678 
679 ============================================================================*/
680 procedure Dm_Nodes_Edit (
681 p_node_id   IN VARCHAR2   DEFAULT NULL
682 );
683 
684 /*===========================================================================
685 
686 Function	Dm_Nodes_Update
687 
688 Purpose		Execute the update of the attributes for the document management
689                 node.
690 ============================================================================*/
691 procedure Dm_Nodes_Update (
692 p_node_id            IN VARCHAR2   DEFAULT NULL,
693 p_node_name          IN VARCHAR2   DEFAULT NULL,
694 p_node_description   IN VARCHAR2   DEFAULT NULL,
695 p_connect_syntax     IN VARCHAR2   DEFAULT NULL,
696 p_product_id         IN VARCHAR2   DEFAULT NULL,
697 p_product_name       IN VARCHAR2   DEFAULT NULL
698 );
699 
700 /*===========================================================================
701 
702 Function	Dm_Nodes_Confirm_Delete
703 
704 Purpose		Delete a currently defined document management node that
705 		has been set up by an administrator.  There is no check to
706 		see if any documents are referencing the document node that
707 		is about to be deleted.  Deleting a document node that has
708 		references will produce warnings when you try to view
709 		documents that use this reference.
710 ============================================================================*/
711 procedure Dm_Nodes_Confirm_Delete (
712 p_node_id   IN VARCHAR2   DEFAULT NULL
713 );
714 
715 /*===========================================================================
716 
717 Function	Dm_Nodes_Delete
718 
719 Purpose		Does the physical delete of a document node after the
720 		delete window has been confirmed by the user
721 ============================================================================*/
722 procedure Dm_Nodes_Delete (
723 p_node_id   IN VARCHAR2   DEFAULT NULL
724 );
725 
726 /*===========================================================================
727 
728 Function	choose home
729 
730 Purpose		Choose your home document management node.  You can only
731                 search or add to one document management system at a time.
732 		This function allows you change which document system you
733 		are currently pointing at.
734 ============================================================================*/
735 procedure choose_home (username IN VARCHAR2 DEFAULT NULL,
736                        callback IN VARCHAR2 DEFAULT NULL);
737 
738 procedure Product_LOV (p_titles_only   IN VARCHAR2 DEFAULT NULL,
739                        p_find_criteria IN VARCHAR2 DEFAULT NULL);
740 
741 
742 /*===========================================================================
743 
744 Function	get_document_attributes
745 
746 Purpose		gets the current document meta data
747 
748 ============================================================================*/
749 PROCEDURE get_document_attributes (
750 username               IN  Varchar2,
751 document_identifier    in  varchar2,
752 document_attributes    out NOCOPY fnd_document_management.fnd_document_attributes);
753 
754 /*===========================================================================
755 
759 		function is meant to fix the browser security issue of not
756 Function	set_document_form_fields
757 
758 Purpose		Copy the document id and name to fields on a form.  This
760 		being able to call javascript from one window page to another
761 		when those two pages are sourced by more than one server.
762 
763 ============================================================================*/
764 PROCEDURE set_document_form_fields (document_identifier    in  varchar2);
765 
766 /*===========================================================================
767 
768 Function	get_document_token_value
769 
770 Purpose		gets a token attribute from an attribute page based on
771                 the requested token that is passed in
772 
773 ============================================================================*/
774 PROCEDURE get_document_token_value (document_text         IN VARCHAR2,
775                                     requested_token       IN VARCHAR2,
776                                     token_value           OUT NOCOPY VARCHAR2);
777 
778 /*===========================================================================
779 
780 Function	show_transport_message
781 
782 Purpose		Displays a message in the transport window when a document
783                 has been selected and then closes itself and the document
784 		management window.
785 
786 ============================================================================*/
787 PROCEDURE show_transport_message;
788 
789 /*===========================================================================
790 
791 Function	get_ticket
792 
793 Purpose		Get the current value of the ticket.  If the ticket
794                 is not set then create a random number and insert it
795 
796 ============================================================================*/
797 FUNCTION get_ticket (username     IN VARCHAR2) RETURN VARCHAR2;
798 
799 /*===========================================================================
800 
801 Function	validate_ticket
802 
803 Purpose		Function for the DM system to validate the current value
804 		of the ticket for single signon.  We will create the initial
805 		value for the ticket.  We will then pass that ticket to the
806 		functions that the user can execute.  The DM vendor will
807 		then call us back through a database link or HTTP request
808 		to verify the value of the ticket.  If the ticket is valid
809                 then the DM vendor will create a new value for the ticket
810                 and pass it to us.  They will keep track of the value
811                 in that ticket so don't have to continually call this
812 		function to validate the ticket.  This function is
813 		only available through a sql*net database link since you
814 		cannot have OUT parameters for a HTTP request.
815 
816 valid_ticket is returned with a value:
817 
818  0 = invalid ticket
819  1 = valid ticket
820 
821 ============================================================================*/
822 PROCEDURE validate_ticket (username     IN VARCHAR2,
823                            ticket       IN VARCHAR2,
824                            valid_ticket OUT NOCOPY NUMBER);
825 
826 
827 /*===========================================================================
828 
829 Function	validate_ticket_http
830 
831 Purpose		Function for the DM system to validate the current value
832 		of the ticket for single signon.  We will create the initial
833 		value for the ticket.  We will then pass that ticket to the
834 		functions that the user can execute.  The DM vendor will
835 		then call us back through a database link or HTTP request
836 		to verify the value of the ticket.  If the ticket is valid
837                 then the DM vendor will create a new value for the ticket
838                 and pass it to us.  They will keep track of the value
839                 in that ticket so don't have to continually call this
840 		function to validate the ticket.  This function is
841 		only available through a sql*net database link since you
842 		cannot have OUT parameters for a HTTP request.
843 
844 valid_ticket is returned with a value:
845 
846  <VALIDTICKET>0</VALIDTICKET> = invalid ticket
847  <VALIDTICKET>1</VALIDTICKET> = valid ticket
848 
849 ============================================================================*/
850 PROCEDURE validate_ticket_HTTP (username    IN VARCHAR2,
851                                 ticket      IN VARCHAR2);
852 
853 /*===========================================================================
854 
855 Function	modulate_ticket
856 
857 Purpose		Function for the DM system to update the current value
858 		of the ticket for single signon.  The DM vendor will
859 		create a value of the ticket and pass it to us.  They will
860                 keep track of the value in that ticket so when we call them
861 		with the value they will know what that value is so they
862 		do not have to continually revalidate the ticket in
863 		our system.
864 
865                 If the ticket value is null then we will create a random
866 		number and plug it in.
867 
868 ============================================================================*/
869 PROCEDURE modulate_ticket (username    IN VARCHAR2,
870                            ticket      IN VARCHAR2);
871 
872 PROCEDURE test (stringy    IN VARCHAR2);
873 
874 PROCEDURE show_test_message (
875 
876 document_id  IN VARCHAR2,
877 display_type IN VARCHAR2,
878 document     IN OUT NOCOPY VARCHAR2,
879 document_type IN OUT NOCOPY VARCHAR2);
880 
881 end FND_DOCUMENT_MANAGEMENT;