Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference

File Formats, Data Descriptions, MIBs, and System Processes Reference

T_DM_ROUTING Class Definition

Overview

The T_DM_ROUTING class represents routing criteria information for routing requests to a domain through a remote domain access point.

Attribute Table

Table 23 DM_MIB(5): T_DM_ROUTING Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
TA_DMROUTINGNAME(r)(k)(*)	string	`rw-r--r--`	`string`[1..15]	N/A
TA_DMBUFTYPE(r)(k)(*)	string	`rw-r--r--`	`string`[1..256]	N/A
TA_DMFIELD(r)	string	`rw-r--r--`	`string`[1..30]	N/A
TA_DMFIELDTYPE	string	`rw-r--r--`	`"`{`CHAR` \| `SHORT` \| `LONG` \| `FLOAT` \| `DOUBLE` \| `STRING`}`"`	N/A
TA_DMRANGES(r)	string	`rw-r--r--`	`string`[1..4096]	N/A
TA_STATE(r)	string	`rw-r--r--`	`GET`: `"VAL"` `SET`: `"`{`NEW` \| `INV`}`"`	N/A N/A
(r)—required when a new object is created (k)—a key field for object retrieval (*)—a required key field for all `SET` operations on the class

Attribute Semantics

TA_DMROUTINGNAME: string[1..15]

The name of the routing criteria table entry—an identifier unique within the scope of T_DM_ROUTING entries in the Domains configuration.

TA_DMBUFTYPE: string[1..256]

"type1[:subtype1[,subtype2 . . . ]][;type2[:subtype3[,subtype4 . . . ]] . . . ]"

List of types and subtypes of data buffers for which this routing entry is valid. A maximum of 32 type/subtype combinations is allowed. The types are restricted to the following: FML, FML32, XML, VIEW, VIEW32, X_C_TYPE, or X_COMMON. No subtype can be specified for type FML, FML32, or XML; subtypes are required for types VIEW, VIEW32, X_C_TYPE, and X_COMMON ("*" is not allowed). Note that subtype names should not contain semicolon, colon, comma, or asterisk characters. Duplicate type/subtype pairs cannot be specified for the same routing criterion name; more than one routing entry can have the same criterion name as long as the type/subtype pairs are unique. If multiple buffer types are specified for a single routing entry, the data types of the routing field for each buffer type must be the same.

TA_DMFIELD: string[1..30]

The name of the field to which routing is applied.

For FML (and FML32) buffer types, TA_DMFIELD contains an FML field name that must be defined in an FML field table. When routing is performed, the field name is retrieved using the FLDTBLDIR and FIELDTBLS (FLDTBLDIR32 and FIELDTBLS32 for FML32) environment variables.

For VIEW (and VIEW32) buffer types, TA_DMFIELD contains a VIEW field name that must be defined in an FML VIEW table. When routing is performed, the field name is retrieved using the VIEWDIR and VIEWFILES (VIEWDIR32 and VIEWFILES32 for VIEW32) environment variables.

When routing a buffer to its correct remote domain access point, the appropriate table is used to get the data-dependent routing field value within a buffer.

For an XML buffer type, TA_DMFIELD contains either a routing element type (or name) or a routing element attribute name.

The syntax of the TA_DMFIELD attribute for an XML buffer type is as follows:

"root_element[/child_element][/child_element]
[/. . .][/@attribute_name]"

The element is assumed to be an XML document or datagram element type. Indexing is not supported. Therefore, the BEA Tuxedo system recognizes only the first occurrence of a given element type when processing an XML buffer for data-dependent routing. This information is used to get the associated element content for data-dependent routing while sending a message. The content must be a string encoded in UTF-8.

The attribute is assumed to be an XML document or datagram attribute of the defined element. This information is used to get the associated attribute value for data-dependent routing while sending a message. The value must be a string encoded in UTF-8.

The combination of element name and attribute name may contain up to 30 characters.

The type of the routing field can be specified by the TA_DMFIELDTYPE attribute.

TA_DMFIELDTYPE: "{CHAR | SHORT | LONG | FLOAT | DOUBLE | STRING}"

The type of the routing field specified in the TA_DMFIELD attribute. The type can be CHAR, SHORT, LONG, FLOAT, DOUBLE, or STRING; only one type is allowed. This attribute is required if TA_DMBUFTYPE is XML; it must be absent if TA_DMBUFTYPE is FML, VIEW, X_C_TYPE, or X_COMMON.

TA_DMRANGES: string[1..4096]

The ranges and associated remote domain access points for the TA_DMFIELD routing field. The format of the string is a comma-separated, ordered list of range/group name pairs. A range/group name pair has the following format:

"lower[-upper]:raccesspoint"

lower and upper are signed numeric values or character strings in single quotes. lower must be less than or equal to upper. To embed a single quote in a character string value, it must be preceded by two backslashes (for example, 'O\\'Brien'). The value MIN can be used to indicate the minimum value for the data type of the associated field on the machine. The value MAX can be used to indicate the maximum value for the data type of the associated field on the machine. Thus, "MIN--5" is all numbers less than or equal to -5, and "6-MAX" is all numbers greater than or equal to 6.

The meta-character "*" (wildcard) in the position of a range indicates any values not covered by the other ranges previously seen in the entry. Only one wildcard range is allowed per entry and it should be last (ranges following it are ignored).

A numeric routing field must have numeric range values, and a string routing field must have string range values.

String range values for string, carray, and character field types must be placed inside a pair of single quotes and cannot be preceded by a sign. Short and long integer values are a string of digits, optionally preceded by a plus or minus sign. Floating point numbers are of the form accepted by the C compiler or atof(3): an optional sign, then a string of digits optionally containing a decimal point, then an optional e or E followed by an optional sign or space, followed by an integer.

The raccesspoint parameter indicates the remote domain access point to which the request is routed if the field matches the range. A raccesspoint of "*" indicates that the request can go to any remote domain access point that imports the desired service.

TA_STATE:

GET: "{VALid}"

A GET operation retrieves configuration information for the T_DM_ROUTING object. The following state indicates the meaning of a TA_STATE attribute value returned in response to a GET request. States not listed are not returned.

"VALid"

The object exists.

SET: "{NEW | INValid}"

A SET operation updates configuration information for the selected T_DM_ROUTING object. The following states indicate the meaning of TA_STATE in a SET request. States not listed may not be set.

`"NEW"`	A new object is created.
`unset`	Modify an existing object. This combination is not allowed in the `"INValid"` state. Successful return leaves the object state unchanged.
`"INValid"`	The object is deleted.

Limitations

You cannot delete an instance of the T_DM_ROUTING class if it is referenced by an instance of the T_DM_IMPORT class.