/
dialog_admin.xml
3354 lines (3216 loc) · 105 KB
/
dialog_admin.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- Module User's Guide -->
<chapter>
<title>&adminguide;</title>
<section id="overview" xreflabel="Overview">
<title>Overview</title>
<para>
The dialog module provides dialog awareness to the &osips; proxy. Its
functionality is to keep trace of the current dialogs, to offer information
about them (like how many dialogs are active).
</para>
<para>
Aside tracking, the dialog module offers functionalities like flags and
attributes per dialog (persistent data across dialog), dialog profiling
and dialog termination (on timeout base or external triggered).
</para>
<para>
The module, via an internal API, also provide the foundation to build on
top of it more complex dialog-based functionalities via other &osips;
modules.
</para>
</section>
<section>
<title>How it works</title>
<para>
To create the dialog associated with an initial request, you must call
the create_dialog() function, with or without parameter.
</para>
<para>
The dialog is automatically destroyed when a <quote>BYE</quote> is
received. In case of no <quote>BYE</quote>, the dialog lifetime is
controlled via the default timeout (see <quote>default_timeout</quote>
- <xref linkend="param_default_timeout"/>) and custom timeout (see
<quote>$DLG_timeout</quote> - <xref linkend="pv_DLG_timeout"/>).
</para>
</section>
<section id="dialog-profiling" xreflabel="Dialog profiling">
<title>Dialog profiling</title>
<para>
Dialog profiling is a mechanism that helps in classifying, sorting and
keeping trace of certain types of dialogs, using whatever properties of
the dialog (like caller, destination, type of calls, etc).
Dialogs can be dynamically added in different (and several) profile
tables - logically, each profile table can have a special meaning (like
dialogs outside the domain, dialogs terminated to PSTN, etc).
</para>
<para>
There are two types of profiles:
<itemizedlist>
<listitem>
<para>
<emphasis>with no value</emphasis> - a dialog simply belongs
to a profile. (like outbound calls profile). There is no other
additional information to describe the dialog's belonging to the
profile;
</para>
</listitem>
<listitem>
<para>
<emphasis>with value</emphasis> - a dialog belongs to a profile
having a certain value (like in caller profile, where the value
is the caller ID). The belonging of the dialog to the profile is
strictly related to the value.
</para>
</listitem>
</itemizedlist>
</para>
<para>
A dialog can be added to multiple profiles in the same time.
</para>
<para>
Profiles are visible (at the moment) in the request route (for initial
and sequential requests) and in the branch, failure and reply routes of
the original request.
</para>
<para>
Dialog profiles can also be used in distributed systems, using the &osips;
CacheDB Interface or the <emphasis>clusterer</emphasis> module. This feature
allows you to share dialog profile information with multiple &osips; instaces
that use the same CacheDB backend or are part of an &osips; cluster. In order
to do that, the <emphasis role='bold'>cachedb_url</emphasis> or
<emphasis role='bold'>profile_replication_cluster</emphasis> parameters must be defined.
Also, the profile must be marked as shared, by adding one of the
<emphasis>'/s'</emphasis> or <emphasis>'/b'</emphasis> suffixes to the name of
the profile in the <emphasis>profiles_with_value</emphasis> or
<emphasis>profiles_no_value</emphasis> parameters.
</para>
</section>
<section id="dialog-clustering" xreflabel="Dialog clustering">
<title>Dialog clustering</title>
<para>
<emphasis role='bold'>Dialog replication</emphasis> is a mechanism used to
mirror all dialog changes taking place in one OpenSIPS instance to one or
multiple other instances. The process is simplified by using the
<emphasis>clusterer</emphasis> module which facilitates the management of a
cluster of OpenSIPS nodes and the sending of replication-related BIN packets
(binary-encoded, using <emphasis>proto_bin</emphasis>). This feature
is useful in achieving High Availability and/or Load Balancing for ongoing calls.
</para>
<para>
Configuring both receival and sending of dialog replication packets is trivial
and can be done by using the
<emphasis role='bold'>dialog_replication_cluster</emphasis> parameter. But in
addition to just sharing data, in order to properly cluster dialogs you will
need to manage which node in the cluster is doing certain actions on certain
dialogs using the <emphasis role='bold'>sharing tags</emphasis> mechanism.
For details and configuration examples on how this would work
in different usage scenarios, see
<ulink url="https://blog.opensips.org/2018/03/23/clustering-ongoing-calls-with-opensips-2-4/">this article</ulink>.
</para>
<para>
The following actions will <emphasis role='bold'>not</emphasis> be performed for a dialog
marked with a sharing tag that is in the "<emphasis role='bold'>backup</emphasis>" state:
<itemizedlist>
<listitem><para>sending Re-Invite or OPTIONS pings to end-points</para></listitem>
<listitem><para>generating BYE requests or any other actions(like producing CDRs)
upon dialog expiration</para></listitem>
<listitem><para>sending replication packets on dialog events(update, delete)</para></listitem>
<listitem><para>counting the dialog in the profiles that it belongs; only if profile replication
is also enabled</para></listitem>
</itemizedlist>
</para>
<para>
In addition to the event-driven replication, an OpenSIPS instance will first
try to learn all the dialog information from antoher node in the cluster at startup.
The data synchronization mechanism requires defining one of the nodes in the cluster
as a "<emphasis role='bold'>seed</emphasis>" node.
See the <ulink url="https://opensips.org/docs/modules/3.0.x/clusterer.html#capabilities">clusterer</ulink>
module for details on how to do this and why is it needed.
</para>
<para>
In the context of dialog replication, using a database as a failsafe for obtaining
restart persistency for dialog data is useful in case all nodes in the cluster are down.
This approach makes the most sense if a separate, local DB is used for each node in the
cluster. Dialogs loaded from the database at startup, which are not reconfirmed through
syncing, are dropped and also deleted from the database once the sync from cluster is complete.
</para>
<para>
Also configuring profile replication via the <emphasis>profile_replication_cluster</emphasis>
parameter is not necessary when dialog replication is already configured. The profile information
is included in the dialog updates sent in the dialog replication cluster. The profiles must still
be marked for sharing though in the <emphasis>profiles_with_value</emphasis> or
<emphasis>profiles_no_value</emphasis> parameters.
</para>
<para>
A scenario were both profile and dialog replication should be configured is when a platform has
multiple POPs, where separate dialog replication clusters are configured for HA purposes, and a
cluster for globally shared profiles is also required. In this case, proper counting for dialogs
is ensured by using the sharing tags mechanism(in order to avoid counting each dialog twice,
both on the active and backup node for that dialog).
</para>
</section>
<section id="dependencies" xreflabel="Dependencies">
<title>Dependencies</title>
<section>
<title>&osips; Modules</title>
<para>
The following modules must be loaded before this module:
<itemizedlist>
<listitem>
<para>
<emphasis>TM</emphasis> - Transaction module
</para>
</listitem>
<listitem>
<para>
<emphasis>RR</emphasis> - Record-Route module, optional,
if Dialog ID matching is used in non Topo Hiding cases
</para>
</listitem>
<listitem>
<para>
<emphasis>clusterer</emphasis> - if <emphasis>replication_cluster</emphasis>
parameter is set (contact replication via clusterer
module)
</para>
</listitem>
</itemizedlist>
</para>
</section>
<section>
<title>External Libraries or Applications</title>
<para>
The following libraries or applications must be installed before
running &osips; with this module loaded:
<itemizedlist>
<listitem>
<para>
<emphasis>None</emphasis>.
</para>
</listitem>
</itemizedlist>
</para>
</section>
</section>
<section id="exported_parameters" xreflabel="Exported Parameters">
<title>Exported Parameters</title>
<section id="param_enable_stats" xreflabel="enable_stats">
<title><varname>enable_stats</varname> (integer)</title>
<para>
If the statistics support should be enabled or not. Via statistic
variables, the module provide information about the dialog processing.
Set it to zero to disable or to non-zero to enable it.
</para>
<para>
<emphasis>
Default value is <quote>1 (enabled)</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>enable_stats</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "enable_stats", 0)
...
</programlisting>
</example>
</section>
<section id="param_hash_size" xreflabel="hash_size">
<title><varname>hash_size</varname> (integer)</title>
<para>
The size of the hash table internally used to keep the dialogs. A
larger table is much faster but consumes more memory. The hash size
must be a power of 2 number.
</para>
<para>
IMPORTANT: If dialogs' information should be stored in a database,
a constant hash_size should be used, otherwise the restored process
will not take place. If you really want to modify the hash_size you
must delete all table's rows before restarting &osips;.
</para>
<para>
<emphasis>
Default value is <quote>4096</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>hash_size</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "hash_size", 1024)
...
</programlisting>
</example>
</section>
<section id="param_log_profile_hash_size" xreflabel="log_profile_hash_size">
<title><varname>log_profile_hash_size</varname> (integer)</title>
<para>
The size of the hash table internally used to store profile->dialog
associations. A larger table can provide more
parallel operations but consumes more memory. The hash size
is provided as the base 2 logarithm(e.g. log_profile_hash_size =4
means the table has 2^4 entries).
</para>
<para>
<emphasis>
Default value is <quote>4</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>hash_size</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "log_profile_hash_size", 5) #set a table size of 32
...
</programlisting>
</example>
</section>
<section id="param_rr_param" xreflabel="rr_param">
<title><varname>rr_param</varname> (string)</title>
<para>
Name of the Record-Route parameter to be added with the dialog cookie.
It is used for fast dialog matching of the sequential requests.
</para>
<para>
<emphasis>
Default value is <quote>did</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>rr_param</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "rr_param", "xyz")
...
</programlisting>
</example>
</section>
<section id="param_default_timeout" xreflabel="default_timeout">
<title><varname>default_timeout</varname> (integer)</title>
<para>
The default dialog timeout (in seconds) if no custom one is set.
</para>
<para>
<emphasis>
Default value is <quote>43200 (12 hours)</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>default_timeout</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "default_timeout", 21600)
...
</programlisting>
</example>
</section>
<section id="param_dlg_extra_hdrs" xreflabel="dlg_extra_hdrs">
<title><varname>dlg_extra_hdrs</varname> (string)</title>
<para>
A string containing the extra headers (full format, with EOH)
to be added in the requests generated by the module (like BYEs).
</para>
<para>
<emphasis>
Default value is <quote>NULL</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>dlf_extra_hdrs</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
...
</programlisting>
</example>
</section>
<section id="param_dlg_match_mode" xreflabel="dlg_match_mode">
<title><varname>dlg_match_mode</varname> (integer)</title>
<para>
How the seqential requests should be matched against the known dialogs.
The modes are a combination between matching based on a cookie (DID)
stored as cookie in Record-Route header and the matching based on SIP
elements (as in RFC3261).
</para>
<para>
The supported modes are:
</para>
<itemizedlist>
<listitem><para>
<emphasis>0 - DID_ONLY</emphasis> - the match is done
exclusively based on DID;
</para></listitem>
<listitem><para>
<emphasis>1 - DID_FALLBACK</emphasis> - the match is first
tried based on DID and if not present, it will fallback to
SIP matching;
</para></listitem>
<listitem><para>
<emphasis>2 - DID_NONE</emphasis> - the match is done
exclusively based on SIP elements; no DID information is added
in RR.
</para></listitem>
</itemizedlist>
<para>
<emphasis>
Default value is <quote>1 (DID_FALLBACK)</quote>.
</emphasis>
</para>
<para>
NOTE that if you have call looping on your OpenSIPS server (passing
more than once through the same OpenSIPS instance), it is strongly
suggested to use only DID_ONLY mode, as the SIP based matching will
have an undefined behavior - from SIP perspective, a sequential
dialog will match all the loops of the call, as the Call-ID, To and
From TAGs are the same.
</para>
<example>
<title>Set <varname>dlg_match_mode</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "dlg_match_mode", 0)
...
</programlisting>
</example>
</section>
<section id="param_db_url" xreflabel="db_url">
<title><varname>db_url</varname> (string)</title>
<para>
If you want to store the information about the dialogs in a database
a database url must be specified.
</para>
<para>
<emphasis>
Default value is <quote>&defaultdb;</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>db_url</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "db_url", "&exampledb;")
...
</programlisting>
</example>
</section>
<section id="param_db_mode" xreflabel="db_mode">
<title><varname>db_mode</varname> (integer)</title>
<para>
Describe how to push into the DB the dialogs' information from memory.
</para>
<para>
The supported modes are:
</para>
<itemizedlist>
<listitem><para>
<emphasis>0 - NO_DB</emphasis> - the memory content is not
flushed into DB;
</para></listitem>
<listitem><para>
<emphasis>1 - REALTIME</emphasis> - any dialog information
changes will be reflected into the database immediately.
</para></listitem>
<listitem><para>
<emphasis>2 - DELAYED</emphasis> - the dialog information
changes will be flushed into the DB periodically, based on a
timer routine.
</para></listitem>
<listitem><para>
<emphasis>3 - SHUTDOWN</emphasis> - the dialog information
will be flushed into DB only at shutdown - no runtime updates.
</para></listitem>
</itemizedlist>
<para>
<emphasis>
Default value is <quote>0</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>db_mode</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "db_mode", 1)
...
</programlisting>
</example>
</section>
<section id="param_db_update_period" xreflabel="db_update_period">
<title><varname>db_update_period</varname> (integer)</title>
<para>
The interval (seconds) at which to update dialogs' information if you chose to store the dialogs' info at a given interval.
A too short interval will generate intensive database operations, a too large one will not notice short dialogs.
</para>
<para>
<emphasis>
Default value is <quote>60</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>db_update_period</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "db_update_period", 120)
...
</programlisting>
</example>
</section>
<section id="param_options_ping_interval" xreflabel="options_ping_interval">
<title><varname>options_ping_interval</varname> (integer)</title>
<para>
The interval (seconds) at which OpenSIPS will generate in-dialog
OPTIONS pings for one or both of the involved parties.
</para>
<para>
<emphasis>
Default value is <quote>30</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>options_ping_interval</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "options_ping_interval", 20)
...
</programlisting>
</example>
</section>
<section id="param_reinvite_ping_interval" xreflabel="reinvite_ping_interval">
<title><varname>reinvite_ping_interval</varname> (integer)</title>
<para>
The interval (seconds) at which OpenSIPS will generate in-dialog
Re-INVITE pings for one or both of the involved parties.
</para>
<para>
<emphasis role='bold'>Important:</emphasis> the ping timeout detection
is performed every time this interval ticks, not when the re-INVITE
transaction times out! Consequently, please make sure that the
timeouts for re-INVITE transactions (e.g. the "fr_timeout"
modparam of the "tm" module or its $T_fr_timeout variable) are
always <emphasis role='bold'>lower</emphasis> than the value of this
parameter! Failing to ensure this ordering of timeouts may possibly
lead to re-INVITE pings never ending a disconnected dialog due to pings
getting retried before getting a chance to properly time out.
</para>
<para>
<emphasis>
Default value is <quote>300</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>reinvite_ping_interval</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "reinvite_ping_interval", 600)
...
</programlisting>
</example>
</section>
<section id="param_table_name" xreflabel="table_name">
<title><varname>table_name</varname> (string)</title>
<para>
If you want to store the information about the dialogs in a
database a table name must be specified.
</para>
<para>
<emphasis>
Default value is <quote>dialog</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>table_name</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "table_name", "my_dialog")
...
</programlisting>
</example>
</section>
<section id="param_call_id_column" xreflabel="call_id_column">
<title><varname>call_id_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' callid.
</para>
<para>
<emphasis>
Default value is <quote>callid</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>call_id_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "call_id_column", "callid_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_uri_column" xreflabel="from_uri_column">
<title><varname>from_uri_column</varname> (string)</title>
<para>
The column's name in the database to store the caller's
sip address.
</para>
<para>
<emphasis>
Default value is <quote>from_uri</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_uri_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_uri_column", "from_uri_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_tag_column" xreflabel="from_tag_column">
<title><varname>from_tag_column</varname> (string)</title>
<para>
The column's name in the database to store the From tag from
the Invite request.
</para>
<para>
<emphasis>
Default value is <quote>from_tag</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_tag_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_tag_column", "from_tag_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_uri_column" xreflabel="to_uri_column">
<title><varname>to_uri_column</varname> (string)</title>
<para>
The column's name in the database to store the calee's sip address.
</para>
<para>
<emphasis>
Default value is <quote>to_uri</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_uri_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_uri_column", "to_uri_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_tag_column" xreflabel="to_tag_column">
<title><varname>to_tag_column</varname> (string)</title>
<para>
The column's name in the database to store the To tag from
the 200 OK response to the Invite request, if present.
</para>
<para>
<emphasis>
Default value is <quote>to_tag</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_tag_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_tag_column", "to_tag_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_cseq_column" xreflabel="from_cseq_column">
<title><varname>from_cseq_column</varname> (string)</title>
<para>
The column's name in the database to store the cseq from caller
side.
</para>
<para>
<emphasis>
Default value is <quote>caller_cseq</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_cseq_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_cseq_column", "from_cseq_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_cseq_column" xreflabel="to_cseq_column">
<title><varname>to_cseq_column</varname> (string)</title>
<para>
The column's name in the database to store the cseq from callee
side.
</para>
<para>
<emphasis>
Default value is <quote>callee_cseq</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_cseq_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_cseq_column", "to_cseq_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_route_column" xreflabel="from_route_column">
<title><varname>from_route_column</varname> (string)</title>
<para>
The column's name in the database to store the route records from
caller side (proxy to caller).
</para>
<para>
<emphasis>
Default value is <quote>caller_route_set</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_route_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_route_column", "from_route_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_route_column" xreflabel="to_route_column">
<title><varname>to_route_column</varname> (string)</title>
<para>
The column's name in the database to store the route records from
callee side (proxy to callee).
</para>
<para>
<emphasis>
Default value is <quote>callee_route_set</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_route_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_route_column", "to_route_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_contact_column" xreflabel="from_contact_column">
<title><varname>from_contact_column</varname> (string)</title>
<para>
The column's name in the database to store the caller's contact
uri.
</para>
<para>
<emphasis>
Default value is <quote>caller_contact</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_contact_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_contact_column", "from_contact_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_contact_column" xreflabel="to_contact_column">
<title><varname>to_contact_column</varname> (string)</title>
<para>
The column's name in the database to store the callee's contact
uri.
</para>
<para>
<emphasis>
Default value is <quote>callee_contact</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_contact_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_contact_column", "to_contact_c_name")
...
</programlisting>
</example>
</section>
<section id="param_from_sock_column" xreflabel="from_sock_column">
<title><varname>from_sock_column</varname> (string)</title>
<para>
The column's name in the database to store the information about
the local interface receiving the traffic from caller.
</para>
<para>
<emphasis>
Default value is <quote>caller_sock</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>from_sock_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "from_sock_column", "from_sock_c_name")
...
</programlisting>
</example>
</section>
<section id="param_to_sock_column" xreflabel="to_sock_column">
<title><varname>to_sock_column</varname> (string)</title>
<para>
The column's name in the database to store information about the
local interface receiving the traffic from callee.
</para>
<para>
<emphasis>
Default value is <quote>callee_sock</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>to_sock_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "to_sock_column", "to_sock_c_name")
...
</programlisting>
</example>
</section>
<section id="param_dlg_id_column" xreflabel="dlg_id_column">
<title><varname>dlg_id_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs'
id information.
</para>
<para>
<emphasis>
Default value is <quote>dlg_id</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>dlg_id_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "dlg_id_column", "dlg_id_c_name")
...
</programlisting>
</example>
</section>
<section id="param_state_column" xreflabel="state_column">
<title><varname>state_column</varname> (string)</title>
<para>
The column's name in the database to store the
dialogs' state information.
</para>
<para>
<emphasis>
Default value is <quote>state</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>state_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "state_column", "state_c_name")
...
</programlisting>
</example>
</section>
<section id="param_start_time_column" xreflabel="start_time_column">
<title><varname>start_time_column</varname> (string)</title>
<para>
The column's name in the database to store the
dialogs' start time information.
</para>
<para>
<emphasis>
Default value is <quote>start_time</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>start_time_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "start_time_column", "start_time_c_name")
...
</programlisting>
</example>
</section>
<section id="param_timeout_column" xreflabel="timeout_column">
<title><varname>timeout_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' timeout.
</para>
<para>
<emphasis>
Default value is <quote>timeout</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>timeout_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "timeout_column", "timeout_c_name")
...
</programlisting>
</example>
</section>
<section id="param_profiles_column" xreflabel="profiles_column">
<title><varname>profiles_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' profiles.
</para>
<para>
<emphasis>
Default value is <quote>profiles</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>profiles_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "profiles_column", "profiles_c_name")
...
</programlisting>
</example>
</section>
<section id="param_vars_column" xreflabel="vars_column">
<title><varname>vars_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' vars.
</para>
<para>
<emphasis>
Default value is <quote>vars</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>vars_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "vars_column", "vars_c_name")
...
</programlisting>
</example>
</section>
<section id="param_sflags_column" xreflabel="sflags_column">
<title><varname>sflags_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' script flags.
</para>
<para>
<emphasis>
Default value is <quote>script_flags</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>sflags_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "sflags_column", "sflags_c_name")
...
</programlisting>
</example>
</section>
<section id="param_mflags_column" xreflabel="mflags_column">
<title><varname>mflags_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' module flags.
</para>
<para>
<emphasis>
Default value is <quote>module_flags</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>mflags_column</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("dialog", "mflags_column", "mflags_c_name")
...
</programlisting>
</example>
</section>
<section id="param_flags_column" xreflabel="flags_column">
<title><varname>flags_column</varname> (string)</title>
<para>
The column's name in the database to store the dialogs' flags.
</para>
<para>
<emphasis>
Default value is <quote>flags</quote>.
</emphasis>
</para>
<example>
<title>Set <varname>flags_column</varname> parameter</title>
<programlisting format="linespecific">