Interface IResourceAssignmentDefinition

    • Method Detail

      • getChangeAgent

        IResourceAssignmentDefinition.ChangeAgentValue getChangeAgent()
        Getter for field CHANGEAGENT

        Last modification agent

        The change agent identifier that made the last modification.

        • DREPAPI - Resource was last changed by a CICSPlex SM API command.
        • N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
      • getName

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

        Name

        The name of the resource assignment.

        Specified by:
        getName in interface ICICSObject
      • getTargetScope

        java.lang.String getTargetScope()
        Getter for field TSCOPE

        Target scope

        The name of the CICS system or system group where the resources are to be assigned. The scope information contained in resource assignments (RASGNDEF) takes precedence over the information contained in the association between the resource description and resource assignment view (RASINDSC), and over the information contained in the resource description view (RESDESC).

      • getRelatedScope

        java.lang.String getRelatedScope()
        Getter for field RSCOPE

        Related scope

        The name of the CICS system or system group where resources identified as REMOTE to the target scope are to be assigned as LOCAL. The scope information contained in resource assignments (RASGNDEF) takes precedence over the information contained in the association between the resource description and resource assignment view (RASINDSC), and over the information contained in the resource description view (RESDESC).

      • getResourceGroup

        java.lang.String getResourceGroup()
        Getter for field RESGROUP

        Resource group

        The name of the resource group that contains the resource definitions of the specified resource type to be assigned. The resource group information contained in the resource assignment definition (RASGNDEF) takes precedence over the information contained in the association between the resource description and resource assignment (RASINDSC), and over the information contained in the resource description (RESDESC).

      • getResourceType

        java.lang.String getResourceType()
        Getter for field RDEFTYPE

        Resource type

        The type of resources to be processed by the assignment.

      • getReferencedResourceAssignment

        java.lang.String getReferencedResourceAssignment()
        Getter for field REFASSGN

        Referenced resource assignment name

        The resource assignment that applies to the related session definitions (SESSDEF) when a Resource Type field contains CONNDEF (for connections). For each connection, CICSPlex SM requires one or more session definitions to construct the actual CICS link properly.

      • getResourceUsage

        IResourceAssignmentDefinition.ResourceUsageValue getResourceUsage()
        Getter for field USAGE

        Resource usage

        Indicates how the resources will be used:

        • LOCAL - The resources are contained within the target CICS systems.
        • REMOTE - The resource definitions refer to resources installed in a different CICS system, as identified in the Related Scope field.

      • getResourceUsageQualifier

        IResourceAssignmentDefinition.ResourceUsageQualifierValue getResourceUsageQualifier()
        Getter for field MODE

        Resource usage qualifier

        For some resource types, CICSPlex SM requires additional information to determine which subset of resource attributes to use in processing a resource assignment. The value you should specify depends on the resource type being assigned:

        • Programs (PROGDEF) - If you specified LOCAL in the Usage field, you can specify AUTO to have CICS automatically install programs into a system. AUTO means that no explicit definition of the programs is required in the CICS system. Otherwise, specify N/A. If REMOTE is specified in the Usage field, you can identify how the program is to be routed:
          • DYNAM - Programs are processed by the dynamic routing program (DTR).
          • STAT - Programs are sent to the remote CICS system identified in the Related Scope
        • Transactions (TRANDEF) - You can specify whether or not the transaction should be processed by the dynamic routing program. If the Usage field contains REMOTE, a Mode must be specified.
          • DYNAM - Transactions are processed by the dynamic routing program.
          • STAT - Each transaction should be sent to the remote CICS system identified in the transaction definition (TRANDEF). This mode may be specified only if the Usage field contains REMOTE. Note: The value you specify when creating a resource assignment overrides the Dynamic value in the TRANDEF.
          Note: The value you specify when creating a resource assignment overrides the Dynamic value in the TRANDEF
        • Transient data queues (TDQDEF) - You can identify the type of transient data queue to be assigned:
          • EXTRA - Extrapartition TDQ.
          • IND - Indirect TDQ.
          • INTRA - Intrapartition TDQ.
          If you specify N/A, CICSPlex SM uses the Type value in the TDQDEF to assign the transient data queue. If the Type value is REMOTE, CICSPlex SM assigns an indirect TDQ.
        For all other resources, specify N/A because no MODE data is required.
      • getOverrideScope

        IResourceAssignmentDefinition.OverrideScopeValue getOverrideScope()
        Getter for field OVERRIDE

        Scope that override is applied to

        If you plan to specify an override expression for the resources, indicate to which scope the override values should be applied:

        • NONE - Do not apply any override values.
        • BOTH - Apply the override values to both scopes.
        • RELATED - Apply the override values to the Related Scope only.
        • TARGET - Apply the override values to the Target Scope only.
      • getFilterString

        java.lang.String getFilterString()
        Getter for field FILTER

        Filter string

        (Optional.) Identifies attributes that are to be used in selecting resources to be assigned. CICSPlex SM processes only those resources that meet the specified filter criteria.

        A filter expression can be made up of one or more attribute expressions in the form 'attribute operator value'. Valid operators are <, <=, =, >=, > and ¬=. Attribute expressions can be combined using AND or OR operators, parentheses to group expressions and NOT to negate an expression.

        If a value contains embedded blanks or special characters (including periods, commas or equal signs) the entire value must be enclosed in single quotes. If a single quote is included in a value it should be converted to two single quotes.

        The filter expression must be terminated with a period.

      • getOverrideString

        java.lang.String getOverrideString()
        Getter for field ORSTRING

        Override string

        (Optional.) Identifies attributes of the specified resources whose values are to be overridden when they are assigned to the scope(s) identified in the OVERRIDE field.

        The string, that defines which values are to be overridden, can be made up of one or more expressions, of the form attribute=value, separated by commas and terminated with a period.

        If a value contains embedded blanks or special characters (including periods, commas or equal signs) the entire value must be enclosed in single quotes. If a single quote is included in a value it should be converted to two single quotes.

      • getDescription

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

        Description

        A description of the resource assignment.