Section II – Functional Modules > Dialog (Treatment) Interface > Action Elements Bottom of Page
| Genesys 8.0 SCXML Technical Reference
< Parameter Elements Events >

## Action Elements

#### <runtreatments>

This action performs a series of treatments in the order specified. It can be a child of the `<submit>` and `<update>` action elements or can function as its own action. This action can only be a child of the `<submit>` or `<update>` action.

##### Attribute Details

None.

The following are action limitations:

- Currently, there is no way to use the `<stop>` action to cancel this treatment.
- This action can only be a child of the `<submit>` or the `<update>` actions.
- If used as a child of `<submit>`, no events will be generated for all treatment actions that are defined.
- If using this action independently, all events will be generated for all child treatment actions that are to be run. This will allow the SCXML session's logic to get the data collected by the treatment action children at the appropriate times.

The following are examples:

    <dialog:runtreatments>
    	<dialog:play language="'English (US)'">
    		<dialog:prompts type="ann">
    			<dialog:prompt interrupt="true" intid="'1111'"/>
    			<dialog:prompt interrupt="true" number="'2222'"/>
    		</dialog:prompts>
    	</dialog:play>
    	<dialog:collect language="'English (US)'">
    		<dialog:input max_digits="'6'" abort_digits="'1'" term_digits="'9'"
    			total_timeout="'20'"/>
    	</dialog:collect>
    	<dialog:playsound type="'music'" resource="'EMusicDN'" duration="'100'"/>
    </dialog:runtreatments>

    <dialog:runtreatments>
    	<dialog:remote destination="'123456'" default="'2334'"/>
    	<dialog:pause/>
    	<dialog:remote destination="'66666'" default="'2334'"/>
    </dialog:runtreatments>

##### Children

- `<collect>` — Occurs 0 to N. This action collects digits from a caller.
- `<play>` — Occurs 0 to N. This action plays announcements to a caller.
- `<playandcollect>` — Occurs 0 to N. This action plays announcements to a caller and then collects digits from a caller.
- `<playandverify>` — Occurs 0 to N. This action plays announcements to a caller, collects digits from the caller and then verifies that the digits are appropriate.
- `<playsound>` — Occurs 0 to N. This action plays sounds to a caller.
- `<start>` — Occurs 0 to N. This action executes a dialog application with which the caller will interact.
- `<pause>` — Occurs 0 to N. This action executes a pause in treatment processing. This is to be used in between the other treatments.
- `<remote>` — Occurs 0 to N. This action executes a dialog application with which the caller will interact by way of a new remote resource.
- `<setdialogdefaultdest>` — Occurs 0 to 1. This action informs the dialog application what the default destination of the interaction should be if a failure occurs between the orchestration platform and the dialog application resource.

##### Events

Events associated with the child action elements will not be generated.

Note: when this action is a child of the `<submit>` or `<update>` action, no events will be generated for these actions.

#### <collect>

This action simply collects a set of digits from a caller. It is equivalent to the IRD function block "Collect Digits".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.collect.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID from which the digits will be collected. There is a special value that can be returned: "0" means the functional module will use the `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- If this action element is a child of the `<runtreatments>` element then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- interactionid
- resource

The following is an example:

    <dialog:collect>
    	<dialog:input max_digits="'6'" abort_digits="'1'"
    		term_digits="'9'" total_timeout="'20'"/>
    </dialog:collect>

##### Children

- `<input>` — Occurs 1 time. This instance defines the characteristics needed to collect the digits.

##### Events

The following events can be generated as part of this action:

- dialog.collect.done
- dialog.collect.requestid
- error.dialog.collect — This event will be sent as a result of problems with the request itself.

#### <play>

This action simply plays a set of announcements to a caller. It is equivalent to the IRD function block "Play Announcement" and "Text to Speech".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.play.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
Interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which the announcements will be played. There is a special value that can be returned: "0" means the functional module will use `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
language | false | value expression | English (US) | Any expression that returns a string with one of the following values: English (US), Spanish, Mandarin, Cantonese, Vietnamese, French, French (Canada), German, Italian, Japanese, Korean, Russian | A value expression which returns a string specifying a language in which the announcements should be made. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- The T-Server "Text To Speech" treatment is used when the associated `<prompts>` type attribute value is "tts" and all the `<prompt>` children are using the text attribute only.
- If this action element is a child of the `<runtreatments>` element then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- interactionid
- resource

The following is an example:

    	<dialog:play language="'English (US)'">
    	<dialog:prompts type="ann">
    		<dialog:prompt interrupt="true" intid="'1111'"/>
    		<dialog:prompt interrupt="true" number="'2222'"/>
    	</dialog:prompts>
    </dialog:play>

##### Children

- `<prompts>` — Occurs 1 time. This instance defines the set of announcements to be played to the caller. The `<prompts>`'s type attribute can only be set to "ann" or "tts"

##### Events

The following events can be generated as part of this action:

- dialog.play.done
- dialog.play.requestid
- error.dialog.play — This event will be sent as a result of problems with the request itself.

#### <playandcollect>

This action plays a set of announcements to a caller and then collects digits. In addition, you can specify the appropriate attributes to verify the digits collected against a defined set of digits. It is equivalent to the IRD function blocks "Play Announcement and Collect Digits" and "Text to Speech and Collect Digits".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.playandcollect.requestid event is received.If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which the announcements will be played and the digits collected. There is a special value that can be returned: "0" means the functional module will use `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
language | false | value expression | English (US) | Any expression that returns a string with one of the following values: English (US), Spanish, Mandarin, Cantonese, Vietnamese, French, French (Canada), German, Italian, Japanese, Korean, Russian | A value expression which returns a string specifying a language in which the announcements should be made. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- The T-Server "Text To Speech and Collect Digits" treatment is used when the associated `<prompts>` type attribute value is "tts" and all the `<prompt>` children are using the text attribute only.
- If this action element is a child of the `<runtreatments>` element, then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- Interactionid
- resource

The following is an example:

    <dialog:playandcollect language="'English (US)'">
    	<dialog:prompts type="ann">
    		<dialog:prompt interrupt="true" intid="'1111'"/>
    		<dialog:prompt interrupt="true" number="'2222'"/>
    	</dialog:prompts>
    	<dialog:input max_digits="'4'" abort_digits="'1'" term_digits="'9'"
    		total_timeout="'20'"/>
    </dialog:playandcollect>

##### Children

- `<prompts>` — Occurs 1 time. This instance defines the set of announcements to be played to the caller. The `<prompts>`'s type attribute can only be set to "ann" or "tts".
- `<input>` — Occurs 1 time. This instance defines the characteristics needed to collect the digits.

##### Events

The following events can be generated as part of this action:

- dialog.playandcollect.done
- dialog.playandcollect.requestid
- error.dialog.playandcollect — This event will be sent as a result of problems with the request itself.

#### <playandverify>

This action plays a set of announcements to a caller, collects digits, and verifies the digits against a defined set of digits. It is equivalent to the IRD function block "Verify Digits".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.playandverify.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | False | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which the announcements will be played and the digits will be collected and verified. There is a special value that can be returned: "0" means the functional module will use `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
language | False | value expression | English (US) | Any expression that returns a string with one of the following values: English (US), Spanish, Mandarin, Cantonese, Vietnamese, French, French (Canada), German, Italian, Japanese, Korean, Russian | A value expression which returns a string specifying a language in which the announcements should be made. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- With this action you cannot use a `<prompts>` type attribute of "tts".
- If this action element is a child of the `<runtreatments>` element, then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- interactionid
- resource

The following is an example:

    <dialog:playandverify language="'English (US)'">
    	<dialog:prompts type="ann">
    		<dialog:prompt interrupt="true" intid="'1111'"/>
    		<dialog:prompt interrupt="true" number="'2222'"/>
    	</dialog:prompts>
    	<dialog:prompts type="iretry">
    			<dialog:prompt interrupt="true" intid ="'3333'"/>
    	</dialog:prompts>
    	<dialog:prompts type="isuccess">
    		<dialog:prompt intid="'4444'"/>
    		<dialog:prompt interrupt="true" text="'hi'"/>
    	</dialog:prompts>
    	<dialog:prompts type="ifailure">
    		< dialog:prompt interrupt="true" intid="'1111'"/>
    		< dialog:prompt interrupt="true" userannid="'10'"/>
    	</dialog:prompts>
    	<dialog:prompts type="itimeout">
    		< dialog:prompt text="'timeout'"/>
    	</dialog:prompts>
    	<dialog:input max_digits="'10'" abort_digits="'1'" term_digits="'9'"
    		total_timeout="'20'"/>
    	<dialog:compare digits="'12426'" attempts="'3'"/>
    </dialog:playandverify>

##### Children

- `<prompts>` — Occurs 5 times. These instances define the different sets of announcements to be played to the caller based on the verification process. Each `<prompts>` element associated with the action must have a different value for the type attribute (that is, you must have one of each type for this action).
- `<input>` — Occurs 1 time. This instance defines the characteristics needed to collect the digits.
- `<compare>` — Occurs 1 time. This instance defines what needs to be compared to the digits collected from the caller.

##### Events

The following events can be generated as part of this action:

- dialog.playandverify.done
- dialog.playandverify.requestid
- error.dialog.playandverify — This event will be sent as a result of problems with the request itself.

#### <playsound>

This action plays a given voice-related sound to a caller. It is a voice-specific treatment. It is equivalent to the following IRD function blocks

- "Busy"
- "Fast Busy"
- "Music"
- "Ringback"
- "Silence"
- "RAN"

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.playsound.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which to play the sound. There is a special value that can be returned: "0" means the functional module will use _genesys.FMname.interactions[0].g_uid for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
resource | false | value expression | "0" | Any valid string or resource object | For type equal to "music", this will be the source of the music (that is, MUSIC_DN) and is a required attribute. For type equal to "ran", this will be the source of the recorded announcement (that is, ROUTE) and is a required attribute. See SCXML Legal Data Values and Value Expressions for details.
type | true | value expression | none | busy,fastbusy music, ringback silence, ran | A value expression which returns a string specifying the type of sound to play to the caller. See SCXML Legal Data Values and Value Expressions for details.
duration | false | value expression | 0 | Any expression that returns a valid integer | A value expression which returns the duration in seconds that the sound should be played. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- The following types of sounds are hard coded to be not interruptible:

- busy, fastbusy, ran

- The following types of sounds are hard coded to be interruptible:

- music, ringback, silence

- If this action element is a child of the `<runtreatments>` element, then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- Interactionid

The following are some examples:

    <dialog:playsound type="'busy'" duration="'100'"/>
    <dialog:playsound type="'fastbusy'" duration="'1000'"/>
    <dialog:playsound type="'silence'"/>
    <dialog:playsound type="'music'" resource="'ElevatorMusicDN'"/>

##### Children

None

##### Events

The following events can be generated as part of this action:

- dialog.playsound.done
- dialog.playsound.requestid
- error.dialog.playsound — This event will be sent as a result of problems with the request itself.

#### <createann>

This action creates and records an announcement from a user. It is equivalent to the IRD function block "Record User Announcement". This is primarily used to collect a message from a customer.

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.createann.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which to create or record the announcement. There is a special value that can be returned: "0" means the functional module will use `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
userid | true | value expression | none | Any expression that returns a valid string | A value expression which returns a string specifying the user ID associated with this recording announcement. See SCXML Legal Data Values and Value Expressions for details.
abort_digits | false | value expression | none | Any expression that returns a valid string | A value expression which returns the sequence of up to two keys that the caller can enter to abort the recording process. The IP is to consider this as a failed recording attempt. See SCXML Legal Data Values and Value Expressions for details.
term_digits | false | value expression | none | Any expression that returns a valid string | A value expression which returns the sequence of up to two keys that the caller can enter to indicate that the caller has finished recording the announcement. See SCXML Legal Data Values and Value Expressions for details.
reset_digits | false | value expression | none | Any expression that returns a valid string | A value expression which returns the sequence of up to two keys that the caller can enter to restart the recording announcement. Any announcement recorded up to the point of these keystrokes will be discarded. See SCXML Legal Data Values and Value Expressions for details.
start_timeout | false | value expression | none | Any expression that returns a valid integer | A value expression which returns the number of seconds the resource should wait for the callers to begin recording their announcements. See SCXML Legal Data Values and Value Expressions for details.
total_timeout | false | value expression | none | Any expression that returns a valid integer | A value expression which returns the total number of seconds the resource should wait for the callers to finish recording their announcements. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.

The following is an example:

    <dialog:createann userid="'12334567'" abort_digits="'1'" term_digits="'9'"
    		total_timeout="'20'">
    	<dialog:prompts type="ann">
    		<dialog:prompt interrupt="true" intid="'1111'"/>
    		<dialog:prompt interrupt="true" number="'2222'"/>
    	</dialog:prompts>
    </dialog:createann>

##### Children

- `<prompts>` — Occurs 1 time. This instance defines the set of announcements to be played to the caller. The `<prompts>`'s type attribute can only be set to "ann".

##### Events

The following events can be generated as part of this action:

- dialog.createann.done
- dialog.createann.requestid
- error.dialog.createann — This event will be sent as a result of problems with the request itself.

#### <deleteann>

This action creates and records an announcement from a user. It is equivalent to the IRD function block "Delete User Announcement"

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestIid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.deleteann.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID on which to create or record the announcement. There is a special value that can be returned: "0" means the functional module will use `_genesys.FMname.interactions[0].g_uid` for collecting the digits. See SCXML Legal Data Values and Value Expressions for details.
userid | true | value expression | none | Any expression that returns a valid string | A value expression which returns a string specifying the user ID associated with the announcement to be deleted. See SCXML Legal Data Values and Value Expressions for details.
annid | true | value expression | none | Any expression that returns a valid string | A value expression which returns the user announcement ID as returned in the dialog.createann.done event. See SCXML Legal Data Values and Value Expressions for details.

The following are action limitations:

- There is no way to use the `<stop>` action to cancel this treatment.
- The action is hard coded to be not interruptible.

The following is an example:

    <dialog:deleteann userid="'12334567'" annid="'464646464'"/>

##### Children

None

##### Events

The following events can be generated as part of this action:

- dialog.deleteann.done
- dialog.deleteann.requestid
- error.dialog.deleteann — This event will be sent as a result of problems with the request itself.

#### <start>

This action requests that a specific dialog be started on a specific interaction and by a specific resource. This is used for all different types of media. This action is equivalent to the IRD function block "Play Application".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.start.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID for which the dialog is to be started. There is a special value that can be returned: "0" means the functional module will use _genesys.FMname.interactions[0].g_uid to route the interaction. See SCXML Legal Data Values and Value Expressions for details.
type | true | value expression | none | agentappl, webpage, vxml, applid, ccxml | A value expression which returns the type of application that is to be started. The following are the different types that will be supported: agentappl — This is a desktop application or agent script that is to be started or launched at the agent desktop. webpage — This is a web page that is either to be started at an agent desktop (for example, by an agent script) or on a website for a customer. vxml — This is a VXML document that is to be started on the voice platform resource. applid — This indicates that the request is for the "Play Application" IRD function block. ccxml — This indicates that a CCXML document is to be started on the interaction platform. See SCXML Legal Data Values and Value Expressions for details.
application | false | value expression |  | Any expression that returns a valid string | A value expression which returns the identifier of a new application which is to be started by the resource in association with the interaction. The format of the application reference is specific to each dialog type: agentappl — This is the executable name of the application to be run. webpage — This is the URL for the web page. vxml — This is the URL for the VXML document. applid — This is the APPL_ID parameter from the "PlayApplication" IRD function block. ccxml — This is the URL for the CCXMLdocument. If this attribute is not specified, then the functional module will use the associated `<param>` elements. See SCXML Legal Data Values and Value Expressions for details.
timeout | false | value expression | 0 | A value expression which returns an integer | A value expression which returns an integer which represents the number of seconds to wait. See SCXML Legal Data Values and Value Expressions for details. The integer returned must be interpreted as a time interval. This interval begins when `<dialog:start>` is executed. A failed and timed out submit must return the error.dialog.start event.

The following are action limitations:

- This action can be cancelled using the `<stop>` action.
- For dialog type of "applid", the timeout attribute will be ignored.
- For dialog type of "applid" the parameters supplied in the name list can only be of simple types.
- All `<param>` name attribute values must match the case of the parameter name of the underlying dialog system (for all Genesys treatments, parameters are in upper case — "LANGUAGE").
- The following is the data model for the dialog type of "appid" (that is, the "Play Application" function block action)

- `<param name="LANGUAGE"/>` — The "Play Application" function block's LANGUAGE parameter
- `<param name="parameterN"/>` — Any custom parameter of the "Play Application" function block — You can add any parameter you want, but this function block functionality only supports strings and integer parameters.

Note: the application attribute will be used for the "Play Application" function block's APP_ID parameter.

- If this action element is a child of the `<runtreatments>` element, then the following attributes are not evaluated and should not be used. The similar attributes in the `<runtreatments>` will be used instead.

- requestid
- Interactionid
- resource

The following is an example of using the IRD Play Application function block:

    <dialog:start type="'applid'" application="'464646464'">
    	<param name="APP_URL" expr="'www.bigplanes.com\bestinworld'"/>
    </dialog:start>

##### Children

- `<param>` Occurs 0 to N. See SCXML `<param>` for details. These parameters will be submitted to the processing resource, based on the functional module's underlying protocol (for example, it will be via key/value pairs for T-Server).

##### Events

The following events can be generated as part of this action:

- dialog.start.done — This event will be sent when the started dialog is complete
- dialog.start.requestid
- error.dialog.start — This event will be sent as a result of a timeout of the request, as well as due to problems with the request itself.

#### <stop>

This action stops a currently running dialog application. It is used for all types of media. This action is equivalent to the IRD function block "Cancel Call".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | true | value expression | none | Any expression that returns a valid string | A value expression which returns the ID of the previously started dialog-related action. Legal Data Values and Value Expressions for details.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID for which the dialog is to be started. There is a special value that can be returned: "0" means the functional module will use _genesys.FMname.interactions[0].g_uid to route the interaction. This attribute is only valid if the compatible attribute is true. See SCXML Legal Data Values and Value Expressions for details.
compatible | false | boolean | false | true, false | This value indicates whether the action is compatible with older capabilities. If true, then this will do the "IRD Cancel Call" function. If false, then this will just stop or terminate the dialog and the actual interaction.

The following are action limitations:

- Only supports a compatible attribute value of true.

The following is an example for IRD "Cancel Call":

    <dialog:stop requestid="_data.reqid" compatible="true"/>

##### Children

None

##### Events

The following events can be generated as part of this action:

- dialog.stop.done — This event will be sent when the dialog application stop action has completed.
- error.dialog.stop — This event will be sent as a result of problems with the request itself.
- error.dialog.start — This event is sent for the dialog action that was started. Note: The error.dialog.start events will be sent before the queue.stop.done.

#### <remote>

This action requests that a specific dialog be started on a specific interaction and by a new remote resource. This is used for voice media only. This action is equivalent to the IRD function block "IVR".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.remote.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submit completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression that returns the interaction ID for which the dialog is to be started. There is a special value that can be returned: "0" means the functional module will use _genesys.FMname.interactions[0].g_uid to route the interaction. See SCXML Legal Data Values and Value Expressions for details.
application | false | value expression | none | Any expression that returns a valid string | A value expression which returns the identifier of a new application that is to be started by the new resource in association with the interaction. See SCXML Legal Data Values and Value Expressions for details.
duration | false | value expression | 0 | A value expression which returns an integer | A value expression which returns an integer that represents the number of seconds to wait. See SCXML Legal Data Values and Value Expressions for details. The character string returned must be interpreted as a time interval. This interval begins when `<remote>` is executed. A failed and timed out submit must return the error.remote.start event.
destination | true | value expression | none | Any value expression that returns a valid string | A value expression which returns the address name of a new remote resource which will be added to provide the treatment on the interaction. See SCXML Legal Data Values and Value Expressions for details.
default | false | value expression |  | Any value expression that returns a valid string | A value expression which returns the destination that should be used if there are problems transferring the interaction to the destination for treatment. See SCXML Legal Data Values and Value Expressions for details.
compatible | false | boolean | false | false, true | This value indicates whether the action is compatible with an attribute signature. If true, the following are the valid attributes: application — SCRIPT destination — TARGET timeout — DURATION If false, the following are the valid attributes: destination — LABEL default — DNIS

The following are action limitations:

- If the compatible attribute is true, the following are the valid attributes:

- application — SCRIPT
- destination — TARGET
- duration — DURATION

- If the compatible attribute is false, the following are the valid attributes:

- destination — LABEL
- default — DNIS

The following is an example for compatible = false :

    <dialog:remote destination="'123456'" default="'2334'"/>

The following is an example for compatible = true:

    <dialog:remote compatible="true"
    	destination="'2323@www.genesys.com\server1.AG'"
    	application="'mortgage'"/>

##### Children

None

##### Events

The following events can be generated as part of this action:

- dialog.remote.done
- dialog.remote.requestid
- error.dialog.remote — This event will be sent as a result of a timeout of the request, as well as due to problems with the request itself.

#### <setdialogdefaultdest>

This action requests a Genesys-specific treatment action. This action is equivalent to the IRD function block ""Set Default Destination".

##### Attribute Details

Name | Required | Type | Default Value | Valid Values | Description
--- | --- | --- | --- | --- | ---
requestid | false | location expression | none | Any valid location expression | This is the location for the request ID that is returned as part of this request. Any data model expression evaluating to a data model location. See SCXML Location Expressions for details. The location's value will be set to an internally generated unique string identifier to be associated with the action being sent. This value will only be valid when the dialog.setdialogdefaultdest.requestid event is received. If this attribute is not specified, the event identifier is dropped. This identifier can be tested by the completion event handler to distinguish among several outstanding requests. If this attribute is not specified, the identifier can be acquired from the submitted completion event. Every request must receive a unique identifier, even if the request is for the same URL.
interactionid | false | value expression | "0" | Any expression that returns a valid string | A value expression which returns the interaction ID for which the action is to be done. There is a special value that can be returned: "0" means the functional module will use _genesys.FMname.interactions[0].g_uid to route the interaction. See SCXML Legal Data Values and Value Expressions for details.
destination | true | value expression | none | Any value expression that returns a valid string | A value expression which returns the address name of the new remote resource that will be added to provide the treatment on the interaction. See SCXML Legal Data Values and Value Expressions for details.

The following is an example:

    <dialog:setdialogdefaultdest destination="'12345'"/>

##### Children

None

##### Events

The following events can be generated as part of this action:

- dialog.setdialogdefaultdest.done
- dialog.setdialogdefaultdest.requestid
- error.dialog.setdialogdefaultdest — This event will be sent as a result of a timeout of the request, as well as due to problems with the request itself.

Section II – Functional Modules > Dialog (Treatment) Interface > Action Elements Top of Page
| Genesys 8.0 SCXML Technical Reference
< Parameter Elements Events >