Previous	Next		Contents	Index	Glossary

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

PL/SQL Syntax

function GetItemAttrDocument

    (itemtype in varchar2,

     itemkey in varchar2,

     aname in varchar2,

     ignore_notfound in boolean default FALSE) 

     return varchar2;

Description

Returns the document identifier for a DM document-type item attribute. The document identifier is a concatenated string of the following values:

DM:<nodeid>:<documentid>:<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.

You can specify TRUE for the ignore_notfound parameter to ignore the exception encountered if the specified item type attribute does not exist. In this case the function returns a null value but does not raise an exception. For example, you can use this parameter if a new item type attribute is added to an item type, and your code needs to handle both the earlier version and the upgraded version of the item type.

Arguments (input)

itemtype	A valid item type.
itemkey	A string generated from the application object's primary key. The string uniquely identifies the item within an item type. The item type and key together identify the process. See: CreateProcess.

Note: Pass #SYNCH as the itemkey to create a forced synchronous process. See: Synchronous, Asynchronous, and Forced Synchronous Processes.

aname	The internal name of the item type attribute.
ignore_notfound	Specify TRUE or FALSE to indicate whether to ignore the exception if the specified item type attribute does not exist. If you specify TRUE and the item type attribute you specify does not exist, the function returns a null value but does not raise an exception. Defaults to FALSE.