Section II – Functional Modules > Interaction Interface > Object Model         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Addressing Resources            Functions >

Object Model

The following are the ECMAScript objects for the common interaction model interface.

Notes:

_genesys.FMname Object

Each SCXML session will have an association with the Interaction functional module (if an interaction is involved with the session). This object allows the session to access the set of interaction-related objects and properties that are associated with the given SCXML session.

The name of the object will be "_genesys.FMname". This object is accessible through the _genesys.FMname property.

Name

Access

Type

Default Value

Valid Values

Description

interactions

read only

array of interaction objects

none

 

This is the list of interactions currently associated with the logic. Each interaction will be represented by an ECMAScript object owned by the Interaction functional module. For routing strategy–based logic only the first entry in the list (interactions[0]) will be used. This list is maintained by the orchestration platform based on the interaction between the orchestration logic and the interaction-related functional modules. So when an interaction is associated with the orchestration logic through an event or action, it is added to the list and when the interaction ends it is removed from the list. This property (list only) is read only. See section interaction Object for details on the interaction object.

interaction Object

Each interaction associated with a given SCXML session will have an object to represent the common properties of an interaction. This object and its properties are maintained by the functional module, but certain properties can be set or updated by the orchestration logic itself.

The name of the object will be "interaction". This object is accessible through the _genesys.FMname.interactions[] property.

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

g_uid

read only

string

none

 

This is the globally unique ID for the interaction that is defined by the underlying media system.

  • T-Server — g_uid
  • Interaction Server — attr_itx_id

category

read only

string

none

voice, msgbased, chat, web

This is the media category associated with the interaction. It defines the type of media extension that is associated with the interaction.

tenantid

read only

string

none

 

This is the ID of the tenant that this interaction was originated from.

parentid

read only

string

none

 

This is the globally unique ID of this interaction's parent interaction.

contactedaddr

read only

string

none

Any valid string that represents the address

This is the address of the resource that was initially contacted and started this interaction.

This property will also be represented in a media- or channel-specific property.

For example:

  • _genesys.FMname.interactions[x].voice.dnis for voice interactions
  • _genesys.FMname.interactions[x].msgbased.toaddr for msgbased interactions

parties

read only

array of party objects

none

 

This is the list of parties or resources currently associated with the interaction. Each party will be represented by an ECMAScript object owned by the Interaction functional module.

udata

read only

object

none

Any valid ECMAScript object

This is application data that can be associated with and attached to the interaction so that the coordination of processing between resources is seamless. An application will manage this data through this property and the defined set of functions. For example,

  • Get udata kvpair value — xvalue = _genesys.FMname.interactions[x].udata.x
  • Set or add udata kvpair — _genesys.FMname.setuData(a);
  • Remove udata kvpair — _genesys.FMname.deleteuData("y");

As a result of these actions, the appropriate action will be taken on the underlying Interaction functional module system (for example, T-Server and user data).

The udata property does not support ECMAScript arrays either as a value of the udata property or as a property of any object in the tree.

This will be used not only for user data, but also for URS-based business data and interaction data.

categories

read only

array of category objects

none

none

These are the current set of classification category objects assigned to this interaction.

voice

read only

voice object

   

This is the object that contains the voice extensions to the interaction.

msgbased

read only

msgbased object

   

This is the object that contains the msgbased extensions to the interaction.

chat

read only

chat object

   

This is the object that contains the chat extensions to the interaction.

xdata

read only

object

none Any valid ECMAScript object

This is extension data that has been associated with the interaction as a result of the event that started this session and is read only. An application may access extension data through this property. For example,
Get xdata kvpair value — x value = _genesys.FMname.interactions[x].xdata.x

party Object

Each party or business resource involved in the associated interaction will be represented by an object and a common set of properties. These objects and their properties are maintained by the functional module, but certain properties can be set or updated by the orchestration logic itself.

The name of the object will be "party". This object is accessible through the interaction object.

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

g_uid

read only

string

none

 

This is the globally unique ID for the party that is defined by the underlying media system.

interactionid

read only

string

none

 

This is the globally unique ID of the interaction this party belongs to.

resourcetype

read only

_genesys.FMname.resourceType

_genesys.FMname.resourceType.CFGNoDN

 

This is the type of resource associated with this interaction.

resource

read only

string

null

 

This is the resource associated with this interaction.

voicep

read only

voicep object

   

This is the object that contains the voice extensions to the party.

msgbasedp

read only

msgbasedp object

   

This is the object that contains the msgbased extensions to the party.

chatp

read only

chatp object

   

This is the object that contains the chat extensions to the party.

_genesys.ixn.mediaType ENUM Object

This represents the media type enumeration. This enumeration is maintained by the orchestration platform.

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

TMediaVoice

read only

integer

none

0

The media for the interaction is voice.

TMediaVoIP

read only

integer

none

1

The media for the interaction is VoIP.

TMediaEMail

read only

integer

none

2

The media for the interaction is e-mail.

TMediaVMail

read only

integer

none

3

The media for the interaction is voice mail.

TMediaSMail

read only

integer

none

4

The media for the interaction is snail mail.

TMediaChat

read only

integer

none

5

The media for the interaction is chat.

TMediaVideo

read only

integer

none

6

The media for the interaction is video.

TMediaCobrowsing

read only

integer

none

7

The media for the interaction is co -browse.

TMediaWhiteboard

read only

integer

none

8

The media for the interaction is whiteboard.

TMediaAppSharing

read only

integer

none

9

The media for the interaction is application sharing.

TMediaWebform

read only

integer

none

10

The media for the interaction is web form.

TMediaWorkItem

read only

integer

none

11

The media for the interaction is work item.

TMediaCallback

read only

integer

none

12

The media for the interaction is callback.

TMediaFax

read only

integer

none

13

The media for the interaction is fax.

TMediaIMChat

read only

integer

none

14

The media for the interaction is IM.

TMediaBusinessEvent

read only

integer

none

15

The media for the interaction is business event.

TMediaAlert

read only

integer

none

16

The media for the interaction is alert.

TMediaSMS

read only

integer

none

17

The media for the interaction is SMS.

TMediaOutboundPreview

read only

integer

none

18

The media for the interaction is outbound preview.

TMediaOpenMedia

read only

integer

none

19

The media for the interaction is open media item.

TMediaNativeSMS

read only

integer

none

20

The media for the interaction is native SMS.

Variables

There are none at this time.

Object Ownership

The object management and ownership policies for this functional module interface are:




Section II – Functional Modules > Interaction Interface > Object Model         Top of Page
Genesys 8.1
SCXML Technical Reference
< Addressing Resources            Functions >