com.ibm.cics.model

Interface IWorkloadTransactionGroup

    • Method Detail

      • getTransactionGroup

        java.lang.String getTransactionGroup()
        Getter for field TRANGRP

        Transaction group

        The name of the transaction group.

      • getWorkload

        java.lang.String getWorkload()
        Getter for field WORKLOAD

        Workload

        The name of the workload in which the transaction group is active.

      • getStatus

        IWorkloadTransactionGroup.StatusValue getStatus()
        Getter for field STATUS

        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.
      • getFilter

        IWorkloadTransactionGroup.FilterValue getFilter()
        Getter for field FILTER

        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.

      • getAffinity

        IWorkloadTransactionGroup.AffinityValue getAffinity()
        Getter for field AFFINITY

        Affinity relationship

        The affinity relationship used when processing occurrences of the transaction group. The affinity relationship values are:

        • GLOBAL - All users at all terminals
        • LUNAME - Terminal logical unit name
        • NONE - No affinity was defined
        • N/A - This field is not applicable
        • 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.
      • getAffinityLifetime

        IWorkloadTransactionGroup.AffinityLifetimeValue getAffinityLifetime()
        Getter for field AFFLIFE

        Affinity lifetime

        The affinity lifetime to be used when processing occurrences of the 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 pseudoconversation
        • 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
        • NONE - No affinity lifetime was defined
        • N/A - This field is not applicable
      • getAbendCrit

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

        Acceptable abend level

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

      • getAbendThreshold

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

        Acceptable target region load level

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

      • getEventName

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

        Event name

        The name of an analysis definition (RTADEF) or status definition (STATDEF) that may affect the routing of transactions in this workload. If a real-time analysis event is generated by this definition, WLM uses the information as part of the AOR selection criteria.

        An analysis or status definition can optionally be associated with a workload when the workload specification is created. If this field is blank, no analysis or status definition is associated with the workload.

        Note: The EVENT view is displayed only if an event of the specified type has occurred.

      • getWorkloadOwner

        java.lang.String getWorkloadOwner()
        Getter for field WRKLOWNER

        Workload owner

        The 4-character CICS system ID of the CMAS that created the workload.

      • getAutomaticAffinityCreation

        IWorkloadTransactionGroup.AutomaticAffinityCreationValue getAutomaticAffinityCreation()
        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 relationship 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 relationship and Affinity lifetime fields, therefore, no affinity is created.
      • getAlgorithmType

        IWorkloadTransactionGroup.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 - 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 MVS workload management class
            • When a specific target cannot be identified, apply the QUEUE algorithm to the remaining set of target regions
        • LNGOAL - 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 MVS workload management class
            • When a specific target cannot be identified, apply the LNQUEUE algorithm to the remaining set of target regions
        • INHERIT - Use the algorithm type specified in the WLM specification (WLMSPEC) to which this transaction group is associated.
      • getTransactionCount

        java.lang.Long getTransactionCount()
        Getter for field TRANCNT

        Active transaction count

        The number of active transactions that are associated with this transaction group.

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