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

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

T_SVCGRP Class Definition

Overview

The T_SVCGRP class represents configuration and run-time attributes of services/groups within an application. These attribute values identify and characterize configured services/groups, and provide run-time tracking of statistics and resources associated with each object.

Both the T_SERVICE class and the T_SVCGRP class define activation time attribute settings for service names within the application. When a new service is activated (advertised), either due to initial activation of a server or due to a call to tpadvertise(), the following hierarchy exists for determining the attribute values to be used at service startup time.

If a matching configured T_SVCGRP object exists (matching service name and server group), the attributes defined in that object are used to initially configure the advertised service.

Otherwise, if a matching configured T_SERVICE object exists (matching service name), the attributes defined in that object are used to initially configure the advertised service.

Otherwise, if any configured T_SVCGRP objects are found with matching TA_SERVICENAME attribute values, the first one found is used to initially configure the advertised service.

If none of the preceding cases is used, the system defaults for service attributes are used to initially configure the advertised service.

The specification of configuration attributes for application services is completely optional, that is, services advertised by servers as they are activated will take on the established default service attribute values if configured values are not available (see above for a description of how attribute values are identified at service activation time). Service names to be offered by a server are built in at run time (see buildserver(1)) and may be overridden by the command-line options specified for a server object (see T_SERVER:TA_CLOPT and servopts(5)).

Once a T_SVCGRP object is active, it is represented solely by the T_SVCGRP class. A particular service name/group name combination may have more than one associated T_SVCGRP class at run time if there are multiple servers within the group offering the service.

Attribute Table

Table 59 TM_MIB(5): T_SVCGRP Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
`TA_SERVICENAME`(r)(*)	string	`ru-r--r--`	`string`[1..15]	N/A
`TA_SRVGRP`(r)(*)	string	`ru-r--r--`	`string`[1..30]	N/A
`TA_GRPNO`(k)	long	`r--r--r--`	1 <= `num` < 30,000	N/A
`TA_STATE`(k)	string	`rwxr-xr--`	`GET`: `"`{`ACT` \| `INA` \| `SUS` \| `PAR`}`"` `SET`: `"`{`NEW` \| `INV` \| `ACT` \| `INA` \| `SUS`}`"`	N/A N/A
`TA_AUTOTRAN`	string	`rwxr-xr--`	`"`{`Y` \| `N`}`"`	`"N"`
`TA_LOAD`	long	`rwxr-xr--`	1 <= `num` < 32,768	50
`TA_PRIO`	long	`rwxr-xr--`	1 <= `num` < 101	50
TA_BLOCKTIME	long	`rwyr--r--`	0 <= `num` < 32,768	0
`TA_SVCTIMEOUT`	long	`rwyr-yr--`	0 <= `num`	0
`TA_TRANTIME`	long	`rwxr-xr--`	0 <= `num`	30
`TA_LMID`(k)	string	`R--R--R--`	`LMID`	N/A
`TA_RQADDR`(*)	string	`R--R--R--`	`string`[1..30]	N/A
`TA_SRVID`(*)	long	`R--R--R--`	1 <= `num` < 30,001	N/A
`TA_SVCRNAM`	string	`R-XR-XR--`	`string`[1..15]	(²)
`TA_BUFTYPE`	string	`r--r--r--`	`string`[1..256]	N/A
`TA_ROUTINGNAME`	string	`r--r--r--`	`string`[0..15]	N/A
`TA_SVCTYPE`(k)	string	`r--r--r--`	`"`{`APP` \| `CALLABLE` \| `SYSTEM`}`"`	`"APP"`
T_SVCGRP Class: LOCAL Attributes
`TA_NCOMPLETED`	long	`R-XR-XR--`	0 <= `num`	N/A
`TA_NQUEUED`	long	`R--R--R--`	0 <= `num` < 32,768	N/A
(k)—`GET` key field (r)—required field for object creation (`SET TA_STATE NEW`) (*)—`GET/SET` key, one or more required for `SET` operations¹

¹SET operations on this class must specify sufficient key fields to uniquely identify the object being addressed. If the object is active, it may be necessary to augment the TA_SERVICENAME and TA_SRVGRP key fields with either TA_RQADDR or TA_SRVID. Modifications to an active object will affect that object and the related configuration record but not other active objects that may have derived their run-time attributes from the same configuration record.
²If nothing is specified for this attribute, it defaults to TA_SERVICENAME.

Attribute Semantics

TA_SERVICENAME: string[1..15]

Service name.

TA_SRVGRP: string[1..30]

Server group name. Server group names cannot contain an asterisk (*), comma, or colon. The hierarchy of the search for service attributes to be used at service activation time is described in the previous T_SVCGRP OVERVIEW section.

TA_GRPNO: 1 <= num < 30,000

Server group number.

TA_STATE:

GET: "{ACTive | INActive | SUSpended | PARtitioned}"

A GET operation will retrieve configuration and run-time information for the selected T_SVCGRP object(s). The following states indicate the meaning of a TA_STATE returned in response to a GET request.

`ACTive`	`T_SVCGRP` object is active within the server identified by the returned values for the `TA_SRVGRP` and `TA_SRVID` attributes. Attribute values returned indicate the current run-time instance of the service and may not be reflected in the configuration instance if temporary updates have been performed.
`INActive`	`T_SVCGRP` object is defined and inactive.
`SUSpended`	`T_SVCGRP` object defined, active, and currently suspended. This service is not available for access by the application in this state. This state is `ACTive` equivalent for the purpose of determining permissions.
`PARtitioned`	`T_SVCGRP` object defined, active, and currently partitioned from the master site of the application. This service is not available for access by the application in this state. This state is `ACTive` equivalent for the purpose of determining permissions.

SET: "{NEW | INValid | ACTive | INActive | SUSpended}"

A SET operation will update configuration and run-time information for the selected T_SVCGRP object. Note that run-time modifications to a service object may affect more than one active server. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

`NEW`	Create `T_SVCGRP` object for application. State change allowed only when in the `INValid` state. Successful return leaves the object in the `INActive` state. Limitation: Unconfigured services may still be active by virtue of a server advertising them. In this case, the service class state is `ACTive` and cannot be updated.
`unset`	Modify an existing `T_SVCGRP` object. This combination is not allowed in the `INValid` state. Successful return leaves the object state unchanged.
`INValid`	Delete `T_SVCGRP` object for application. State change allowed only when in the `INActive` state. Successful return leaves the object in the `INValid` state.
`ACTive`	Activate (advertise) the `T_SVCGRP` object. State change allowed only when in the `INActive`, `SUSpended` or `INValid` states. Either `TA_SRVID` or `TA_RQADDR` must be specified with this state change. For the purpose of determining permissions for this state transition, the active object permissions are considered (that is, --x--x--x). Successful return leaves the object in the `ACTive` state. Limitation: State change not permitted for service names (`TA_SERVICENAME`) beginning with the reserved string ".".
`INActive`	Deactivate the `T_SVCGRP` object. State change allowed only when in the `SUSpended` state. Successful return leaves the object in either the `INActive` (configured entries) or `INValid` (unconfigured entries) state. Limitation: State change not permitted for service names (`TA_SERVICENAME`) beginning with the reserved string "_".
`SUSpended`	Suspend the `T_SVCGRP` object. State change allowed only when in the `ACTive` state. Successful return leaves the object in the `SUSpended` state. Limitation: State change not permitted for service names (`TA_SERVICENAME`) beginning with the reserved string "`_`".

TA_AUTOTRAN: "{Y | N}"

Automatically begin a transaction ("Y") when a service request message is received for this service if the request is not already in transaction mode.

TA_LOAD: 1 <= num < 32,768

This T_SVCGRP object imposes the indicated load on the system. Service loads are used for load balancing purposes, that is, queues with higher enqueued workloads are less likely to be chosen for a new request.

TA_PRIO: 1 <= num < 101

This T_SVCGRP object has the indicated dequeuing priority. If multiple service requests are waiting on a queue for servicing, the higher priority requests will be serviced first.

TA_BLOCKTIME: 0 <= num < 32,768

Blocktime limit (in seconds) indicating the minimum amount of time a blocking ATMI call will block before timing out for this service name. The per service blocktime is applicable only when receiving a reply to the service.

If not specified, the default is 0 which indicates that the system-wide BLOCKTIME value specified in the UBBCONFIG RESOURCES section is used for the service.

TA_SVCTIMEOUT: 0 <= num

Time limit (in seconds) for processing requests for this service name. Servers processing service requests for this service will be abortively terminated (kill -9) if they exceed the specified time limit in processing the request. A value of 0 for this attribute indicates that the service should not be abortively terminated.

Limitation: This attribute value is not enforced on BEA Tuxedo release 4.2.2 sites or earlier.

TA_TRANTIME: 0 <= num

Transaction timeout value in seconds for transactions automatically started for this T_SVCGRP object. Transactions are started automatically when a request not in transaction mode is received and the T_SVCGRP:TA_AUTOTRAN attribute value for the service is "Y".

TA_LMID: LMID

Current logical machine on which an active server offering this service is running.

TA_RQADDR: string[1..30]

Symbolic address of the request queue for an active server offering this service. See T_SERVER:TA_RQADDR for more information on this attribute.

TA_SRVID: 1 <= num < 30,001

Unique (within the server group) server identification number for an active server offering this service. See T_SERVER:TA_SRVID for more information on this attribute.

TA_SVCRNAM: string[1..15]

Function name within the associated server assigned to process requests for this service. On a SET request, the server must be able to map the function name to a function using its symbol table to successfully advertise the service. In some situations (for example, direct calls to tpadvertise() by the server), the function name for an ACTive service object will not be known and the string "?" will be returned as the attribute value.

Limitation: This attribute may only be set along with a state change from INActive to ACTive.

TA_BUFTYPE: string[1..256]

Configured buffer types accepted by this service.

Limitation: This attribute is settable only via the corresponding T_SERVICE class object.

TA_ROUTINGNAME: string[0..15]

Routing criteria name.

Limitation: This attribute is settable only via the corresponding T_SERVICE class object.

TA_NCOMPLETED: 0 <= num

Number of service requests completed with respect to the retrieved ACTive or SUSpended object since it was activated (advertised).

Limitation: This attribute is returned only when the T_DOMAIN:TA_LDBAL attribute value is set to "Y".

TA_SVCTYPE: "{APP | CALLABLE | SYSTEM}"

Type of service. APP indicates an application defined service name. CALLABLE indicates a system provided callable service. SYSTEM indicates a system provided and system callable service. SYSTEM services are not available to application clients and servers for direct access. Note that when used as a GET key field, a delimited list ('|' delimiter) may be used to retrieve multiple types of service group entries on one request. By default, only APP services are retrieved.

Number of requests currently enqueued to this service. This attribute is incremented at enqueue time and decremented when the server dequeues the request. Limitation: This attribute is returned only when the T_DOMAIN:TA_LDBAL attribute value is set to "Y".

TA_NQUEUED: 0 <= num < 32,768

Number of requests currently enqueued to this service. This attribute is incremented at enqueue time and decremented when the server dequeues the request.

Limitation: This attribute is returned only when the T_DOMAIN:TA_LDBAL attribute value is set to "Y".

Limitations

None.