TRANSLATE

Translate resource table attribute values.

Description

This command translates resource table attribute values that are maintained in an encoded form (such as EYUDA and CVDA values) between their internal coded format and an external display format.
  • If your program is written in REXX, you can use the TPARSE command to access a resource table record and translate its attribute values. However, if you use the ASIS option with TPARSE, attribute values are not translated into their external format; in that case, you would need to use TRANSLATE after using TPARSE to receive the formatted display values. For a description of the TPARSE command, see REXX functions and commands.
  • Start of changeIn a CICS environment, the DFHVALUE function can return incompatible CVDA values for the following resource table attributes:
    Resource table Attribute value
    CONNECT RECOVSTATUS(NRS)
    IPCONN RECOVSTATUS(NRS)
    LIBRARY CRITSTATUS(CRITICAL)
    LOCTRAN RESSEC(RESSECEXT)
    PROGDEF API(CICSAPI)
    PROGRAM APIST(CICSAPI)
    PROGRAM LPASTAT(NOTSVA)
    PROGRAM LPASTAT(SVA)
    Because these CVDA values conflict with values used in CICS, CICSPlex SM must modify them to retain their uniqueness. CICSPlex SM adds either 8000 or 9000 to the value returned by DFHVALUE for each of these CICS CVDA attributes.

    If you want to translate any of these attributes, you must add either 8000 or 9000 to the value you received from DFHVALUE before presenting the attribute to CICSPlex SM.

    End of change

Options

ATTRIBUTE(data-value)
Identifies the resource table attribute that is to be translated. This value must be the 1- to 12-character name of a valid attribute for the resource table.
FROMCHAR(data-value)
Specifies the 1- to 12-character value for the specified attribute.
FROMCV(data-value)
Specifies the 4-byte internal coded value for the specified attribute.
OBJECT(data-value)
Identifies the resource table to which the attribute being translated belongs. This value must be the 8-character name of a valid resource table.
REASON(data-ref)
Names a variable to receive the fullword reason value returned by this command.
RESPONSE(data-ref)
Names a variable to receive the fullword response value returned by this command.
THREAD(cpsm-token)
Identifies the API thread to be used for this operation. The cpsm-token value that identifies a thread is returned by the CONNECT command.
TOCHAR(data-ref)
Names a variable to receive the result of translating an internal coded value to the 1- to 12-character value for the specified attribute.
TOCV(data-ref)
Names a variable to receive the result of translating a character value to the 4-byte internal coded value for the specified attribute.

Conditions

The following is a list of the RESPONSE values that can be returned by the TRANSLATE command. The description of each RESPONSE includes a list of associated REASON values, if appropriate.
OK
The command completed processing successfully.
ENVIRONERROR
An environment error occurred for one of the following reasons:
NOSERVICE
The application stub program could not load the API service module.
NOSTORAGE
The application stub program could not obtain the necessary storage in the address space where the processing thread is running.
SOCRESOURCE
A required resource that is owned by the CMAS is not available.
FAILED
The command failed for one of the following reasons:
ABENDED
Command processing abended.
EXCEPTION
Command processing encountered an exceptional condition.
INVALIDPARM
An invalid parameter was detected. The parameter that is invalid is returned as the reason value:
  • ATTRIBUTE
  • FROMCHAR
  • FROMCV
  • OBJECT
  • THREAD
  • TOCHAR
  • TOCV.
Check the command description for valid parameter syntax.
NOTAVAILABLE
A not available condition occurred for one of the following reasons:
APITASK
The API control subtask is not active.
CPSMAPI
The CMAS to which the processing thread is connected is not available for API processing.
SERVERGONE
The CMAS to which the processing thread was connected is no longer active.
TABLEERROR
A resource table record is invalid for the following reason:
INVALIDVER
The specified version of the resource table is not supported by CICSPlex SM.
VERSIONINVL
A version conflict occurred for one of the following reasons:
NOTSUPPORTED
The version of the application stub program used for this command is not supported.
NOTVSNCONN
The version of the application stub program used for this command is not the same as the version used with the CONNECT command.