59.1 Constants and Data Types

Constants

The APEX_WORKFLOW package uses the following constants.

c_workflow_system_user  constant varchar2(8)  := 'system';

Workflow and Activity (Instance) States

c_state_active      constant t_workflow_state := 'ACTIVE';
c_state_terminated  constant t_workflow_state := 'TERMINATED';
c_state_completed   constant t_workflow_state := 'COMPLETED';
c_state_faulted     constant t_workflow_state := 'FAULTED';
c_state_suspended   constant t_workflow_state := 'SUSPENDED';
c_state_waiting     constant t_workflow_state := 'WAITING';

Workflow (Instance) Operations

c_workflow$_op_suspend      constant t_workflow_operation   := 'SUSPEND';
c_workflow$_op_resume       constant t_workflow_operation   := 'RESUME';
c_workflow$_op_retry        constant t_workflow_operation   := 'RETRY';
c_workflow$_op_update_var   constant t_workflow_operation   := 'UPDATE_VARIABLE';
c_workflow$_op_terminate    constant t_workflow_operation   := 'TERMINATE';

Workflow Substitution Strings

c_workflow_id                constant varchar2(30)     := 'APEX$WORKFLOW_ID';
c_workflow_activity_id       constant varchar2(30)     := 'APEX$WORKFLOW_ACTIVITY_ID';
c_workflow_initiator         constant varchar2(30)     := 'APEX$WORKFLOW_INITIATOR';
c_workflow_state             constant varchar2(30)     := 'APEX$WORKFLOW_STATE';
c_workflow_detail_pk         constant varchar2(30)     := 'APEX$WORKFLOW_DETAIL_PK';
c_workflow_created_on        constant varchar2(30)     := 'APEX$WORKFLOW_CREATED_ON';

Workflow Activity (Instance) Status

c_activity_status_success    constant t_activity_status := 'SUCCESS';
c_activity_status_failure    constant t_activity_status := 'FAILURE';

Workflow Parameters Default

c_empty_workflow_parameters  t_workflow_parameters;

Workflow Participant Types

c_workflow_owner             constant t_workflow_participant_type := 'OWNER';
c_workflow_admin             constant t_workflow_participant_type := 'ADMIN';

Workflow List Context Types

c_context_my_workflows           constant t_workflow_list_context := 'MY_WORKFLOWS';
c_context_admin_workflows        constant t_workflow_list_context := 'ADMIN_WORKFLOWS';
c_context_initiated_by_me        constant t_workflow_list_context := 'INITIATED_BY_ME';
c_context_single_workflow        constant t_workflow_list_context := 'SINGLE_WORKFLOW';

Data Types

The APEX_WORKFLOW package uses the following data types.

Global Data Types

subtype t_workflow_state            is varchar2(10);
subtype t_activity_status           is varchar2(15);
subtype t_workflow_participant_type is varchar2(15);
subtype t_workflow_list_context     is varchar2(15);
subtype t_workflow_operation        is varchar2(30);

Workflow Parameters (Value)

Value	Description
static_id	The static ID of the parameter. This ID must match the static ID of the corresponding parameter in the workflow definition.
value	The value of the parameter as a session state value.
string_value	(Deprecated) The value of the parameter as a string.
format_mask	(Optional) Format mask for the parameter.

type t_workflow_parameter    is record (
    static_id                varchar2(255),
    value                    apex_session_state.t_value,
    string_value             varchar2(32767), /* Deprecated */
    format_mask              varchar2(255));

Collection of Workflow Parameter Values

type t_workflow_parameters   is table of t_workflow_parameter index by pls_integer;

Collection of Workflow Participant Types

type t_workflow_participant_types is table of t_workflow_participant_type
    index by pls_integer;