Section III – External Interfaces > Supported URI Schemes         Bottom of Page
Genesys 8.1
SCXML Technical Reference
< Campaign Interface            External Interfaces >

Supported URI Schemes

Scheme

Purpose

Defined by

General format

Notes

Used by

HTTP

HTTP resources

RFC 2616

generic syntax

 
  • the platform to fetch the SCXML documents
  • all src attribute values
  • URL-based attributes
  • dialog application attributes

HTTPS

HTTP connections secured using SSL/TLS

RFC 2817

generic syntax

 
  • the platform to fetch the SCXML documents
  • all src attribute values
  • URL-based attributes
  • dialog application attributes

file

Addressing files on local or network file systems

RFC 1738

generic syntax(often appears as file:///path , the 3rd '/' is the final delimiter when no host (authority) is specified between)

Unusual in not being bound to any network protocol, and not usable in an Internet context.

  • the platform to fetch the SCXML documents
  • all src attribute values
  • URL-based attributes
  • dialog application attributes

tel

Used for telephone numbers

RFC 3966 RFC 2806

tel:<phonenumber>

 
  • Voice media address attributes (for example, _genesys.FMname.interactions[x].contactedaddr)
  • <createcall> to and from attributes
  • <redirect> to and from attributes.

sip

Used with Session Initiation Protocol (SIP)

RFC 3969 RFC 3261

sip:<user>[:<password>]@<host>[:<port>]

[;<uri-parameters>][?<headers>]

 
  • Voice and chat media address attributes (for example, _genesys.FMname.interactions[x].contactedaddr)
  • <createcall> to and from attributes
  • <redirect> to and from attributes.

gdata

Used to address configuration layer objects and options in Genesys Configuration Server, as well as data in an interaction's user data.

Genesys

gdata:[<host>:<port>/]<source> [/<objtype>.<objname>][/<p-name>]

For example,

gdata:config/AG.SalesGroup/supervisor

gdata:udata

The following are the meanings of the different elements of the format:

  • "host" is the IP host address for the targeted Configuration Server. This is optional. This element is ignored if the source element is "udata".
  • "port" is the port number for the targeted Configuration Server. This is optional. This element is ignored if the source element is "udata".
  • "source" is the source of the data. The following are the possible values:
    • config — This is data from Configuration Server.
    • udata — This is data from the associated interaction.
  • "objtype" is the type of configuration layer object. This element is only valid when the source element is "config". The values are the following:
    • DN — DN object
    • SS — Script object
    • AG — Agent Group object
    • PG — Place Group
    • CA — BA Category or Standard Response object
    • CM — Campaign object
    • CL — Calling List
    • TR — Transaction object
    • AP — Application object
    • PE — Person object.
    • SK — Skill object
    • PL — Place object
    • ST — Statistics Table
    • SC — BA Screening Rule object
  • "objname" is the unique name (ID) for the configuration layer object that is being referenced. There is one exception where the name is not unique and this is with the CfgDN object. This element is only valid when the source element is "config". So the unique name will be the following combination of names:
    • DN name — This is the name of the CfgDN object.
    • Switch name — This is the name of the CfgSwitch object.

    The format of the objname string in this case will be dname@switchname.

  • "p-name" is the name of a specific property of the object. For properties like annex data. The p-name has the following format: "annex"/section-name/option-name. In the case where the source element value is "udata", this will be the key name of the user data that you want to use. For example, gdata:udata/CategoryID
  • <data> src attribute
  • <submit> and <update> src attributes
  • <createmessage> msgsrc attribute

gesp

Used to invoke an Interaction Server ESP function

Genesys

gesp: <applname>\ [<type>\]<service>\[method>]

For example,

gesp: CFGInteractionServer/Interaction/SubmitNew

The following are the meanings of the different elements of the format:

  • "applname" is the 3rd party application that is to be used to process this request.
  • "service" is the name of the service with which this request is associated.
  • "method" is the specific function to be performed by the 3rd party application.
  • <fetch> srcexpr attribute

fm

Used to address a specific functional module when sending an event

Genesys

fm:namespace

For example,

fm: www.genesyslab.com/modules/queue

The following are the meanings of the different elements of the format:

  • "namespace" is the XML namespace for the functional module you are going to send an event to. This follows the XML namespace format.
  • <send> target attribute



Section III – External Interfaces > Supported URI Schemes         Top of Page
Genesys 8.1
SCXML Technical Reference
< Campaign Interface            External Interfaces >