Universal Queue Classes Constructors

You must use the constructor for each class to instantiate an instance of that class. The following are the constructors for the universal queue Classes.

Syntax

Agent(AgentID)

Description

Use the Agent constructor to instantiate an Agent object.

All objects encapsulated by this object are created when the constructor is called.

Note: When an MCFFactory object is created, Agent objects are automatically created. In this case, the number of tasks in the list is limited by the MAX_TASKLIST_ITEMS parameter used when creating the MCFFactory object.

Parameters

Field or Control

Definition
AgentID

Specify a valid AgentID as a string.

Returns

An Agent object.

Example

Create Agent(&AgentID);

Syntax

AgentPhysQueueProps(AgentID, PhysicalQueueID)

Description

Use the AgentPhysQueueProps constructor to instantiate an agent physical queue properties object.

Parameters

Field or Control

Definition
AgentId

Specify as valid AgentId as a string.

PyhscialQueueId

Specify a PhyscialQueueId as a string.

Returns

An agent physical queue properties object.

Syntax

AgentPhysQueueTasks(AgentID, PhysicalQueueID)

Description

Use the AgentPhysQueueTasks constructor to instantiate an agent physical queue task object.

Parameters

Field or Control

Definition
AgentID

Specify an agent ID as a string.
PhysicalQueueID

Specify a PhysicalQueueID as a string.

Returns

An agent physical queue task object.

Syntax

Broadcast()

Description

Use the Broadcast constructor to instantiate a Broadcast object.

Parameters

None.

Returns

A Broadcast object.

Syntax

LogicalQueue(LogicalQueueID)

Description

Use the LogicalQueue constructor to instantiate a LogicalQueue object.

Parameters

Field or Control

Definition
LogicalQueueID

Specify the ID of a logical queue as a string.

Returns

A LogicalQueue object.

Example

Local LogicalQueue &MyLogQueue = Create LogicalQueue(&LogicalQueueID);

Syntax

MCFFactory([MAX_TASKLIST_ITEMS])

Description

Use the MCFFactory constructor to instantiate an MCFFactory object.

Parameters

Field or Control

Definition
MAX_TASKLIST_ITEMS

Specify the maximum number of tasks loaded on a TaskList.

Returns

An MCFFactory object.

Example

Local MCFFactory &myMCFFactory = Create MCFFactory(MAX_TASKLIST_ITEMS);

Syntax

PhysicalQueue(PhysicalQueueID)

Description

Use the PhysicalQueue constructor to instantiate a PhysicalQueue object. All objects encapsulated by this object are created when the constructor is called.

Note: When an MCFFactory object is created, the PhysicalQueue objects are automatically created. In this case, the number of tasks in the list is limited by the MAX_TASKLIST_ITEMS parameter used when creating the MCFFactory object.

Parameters

Field or Control

Definition
PhysicalQueueID

Specify a physical queue ID as a string.

Returns

A PhysicalQueue object.

Example

Local PhysicalQueue &myPhysicalQueue = Create PhysicalQueue(&PhysicalQueueID);

Syntax

Task(TaskNumber)

Description

Use the Task constructor to instantiate a task object.

Only persistent tasks (email and generic tasks) are available for introspection. Each persistent task goes through a lifecycle that is recorded by the following statuses:

State

Indicated Action

Status of Task Object

Enqueued by the universal queue server

Enqueued

ENQ

Universal queue assigns to physical queue

Assigned

ASGN

Agent accepts task

Accepted

ACPT

Agent completes task

Done

DONE

Task is not accepted within the overflow (action) time period

Overflowed

OVFL

Agent does not complete task or task not assigned within the escalation (complete) time period

Escalated

ESCL

Inderminate Task (task not found in system)

Indeterminate

IND

Parameters

Field or Control

Definition
TaskNumber

Specify a task number.

Returns

A task object if the task exists, or an error message if the task number is not in the expected format. If the task number is properly formatted, but the task is not found, the task object is returned with a task status of IND.

Example

Local string &tasknumber, &status;

Local Task &myTask = Create Task(&tasknumber);

&status = &myTask.Status;

Syntax

TaskList(Status, TaskType, PhysicalQueueID, AgentID)

Description

Use the TaskList constructor to instantiate a task list.

If the queue is not provided, a list of tasks for all physical queues for that TaskType and Status is returned. To get all tasks on all queues do not specify any of the optional parameters.

Parameters

Field or Control

Definition
Status

Specify a task status, as an uppercase string. If you do not specify a valid status, an empty tasklist is returned. Valid values are:

Value

Description

ACPT

Accepted

ASGN

Assigned

ENQ

Enqueued

ESCL

Escalated

OVFL

Overflowed

Field or Control

Definition
TaskType

Specify a task type as a lowercase string. Valid values are:

Value

Description

chat

Chat tasks.

email

Email tasks.

generic

Generic type tasks.

voice

Voice type tasks.

Field or Control

Definition
PhysicalQueueID

Specify a physical queue ID as a string.

AgentID

Specify an agent ID as a string.

Returns

A task list object.

Example

Local string &sStatus;

/* get all enqueued task on the UQ server*/

&sStatus = "ENQ";
Local TaskList &myTaskList = Create TaskList (&sStatus, "", "", "");

Syntax

Util()

Description

Use the Util constructor to instantiate a util object.

Parameters

None.

Returns

A Util object.

Example

Create Util();

Local &myUtil = create Util();