CreateAdHocUser (Oracle Workflow API Reference)

Oracle Workflow API Reference
Release 2.6.3
Part Number B10286-02


	Previous	Next		Contents	Index	Glossary

CreateAdHocUser

Syntax

procedure CreateAdHocUser

(name in out varchar2,
      display_name in out varchar2,
      language in varchar2 default null,
      territory in varchar2 default null,
      description in varchar2 default null,
      notification_preference in varchar2 default
      'MAILHTML',
      email_address in varchar2 default null,
      fax in varchar2 default null,
      status in varchar2 default 'ACTIVE',
      expiration_date in date default sysdate);

Description

Creates a user at runtime by creating a value in the WF_LOCAL_ROLES table with the user flag set to Y. This is referred to as an ad hoc user.

Attention: If you implement Oracle Internet Directory integration for standalone Oracle Workflow, you must maintain your users only through OID. You must not use the CreateAdHocUser( ) API to create new users in the WF_LOCAL_ROLES table, because you risk discrepancies in your user information and unpredictable results if you use any tool other than OID to maintain users after integrating with OID.

Arguments (input)

name	An internal name for the user. The internal name must be no longer than 320 characters. It is recommended that the internal name be all uppercase. This procedure checks that the name provided does not already exist in WF_USERS and returns an error if the name already exists. If you do not provide an internal name, the system generates an internal name for you where the name contains a prefix of '~WF_ADHOC-' followed by a sequence number.
display_name	The display name of the user. This procedure checks that the display name provided does not already exist in WF_USERS and returns an error if the display name already exists. If you do not provide a display name, the system generates one for you where the display name contains a prefix of '~WF_ADHOC-' followed by a sequence number.
language	The value of the database NLS_LANGUAGE initialization parameter that specifies the default language-dependent behavior of the user's notification session. If null, the procedure resolves this to the language setting of your current session.
territory	The value of the database NLS_TERRITORY initialization parameter that specifies the default territory-dependent date and numeric formatting used in the user's notification session. If null, the procedure resolves this to the territory setting of your current session.
description	An optional description for the user.
notification_preference	Indicate how this user prefers to receive notifications: 'MAILTEXT', 'MAILHTML', 'MAILATTH', 'MAILHTM2', 'QUERY' or 'SUMMARY'. If null, the procedure sets the notification preference to 'MAILHTML'.
email_address	A optional electronic mail address for this user.
fax	An optional fax number for the user.
status	The availability of the user to participate in a workflow process. The possible statuses are 'ACTIVE', 'EXTLEAVE', 'INACTIVE', and 'TMPLEAVE'. If null, the procedure sets the status to 'ACTIVE'.
expiration_date	The date at which the user is no longer valid in the directory service. If null, the procedure defaults the expiration date to sysdate.

CreateAdHocUser

See Also