Section I – SCXML > SCXML Extensions > Object Model         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< SCXML Event Extensions            Functions >

Object Model

_genesys Object

Every SCXML session instance running in the orchestration platform will have a global root object from which an application will have access to all Genesys platform-related objects, properties, and functions (SCXML extension–based objects, functional module objects, and so on). This object is maintained by the orchestration platform.

The name of the object will be "_genesys".

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

"FMname"

read only

objects (all at the same level, that is, they are all siblings)

none

The valid list of Genesys functional module root objects, see the Genesys Functional Modules section.

For each functional module there will be a functional module root object. For example, the Interaction functional module and Queue functional module will have the corresponding root object off of the _genesys object: _genesys.ixn and _genesys.queue.

_genesys.session.server Object

Every SCXML session instance running in the orchestration platform will have a global root object from which an application will have access to platform server information. This object is maintained by the orchestration platform.

The name of the object will be "_genesys.session.server".

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

name

read only

string

none

 

This is the configuration layer application name for the active platform server running this session.

cluster

read only

string

none

 

This is the configuration layer application name of the platform cluster (that is, the primary platform server) running this session.

_genesys.session Object

Every SCXML session instance running in the orchestration platform will have an object with a set of common orchestration logic properties. These properties are maintained by the orchestration platform, but they can be set or updated by the orchestration logic itself. They are also used by the orchestration platform for orchestration logic reporting and management functionality.

The name of the object will be "_genesys.session".

This is the set of properties for the object:

Name

Access

Type

Default Value

Valid Values

Description

server

read only

server object

none

 

This is the Genesys server information on which this session is running.

tenant

read only

string

none

 

This is the name of the tenant that this session is associated with. It can be changed with the _genesys.session.setTenant() function.

_genesys.session.lookupseq ENUM Object

This represents the lookupsequence 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

StartFromStrategy

read only

integer

none

-1

The lookup starts from the routing strategy

StartFromCDN

read only

integer

none

0

The lookup starts from the CDN

StartFromTserver

read only

integer

none

1

The lookup starts from the T-Server

StartFromTenant

read only

integer

none

2

The lookup starts from the Tenant

StartFromRouter

read only

integer

none

3

The lookup starts from the URS

_genesys.session.day ENUM Object

This represents the day 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

Sunday

read only

integer

none

0

This represents Sunday.

Monday

read only

integer

none

1

This represent Monday.

Tuesday

read only

integer

none

2

This represents Tuesday.

Wednesday

read only

integer

none

3

This represents Wednesday.

Thursday

read only

integer

none

4

This represents Thursday.

Friday

read only

integer

none

5

This represents Friday.

Saturday

read only

integer

none

6

This represents Saturday.

Variables

Global Scope Variables

The developer can and should use the following global scope variables:

Local Scope Variables

The developer can and should use the following local scope variables:

Object Ownership

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




Section I – SCXML > SCXML Extensions > Object Model         Top of Page
Genesys 8.1
SCXML Technical Reference
< SCXML Event Extensions            Functions >