Previous	Next		Contents	Index	Glossary

function GetAdvancedEnvelopeURL

    (x_agent in varchar2,

     x_item_type in varchar2,

     x_item_key in varchar2,

     x_admin_mode in varchar2 default 'NO',

     x_options in varchar2 default null)

     return varchar2;

Description

Can be called by an application to return a URL that displays the Workflow Monitor Activities List in standalone Oracle Workflow with an attached access key password, or to the Activity History page in the Status Monitor in Oracle Applications with guest access.

• In standalone Oracle Workflow, the URL displays the Activities List for a specific instance of a workflow process in the Workflow Monitor. The Activities List allows you to apply advanced filtering options in displaying the list of activities for a process instance.

The URL returned by the function WF_MONITOR.GetAdvancedEnvelopeURL( ) looks as follows if the x_options argument is null:

<webagent>/wf_monitor.envelope?x_item_type=<item_type>&x_item_key=<item_key>&x_admin_mode=<YES or NO>&x_access_key=<access_key>&x_advanced=TRUE

<webagent> represents the base URL of the web agent configured for Oracle Workflow in your Web server. See: Setting Global User Preferences, Oracle Workflow Administrator's Guide.

wf_monitor.envelope represents the name of the PL/SQL package procedure that generates the Workflow Monitor Notifications List for the process instance.

• In Oracle Applications, the URL displays the Activity History page for a specific instance of a workflow process in the administrator version of the Status Monitor, operating either with or without administrator privileges. All activity type and activity status filtering options are automatically selected by default.

x_agent	The base web agent string defined for Oracle Workflow or Oracle Self-Service Web Applications in your Web server. The base web agent string should be stored in the WF_RESOURCES table, and looks something like: http://<server.com:portID>/<PLSQL_agent_path>
	When calling this function, your application must first retrieve the web agent string from the WF_RESOURCES token WF_WEB_AGENT by calling WF_CORE.TRANSLATE( ). See: Setting Global User Preferences, Oracle Workflow Administrator's Guide or Applications Web Agent, Oracle Applications System Administrator's Guide.
x_item_type	A valid item type.
x_item_key	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 to report on.
x_admin_mode	A value of YES or NO. YES directs the function to retrieve the access key password that runs the monitor in 'ADMIN' mode in standalone Oracle Workflow, or to grant administrator privileges to the user accessing the Status Monitor in Oracle Applications. NO directs the function to retrieve the access key password that runs the monitor in 'USER' mode in standalone Oracle Workflow, or to withhold administrator privileges from the user accessing the Status Monitor in Oracle Applications.
x_options	In standalone Oracle Workflow only, specify 'All' if you wish to return a URL that displays the Activities List with all filtering options checked. If you leave this argument null, then a URL that displays the Activities List with no filtering options checked, is returned. This allows you to append any specific options if you wish. The default is null.

Note: The x_options parameter does not apply for the Status Monitor in Oracle Applications. When you access the Status Monitor with a URL from GetAdvancedEnvelopeURL(), all filtering options are always selected by default.

See Also