Navigation :

OSD Op - Send & Receive

Overview

The OSD operation represents the sending of an NCC Open Services Development (OSD) request, and the receipt and processing of the associated response. The NCC OSD interface is sent via the SOAP protocol.

Direction: OUTBOUND/INBOUND
From: IN Tester (OSD Client)
To: SCP (OSD Server)

Note that in order to use this operation, the following pre-requisite configuration is required:

At least one OSDApp Application Instance must be configured within the N2SVCD Service Daemon.
The ExecuteTest JSON-RPC method request must specify the osd top-level attribute as the name of a configured OSDApp Application Instance.

Refer to the IN Tester Technical Guide for information on configuring OSDApp Application Instances, and on using the ExecuteTest JSON-RPC method.

Note that the test instance processing will be terminated if a network error or HTTP/SOAP parsing error occurs during the request/response process.

Attributes

The operation attributes are as follows.

Attribute	Type	Description
`type`	String	`ocncc.osd.Request`
`label`	String	An optional label for this node if it is to be the target of a `branch` operation.
`arguments`	Object	[Required] Details of the OSD request to perform and the expected response to validate. Expressions may be supplied within this structure.
`tests`	Array of Object	An array of anonymous Objects. Each Object represents a check to be performed. The associated Pass/Fail entries will be generated in the test instance `check_log`. Refer to the Operation Tests documentation for more information on the syntext for Operation `tests`.

Example

This is an example entry within the operations array:

{
    "type": "ocncc.osd.Request",
    "arguments": {
        "action": "http://tcl-sms/wsdls/Boss/OperationSet1/Operation1",
        "wsdl_url": "http://tcl-sms/wsdls/Boss/OperationSet1.wsdl",
        "operation": "Operation1",
        "parameters": {
            "Reason": "My Very Good Reason",
            "CC_Calling_Party_Id": "64220635462"
        }
    },
    "tests": [
        {
            "kpath": "returned.Response_Description",
            "type": "string",
            "value": "My Very Good Reason"
        },
        {
            "kpath": "returned.TERMINATING_BLACKLIST",
            "type": "ordered_str_array",
            "value": ["1234", "44", "444"]
        },
        {
            "kpath": "returned.Absent_Parameter",
            "type": "string"
        },
        {
            "kpath": "returned.Subscriber_Age",
            "type": "integer",
            "value": "3"
        }
    ]
}

Arguments (Request)

The following request/outbound arguments are supported.

Argument	Type	Notes
`action`	HTTP Address	This is the string to specify in the `SOAPAction` header when making the outbound OSD request. Please refer to the Oracle NCC OSD documentation for more information about this header, and whether it is required and/or validated in your OSD installation.
`wsdl_url`	HTTP Address	This is the string to use as the `xmlns:oper` attribute in the SOAP envelope when making the outbound OSD request. Please refer to the Oracle NCC OSD documentation for more information about this attribute, and whether it is required and/or validated in your OSD installation.
`operation`	String	[Required] The element `{operation}Request` will be used within the SOAP body when performing the outbound OSD request.
`parameters`	Object	This object defines all of the outbound user parameters to place into the OSD request. These parameters should all be string scalars. Structured parameters are not supported.

Arguments (Response)

The following response/inbound arguments are supported.

Argument	Type	Notes
`operation`	String	[Required] The response from the OSD Server must contain the element `{operation}Response` in the SOAP body.

KPath Test Paths

For OSD tests the following top-level elements are available via the KPath:

returned - All the returned OSD parameters as an Object.
content - The complete SOAP XML content as a multi-line string.

The parameters in the returned Object may be scalar strings (SOAP types xs:string or ocncc:NumericString), but may be an array of strings (SOAP type ocncc:NumberList). Refer to the OSD WSDL and the ORACLE NCC OSD documentation for more information about NCC OSD result types.