Document Management APIs

This chapter describes the APIs for Oracle Workflow document management. The APIs include PL/SQL functions and procedures to integrate with document management systems. Document management functionality is reserved for future use. This description of Oracle Workflow document management APIs is provided for reference only.

This chapter covers the following topics:

Document Management APIs

Document Management APIs

Important: Document management functionality is reserved for future use. This description of Oracle Workflow document management APIs is provided for reference only.

The following document management APIs can be called by user interface (UI) agents to return URLs or javascript functions that enable integrated access to supported document management systems. All supported document management (DM) systems accommodate a URL interface to access documents.

The document management APIs allow you to access documents across multiple instances of the same DM system, as well as across multiple instances of DM systems from different vendors within the same network.

The document management APIs are defined in a PL/SQL package called FND_DOCUMENT_MANAGEMENT.

Related Topics

Standard API for PL/SQL Procedures Called by Function Activities, Oracle Workflow Developer's Guide

get_launch_document_url

Important: Document management functionality is reserved for future use. This description of the get_launch_document_url API is provided for reference only.

Syntax

procedure get_launch_document_url 
  (username in varchar2,
   document_identifier in varchar2,
   display_icon in Boolean,
   launch_document_url out varchar2);

Description

Returns an anchor URL that launches a new browser window containing the DM integration screen that displays the specified document. The screen is a frame set of two frames. The upper frame contains a customizable company logo and a toolbar of Oracle Workflow-integrated document management functions. The lower frame displays the specified document.

Arguments (input)

Variable	Description
username	The username of the person accessing the document management system.
document_identifier	The document identifier for the document you wish to display. The document identifier should be stored as a value in an item attribute of type document. You can retrieve the document identifier using the GetItemAttrDocument API. See: GetItemAttrDocument and SetItemAttrDocument.
display_icon	True or False. True tells the procedure to return the URL with the paper clip attachment icon and translated prompt name, whereas False tells the procedure to return only the URL. This argument provides you the flexibility needed when you call this procedure from a form- or HTML-based UI agent.

get_launch_attach_url

Important: Document management functionality is reserved for future use. This description of the get_launch_attach_url API is provided for reference only.

Syntax

procedure get_launch_attach_url 
  (username in varchar2,
   callback_function in varchar2,
   display_icon in Boolean,
   launch_attach_url out varchar2);

Description

Returns an anchor URL that launches a new browser window containing a DM integration screen that allows you to attach a document. The screen is a frame set of two frames. The upper frame contains a customizable company logo and a toolbar of Oracle Workflow-integrated document management functions. The lower frame displays the search screen of the default document management system.

Arguments (input)

Variable	Description
username	The username of the person accessing the document management system.
callback_function	The URL you would like to invoke after the user selects a document to attach. This callback function should be the callback_url syntax that is returned from the set_document_id_html API.
display_icon	True or False. True tells the procedure to return the URL with the paper clip attachment icon and translated prompt name, whereas False tells the procedure to return only the URL. This argument provides you the flexibility needed when you call this procedure from a form- or HTML-based UI agent.

get_open_dm_display_window

Important: Document management functionality is reserved for future use. This description of the get_open_dm_display_window API is provided for reference only.

Syntax

procedure get_open_dm_display_window

Description

Returns a javascript function that displays an attached document from the current UI. The javascript function is used by all the document management functions that the user can perform on an attached document. Each DM function also gives the current DM integration screen a name so that the Document Transport Window can call back to the javascript function in the current window.

get_open_dm_attach_window

Important: Document management functionality is reserved for future use. This description of the get_open_dm_attach_window API is provided for reference only.

Syntax

procedure get_open_dm_attach_window

Description

Returns a javascript function to open a Document Transport Window when a user tries to attach a document in the current UI. The javascript function is used by all the document management functions that the user can perform to attach a document. Each DM function also gives the current DM integration screen a name so that the Document Transport Window can call back to the javascript function in the current window.

set_document_id_html

Important: Document management functionality is reserved for future use. This description of the set_document_id_html API is provided for reference only.

Syntax

procedure set_document_id_html 
  (frame_name in varchar2,
   form_name in varchar2,
   document_id_field_name in varchar2
   document_name_field_name in varchar2,
   callback_url out varchar2);

Description

Returns a callback URL that gets executed when a user selects a document from the DM system. Use this procedure to set the document that is selected from the document management Search function to the specified destination field of an HTML page. The destination field is the field from which the user launches the DM integration screen to attach a document. Pass the returned callback URL as an argument to the get_launch_attach_url API.

Arguments (input)

Variable	Description
frame_name	The name of the HTML frame that you wish to interact with in the current UI.
form_name	The name of the HTML form that you wish to interact with in the current UI.
document_id_field_name	The name of the HTML field in the current UI that you would like to write the resulting document identifier to. The resulting document identifier is determined by the document the user selects from the document management Search function. The document identifier is a concatenation of the following values: `DM:<node_id>:<document_id>:<version>` <nodeid> is the node ID assigned to the document management system node as defined in the Document Management Nodes Web page. <documentid> is the document ID of the document, as assigned by the document management system where the document resides. <version> is the version of the document. If a version is not specified, the latest version is assumed.
document_name_field_name	The name of the HTML field in the current UI that you would like to write the resulting document name to.