com.ibm.cics.model

Interface ITransactionGroup

    • Method Detail

      • getName

        java.lang.String getName()
        Getter for field NAME

        Name

        The name of the transaction group.

        Specified by:
        getName in interface ICICSObject
      • getAffinityRelation

        ITransactionGroup.AffinityRelationValue getAffinityRelation()
        Getter for field AFFINITY

        Affinity relationship

        The affinity relationship to be used when processing transactions in this transaction group. The affinity relationship values are:

        • Global - All users at all terminals.
        • Luname - Terminal logical unit name.
        • Userid - User ID.
        • Bappl - CICS BTS business application.
        • Locked - LOCKED affinities can arise only between dynamically linked programs. A LOCKED affinity is created when a called program retains state data that is to be preserved after returning to its caller. Programs with this type of affinity are routed to the same target region until end of unit of work occurs. LOCKED can be used only for dynamic program link (DPL) requests with an associated affinity lifetime of UOW.
        • N_a - No affinity relationship is defined

        If this field is blank, no affinity relation was defined.

        This field and the Affinity Lifetime field are closely related. If you update this value, make sure an appropriate lifetime value is also specified.

      • getAffinityLifetime

        ITransactionGroup.AffinityLifetimeValue getAffinityLifetime()
        Getter for field AFFLIFE

        Affinity lifetime

        The affinity lifetime to be used when processing transactions in this transaction group. The affinity lifetime values are:

        • Delimit - Until the pseudoconversation mode is END.
        • Logon - For the duration of the terminal session.
        • Pconv - For the duration of the pseudo conversation.
        • Permanent - As long as the workload is active.
        • Signon - As long as the user session is active.
        • System - As long as the AOR to which transactions are routed is active.
        • Activity - As long as the CICS BTS activity is active.
        • Process - As long as the CICS BTS process is active.
        • Uow - For as long as the unit-of-work is active
        • N_a - No affinity lifetime is defined

        If this field is blank, no affinity lifetime was defined.

        This field and the Affinity Relation field are closely related. If you update this value, make sure an appropriate affinity relation value is also specified.

      • getMatchKey

        ITransactionGroup.MatchKeyValue getMatchKey()
        Getter for field MATCH

        Primary search criterion

        Identifies whether the user name (USERID) or the logical unit name (LUNAME) is to be used as the primary search criteria for transactions associated with the transaction group.

      • getStatus

        ITransactionGroup.StatusValue getStatus()
        Getter for field STATE

        Transaction group status

        Indicates how an AOR is to be selected for transactions associated with the transaction group:

        • ACTIVE - Selects an AOR from the AOR scope identified with the associated workload definition.
        • DORMANT - Uses the AOR associated with the transaction when it was defined to CICS.

      • getDescription

        java.lang.String getDescription()
        Getter for field DESC

        Description

        A description of the transaction group.

      • getRtaEvent

        java.lang.String getRtaEvent()
        Getter for field EVENTNAME

        RTA event

        The name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect transactions associated with this transaction group. If a real-time analysis event is generated by this definition, WLM uses the information to select the best routing for those transactions.

        If this field is blank, no analysis or status definition is associated with the transaction group.

      • getAbendProbability

        java.lang.Long getAbendProbability()
        Getter for field ABENDCRIT

        Acceptable level of abend probability

        The abend probability for a transaction associated with the default transaction group that should cause a target region to be considered unhealthy.

      • getAbendLoadLevel

        java.lang.Long getAbendLoadLevel()
        Getter for field ABENDTHRESH

        Acceptable abend load threshold

        The abend probability for a transaction associated with the default transaction group that should cause a target region's load level to be doubled.

      • getCreateAffinity

        ITransactionGroup.CreateAffinityValue getCreateAffinity()
        Getter for field AFFAUTO

        Automatic affinity creation

        Indicates whether CICSPlex SM is to automatically create an affinity relationship for transactions associated with the transaction group.

        • YES - An affinity is created using the values in the Affinity Relation and Affinity Lifetime fields.
        • NO - An affinity is not automatically created (but can be created by a customized version of the dynamic routing program EYU9WRAM).
        • N/A - There are no values in the Affinity Relation and Affinity Lifetime fields, therefore, no affinity is created.
      • getAlgorithmType

        ITransactionGroup.AlgorithmTypeValue getAlgorithmType()
        Getter for field ALGTYPE

        Algorithm type

        The algorithm to be used when selecting the best target region in the Target Scope to which a transaction in the current transaction group should be routed. Valid options are:

        • QUEUE - Route the transaction to the target region with best combination of:
          • Health (MaxTask, Short-on-storage, Dumping, Stalled)
          • Task queue depth (or load)
          • Link speed from the routing region
          • Abend probability, when calculated
          • RTA event impact, when defined
        • LNQUEUE - (Link Neutral Queue) Route the transaction to the target region with best combination of:
          • Health (MaxTask, Short-on-storage, Dumping, Stalled)
          • Task queue depth (or load)
          • Abend probability, when calculated
          • RTA event impact, when defined
          Note - The link speed from the router to the target is not factored into the routing weight calculation for the LNQUEUE algorithm
        • GOAL - Route the transaction to the target region that:
          • Is the most likely to allow the transaction to meet the response time goal set for it and other transactions in its z/OS workload management class
            • When a specific target cannot be identified, apply the QUEUE algorithm to the remaining set of target regions
        • LNGOAL - (Link Neutral Goal) Route the transaction to the target region that:
          • Is the most likely to allow the transaction to meet the response time goal set for it and other transactions in its z/OS workload management class
            • When a specific target cannot be identified, apply the LNQUEUE algorithm to the remaining set of target regions
            Note The link speed from the router to the target is not factored into the routing weight calculation for the LNGOAL algorithm
        • INHERIT - Use the algorithm type specified in the WLM specification (WLMSPEC) to which this transaction group is associated.

Copyright ? 2008-2015 IBM Corp. All Rights Reserved.