com.ibm.cics.model

Interface IWorkloadAffinity

    • Method Detail

      • getTransactionGroup

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

        Transaction group

        The name of an active transaction group. A value of $$DTGA$$ represents the default transaction group, which is used for any transactions that are not associated with a transaction group.

      • getWorkload

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

        Workload name

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

      • getAffinity

        IWorkloadAffinity.AffinityValue getAffinity()
        Getter for field AFFINITY

        Affinity relationship

        The affinity relationship used when processing a transaction associated with the 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.
        • NONE - No affinity relation was defined.

      • getLifetime

        IWorkloadAffinity.LifetimeValue getLifetime()
        Getter for field LIFETIME

        Affinity lifetime

        The affinity lifetime used when processing a transaction associated with the transaction group. The affinity lifetime values are:

        • DELIMIT - Until the pseudoconversation mode is END.
        • LOGON - For the duration of the terminal session.
        • NONE - No affinity lifetime was defined.
        • 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 target region 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

      • getUserId

        java.lang.String getUserId()
        Getter for field USERID

        User identifier

        The user identifier ID.

      • getLuName

        java.lang.String getLuName()
        Getter for field LUNAME

        Terminal LU name

        The logical unit name of the terminal of the CICS system to which transactions associated with the transaction group are to be routed.

      • getRoutingRegion

        java.lang.String getRoutingRegion()
        Getter for field TORNAME

        Routing region

        The name of the CICS system to which transactions associated with the transaction group are to be routed.

      • getTerminalId

        java.lang.String getTerminalId()
        Getter for field TERMID

        Routing region terminal

        The terminal ID of the CICS system to which transactions associated with the transaction group are to be routed.

      • getCbtsActivityID

        java.lang.String getCbtsActivityID()
        Getter for field RESERVD2

        The activity ID of the CBTS activity

        The ID of the CBTS activity.

      • getTargetRegion

        java.lang.String getTargetRegion()
        Getter for field AOR

        Target region

        The name of the CICS system to which transactions associated with the transaction group are to be routed.

      • getWorkloadOwner

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

        System ID of workload owner

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

      • getBtsActivityID

        java.lang.String getBtsActivityID()
        Getter for field CBTSKEY

        BTS activity ID

        The hexadecimal representation of the Affinity Key. It is shown in this additional format because part of the key may not be displayable in normal character representation.

      • getLocalUOWID

        java.lang.String getLocalUOWID()
        Getter for field LOCUOWID

        Local unit-of-work ID

        The hexadecimal representation of the CICS local unit-of-work identifier. It is shown in this additional format because part of the key may not be displayable in normal character representation.

      • getNetworkUOWID

        java.lang.String getNetworkUOWID()
        Getter for field NETUOWID

        Network unit-of-work ID

        The hexadecimal representation of the CICS network unit-of-work identifier. It is shown in this additional format because part of the key may not be displayable in normal character representation.

      • getAffinityKey

        java.lang.String getAffinityKey()
        Getter for field AFFKEY

        Key that identifies creator of affinity

        Up to 64 characters identifying who invoked a transaction, comprising the transaction group and their location. Depending on the affinity relation and lifetime values, this key will be some combination of the user ID, logical unit name, routing region name, and terminal ID, in the following format: userid.luname.rtrname.termid. If one or more of these values does not apply to the affinity, that part of the key is left blank.

        For BAPPL affinities, this field contains the Activity ID of the CICS BTS activity.

        For LOCKED affinities, this field contains the combination of the routing region name with the network and local unit-of-work identifiers.

        A value of GA is displayed for global affinities.

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