Edit D:\app\Administrator\product\11.2.0\dbhome

Edit D:\app\Administrator\product\11.2.0\dbhome_1\owb\wf\sql\AFWFDMGB.pls

REM dbdrv: sql ~PROD ~PATH ~FILE none none none package &phase=plb \
REM dbdrv: checkfile:~PROD:~PATH:~FILE
/*=======================================================================+
 |  Copyright (c) 1995 Oracle Corporation Redwood Shores, California, USA|
 |                            All rights reserved.                       |
 +=======================================================================+
 | FILENAME
 |   AFWFDMGB.pls
 | DESCRIPTION
 |   PL/SQL body for package:  FND_DOCUMENT_MANAGEMENT
 | MODIFICATION LOG:
 |   01/2002 JWSMITH BUG 2001012 - increase username,email,admin_role,
 |           l_username to varchar2(320), increase realname to 360 
 *=======================================================================*/

SET VERIFY OFF
WHENEVER SQLERROR EXIT FAILURE ROLLBACK;
WHENEVER OSERROR EXIT FAILURE ROLLBACK;

set escape '*'
set escape '\'
set array 1
set scan off

CREATE OR REPLACE PACKAGE BODY fnd_document_management AS
/* $Header: AFWFDMGB.pls 26.7 2002/11/11 03:04:22 rosthoma ship $ */

--
-- Error (PRIVATE)
--   Print a page with an error message.
--   Errors are retrieved from these sources in order:
--     1. wf_core errors
--     2. Oracle errors
--     3. Unspecified INTERNAL error
--
procedure Error
as
  error_name      varchar2(30);
  error_message   varchar2(2000);
  error_stack     varchar2(32000);
begin
    htp.htmlOpen;
    htp.headOpen;
    htp.title(wf_core.translate('ERROR'));
    htp.headClose;

begin
      wfa_sec.Header(background_only=>TRUE);
    exception
      when others then
        htp.bodyOpen;
    end;

htp.header(nsize=>1, cheader=>wf_core.translate('ERROR'));

wf_core.get_error(error_name, error_message, error_stack);

if (error_name is not null) then
        htp.p(error_message);
    else
        htp.p(sqlerrm);
    end if;

htp.hr;
 htp.p(wf_core.translate('WFENG_ERRNAME')||': '||error_name);
 htp.br;
 htp.p(wf_core.translate('WFENG_ERRSTACK')||': '||
 replace(error_stack,wf_core.newline,' '));

wfa_sec.Footer;
    htp.htmlClose;
end Error;

/*===========================================================================

Procedure	get_product_parameter_list

Purpose		Retrieves the parameters for a specific implementation for
		a function and product

============================================================================*/
PROCEDURE get_product_parameter_list 
(product_function_id IN  NUMBER,
 parameter_list      OUT fnd_document_management.fnd_dm_product_parms_tbl_type
)
IS

/*
** c_fetch_function_parameters fetches the parameters for a specific
** implementation of a function by a DM vendor
*/
CURSOR c_fetch_function_parameters
(c_product_function_id IN Number) IS
SELECT  dmparm.parameter_name,
        dmprod.parameter_syntax
FROM   fnd_dm_function_parameters dmparm,
       fnd_dm_product_parm_syntax dmprod 
WHERE  dmprod.product_function_id = c_product_function_id
AND    dmprod.parameter_id = dmparm.parameter_id
ORDER BY dmparm.parameter_name;

l_record_num   NUMBER := 0;

BEGIN

/*
   ** Fetch the parameters for the display function for the vendor
   ** that is installed on the selected node
   */
   OPEN  c_fetch_function_parameters(product_function_id);

/*
   ** Loop through all the parameters for the given function
   ** building the l_parameter_list variable
   */
   LOOP

l_record_num := l_record_num + 1;

FETCH c_fetch_function_parameters INTO 
         parameter_list(l_record_num);

EXIT WHEN c_fetch_function_parameters%NOTFOUND;

END LOOP;

EXCEPTION
   WHEN OTHERS THEN
      Wf_Core.Context('fnd_document_management', 
                      'get_product_parameter_list',
                      to_char(product_function_id));
      RAISE;

END get_product_parameter_list;

/*===========================================================================

Procedure	get_function_definition

Purpose		Retrieves the node and function definition for a give node
                function and vendor who is servicing that node.

============================================================================*/
PROCEDURE get_function_definition
(p_node_id              IN  NUMBER,
 p_function_name        IN  VARCHAR2,
 p_node_syntax          OUT VARCHAR2,
 p_product_id           OUT NUMBER,
 p_function_syntax      OUT VARCHAR2, 
 p_product_function_id  OUT NUMBER,
 p_icon_name            OUT VARCHAR2)

BEGIN

/*
    ** See if you can find the name in the document management reference system
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a display function for the vendor 
    ** that is servicing this particular node.
    */
    BEGIN

SELECT dmnode.connect_syntax,
               dmnode.product_id,
               dmprod.function_syntax, 
               dmprod.product_function_id, 
               dmfunc.icon_name
        INTO   p_node_syntax,
               p_product_id,
               p_function_syntax, 
               p_product_function_id,
               p_icon_name
        FROM   fnd_dm_product_function_syntax dmprod, 
               fnd_dm_functions dmfunc,
               fnd_dm_nodes dmnode
        WHERE  dmnode.node_id       = p_node_id
        AND    dmnode.product_id    = dmprod.product_id
        AND    dmfunc.function_name = p_function_name
        AND    dmprod.function_id = dmfunc.function_id;
     
    /*
    ** No data found is an exceptable response for this query.  It means that
    ** the fetch function is not supported by the particular dm vendor 
    ** software.  I can't imagine what vendor would not support a fetch
    ** function but who knows.  Set the  display_document_URL to null in 
    ** this case.
    */
    EXCEPTION 
       WHEN no_data_found THEN
          p_node_syntax := NULL;
          p_product_id := 0;
          p_function_syntax := NULL;
          p_product_function_id := 0;
          p_icon_name := NULL;
       WHEN OTHERS THEN
          Wf_Core.Context('fnd_document_management', 
                          'get_function_defintion',
                          to_char(p_node_id),
                          p_function_name);
          RAISE;

END;

EXCEPTION
   WHEN OTHERS THEN
      Wf_Core.Context('fnd_document_management', 
                      'get_function_defintion',
                      to_char(p_node_id),
                      p_function_name);
      RAISE;

END get_function_definition;

/*===========================================================================

Procedure	create_html_syntax

Purpose		Create the proper syntax for displaying the function
                and the associate icon with proper HTML syntax.

============================================================================*/
PROCEDURE create_html_syntax
(p_html_formatting      IN  BOOLEAN,
 p_function_name        IN  VARCHAR2,
 p_node_connect_syntax  IN  VARCHAR2, 
 p_function_syntax      IN  VARCHAR2, 
 p_parameter_syntax     IN  VARCHAR2, 
 p_resource_name        IN  VARCHAR2,
 p_icon_name            IN  VARCHAR2,
 p_document_html        OUT VARCHAR2)

BEGIN

/*
 ** Check if the caller wishes to construct html syntax that includes
 ** the appropriate icon and tranlated function name for this URL.
 */
 IF (p_html_formatting = TRUE AND p_function_syntax IS NOT NULL) THEN
 
 /*
 ** Populate the display_document_URL with the full HTML syntax to
 ** draw and icon and a function name for the display function.
 ** Also get the translated string for the function display name
 */
 if (p_function_name IN ('get_search_document_url', 
 'get_create_document_url',
		 	 'get_browse_document_url')) THEN
 p_document_html := 
 '<IMG SRC="'||wfa_html.image_loc||p_icon_name||'" alt="' || 
 p_resource_name || '">'||
 '<A HREF="javascript:fnd_open_dm_attach_window(' || '''' ||
 p_node_connect_syntax||p_function_syntax||p_parameter_syntax|| 
 '''' ||
 ', 700, 600)">'||
 p_resource_name ||
 ' </A>';

else

p_document_html := 
 '<IMG SRC="'||wfa_html.image_loc||p_icon_name||'" alt="' ||
 p_resource_name || '">'||
 '<A HREF="javascript:fnd_open_dm_display_window(' || '''' ||
 p_node_connect_syntax||p_function_syntax||p_parameter_syntax|| 
 '''' ||
 ', 700, 600)">'||
 p_resource_name ||
 ' </A>';
 end if;

ELSIF (p_function_syntax IS NOT NULL) THEN

/*
      ** Populate the display_document_URL with just the sting for the URL
      ** and leave the formatting up to the caller.
      */
      p_document_html := 
         p_node_connect_syntax||p_function_syntax||p_parameter_syntax;

ELSE

p_document_html := null;

END IF;
 
   EXCEPTION
   WHEN OTHERS THEN
      Wf_Core.Context('fnd_document_management', 
                      'create_html_syntax',
                      p_function_name,
                      p_node_connect_syntax,
                      p_function_syntax,
                      p_parameter_syntax,
                      p_resource_name);
      RAISE;

END create_html_syntax;

/*===========================================================================

Function	get_launch_document_url

Purpose		Set up the anchor to launch a new window with a frameset
                with two frames.  The upper frame has all the controls.
                The lower frame displays the document.

============================================================================*/
PROCEDURE get_launch_document_url 
(username             IN  Varchar2,
 document_identifier  IN  Varchar2,
 display_icon         IN  Boolean,
 launch_document_URL OUT Varchar2) IS

l_product_id            Number := 0;
l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_document_name         Varchar2(240) := NULL;
l_username              Varchar2(320);   -- Username to query /*Bug2001012*/
l_document_url          Varchar2(4000) := NULL;
l_document_attributes   fnd_document_management.fnd_document_attributes;

BEGIN

l_username := upper(username);
    
    /*
    ** get all the components of the document attribute
    */
    fnd_document_management.ParseDocInfo(document_identifier, 
                                         l_dm_node_id,
                                         l_document_id,
                                         l_version);

/*
    ** get the product that is installed for that dm node
    */
    SELECT MAX(PRODUCT_ID)
    INTO   l_product_id
    FROM   fnd_dm_nodes
    WHERE  node_id = l_dm_node_id;

/*
    ** get all the components of the document anchor
    */
    IF (display_icon = FALSE) THEN

/*
       ** If the product id = 1 then this is an Internet Documents install
       ** We do not display the multiframe window in this case with the 
       ** control bar on top.  Internet documents has their own toolbar and
       ** has their own mechanism for controlling the DM options.  
       */
       IF (l_product_id = 1) THEN

/* 
          ** Get the HTML text for displaying the document
          */
          fnd_document_management.get_display_document_url (
              l_username,
              document_identifier,
              FALSE,
              FALSE,
              l_document_url);

launch_document_URL := l_document_url;

ELSE

launch_document_URL := dm_base_url||
             '/fnd_document_management.create_display_document_url?'||
             'document_identifier='||
              wfa_html.conv_special_url_chars(document_identifier)||
             '&username='||l_username;

END IF;

ELSE

/*
       ** get the document name
       */
       fnd_document_management.get_document_attributes(l_username,
            document_identifier,
            l_document_attributes);

l_document_name := l_document_attributes.document_name;

launch_document_URL :=
 '<A HREF="javascript:fnd_open_dm_display_window(' || '''' ||
 l_document_url||
 '''' ||
 ', 700, 600)">'||
 l_document_name||
 ' </A>';

ELSE

launch_document_URL :=
 '<A HREF="javascript:fnd_open_dm_display_window(' || '''' ||
 dm_base_url||
 '/fnd_document_management.create_display_document_url?'||
 'document_identifier='||
 wfa_html.conv_special_url_chars(document_identifier)|| 
 '&username='||l_username||
 '''' ||
 ', 700, 600)">'||
 l_document_name||
 ' </A>';

END IF;

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_launch_document_url',
                       document_identifier); 
       RAISE;

END get_launch_document_url;

/*===========================================================================

Function	create_display_document_url

Purpose		Launches the toolbar in one frame for the document 
                operations and then creates another frame to display
                the document.

============================================================================*/
PROCEDURE create_display_document_url
(username             IN  Varchar2,
 document_identifier  IN  Varchar2) IS

l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_document_url          Varchar2(2000) := NULL;

BEGIN

/*
 ** Create the top header frameset and the bottom summary/detail frameset
 */
 htp.p ('<FRAMESET ROWS="15%,85%" BORDER=0 LONGDESC="'||
 owa_util.get_owa_service_path ||
 'wfa_html.LongDesc?p_token=WFDM_LONGDESC">');

/*
 ** Create the header frame
 */
 htp.p ('<FRAME NAME=CONTROLS '||
 'SRC='||
 dm_base_url||
 '/fnd_document_management.create_document_toolbar?'||
 'document_identifier='||
 wfa_html.conv_special_url_chars(document_identifier)||
 '&username='||username||
 ' MARGINHEIGHT=10 MARGINWIDTH=10 '||
 'SCROLLING="NO" NORESIZE FRAMEBORDER=YES LONGDESC="'||
 owa_util.get_owa_service_path ||
 'wfa_html.LongDesc?p_token=WFDM_LONGDESC">');

/* 
   ** Get the HTML text for displaying the document
   */
   fnd_document_management.get_display_document_url (
      username,
      document_identifier,
      FALSE,
      FALSE,
      l_document_url);

htp.p ('<FRAME NAME=DOCUMENT '||
 'SRC='||
 l_document_url ||
 ' MARGINHEIGHT=10 MARGINWIDTH=10 '||
 'NORESIZE SCROLLING="YES" FRAMEBORDER=NO LONGDESC="'||
 owa_util.get_owa_service_path ||
 'wfa_html.LongDesc?p_token=WFDM_LONGDESC">');

/*
 ** Close the summary/details frameset
 */
 htp.p ('</FRAMESET>');

EXCEPTION
   WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'create_display_document_url',
                       document_identifier); 
       RAISE;

END create_display_document_url;

/*===========================================================================
Function	get_search_document_url

Purpose		Bring up a search window to allow the user to find a 
                document in their document management system. The function 
                does not take a document system argument because you'll
                be first asked to choose which document  management 
                system to search before given the actual search criteria. 
                
                The challenge here is to return the DM system id, the 
                document id, and the document name for the document that
                you've selected during your search process. We'll likely 
                need our DM software partners to add new arguments to their 
                standard URL syntax to allow for extra url links/icons that 
                refer to Oracle Application functions that will allow us to 
                return the selected documents that you wish to attach to your
                application business objects. The extra arguments would be 
                pushed into the standard HTML templates so you can execute 
                these functions when you've selected the appropriate document.

============================================================================*/
PROCEDURE get_search_document_url 
(username               IN  Varchar2,
 callback_function 	IN  Varchar2, 
 html_formatting 	IN  Boolean, 
 search_document_URL 	OUT Varchar2) IS

l_product_id            Number  := 0;
l_product_function_id   Number  := 0;
l_record_num            Number  := 0;
l_node_connect_syntax   Varchar2(240)  := '';
l_parameter_str         Varchar2(4000) := '';
l_function_syntax       Varchar2(4000)  := '';
l_icon_name             Varchar2(40)   := '';
l_parameter_list        fnd_document_management.fnd_dm_product_parms_tbl_type;
l_username              Varchar2(320);   -- Username to query
l_dm_node_id            Number;         -- Document Management Home preference
l_dm_node_name          Varchar2(240);

BEGIN

l_username := upper(username);

-- get the document management home node information
    fnd_document_management.get_dm_home (l_username, l_dm_node_id, l_dm_node_name); 
 
    /*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a search function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_search_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the search function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name = 'CALLBACK') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 callback_function;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting, 
                        'get_search_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        'WFDM_SEARCH',
                        l_icon_name,
                        search_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_search_document_url'); 
       RAISE;

END get_search_document_url;

/*===========================================================================
Function	get_create_document_url

Purpose		Create a new document in your Document Management System 
                for a local file stored on your file system.

The challenge here is to return the DM system name and the 
                document id/name for the document that you've just added to 
                the DM system. If your in the attachments form and you've 
                attached a file, you may wish to add that file to a DM 
                system by clicking on the Create New link. Once you provide 
                all the meta data for that document in the DM system we'll 
                need to push the document information back to the creating 
                application object. We'll likely need our DM software 
                partners to add new arguments to their standard URL 
                syntax to allow for extra url links/icons that refer to 
                Oracle Application functions that will allow us to return 
                the selected document id information once you've created 
                your document. The extra arguments would be pushed into 
                the standard HTML templates so you can execute these 
                functions when you've selected the created the document.

============================================================================*/
PROCEDURE get_create_document_url 
(username               IN  Varchar2,
 callback_function 	IN  Varchar2, 
 html_formatting 	IN  Boolean, 
 create_document_URL 	OUT Varchar2) IS

BEGIN

/*
    ** The forms attachments interface calls this same function to 
    ** get the proper url to attach a document to a business object.
    ** Since the forms launch process is not within a browser the 
    ** owa_util variables will not be available when this string 
    ** gets created.  We check here whether your calling this from
    ** a web interface or a forms interface.
    */
    IF (html_formatting = TRUE) THEN
 
       l_browser := owa_util.get_cgi_env('HTTP_USER_AGENT');

ELSE
  
       l_browser := 'NETSCAPE';

END IF;

l_username := upper(username);

-- get the document management home node information
    fnd_document_management.get_dm_home (l_username, l_dm_node_id, l_dm_node_name);

/*
    ** This is a total hack but it must be done for now for simplicity of
    ** the interface.  Netscape has another layer of objects that must
    ** be referenced when calling it through javascript.  Thus if you 
    ** are not using IE then add another opener.parent to the hierarchy.
    ** We have two different calls because it depends if you are calling
    ** this from the multiframe response window or from a single frame window.
    */
    IF (instr(owa_util.get_cgi_env('HTTP_USER_AGENT'), 'MSIE') = 0) THEN

l_callback_function := REPLACE(callback_function, 
                                       'opener.parent.bottom.document',
                                       'opener.parent.opener.parent.bottom.document');

l_callback_function := REPLACE(l_callback_function, 
                                     'top.opener.parent.document',
                                      'top.parent.opener.parent.opener.document');
 
     ELSE

l_callback_function := callback_function;

END IF;

/*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a create function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_create_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the create function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      /*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name = 'CALLBACK') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_callback_function;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting, 
                        'get_create_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        'WFDM_CREATE',
                        l_icon_name,
                        create_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_create_document_url',
                       callback_function); 
       RAISE;

END get_create_document_url;

/*===========================================================================
Function	get_browse_document_url

Purpose		Browse through a folder hierarchy and choose the document
		you wish to attach then return that document to the calling
		application.

The challenge here is to return the DM system name and the 
                document id/name for the document that you've selected in 
                the DM system. If your in the attachments form and you've 
                attached a file, you may wish to select a file using the 
		browse feature. Once you select a  document in the DM 
                system we'll need to push the document information 
                back to the creating application object. We'll likely 
                need our DM software 
                partners to add new arguments to their standard URL 
                syntax to allow for extra url links/icons that refer to 
                Oracle Application functions that will allow us to return 
                the selected document id information once you've created 
                your document. The extra arguments would be pushed into 
                the standard HTML templates so you can execute these 
                functions when you've selected the created the document.

============================================================================*/
PROCEDURE get_browse_document_url 
(username               IN  Varchar2,
 callback_function 	IN  Varchar2, 
 html_formatting 	IN  Boolean, 
 browse_document_URL 	OUT Varchar2) IS

BEGIN

l_username := upper(username);

-- get the document management home node information
    fnd_document_management.get_dm_home (l_username, l_dm_node_id, l_dm_node_name);

/*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a create function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_browse_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the create function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name = 'CALLBACK') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 callback_function;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting, 
                        'get_browse_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        'WFDM_BROWSE',
                        l_icon_name,
                        browse_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_browse_document_url',
                       callback_function); 
       RAISE;

END get_browse_document_url;

/*===========================================================================

Function	get_display_document_url

Purpose		Invoke the appropriate document viewer for the selected 
		document. This function will show the latest document version
                for the item selected. Most document management systems
		support a wide range of document formats for viewing. 
		We will rely on the  document management system to
                display the document in it's native format whenever possible.

============================================================================*/
PROCEDURE get_display_document_url 
(username             IN  Varchar2,
 document_identifier  IN  Varchar2,
 show_document_icon   IN  Boolean,
 html_formatting      IN  Boolean, 
 display_document_URL OUT Varchar2) IS

l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_document_name         Varchar2(240) := NULL;
l_product_id            Number  := 0;
l_product_function_id   Number  := 0;
l_record_num            Number  := 0;
l_node_connect_syntax   Varchar2(240)  := NULL;
l_parameter_str         Varchar2(4000) := NULL;
l_function_syntax       Varchar2(4000)  := NULL;
l_icon_name             Varchar2(40)   := NULL;
l_parameter_list        fnd_document_management.fnd_dm_product_parms_tbl_type;
l_document_attributes   fnd_document_management.fnd_document_attributes;
l_username              VARCHAR2(320) := NULL;

BEGIN

l_username := upper(username);

/*
    ** get all the components of the document attribute
    */
    fnd_document_management.ParseDocInfo(document_identifier, 
                                         l_dm_node_id,
                                         l_document_id,
                                         l_version);

/*
    ** If you're calling this with full html formatting to include the
    ** document title in the link then go get the document title from
    ** the dm system.  This is a very expensive operation and is not 
    ** recommended
    */
    IF (html_formatting = TRUE) THEN

/*
       ** get the document name
       */
       fnd_document_management.get_document_attributes(l_username,
          document_identifier,
          l_document_attributes);

l_document_name := l_document_attributes.document_name;

ELSE

l_document_name := NULL;

END IF;

/*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a display function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_display_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the search function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name =  'DOCUMENT_ID') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_document_id;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(l_username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting,
                        'get_display_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        l_document_name,
                        l_icon_name,
                        display_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_display_document_url',
                       document_identifier); 
       RAISE;

END get_display_document_url;

/*===========================================================================

Function	get_original_document_url

Purpose		Invoke the appropriate document viewer for the original version
                of the selected document. The default operation of the DM 
                system is to show the latest version of the document that 
                was attached to the item.
                We are providing another function here to show the original
                version of the document. 
                Most document management systems
		support a wide range of document formats for viewing. 
		We will rely on the  document management system to
                display the document in it's native format whenever possible.

============================================================================*/
PROCEDURE get_original_document_url 
(username             IN  Varchar2,
 document_identifier  IN  Varchar2,
 show_document_icon   IN  Boolean,
 html_formatting      IN  Boolean, 
 original_document_URL OUT Varchar2) IS

BEGIN

l_username := upper(username);

/*
       ** get the document name
       */
       fnd_document_management.get_document_attributes(l_username,
          document_identifier,
          l_document_attributes);

l_document_name := l_document_attributes.document_name;

ELSE

l_document_name := NULL;

END IF;

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the search function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

/*
         ** The only difference in the syntax from the 
         ** get_display_document_url  is to drop the version parameter
         */

IF (l_parameter_list(l_record_num).parameter_name =  'DOCUMENT_ID') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_document_id;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'VERSION') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_version;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(l_username);

END IF;

END LOOP;

END IF;

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_original_document_url',
                       document_identifier); 
       RAISE;

END get_original_document_url;

/*===========================================================================

Function	get_fetch_document_url

Purpose		Fetch a copy of a document from a document management system 
                and place it on the local system.  Always fetch the latest 
                version of the document

============================================================================*/
PROCEDURE get_fetch_document_url 
(username               IN  Varchar2,
 document_identifier    IN  Varchar2, 
 html_formatting        IN  Boolean, 
 fetch_document_URL     OUT Varchar2) IS

l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_product_id            Number  := 0;
l_product_function_id   Number  := 0;
l_record_num            Number  := 0;
l_node_connect_syntax   Varchar2(240)  := '';
l_parameter_str         Varchar2(4000) := '';
l_function_syntax       Varchar2(4000)  := '';
l_icon_name             Varchar2(40)   := '';
l_parameter_list        fnd_document_management.fnd_dm_product_parms_tbl_type;
l_username              Varchar2(320) := NULL;

BEGIN

l_username := upper(username);

/*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a fetch function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_fetch_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the search function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name =  'DOCUMENT_ID') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_document_id;
/*  Always fetch the latest version rather than the original version
         ELSIF (l_parameter_list(l_record_num).parameter_name = 'VERSION') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_version;
*/
         ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(l_username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting, 
                        'get_fetch_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        'WFDM_FETCH',
                        l_icon_name,
                        fetch_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_fetch_document_url',
                       document_identifier); 
       RAISE;

END  get_fetch_document_url;

/*===========================================================================

Function	get_check_out_document_url

Purpose		Lock the document in the DM system so that no other user can 
                check in a new revision of the document while you
                hold the lock. This function will also allow you to create 
                a local copy of the document on your file system.

============================================================================*/
PROCEDURE get_check_out_document_url 
(username               IN  Varchar2,
 document_identifier    IN  Varchar2,
 html_formatting        IN  Boolean, 
 check_out_document_URL OUT Varchar2) IS

l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_product_id            Number  := 0;
l_product_function_id   Number  := 0;
l_record_num            Number  := 0;
l_node_connect_syntax   Varchar2(240)  := '';
l_display_document_url  Varchar2(2000) := '';
l_function_syntax       Varchar2(4000)  := '';
l_parameter_str         Varchar2(4000) := '';
l_icon_name             Varchar2(40)   := '';
l_parameter_list        fnd_document_management.fnd_dm_product_parms_tbl_type;
l_username              Varchar2(320):= NULL;

BEGIN

l_username := upper(username);

/*
    ** get all the components of the document attribute
    */
    fnd_document_management.ParseDocInfo(document_identifier, 
                                         l_dm_node_id,
                                         l_document_id,
                                         l_version);
 
    /*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a check out function for the 
    ** vendor that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_check_out_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);

/*
    ** Go get the parameters for this function for the specific 
    ** vendor software that is servicing this particular node
    */
    IF (l_function_syntax IS NOT NULL) THEN

/* 
      ** Get the parameters for the search function
      */
      get_product_parameter_list (l_product_function_id,
 				  l_parameter_list);

/*
      ** Loop through the parameter list filling in the corresponding
      ** values
      */
      FOR l_record_num IN 1..l_parameter_list.count LOOP

/*
         ** Determine which argument separator to add
         */

IF (INSTR(l_parameter_str, '?') > 0 OR 
              INSTR(l_function_syntax, '?') > 0) THEN

l_parameter_str := l_parameter_str || '&';

ELSE

l_parameter_str := l_parameter_str || '?';

END IF;

IF (l_parameter_list(l_record_num).parameter_name =  'DOCUMENT_ID') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_document_id;

ELSIF (l_parameter_list(l_record_num).parameter_name =  'CALLBACK') THEN

fnd_document_management.get_display_document_url (
                 l_username,
                 document_identifier,
                 FALSE,
                 FALSE,
                 l_display_document_url);

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 wfa_html.conv_special_url_chars(l_display_document_url);

ELSIF (l_parameter_list(l_record_num).parameter_name = 'USERNAME') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 l_username;

ELSIF (l_parameter_list(l_record_num).parameter_name = 'TICKET') THEN

l_parameter_str := l_parameter_str ||
                 l_parameter_list(l_record_num).parameter_syntax ||
                 fnd_document_management.get_ticket(l_username);

END IF;

END LOOP;

END IF;

/*
    ** Create the proper html syntax for the document function
    */
    create_html_syntax (html_formatting, 
                        'get_check_out_document_url',
                        l_node_connect_syntax,
                        l_function_syntax,
                        l_parameter_str,
                        'WFDM_CHECK_OUT',
                        l_icon_name,
                        check_out_document_url);

EXCEPTION
    WHEN OTHERS THEN
       Wf_Core.Context('fnd_document_management', 
                       'get_check_out_document_url',
                       document_identifier); 
       RAISE;

END  get_check_out_document_url;

/*===========================================================================

Function	get_check_in_document_url

Purpose		Copy a new version of a file from your local file system
                back into the document management system.  UnLock the 
                document in the DM system so that other users can work 
                on the document.

============================================================================*/
PROCEDURE get_check_in_document_url 
(username               IN  Varchar2,
 document_identifier    IN Varchar2,
 html_formatting        IN Boolean, 
 check_in_document_URL  OUT Varchar2) IS

l_dm_node_id            Number := 0;
l_document_id           Varchar2(30) := NULL; 
l_version               Varchar2(10) := NULL;
l_product_id            Number  := 0;
l_product_function_id   Number  := 0;
l_record_num            Number  := 0;
l_node_connect_syntax   Varchar2(240)  := '';
l_display_document_url  Varchar2(2000) := '';
l_function_syntax       Varchar2(4000)  := '';
l_parameter_str         Varchar2(4000) := '';
l_icon_name             Varchar2(40)   := '';
l_parameter_list        fnd_document_management.fnd_dm_product_parms_tbl_type;
l_username              Varchar2(320)  := NULL;

BEGIN

l_username := upper(username);

/*
    ** get all the components of the document attribute
    */
    fnd_document_management.ParseDocInfo(document_identifier, 
                                         l_dm_node_id,
                                         l_document_id,
                                         l_version);
    /*
    ** Get the URL prefix for the route to the DM host and the product id
    ** Also get the appropriate syntax for a check in function for the vendor 
    ** that is servicing this particular node.
    */
    get_function_definition (l_dm_node_id,
                             'get_check_in_document_url',
                             l_node_connect_syntax,
                             l_product_id,
                             l_function_syntax,
                             l_product_function_id,
                             l_icon_name);