Section I – SCXML > SCXML Extensions > Events         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements

Events

The event namespace convention is session.xxxx

The following are the session action result events:

Event

Attributes

Description

session.fetch.done

 

This event indicates the success of the request and that the data location has been updated with the returned content in JSON format.

requestid

This is the ID of the <fetch> request.

content

This is the returned content. Its format is based on the <fetch> request's type attribute. If it is "JSON", the content will be a JSON-based string and the application must use the appropriate function to convert it to the appropriate ECMAScript objects. The format of the response content will be based on the <fetch> type attribute. If there is not a match, an error.session.fetch will be raised.

Note: when the <fetch> method attribute value is "esp", the content value will always be JSON.

hints

This is the protocol-specific data associated with the fetch response (for example, HTTP header data). Its format is based on the <fetch> request's srcexpr and type attributes. If it is HTTP, the content will be ECMAScript Object with the HTTP header elements as properties of the object.

error.session.fetch

 

This indicates that an error occurred while trying to perform the fetch request.

requestid

This is the ID associated with the request.

error

This is the type of error that occurred. The following is a specific error code:

  • protocol.errorcode — This represents the protocol-specific errors that occur when the attempting the <fetch> request.

description

This is a more detailed description of the error

session.start.done

 

This event reflects the results of <start>.

sessionid

This is the ID of the SCXML session that has been started.

error.session.start

 

This indicates that an error occurred while trying to perform the <start> request. The sessionID returned on the action will be invalid after receiving this event.

sessionid

This is the ID of the SCXML session that was supposed to have started.

error

This is the type of error that occurred.

description

This is a more detailed description of the error

session.terminate.done

 

This event reflects the results of <terminate>.

sessionid

This is the ID of the SCXML session that has terminated.

error.session.terminate

 

This indicates that an error occurred while trying to perform the <terminate> request.

error

This is the type of error that occurred.

description

This is a more detailed description of the error

session.updatestart.done

 

This event reflects the results of <updatestart>.

sessionid

This is the ID of the SCXML session that was updated.

error.session.updatestart

 

This indicates that an error occurred while trying to perform the <updatestart> request.

error

This is the type of error that occurred.

description

This is a more detailed description of the error.

session.cancel.done

 

This event reflects the results of <cancel>.

error.session.cancel

 

This indicates that an error occurred while trying to perform the <cancel> request.

error

This is the type of error that occurred.

description

This is a more detailed description of the error

The following are the session asynchronous events:

Event

Attributes

Description

done.xxx

 

This event indicates that a started session was finished or was terminated. The xxx part of the event is different depending on how the session was started.

  • <invoke> — The xxx is "invoke.invokeid"
  • <start> and web service interface initiation — The xxx is "scxml.name", where name is the value from the <scxml> name attribute.
  • <final> for a state — The xxx is "state.stateid" where statid is the value from the <state> id attribute and id is an identifier generated by the platform.

Note: see the SCXML Event Extensions for details on the attributes supported.

session.restored

 

This event indicated that a session was restored from a previous checkpoint and some state processing may be lost.

sessionid

This is the session ID of the session that is being restored.

type

This is the type of restoration. Valid values are:

  • newdoc — This indicates that the session was restarted with a new SCXML document.
  • failure — This indicates that the session is being restored because of a platform failure.
  • persisted — This indicates that the session is being restored because it was persisted as part of normal processing.

states

This is an array of state ids which the session was in previously.

name

This is the previous name of the session (_name).

session.terminating

 

This event indicates that the session is being terminated because of a hung condition.This is only sent when a session is being terminated by the platform due to an error condition (hung condition, infinite loop, and so on). This gives the session the ability to graceful terminate itself. So this event is sent by the platform to a session in trouble. A done.xxx will not be sent at all in this condition.

sessionid

This is the session ID of the session that is being terminated.

reason

This is the reason the platform is terminating the session. The following is the set of reasons:

  • TerminationTimeout — The termination cancel operation has not finished in a reasonable time frame or the <final> processing for an application has not finished in a reasonable time frame.
  • IdleTimeout — A session has been idle for a given time period (no events or processing).
  • ElementCountExceeded — A session has executed too many of the same type of SCXML element (<transition>).
  • ElementTimeout — A session spends too long executing an element (<script>, <queue:submit>, and so on).

session.configupdate

 

This event indicates that data managed by the Genesys Configuration Server has been updated and can be used by the session.

id

This is a string which is the DB ID of the configuration object that has been updated.

name

This is the name of the data model property that was updated — _data.name

session.cancelled

 

This event indicates that the session is being cancelled from a <terminate> action.

sessionid

This is the session ID of the session that is being terminated.




Section I – SCXML > SCXML Extensions > Events         Top of Page
Genesys 8.1
SCXML Technical Reference
< Action Elements