Toolpack monitoring sip simulator variables - Revision history

Cbilodeau: fix link

2016-04-22T17:30:14Z

fix link

← Older revision		Revision as of 13:30, 22 April 2016
Line 1:		Line 1:
	The [[Toolpack_monitoring_sip_simulator]] is formatting the generated SIP messages based on a text-based configuration, which describes the SIP message content.		The [[Toolpack_monitoring_sip_simulator\|Toolpack SIP simulator]] is formatting the generated SIP messages based on a text-based configuration, which describes the SIP message content.

	Well-known variables are used to define portion of the SIP messages that change from one call to the other.		Well-known variables are used to define portion of the SIP messages that change from one call to the other.
Line 23:		Line 23:


	To see other SIP messages default formatting, check in the [[Toolpack_monitoring_sip_simulator]] configuration page in the Web Portal.		To see other SIP messages default formatting, check in the [[Toolpack_monitoring_sip_simulator\|Toolpack SIP simulator]] configuration page in the Web Portal.

	== Variables ==		== Variables ==

Abrassard: /* Well-known variables */

2016-04-22T15:47:04Z

Well-known variables

← Older revision		Revision as of 11:47, 22 April 2016
Line 39:		Line 39:
	* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''sip_from''' : The simulated SIP "from" address. Example: 5551234@10.1.2.3:5060, or anonymous@anonymous.invalid. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd		* '''sip_from''' : The simulated SIP "from" address. Example: 5551234@10.1.2.3:5060, or anonymous@anonymous.invalid if privacy is enabled. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd
			* '''sip_from_private''' : The simulated SIP private address. Example: 5551234@10.1.2.3:5060. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd
	* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call		* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call
	* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call		* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call

Abrassard: /* Well-known variables */

2016-04-22T15:36:16Z

Well-known variables

← Older revision		Revision as of 11:36, 22 April 2016
Line 39:		Line 39:
	* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''sip_from''' : The simulated SIP "from" address. Example: 5551234@10.1.2.3:5060. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd		* '''sip_from''' : The simulated SIP "from" address. Example: 5551234@10.1.2.3:5060, or anonymous@anonymous.invalid. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd
	* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call		* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call
	* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call		* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call

Abrassard: /* Well-known variables */

2016-04-22T15:32:56Z

Well-known variables

← Older revision		Revision as of 11:32, 22 April 2016
Line 35:		Line 35:

	=== Well-known variables ===		=== Well-known variables ===
	* '''sip_to''' : The simulated SIP "from" address: called@ip.~~port~~		* '''sip_to''' : The simulated SIP "from" address. Example 5551234@10.1.2.3:5060. If present, called sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd
	* '''called''' : The called number, as decoded from the monitored call		* '''called''' : The called number, as decoded from the monitored call
	* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_noa''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call		* '''called_npi''' : The called number NPI (Numbering Plan), as decoded from the monitored call
	* '''sip_from''' : The simulated SIP "to" address: ~~calling~~@ip.~~port~~, ~~or anonymous~~@~~anonymous~~.~~invalid~~		* '''sip_from''' : The simulated SIP "from" address. Example: 5551234@10.1.2.3:5060. If present, calling sub-address may be inserted too: 5551234@10.1.2.3:5060;isub=31514;isub-encoding=nsap-bcd
	* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call		* '''calling''' : The calling number (or "anonymous" if privacy is enabled), as decoded from the monitored call
	* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call		* '''calling_noa''' : The calling number NOA (Nature Of Address), as decoded from the monitored call

Abrassard at 18:24, 21 April 2016

2016-04-21T18:24:42Z

← Older revision		Revision as of 14:24, 21 April 2016
Line 77:		Line 77:

	=== User-defined variables ===		=== User-defined variables ===
			The "SIP Simulator" configuration includes a list of user-defined variables, in the form "name=value".
			For example:
			my_var_1 = My first value
			my_var_2 = Hello world!

	~~== User~~-~~defined variables ==~~		These variables can be used in the SIP messages format definition.

			For example, a custom SIP header may be inserted, with the content of "my_var_1":
			X-Example-Var:#{my_var_1}
			Ths SIP message would be generated as:
			X-Example-Var:My first value

Abrassard: /* Well-known variables */

2016-04-21T18:22:00Z

Well-known variables

@@ Line 35: / Line 35: @@
 === Well-known variables ===
+* '''sip_to'''                   : The simulated SIP "from" address: called@ip.port
 === User-defined variables ===
 == User-defined variables ==

Abrassard: Preparing variables

2016-04-21T17:34:11Z

Preparing variables

← Older revision		Revision as of 13:34, 21 April 2016
Line 25:		Line 25:
	To see other SIP messages default formatting, check in the [[Toolpack_monitoring_sip_simulator]] configuration page in the Web Portal.		To see other SIP messages default formatting, check in the [[Toolpack_monitoring_sip_simulator]] configuration page in the Web Portal.

	== ~~Well-known variables~~ ==		== Variables ==
			All variables are referenced in the SIP messages definition by wrapping them inside '''#{}'''

			For example: #{call_id}

			There are "well-known" variables, which value is dynamically replaced by the SIP simulator according to the context.

			There are "user-defined" variables that can be inserted in the SIP messages.

			=== Well-known variables ===


			=== User-defined variables ===

	== User-defined variables ==		== User-defined variables ==

Abrassard: Page structure for now (under construction)

2016-04-21T17:16:01Z

Page structure for now (under construction)

New page

The [[Toolpack_monitoring_sip_simulator]] is formatting the generated SIP messages based on a text-based configuration, which describes the SIP message content.

Well-known variables are used to define portion of the SIP messages that change from one call to the other.

== Example SIP message format ==
INVITE sip:#{called}@#{callee_sip_ip}:#{callee_sip_port} SIP/2.0
Call-ID:#{call_id}
X-Monitored-Sender:#{sender_label}:#{sender}
X-Isdn-Info:interface-id:#{isdn_interface_id};channel-number:#{isdn_channel_number}
X-Example-Var:#{example_var}
To:<sip:#{sip_to}>
From:#{calling_display}<sip:#{sip_from}>;tag=#{caller_tag}
Remote-Party-ID:#{calling_private_display}<sip:#{calling_private}@#{caller_sip_ip}:#{caller_sip_port}>;party=calling;screen=#{calling_screening};privacy=#{calling_presentation};noa=#{calling_noa}
Privacy:#{calling_privacy}
Contact:sip:#{calling}@#{caller_sip_ip}:#{caller_sip_port}
Via:SIP/2.0/UDP #{caller_sip_ip}:#{caller_sip_port};branch=#{branch};rport
User-to-User:#{uui};encoding=text;purpose=isdn-interwork;content=isdn-uui
Date:#{date}
Timestamp:#{timestamp}
CSeq:#{cseq}
Max-Forwards:70
#{caller_content}

To see other SIP messages default formatting, check in the [[Toolpack_monitoring_sip_simulator]] configuration page in the Web Portal.

== Well-known variables ==

== User-defined variables ==