☰
Navigation :

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).

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).
variant String Variant key as described in N2::INAP::Codec PromptAndCollectUserInformation.
arguments Object [Required] The structure of the INAP PromptAndCollectUserInformationArg we expect to receive.
The received argument will be decoded, the elements tested, and PASS/FAIL match entries will be generated in the match log.
To check that an inbound value is NOT present, specify the argument as null.
.* Fields as described in N2::INAP::Codec PromptAndCollectUserInformation.

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
            }
        }
    }
}