document var_metric usage to prevent bugreports that are actually configuration issues
[asterisk/asterisk.git] / doc / tex / realtime.tex
index 6753d32..26f937e 100644 (file)
@@ -39,6 +39,20 @@ modules that read configurations, there's no difference between a static
 file in the file system, like extensions.conf, and a configuration loaded
 from a database.
 
+You just have to always make sure the var\_metric values are properly set and
+ordered as you expect in your database server if you're using the static mode
+with ARA (either sequentially or with the same var\_metric value for everybody).
+
+If you have an option that depends on another one in a given configuration
+file (i.e, 'musiconhold' depending on 'agent' from agents.conf) but their
+var\_metric are not sequential you'll probably get default values being assigned for
+those options instead of the desired ones. You can still use the same
+var\_metric for all entries in your DB, just make sure the entries
+are recorded in an order that does not break the option dependency.
+
+That doesn't happen when you use a static file in the file system. Although
+this might be interpreted as a bug or limitation, it is not.
+
 \subsubsection{Realtime SIP friends}
 
 The SIP realtime objects are users and peers that are loaded in memory
@@ -50,6 +64,9 @@ the ones in static configuration.
 With caching, the device stays in memory for a specified time. More
 information about this is to be found in the sip.conf sample file.
 
+If you specify a separate family called "sipregs" SIP registration
+data will be stored in that table and not in the "sippeers" table.
+
 \subsubsection{Realtime H.323 friends}
 
 Like SIP realtime friends, H.323 friends also can be configured using