PromptAndCollectUserInformation
Overview
The PromptAndCollectUserInformation operation represents the receipt of an INAP PromptAndCollectUserInformation. The test instance will abort if any other inbound message is received.
This message is received by the IN Tester when it is simulating the role of a Service Switching Platform (SSP) or a Specialized Resource Platform (SRP).
- Direction: INBOUND
- From: SCP (Application Under Test)
- To: SSP (IN Tester) or SRP (IN Tester)
Attributes
The operation attributes are as follows.
Attribute | Type | Description |
---|---|---|
type
|
String |
inap.ssp_from_scp.PromptAndCollectUserInformation or inap.srp_from_scp.PromptAndCollectUserInformation
|
label
|
String |
An optional label for this node if it is to be the target of a branch operation.
|
last_component
|
1 / 0
|
If 1 performs a test that this is the last component of a TCAP_END message.If 0 performs a test that this is not the last component of a TCAP_END message.(Default = do not perform any test). |
tcap_ac
|
null / TCAP alias / Hex String
|
Tests the received TCAP Application Context from the first inbound TCAP_CONTINUE / TCAP_END dialogue portion. If null tests that we did not receive a dialogue portion.(Default = do not perform any test). |
tcap_result
|
Integer |
Tests the received result value from the first inbound TCAP_CONTINUE / TCAP_END dialogue portion.If null tests that we did not receive a dialogue portion.(Default = do not perform any test). |
tcap_result_diagnostic_user
|
Integer |
Tests the received dialogue-service-user value from the first inbound TCAP_CONTINUE / TCAP_END dialogue portion.If null tests that we did not receive a dialogue portion, or that it did not contain a user result diagnostic.(Default = do not perform any test). |
tcap_result_diagnostic_provider
|
Integer |
Tests the received dialogue-service-provider value from the first inbound TCAP_CONTINUE / TCAP_END dialogue portion.If null tests that we did not receive a dialogue portion, or that it did not contain a provider result diagnostic.(Default = do not perform any test). |
arguments
|
Object |
[Required] The structure of the INAP PromptAndCollectUserInformationArg we expect to receive. Expressions may be supplied within this structure. |
Example
This is an example entry within the operations
array:
{
"type": "inap.scp_to_srp.PromptAndCollectUserInformation",
"arguments" : {
"informationToSend": {
"inbandInfo": {
"messageID": {
"variableMessage": {
"elementaryMessageID": "3",
"variableParts": [
{ "number": "4500" }
]
}
}
}
},
"collectedInfo": {
"collectedDigits": {
"minimumNbOfDigits": 4,
"maximumNbOfDigits": 4
}
}
}
}
Arguments
The following inbound arguments are supported. Unless specifically indicated otherwise,
the actual received inbound arguments will be checked for each supplied “expected” value,
and Pass/Fail entries will be generated in the test instance check_log
.
To check that an inbound value is NOT present, specify the argument as null
.
Argument | Type | Notes |
---|---|---|
informationToSend
|
Object | Container for inner elements. |
.inbandinfo
|
Object | Container for announcement parameters. |
.messageID
|
Object | Container for announcement message parameters. |
.elementaryMessageID
|
Integer | Specify the expected value for a single message ID. |
.text
|
Object | Container for text message parameters. |
.messageContent
|
IA5 String | Specify the expected 7-bit IA5 string value. |
.attributes
|
Binary String | Specify the expected binary value. |
.elementaryMessageIDs
|
Array of Integer | Expected array of Integer message IDs. |
.variableMessage
|
Object | Container for expected variable message parameters. |
.elementaryMessageID
|
Integer | Specify the expected value for a single variable part message ID. |
.variableParts
|
Array of Object | Array of anonymous objects representing the expected variable parts. |
.integer . number . date . time . price
|
Integer Binary String Binary String Binary String Binary String |
Each expected variable part is an object defining exactly one of these parameters. |
.numberOfRepetitions
|
Integer | Specify the expected numeric value. |
.duration
|
Integer | Specify the expected numeric value (in seconds). |
.interval
|
Integer | Specify the expected numeric value (in seconds). |
.tone
|
Object | Container for audio tone parameters. |
.toneID
|
Integer | Specify the expected numeric value. |
.duration
|
Integer | Specify the expected numeric value (in seconds). |
.displayInformation
|
IA5 String | Specify the expected 7-bit IA5 string value. |
disconnectFromIPForbidden
|
Boolean | Specify "1" if the value is expected to be present. |
collectedInfo
|
Object | Container for expected information collection parameters. |
.collectedDigits
|
Object | Container for expected digit collection parameters. |
.minimumNbOfDigits
|
Integer | Specify the expected numeric value. |
.maximumNbOfDigits
|
Integer | Specify the expected numeric value. |
.endOfReplyDigit
|
Binary String |
Specify the expected binary string value. One or two digits in BCD, one digit per octet, contained in the least significant bits. |
.cancelDigit
|
Binary String |
Specify the expected binary string value. One or two digits in BCD, one digit per octet, contained in the least significant bits. |
.startDigit
|
Binary String |
Specify the expected binary string value. One or two digits in BCD, one digit per octet, contained in the least significant bits. |
.firstDigitTimeOut
|
Integer | Specify the expected numeric value (in seconds). |
.interDigitTimeOut
|
Integer | Specify the expected numeric value (in seconds). |
.errorTreatment
|
Integer | Specify the expected numeric value. |
.interruptableAnnInd
|
Boolean | Specify "1" if the value is expected to be present. |
.voiceInformation
|
Boolean | Specify "1" if the value is expected to be present. |
.voiceBack
|
Boolean | Specify "1" if the value is expected to be present. |