|
Dynamic Routing Guide
|
For controlling/configuring each DRO, you use a XML DRO configuration file, which also contains references to UM configuration files to extract needed information about the TRDs interfaced by endpoint portals.
An overview of the file format can be seen in the DRO Configuration DTD.
An XML DRO configuration file follows standard XML conventions. Element declarations or a pointer to a DTD file are not needed, as these are handled by the DRO.
An XML DRO configuration file generally comprises two primary elements: <daemon> and <portals>. Organized and contained within these are option value assignments. <daemon> sub-containers let you set options global to the DRO. <portals> sub-containers let you configure each portal in the DRO individually.
In general, the order of the elements is important. Please refer to the examples and ensure proper element ordering.
XML DRO configuration files use the high-level structure shown in the following example. This example includes only some container elements, and only some options.
The XInclude mechanism can be used to merge or share XML files for UM library configuration, Store configuration, and DRO configuration. This is typically done to avoid duplicating groups of configuration options in multiple places.
To include an external file from a DRO configuration file, use the following syntax:
Where FILEPATH can be a local file name, or a network path starting with "http:" or "ftp:". For example:
Note that secure forms of network paths ("https:" or "sftp:") are not supported.
Files to be included must be formatted such that all elements are enclosed in a single container element.
Example of an invalid file:
Example of valid file:
DRO configuration files do not support templates. It is common that groups of configuration options need to be repeated across many DRO configurations.
For example consider the DRO configuration file "dro1_conf.xml":
If this same ACL needs to be applied to many different DROs, it can be a lot of repeated content across every DRO's configuration file.
The XInclude feature can be used to reduce duplicate content by creating a second file "dro_ace.xml":
Now "dro1_conf.xml" (and others) can be coded as:
Container for all options residing in the XML DRO configuration file. This is the top-level element.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| version | The version of the DTD, which is currently. (This is not the product version.) | "1.0" - Current version of DTD. | (no default; must be specified) |
Example:
Container for all endpoint and peer portal configuration information.
Example:
Container element for all configuration options of a single peer portal.
Example:
DEPRECATED: Configures the rate at which Daemon Statistics messages are published. See daemonstatistics for general information on Daemon Statistics.
Informatica requests users to migrate to using the UM configuration file to enable automatic monitoring with Protocol Buffer monitoring format for Store and DRO by setting monitor_format (context) to "pb". See Automatic Monitoring.
Example:
Configures the rate at which one particular grouping of Daemon Statistics messages are published. See daemonstatistics for general information on Daemon Statistics.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| name | Name of statistics group being configured. | "default" - Sets a default interval for all message types. "gateway-config" - Sets the interval for messages of type tnwg_dstat_gatewaycfg_msg_t. "route-manager-topology" - Sets the interval for messages of types tnwg_rm_stat_grp_msg_t. "malloc-info" - Sets the interval for messages of type tnwg_dstat_mallinfo_msg_t. "portal-config" - Sets the interval for messages of type tnwg_pcfg_stat_grp_msg_t. "portal-stats" - Sets the interval for messages of type tnwg_dstat_portalstats_msg_t | (no default; must be specified) |
| ivl | Time, in seconds, between publishing the statistics group being configured. | string | (no default; must be specified) |
Example:
Contains parameters for the keepalive signals sent from this peer portal. This is a DRO-level keepalive, not to be confused with the TCP-level <keepalive> element.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| idle | Determines if DRO keepalives should be sent only if no traffic has been sent or received in the last interval. | "yes" - Send only if no traffic has been exchanged. "no" - Send always, even of traffic has been exchanged. | "yes" |
| interval | Minimum interval, in milliseconds, between keepalive messages sent. Informatica recommends setting this to 2000 or greater. A value of 0 (zero) disables keepalives. | string | "5000" |
| timeout | Maximum time, in milliseconds, a peer can receive nothing from the companion before determining the connection is dead and disconnecting. We recommend setting this to 3 times the interval value. | string | "15000" |
Example:
Determines timing characteristics for context name queries generated at this portal.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | Interval (in milliseconds) at which context queries are generated. Before changing the value of this option, please contact Informatica Support. | string | "300000" |
| max-contexts | Maximum number of contexts for which queries are generated at one time. Before changing the value of this option, please contact Informatica Support. | string | "20" |
| interval | Interval (in milliseconds) between groups of context queries. Before changing the value of this option, please contact Informatica Support. | string | "200" |
| timeout | Minimum time (in seconds) a context query must be unanswered before it is removed for the portal. Before changing the value of this option, please contact Informatica Support. | string | "900" |
Example:
Specifies the portal's awareness of received message sequence numbers, for the purpose of detecting duplicates.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| size | Determines the maximum number of topic (fragment) sequence numbers maintained in the window, for any given source. Must be a multiple of 8. Before changing the value of this option, please contact Informatica Support. | string | "16384" |
| increment | Determines the minimum increment, in topic (fragment) sequence numbers, by which the sequence number window is moved when the window size (below) is exceeded. Must be a multiple of 8, an even divisor of the window size, and less the window size. Before changing the value of this option, please contact Informatica Support. | string | "2048" |
Example:
Specifies the portal receiver context name.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Specifies the portal source context name.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Checks for interest in patterns at periodic intervals. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | The interval (in milliseconds) at which source pattern are checked to determine if there is no more interest. This element is deprecated and has no function. | string | "300000" |
Checks for interest in topics at periodic intervals. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | The interval (in milliseconds) at which source topics are checked to determine if there is no more interest. This element is deprecated and has no function. | string | "300000" |
Determines how long a domain remains quiescent until it is determined inactive. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| timeout | Minimum time (in seconds) domain interest for a pattern must be refreshed before interest is removed for that domain. This element is deprecated and has no function. | string | "900" |
Determines timing characteristics for interest message generation at this portal. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | Interval (in milliseconds) at which pattern interest is generated. This element is deprecated and has no function. | string | "300000" |
| max-patterns | Maximum patterns for which interest is generated at one time. This element is deprecated and has no function. | string | "300000" |
| interval | Interval (in milliseconds) between groups of patterns. This element is deprecated and has no function. | string | "200" |
Determines when this portal's proxy receivers can purge pattern. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | Interval (in milliseconds) at which receiver patterns are checked to determine if they can be purged. This element is deprecated and has no function. | string | "6000" |
Determines how long a domain remains quiescent until it is determined inactive. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| timeout | Minimum time (in seconds) domain interest for a topic must be refreshed before interest is removed for that domain. This element is deprecated and has no function. | string | "900" |
Determines timing characteristics for interest message generation at this portal. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | Interval (in milliseconds) at which topic interest is generated. This element is deprecated and has no function. | string | "300000" |
| max-topics | Maximum topics for which interest is generated at one time. This element is deprecated and has no function. | string | "20" |
| interval | Interval (in milliseconds) between groups of topics. This element is deprecated and has no function. | string | "200" |
Determines when this portal's proxy receivers can purge topics. This element is deprecated and has no function.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | Interval (in milliseconds) at which receiver topics are checked to determine if they can be purged. This element is deprecated and has no function. | string | "6000" |
Contains elements (inbound and outbound ACEs) that specify how an ACL (Access Control List) filters messages.
See Access Control Lists (ACL) for information on how ACLs work.
Example:
Container for ACE elements, to separate outbound ACEs from inbound ACEs.
See Access Control Lists (ACL) for information on how ACLs work.
Example:
Only forward messages for topics AAA and ABA.
Within an inbound or outbound ACL, you can have one or more "<ace>" elements. Each ACE (Access Control Entry) lets you match and accept or reject messages based on access control conditional elements, which are the elements contained within an "<ace>" element.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| match | This required attribute determines what to do with matched messages. | "accept" - Pass the message. "reject" - Block the message. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches the message's transport ID number (see transport_lbtipc_id (source)). This applies only to LBT-IPC transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches the message's TCP source port number (see transport_tcp_port (source)). This applies only to TCP transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches the message's UDP destination port number (see transport_lbtrm_destination_port (source)). This applies only to LBT-RM transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, matches the message's UDP source port number (see transport_lbtrm_source_port_low (context) and transport_lbtru_port (source)). This applies only to LBT-RM and LBT-RU transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches the message's multicast group address (see transport_lbtrm_multicast_address (source)). This applies only to LBT-RM transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches the message's source IP address. This applies only to TCP, LBT-RM, and LBT-RU transports.
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The xport ID number to be compared. | string | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. "lt" - Matches if less than. "lessthan" - Matches if less than. "le" - Matches if less than or equal to. "lessthanequal" - Matches if less than or equal to. "gt" - Matches if greater than. "greaterthan" - Matches if greater than. "ge" - Matches if greater than or equal to. "greaterthanequal" - Matches if greater than or equal to. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this matches a UM transport type (see transport (source)).
This conditional element can only be used in inbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| value | The transport type to be matched. | "tcp" - TCP transport. "lbt-rm" - LBT-RM transport. "lbtrm" - LBT-RM transport. "lbt-ru" - LBT-RU transport. "lbtru" - LBT-RU transport. "lbt-ipc" - IPC transport. "lbtipc" - IPC transport. | (no default; must be specified) |
| comparison | Defines a match condition. | "eq" - Matches if equal. "equal" - Matches if equal. "ne" - Matches if not equal. "notequal" - Matches if not equal. | (no default; must be specified) |
Example:
Defines a condition used in an ACE. Specifically, this is a match pattern for one or more topics using a POSIX regular expression.
This element is deprecated. Please use <pcre-pattern> .
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Defines a condition used in an ACE. Specifically, this is a match pattern for one or more topics using a Perl Compatible Regular Expression (PCRE).
This conditional element can be use in both inbound and outbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example 1:
This example will match patterns "ABC", "ABC789", and "ABC". It will not match "abc" or "123ABC".
Example 2:
In this example, match any topic that has one or more spaces anywhere in the topic name. Note that the "xml:space" attribute defaults to "default", which trims leading and trailing spaces. Therefore that attribute must set to "preserve", and the pattern must be combined onto a single line (to avoid newlines in the pattern):
Defines a condition used in an ACE. Specifically, this matches a topic name.
This conditional element can be use in both inbound and outbound ACLs.
See Access Control Lists (ACL) for information on how ACLs work.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example 1:
Accept messages for topic "ABC":
Example 2:
To match a topic name that includes a trailing space, you must use the change the xml:space attribute value:
Container for ACE elements, to separate inbound ACEs from outbound ACEs.
See Access Control Lists (ACL) for information on how ACLs work.
Example:
Container for individual UM-option-setting elements. It lets you set individual UM attributes without referencing a UM configuration file. These values override any values set via files referenced by <lbm-config>.
Example:
Lets you set an individual UM configuration option without referencing a UM configuration file. This value overrides any values set via files referenced by <lbm-config>.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| scope | The type of object to which an option can apply. | "receiver" - Receiver option. "context" - Context option. "source" - Source option. "wildcard_receiver" - Wildcard Receiver option. "event_queue" - Event queue option. | (no default; must be specified) |
| name | The name of the option. | attr_name | (no default; must be specified) |
| value | The value for the option. | string | (no default; must be specified) |
Example:
Specifies the UM configuration file that contains configuration options associated with this portal.
Note that as of UM version 6.13, if one or more errors are discovered in the UM configuration file, the errors are written to the log file and the DRO continues running. I.e. errors in the UM configuration file are treated as warnings. See Configuration Error Handling for an explanation.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Contains batching size and timing parameters for peer link implicit batching. This applies to data messages only: the DRO sends control messages immediately (flushing any batched data messages). Note: worst-case latency can be dramatically reduced by combining batching with <smart-batch>.
Example:
Specifies the maximum interval (in milliseconds) between when the first message of a batch is queued until the batch is sent. A message stays in the batch queue until this value or <min-length> is met or exceeded (whichever occurs first). The minimum allowed value is 3 milliseconds.
If not specified, it defaults to 200 milliseconds.
Example:
Specifies the minimum length of a set of batched messages. When the total length of the batched messages reaches or exceeds this value, the batch is sent.
If not specified, it defaults to 8192 bytes.
Example:
Specifies the maximum datagram size a peer portal will allow the peer link batcher to construct.
Note that this does not actually limit the size of the datagrams that can transit the peer link, it only limits the batching. For example, if this element is set to 4,000 and a series of 1K messages are sent, approximately 4 messages will be batched (depending on overhead) and forwarded across the peer link. However, if an 8K message is sent, it will be forwarded across the peer link as an 8K datagram.
Before changing the value of this option, please contact Informatica Support.
If not specified, it defaults to 65500, which is also the maximum allowable value.
Example:
Enables the smart batching algorithm used by the DRO when forwarding messages from one portal to another. Possible values are 0 (disable) and 1 (enable).
If not specified, it defaults to 0 (disabled).
In general, batching algorithms are used to increase throughput, but many such algorithms can produce latency outliers. The Smart Batching algorithm is designed to ensure low latencies by flushing the batching buffer when no more messages are waiting to be sent out the portal.
Smart batching works with both endpoint and peer portals. For endpoint portals, a UM configuration file may be provided to set the implicit_batching_minimum_length (source) option to a large value. For peer portals, the <batching> element may be used to set the <min-length> to a large value. In either case, large values are recommended and will not produce significant latency outliers.
Example:
Sets the maximum buffer size for blocking messages.
If not specified, this defaults to 1000000 bytes.
Example:
Sets the time in milliseconds to wait after a source is detected as deleted before deleting the proxy source. Applies to both endpoint and peer portals.
Sources can be detected as being deleted by an EOS event at an endpoint portal, or by a route map change. Note that a route map change could be due to failure of a DRO or link within a network.
If not specified, source-deletion-delay defaults to 1000 milliseconds.
Example:
Enables the UDP Peer Link functionality.
Adds a UDP-based protocol, similar to Transport LBT-RU, to the peer link for message data. Note that the Router Element "<single-tcp>" is still needed for command and control of the peer link.
At a minimum you must configure the port number using Router Element "<port>". Note that the port number supplied under "<udp>" is independent from the port number supplied under <single-tcp>.
Example:
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| attempt-interval | Time, in milliseconds, between connect retry attempts. | string | "200" |
| max-attempts | Number of times the UDP link will be retried before the portal gives up and re-initializes. Note that when the portal re-initializes, the initiator will again try to start both the TCP and the UDP links. | string | "10" |
Controls the algorithms used to establish a connection for the UDP Peer Link. This element has no base value, but has several attributes that control the connection algorithms.
Example:
Controls the sending of session (keep alive) messages for the UDP Peer Link. This element has no base value, but has several attributes that control the session messages.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| min-interval | The minimum time in milliseconds between session messages. Corresponds to transport_lbtru_sm_minimum_interval (source). | string | "200" |
| max-interval | The maximum time in milliseconds between session messages. Corresponds to transport_lbtru_sm_maximum_interval (source). | string | "10000" |
| activity-timeout | The time in milliseconds during which a lack of messages (data or session) indicates that the connection is terminated. Corresponds to transport_lbtru_activity_timeout (receiver). | string | "60000" |
Example:
Controls the algorithms used to repair lost datagrams for the UDP Peer Link. This element has no base value, but has several attributes that control the NAK algorithms.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| initial-backoff-interval | The interval in milliseconds between the detection of loss and the transmission of the first NAK. Corresponds to transport_lbtru_nak_initial_backoff_interval (receiver). | string | "0" |
| backoff-interval | The maximum interval in milliseconds between NAKs for a given datagram, after the first NAK. Corresponds to transport_lbtru_nak_backoff_interval (receiver). | string | "200" |
| suppress-interval | The time in milliseconds that peer link receiver will suppress sending a NAK for a given missing datagram after an NCF is received from the peer. Corresponds to transport_lbtru_nak_suppress_interval (receiver). | string | "1000" |
| generation-interval | The maximum time in milliseconds that a lost datagram may be outstanding before the datagram is declared unrecoverable. Corresponds to transport_lbtru_nak_generation_interval (receiver). | string | "10000" |
| send-naks | Controls the sending of NAKs for missing packets. Corresponds to transport_lbtru_send_naks (receiver). | "yes" - Send NAKs to recover missing packets. "no" - Do not send NAKs to recover missing packets. (Missing packets will not be recovered.) | "yes" |
| ignore-interval | The interval in milliseconds that a sender will ignore additional NAKs after a retransmission is sent. Corresponds to transport_lbtru_ignore_interval (source). | string | "100" |
Example:
Controls the rate limiter for the UDP Peer Link. This element has no base value, but has several attributes that control the rate limiter.
Note that each peer portal of a DRO that uses a UDP peer link has an independent rate limiter. I.e. traffic sent on one peer link does not count against the rate limiter for a different peer link.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| data | Maximum transmission rate (in bits per second) for the UDP data sent by this peer portal, including internal overhead bytes. Corresponds to transport_lbtru_data_rate_limit (context). | string | "10000000" |
| retransmit | Maximum transmission rate (in bits per second) for the UDP data re-sent by this peer portal, including internal overhead bytes. Data is re-sent if it is lost and the peer requests retransmission by sending NAKs. Corresponds to transport_lbtru_retransmit_rate_limit (context). | string | "5000000" |
| interval | Period (in milliseconds) that the UDP peer link rate limiter runs. Corresponds to transport_lbtru_rate_interval (context). | string | "100" |
Example:
Controls the UDP Peer Link memory buffer used to retransmit datagrams that are lost/dropped. This element has no base value, but has several attributes that control the transmission window.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| size | Number of bytes of user message data to store in the transmission window, not including internal overhead bytes. Corresponds to transport_lbtru_transmission_window_size (source). | string | "25165824" |
| limit | Limit on memory used by transmission window, including internal overhead bytes. Value of 0 indicates no limit (but the "size" attribute imposes its own limit). Corresponds to transport_lbtru_transmission_window_limit (source). | string | "0" |
Example:
Sets the coalesce threshold for the UDP Peer Link.
Corresponds to transport_lbtru_coalesce_threshold (source).
This should normally be left at its default (15).
Example:
Enables the Receive Multiple Datagrams feature for the UDP Peer Link and specifies the maximum number of datagrams to read at a time.
See multiple_receive_maximum_datagrams (context) for more details.
Note that each peer portal of a DRO that uses a UDP peer link has an independent setting for multiple-receive-max-datagrams. I.e. different portals can have different values configured.
If not specified, the default value is 0, which disables receiving multiple datagrams.
For high-throughput applications, Informatica recommends setting this between 10 and 100 (larger values will consume more memory).
Example:
Contains the size of the send-side socket buffer.
The default value depends on the parent element:
Example:
Contains the size of the receive-side socket buffer.
The default value depends on the parent element:
Example:
Used by the peer link for both <single-tcp> and the optional <udp> elements.
For TCP, contains the IP port used by the initiator to connect to the acceptor portal's Router Element "<listen-port>".
For UDP, contains the IP port that the portal uses for both incoming and outgoing data.
The TCP and UDP ports are independent of each other.
(As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)
Example:
Contains elements for a peer portal's tcp settings, when configuring the peer.
Note: the term "single-tcp" is an unfortunate artifact from earlier versions of UM that also supported a dual TCP peer link. That feature was eliminated, leaving "single-tcp" as the only available type of peer link. The name "single-tcp" does not imply "tcp-only"; the optional Router Element "<udp>" is available under <single-tcp>.
Example:
Contains the listen port address of the corresponding acceptor peer portal on another DRO, to which this peer is connected. This element is used in single-tcp peer configurations.
Example:
Contains port number on which an acceptor peer portal listens for connections from the initiating peer portal. There is no default for the port number, the initiating peer portal configuration must specify this port as its initiator port.
Example:
Contains the IP address and the port of the corresponding acceptor peer portal on another DRO, to which this peer is connected. This element is used in single-tcp peer configurations.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| reconnect-interval | The time interval, in milliseconds, to wait before reconnecting to the companion portal if this connection is interrupted. | string | "5000" |
Example:
Contains the IP address of the acceptor peer portal on another DRO, to which this initiator peer is connected via "single TCP". (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)
Example:
Contains elements to configure TCP-only peer link encryption.
Example:
Defines the list of one or more (comma separated) names of cipher suites that the context will accept. See OpenSSL's Cipher Suite Names for the full list of suite names. When configuring UM, use the OpenSSL names (with dashes), not* the IANA names (with underscores).
If more than one suite name is supplied, they should be in descending order of preference. When a remote context negotiates encrypted TCP, the two sides must find a cipher suite in common, otherwise the connection will be canceled.
The default is highly secure and is recommended.
Example:
Specifies the path to a file containing one or more OpenSSL-compatible PEM-formatted TLS client certificates and certificate authorities. If this element is not supplied, the default behavior is to use the system-level trusted certificates and certificate authorities (operating-system dependent). The TLS server uses these trusted certificates to verify the identity of connecting clients. If a client connects and presents a certificate which is not in the server's trusted certificates file, the connection will be canceled.
Example:
Specifies the passphrase needed to decrypt the server private key file specified by <certificate-key>.
Example:
Specifies the path to a file containing the private key associated with the "server" certificate specified by <certificate>. Note that this private key must be protected from intruders. For that reason, when the certificate and private key files are generated, the private key file is typically encrypted with a passphrase. The passphrase is supplied using <certificate-key-password>.
Example:
Specifies the path to a file containing an OpenSSL-compatible PEM-formatted certificate that will be presented as the TLS server certificate when a TLS connection is established by a client.
Example:
Enables compression and sets the desired data compression algorithm for the TCP-only peer link. Currently, only LZ4 lossless data compression is supported.
If not specified, no compression is used.
Example:
Enables setting the TCP_NODELAY socket option on the peer link. Setting TCP_NODELAY disables Nagle's algorithm, which somewhat decreases the efficiency and throughput of TCP, but decreases the latency of individual messages.
By default, TCP_NODELAY is not set (maximizes efficiency).
Example:
When present, enables a TCP keepalive signal transmission, which is disabled by default.
Example:
Contains the IP host or network address for this peer portal, specified in dotted-decimal or CIDR format.
Example:
DEPRECATED AND ELIMINATED AS OF UM 6.10. DO NOT USE. Contains elements for a peer portal's "dual TCP" settings. (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)
DEPRECATED AND ELIMINATED AS OF UM 6.10. DO NOT USE. Contains the IP address and the port of the companion peer portal on another DRO, to which this peer is connected via "dual TCP". (As of UM version 6.10, dual TCP (<tcp>) is no longer supported. Please use <single-tcp> instead.)
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| reconnect-interval | string |
Sets the size of the peer portal's source map. This normally does not need to be modified, but if very large numbers of topics are being used, a larger value might improve efficiency.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| size | Number of entries in the source map. Value must be a power of 2 (e.g., 1024, 2048, ...). | string | "131072" |
Example:
Assigns a positive non-zero integer cost to the portal.
If not specified, it defaults to 1. See Forwarding Costs.
Example:
Lets you set a name for this DRO (do not duplicate for any other known DROs), or for the name of an endpoint or peer portal. Each portal name must be unique within the DRO.
If not specified, no name is assigned.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Container element for all configuration options of a single endpoint portal.
Example:
Determines timings and limits for determination of continued pattern interest at this portal.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| check-interval | Interval (in milliseconds) between checking individual patterns for continued interest. Before changing the value of this option, please contact Informatica Support. | string | "90000" |
| max-patterns | Maximum number of patterns to check at a time. Before changing the value of this option, please contact Informatica Support. | string | "100" |
| timeout | Minimum time (in milliseconds) remote interest for a pattern must be refreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. | string | "300000" |
Example:
Determines timings and limits for determination of continued topic interest at this portal.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| check-interval | Interval (in milliseconds) between checking individual topics for continued interest. Before changing the value of this option, please contact Informatica Support. | string | "90000" |
| max-topics | Maximum number of topics to check at a time. Before changing the value of this option, please contact Informatica Support. | string | "100" |
| timeout | Minimum time (in milliseconds) remote interest for a topic must be refreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. | string | "300000" |
Example:
DEPRECATED AND ELIMINATED. DO NOT USE. Determines how Late Join is handled by this endpoint portal.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| provide | "source""always""never" | ||
| forward | "yes""no" |
Container for DRO topic resolution behavior options.
Example:
Sets interval and duration for initial topic resolution requests.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| periodic-interval | The interval at which the initial topic resolution requests are sent. Before changing the value of this option, please contact Informatica Support. | string | "1000" |
| duration | The minimum duration for which the initial topic resolution requests are sent. Before changing the value of this option, please contact Informatica Support. | string | "10" |
Example:
Sets maximum and minimum limits for the interval between periodic domain route messages being sent for each remote domain that the portal is servicing.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| min-interval | The minimum interval, in milliseconds, between domain route messages being sent for each domain. | string | "100" |
| max-interval | The maximum interval, in milliseconds, between domain route messages being sent for each domain. | string | "1000" |
Example:
Sets rate limits for topic resolution data sent over the network.
You can set rate limits individually for each of the topic resolution message types (see children elements).
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| bps | The limit in Bits per Second that data will be sent on the network. A value of 0 disables limiting by bits per second. Before changing the value of this option, please contact Informatica Support. | string | "500000" (For use queries and interest messages) |
| objects-per-second | The limit in Objects per Second that data will be sent on the network. A value of 0 disables limiting by objects per second. Before changing the value of this option, please contact Informatica Support. | string | "500" (For use queries) |
Example:
Sets parameters for when and how often this endpoint portal sends pattern interest messages
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| min-interval | The minimum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. | string | "1000" |
| max-interval | The maximum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. | string | "60000" |
Example:
Sets parameters for when and how often this endpoint portal sends topic interest messages.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| min-interval | The minimum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. | string | "1000" |
| max-interval | The maximum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. | string | "60000" |
Example:
Sets parameters for when and how often this endpoint portal sends pattern use queries.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| timeout | The maximum time, in milliseconds, to wait for a pattern use response. Before changing the value of this option, please contact Informatica Support. | string | "3000" |
| max | Maximum number of pattern use queries to send for a given pattern, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. | string | "5" |
| periodic-interval | The interval, in milliseconds, between periodic pattern use queries being sent for each pattern the portal has interest in. Before changing the value of this option, please contact Informatica Support. | string | "300000" |
Example:
Sets parameters for when and how often this endpoint portal sends topic use queries.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| timeout | The maximum time, in milliseconds, to wait for a topic use response. Before changing the value of this option, please contact Informatica Support. | string | "3000" |
| max | Maximum number of topic use queries to send for a given topic, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. | string | "5" |
| periodic-interval | The interval, in milliseconds, between periodic topic use queries being sent for each topic the portal has interest in. Before changing the value of this option, please contact Informatica Support. | string | "300000" |
Example:
Identifies the TRD for this endpoint portal. It must be unique within the DRO (which means that for any TRD, you can assign only one endpoint portal per DRO). Also, all endpoints interfacing a given TRD must have the same <domain-id> value.
There is no default, it must be supplied.
Example:
Container for options common to the entire DRO process.
Example:
Lets you set timing parameters for DRO rerouting route calculation behavior.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| backoff-interval | How long, in milliseconds, the DRO waits after the last detected change in topology before initiating a route recalculation. | string | "5000" |
| warning-interval | How long, in milliseconds, the DRO waits before warning that a route recalculation is being held up due to a non-converging topology. | string | "10000" |
Example:
Lets you set control parameters for DRO initial route setup (or reroute) behavior.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| propagation-interval | The time interval between route information messages that the DRO sends to other DRO. | string | "1000" |
| check-interval | How often the DRO checks to see if a route information message needs to be sent, a DRO has timed out, and/or the routes need to be recalculated. | string | "750" |
| timeout | How long a DRO waits after receiving no route information messages from another DRO before determining that that DRO is out of service or unreachable. | string | "4000" |
| max-hop-count | The maximum number of DROs a route information message can traverse before being discarded. | string | "100" |
Example:
Specifies the UM XML configuration file.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
DEPRECATED AND ELIMINATED. DO NOT USE. Specifies the difference between the shortest and longest propagation delays in the network.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| delta | string |
DEPRECATED: Configures the Daemon Statistics feature. See daemonstatistics for general information on Daemon Statistics.
Informatica requests users to migrate to using the UM configuration file to enable automatic monitoring with Protocol Buffer monitoring format for Store and DRO by setting monitor_format (context) to "pb". See Automatic Monitoring.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| topic | Topic name to use for publishing Daemon Statistics. | string | "tnwgd.monitor" |
Example:
Configures whether the DRO will respond to monitoring apps requests to change the rate at which Daemon Statistics messages are published. See daemonstatistics for general information on Daemon Statistics.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| allow | Enable or disable change requests. | "0" - Ignore change requests. "1" - Respond to change requests. | "0" |
Example:
Configures whether the DRO will respond to monitoring apps requests to send on-demand snapshots of daemon statistics. See daemonstatistics for general information on Daemon Statistics.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| allow | Enable or disable snapshot requests. | "0" - Ignore snapshot requests. "1" - Respond to snapshot requests. | "0" |
Example:
Identifies the address for the web monitor, in the form of interface:port. You can use "*" to specify the local host.
Omit this element to disable the web monitor.
See Webmon Security for important security information.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Container for UM Transport monitoring configuration elements.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| interval | Monitoring interval, in seconds. 0 disables monitoring. | string | "0" |
Example:
Provides specifics about the monitoring format module.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| module | Selects the message formatting module. See Monitoring Formats. | "csv" - Comma-separated values. "pb" - Google Protocol Buffers. | "csv" |
| options | Option string to be passed to the formatting module. Available option is "separator" (defaults to comma). | string | (if omitted, no options are passed to the formatting module) |
Example:
Specifies characteristics about the monitoring transport module used.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| module | Selects the message transport module. | "lbm" - Publish messages via standard UM source. "lbmsnmp" - Publish messages via standard UM source with special settings intended for the UM SNMP agent. "udp" - Publish messages as simple UDP datagrams. | "lbm" |
| options | Option string to be passed to the transport module. Available options are "config" (configuration file pathname) and "topic" (the topic name to use for sending and receiving statistics; defaults to "/29west/statistics"). | string | (if omitted, no options are passed to the transport module) |
Example 1:
Example 2:
Monitoring configuration options can be supplied directly in the XML.
Determines characteristics of the internal topic resolution maps for wildcard patterns.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| hash-function | Topic resolution hash function to use. Informatica recommends the default. See resolver_string_hash_function (context) for more information. | "classic" - UM's original hash function. May be better for certain specialized topic names. "djb2" - The Dan Bernstein algorithm from comp.lang.c. May be better for topic names have a changing prefix with a constant suffix. "sdbm" - Sdbm database library (used in Berkeley DB). May be better for certain specialized topic names. "murmur2" - Good all-around hash function by Austin Appleby. | "murmur2" |
| size | Number of buckets in hash table. Should be a prime number. | string | "131111" |
Example:
Determines characteristics of the internal topic resolution maps for topic names.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| hash-function | Topic resolution hash function to use. Informatica recommends the default. See resolver_string_hash_function (context) for more information. | "classic" - UM's original hash function. May be better for certain specialized topic names. "djb2" - The Dan Bernstein algorithm from comp.lang.c. May be better for topic names have a changing prefix with a constant suffix. "sdbm" - Sdbm database library (used in Berkeley DB). May be better for certain specialized topic names. "murmur2" - Good all-around hash function by Austin Appleby. | "murmur2" |
| size | Number of buckets in hash table. Should be a prime number. | string | "131111" |
Example:
Specifies the UM license file's pathname.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Contains the pathname for daemon process ID (PID) file.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Specifies a Group ID (GID) for daemon process (if run as root).
Example:
Specifies a User ID (UID) for the daemon process (if run as root).
Example:
Specifies the destination for DRO log messages. If you set the type for "file", use this element to contain the full pathname.
XML Attributes:
| Attribute | Description | Valid Values | Default Value |
|---|---|---|---|
| type | Method of writing logs. | "file" - Write log to disk file. "syslog" - Write log to Unix "syslog". "console" - Write log to standard out. | "console" |
| frequency | Frequency by which to roll log file. Only applies for type="file". | "disable" - Do not roll log file. "daily" - Roll log file at midnight. "hourly" - Roll log file after approximately an hour, but is not exact and can drift significantly over a period of time. "test" - For Informatica internal use only. Do not use. | "disable" |
| size | Number of millions of bytes of file size to roll log file. E.g. a value of 1 rolls after 1000000 bytes. Maximum value is 4000. Value of 0 disables rolling by file size. Only applies for type="file". | string | "0" |
| xml:space | Specifies how whitespace (tabs, spaces, linefeeds) are handled in the element content. See xml:space Attribute. | "default" - Trim whitespace. "preserve" - Retain whitespace exactly as entered. | default |
Example:
Here is the XML configuration DTD with the comments removed. To see the DTD with comments included, enter tnwgd --dump-dtd.